zibri 2.2.1 → 2.4.0

package/dist/cjs/auth/encryption/encryption-service.interface.d.ts

@@ -0,0 +1,68 @@
+import { EncryptionKey, EncryptionKeyCreateData } from './encryption-key.model';
+import { EncryptionString } from './encryption.utilities';
+import { BaseEncryptOptions, EncryptionStrategyInterface } from './strategies/encryption-strategy.interface';
+import { BaseRepositoryOptions } from '../../data-source/models/options/base-repository-options.model';
+import { Where } from '../../data-source/models/where/where-filter.model';
+import { AnyObject } from '../../entity/any-object.model';
+import { Newable } from '../../types/newable.type';
+import { OmitStrict } from '../../types/omit-strict.type';
+/**
+ * Options for encrypting a value.
+ */
+export type EncryptOptions<TKey, TEncryptOptions extends BaseEncryptOptions<TKey>> = {
+    /**
+     * The strategy to use.
+     */
+    strategy: Newable<EncryptionStrategyInterface<TKey, TEncryptOptions>>;
+    /**
+     * Additional options for that strategy.
+     */
+    strategyOptions?: Partial<OmitStrict<TEncryptOptions, 'key'>>;
+};
+/**
+ * Additional options for deleting encryption keys.
+ */
+export type DeleteEncryptionKeyOptions = BaseRepositoryOptions & {
+    /**
+     * Whether or not it is allowed to delete the default key.
+     */
+    allowDefault?: boolean;
+};
+/**
+ * Interface for an encryption service.
+ */
+export interface EncryptionServiceInterface {
+    /**
+     * Encrypts the given value using the provided options.
+     */
+    encrypt: <TKey, TEncryptOptions extends BaseEncryptOptions<TKey>>(value: string, options?: EncryptOptions<TKey, TEncryptOptions>) => EncryptionString | Promise<EncryptionString>;
+    /**
+     * Decrypts the given value using the provided options.
+     */
+    decrypt: <TDecryptOptions extends BaseRepositoryOptions & AnyObject>(value: EncryptionString, options?: TDecryptOptions) => string | Promise<string>;
+    /**
+     * Creates a new encryption key for the given strategy.
+     */
+    createKey: <TKey>(strategy: Newable<EncryptionStrategyInterface<TKey>>, data: OmitStrict<EncryptionKeyCreateData, 'strategy' | 'value'>, options?: BaseRepositoryOptions) => EncryptionKey | Promise<EncryptionKey>;
+    /**
+     * Deletes the key with the given id.
+     */
+    deleteKey: (keyId: string, options?: DeleteEncryptionKeyOptions) => void | Promise<void>;
+    /**
+     * Deletes all keys that match the given where clause.
+     */
+    deleteAllKeys: (where: Where<EncryptionKey>, options?: DeleteEncryptionKeyOptions) => void | Promise<void>;
+    /**
+     * Marks the key with the given id as the default key for the given strategy.
+     */
+    markKeyAsDefaultForStrategy: <TKey>(keyId: string, strategy: Newable<EncryptionStrategyInterface<TKey>>, options?: BaseRepositoryOptions) => void | Promise<void>;
+    /**
+     * Decrypts the key of the given strategy.
+     */
+    decryptKey: <TKey>(strategy: Newable<EncryptionStrategyInterface<TKey>>, encryptedKey: EncryptionString) => Promise<TKey>;
+    /**
+     * Checks whether or not the given encryption string should be re-encrypted.
+     */
+    needsReEncryption: (encrypted: EncryptionString) => boolean | Promise<boolean>;
+}
+//# sourceMappingURL=encryption-service.interface.d.ts.map

package/dist/cjs/auth/encryption/encryption-service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption-service.interface.d.ts","sourceRoot":"","sources":["../../../../src/auth/encryption/encryption-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AAC7G,OAAO,EAAE,qBAAqB,EAAE,MAAM,gEAAgE,CAAC;AACvG,OAAO,EAAE,KAAK,EAAE,MAAM,mDAAmD,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,EAAE,eAAe,SAAS,kBAAkB,CAAC,IAAI,CAAC,IAAI;IACjF;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;IACtE;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,CAAA;CAChE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,qBAAqB,GAAG;IAC7D;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAC5D,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,KAC9C,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAClD;;OAEG;IACH,OAAO,EAAE,CAAC,eAAe,SAAS,qBAAqB,GAAG,SAAS,EAC/D,KAAK,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,eAAe,KACxB,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,CAAC,IAAI,EACZ,QAAQ,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,EACpD,IAAI,EAAE,UAAU,CAAC,uBAAuB,EAAE,UAAU,GAAG,OAAO,CAAC,EAC/D,OAAO,CAAC,EAAE,qBAAqB,KAC9B,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5C;;OAEG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzF;;OAEG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,EAAE,0BAA0B,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3G;;OAEG;IACH,2BAA2B,EAAE,CAAC,IAAI,EAC9B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,EACpD,OAAO,CAAC,EAAE,qBAAqB,KAC9B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B;;OAEG;IACH,UAAU,EAAE,CAAC,IAAI,EACb,QAAQ,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,EACpD,YAAY,EAAE,gBAAgB,KAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB;;OAEG;IACH,iBAAiB,EAAE,CAAC,SAAS,EAAE,gBAAgB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACjF"}

package/dist/cjs/auth/encryption/encryption-service.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=encryption-service.interface.js.map

package/dist/cjs/auth/encryption/encryption-service.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption-service.interface.js","sourceRoot":"","sources":["../../../../src/auth/encryption/encryption-service.interface.ts"],"names":[],"mappings":""}

package/dist/cjs/auth/encryption/encryption.service.d.ts

@@ -0,0 +1,71 @@
+import { EncryptionKeyCreateData, EncryptionKey } from './encryption-key.model';
+import { type EncryptionMasterOptions } from './encryption-master-options.model';
+import { type DeleteEncryptionKeyOptions, EncryptionServiceInterface, EncryptOptions } from './encryption-service.interface';
+import { type EncryptionString } from './encryption.utilities';
+import { EncryptionStrategyEntity, type EncryptionStrategyEntityCreateData } from './strategies/encryption-strategy-entity.model';
+import { BaseEncryptOptions, EncryptionStrategyInterface } from './strategies/encryption-strategy.interface';
+import { WriteThroughReadThroughCache } from '../../caching/cache/read-through/write-through-read-through.cache';
+import { type CacheServiceInterface } from '../../caching/cache-service.interface';
+import { type BaseRepositoryOptions } from '../../data-source/models/options/base-repository-options.model';
+import { Where } from '../../data-source/models/where/where-filter.model';
+import { Repository } from '../../data-source/repository';
+import { AnyObject } from '../../entity/any-object.model';
+import { OnAppInit } from '../../global/on-app-init.interface';
+import { type LoggerInterface } from '../../logging/logger.interface';
+import { type MetricsServiceInterface } from '../../metrics/metrics-service.interface';
+import { type Newable } from '../../types/newable.type';
+import { type OmitStrict } from '../../types/omit-strict.type';
+export declare class EncryptionKeyCache extends WriteThroughReadThroughCache<string, EncryptionKey, 'EncryptionKeyCache'> {
+    protected get logger(): LoggerInterface;
+    protected get cacheService(): CacheServiceInterface;
+    protected get metricsService(): MetricsServiceInterface;
+    constructor();
+}
+/**
+ * Default encryption service implementation of Zibri.
+ */
+export declare class EncryptionService implements EncryptionServiceInterface, OnAppInit {
+    private readonly strategyRepository;
+    private readonly keyRepository;
+    private readonly strategyClasses;
+    private hasCreatedInitialDefaultStrategy;
+    private readonly strategies;
+    private readonly strategyEntities;
+    private readonly options;
+    constructor(strategyRepository: Repository<EncryptionStrategyEntity, EncryptionStrategyEntityCreateData>, keyRepository: Repository<EncryptionKey, EncryptionKeyCreateData>, strategyClasses: Newable<EncryptionStrategyInterface<unknown>>[], options: EncryptionMasterOptions<unknown> | undefined);
+    onAppInit(): Promise<void>;
+    encrypt<TKey, TEncryptOptions extends BaseEncryptOptions<TKey>>(value: string, options?: EncryptOptions<TKey, TEncryptOptions>): Promise<EncryptionString>;
+    decrypt<TDecryptOptions extends AnyObject>(value: EncryptionString, options?: TDecryptOptions): Promise<string>;
+    createKey<TKey>(strategyClass: Newable<EncryptionStrategyInterface<TKey>>, data: OmitStrict<EncryptionKeyCreateData, 'strategy' | 'value'>, options?: BaseRepositoryOptions): Promise<EncryptionKey>;
+    deleteKey(keyId: string, options?: DeleteEncryptionKeyOptions): Promise<void>;
+    deleteAllKeys(where: Where<EncryptionKey>, options?: DeleteEncryptionKeyOptions): Promise<void>;
+    markKeyAsDefaultForStrategy<TKey>(keyId: string, strategyClass: Newable<EncryptionStrategyInterface<TKey>>, options?: BaseRepositoryOptions): Promise<void>;
+    decryptKey<TKey, TEncryptOptions extends BaseEncryptOptions<TKey>>(strategy: Newable<EncryptionStrategyInterface<TKey, TEncryptOptions>>, encryptedKey: EncryptionString): Promise<TKey>;
+    needsReEncryption(encrypted: EncryptionString): Promise<boolean>;
+    private needsMasterReEncryption;
+    private generateEncryptedKey;
+    private findKey;
+    private findKeyEntityById;
+    private createKeyEntity;
+    private updateKeyEntityById;
+    private deleteKeyEntityById;
+    private createStrategyEntity;
+    private syncStrategyEntityKey;
+    private findOrCreateDefaultKeyForStrategy;
+    private findStrategy;
+    private findStrategyClass;
+    private masterEncrypt;
+    private masterDecrypt;
+    private findDefaultStrategy;
+    private validateNoDuplicateEncryptionStrategy;
+    private validateNoDuplicateMasterEncryptionStrategy;
+    private validateNoMissingEncryptionStrategy;
+    private validateNoDotsInMasterKeyIds;
+    private validateNoMissingMasterKeyIds;
+    private validateNoMissingMasterEncryptionStrategy;
+    private validateStrategyNamesAndVersions;
+    private validateMasterStrategyNamesAndVersions;
+    private reEncryptKeys;
+    private reEncryptKey;
+}
+//# sourceMappingURL=encryption.service.d.ts.map

package/dist/cjs/auth/encryption/encryption.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.service.d.ts","sourceRoot":"","sources":["../../../../src/auth/encryption/encryption.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAuB,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACrG,OAAO,EAAE,KAAK,uBAAuB,EAAuB,MAAM,mCAAmC,CAAC;AACtG,OAAO,EAAE,KAAK,0BAA0B,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAC7H,OAAO,EAAqB,KAAK,gBAAgB,EAAuB,MAAM,wBAAwB,CAAC;AACvG,OAAO,EAAE,wBAAwB,EAAE,KAAK,kCAAkC,EAA4B,MAAM,+CAA+C,CAAC;AAC5J,OAAO,EAAsB,kBAAkB,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AACjI,OAAO,EAAE,4BAA4B,EAAE,MAAM,mEAAmE,CAAC;AACjH,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAMnF,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,gEAAgE,CAAC;AAC5G,OAAO,EAAE,KAAK,EAAE,MAAM,mDAAmD,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAS1D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAC/D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAEvF,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAa/D,qBAEa,kBAAmB,SAAQ,4BAA4B,CAAC,MAAM,EAAE,aAAa,EAAE,oBAAoB,CAAC;IAG7G,SAAS,KAAK,MAAM,IAAI,eAAe,CAEtC;IAGD,SAAS,KAAK,YAAY,IAAI,qBAAqB,CAElD;IAGD,SAAS,KAAK,cAAc,IAAI,uBAAuB,CAEtD;;CAKJ;AAED;;GAEG;AACH,qBACa,iBAAkB,YAAW,0BAA0B,EAAE,SAAS;IAQvE,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAEnC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAE9B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAXpC,OAAO,CAAC,gCAAgC,CAAkB;IAC1D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8C;IACzE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkC;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;gBAItC,kBAAkB,EAAE,UAAU,CAAC,wBAAwB,EAAE,kCAAkC,CAAC,EAE5F,aAAa,EAAE,UAAU,CAAC,aAAa,EAAE,uBAAuB,CAAC,EAEjE,eAAe,EAAE,OAAO,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,EAAE,EAEjF,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,GAAG,SAAS;IASnD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB1B,OAAO,CAAC,IAAI,EAAE,eAAe,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAChE,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,GAChD,OAAO,CAAC,gBAAgB,CAAC;IA4FtB,OAAO,CAAC,eAAe,SAAS,SAAS,EAC3C,KAAK,EAAE,gBAAgB,EACvB,OAAO,CAAC,EAAE,eAAe,GAC1B,OAAO,CAAC,MAAM,CAAC;IAQZ,SAAS,CAAC,IAAI,EAChB,aAAa,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,EACzD,IAAI,EAAE,UAAU,CAAC,uBAAuB,EAAE,UAAU,GAAG,OAAO,CAAC,EAC/D,OAAO,CAAC,EAAE,qBAAqB,GAChC,OAAO,CAAC,aAAa,CAAC;IAiBnB,SAAS,CACX,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC;IAUV,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,EAAE,OAAO,GAAE,0BAA+B,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BnG,2BAA2B,CAAC,IAAI,EAClC,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,EACzD,OAAO,GAAE,qBAA0B,GACpC,OAAO,CAAC,IAAI,CAAC;IAuCV,UAAU,CAAC,IAAI,EAAE,eAAe,SAAS,kBAAkB,CAAC,IAAI,CAAC,EACnE,QAAQ,EAAE,OAAO,CAAC,2BAA2B,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,EACrE,YAAY,EAAE,gBAAgB,GAC/B,OAAO,CAAC,IAAI,CAAC;IAOV,iBAAiB,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAatE,OAAO,CAAC,uBAAuB;YAyBjB,oBAAoB;YAOpB,OAAO;YAYP,iBAAiB;YAMjB,eAAe;YAkBf,mBAAmB;YAanB,mBAAmB;YASnB,oBAAoB;IAMlC,OAAO,CAAC,qBAAqB;YASf,iCAAiC;IAM/C,OAAO,CAAC,YAAY;IAcpB,OAAO,CAAC,iBAAiB;YAcX,aAAa;YAkBb,aAAa;IAmB3B,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,qCAAqC;IAc7C,OAAO,CAAC,2CAA2C;IAkBnD,OAAO,CAAC,mCAAmC;IAc3C,OAAO,CAAC,4BAA4B;IAmBpC,OAAO,CAAC,6BAA6B;IAuBrC,OAAO,CAAC,yCAAyC;IAoBjD,OAAO,CAAC,gCAAgC;IAiBxC,OAAO,CAAC,sCAAsC;YAqBhC,aAAa;YAIb,YAAY;CAU7B"}