Class EncryptionService

Default encryption service implementation of Zibri.

Implements

Index

Constructors

constructor

Methods

createKey decrypt decryptKey deleteAllKeys deleteKey encrypt markKeyAsDefaultForStrategy needsReEncryption onAppInit

Constructors

constructor

new EncryptionService(
    strategyRepository: Repository<
        EncryptionStrategyEntity,
        EncryptionStrategyEntityCreateData,
    >,
    keyRepository: Repository<EncryptionKey, EncryptionKeyCreateData>,
    strategyClasses: Newable<
        EncryptionStrategyInterface<
            unknown,
            BaseEncryptOptions<unknown>,
            BaseDecryptOptions<unknown>,
        >,
    >[],
    options: EncryptionMasterOptions<unknown> | undefined,
): EncryptionService
Parameters
- strategyRepository: Repository<EncryptionStrategyEntity, EncryptionStrategyEntityCreateData>
- keyRepository: Repository<EncryptionKey, EncryptionKeyCreateData>
- strategyClasses: Newable<
      EncryptionStrategyInterface<
          unknown,
          BaseEncryptOptions<unknown>,
          BaseDecryptOptions<unknown>,
      >,
  >[]
- options: EncryptionMasterOptions<unknown> | undefined
Returns EncryptionService
- Defined in src/auth/encryption/encryption.service.ts:79

Methods

createKey

createKey<TKey>(
    strategyClass: Newable<
        EncryptionStrategyInterface<
            TKey,
            BaseEncryptOptions<TKey>,
            BaseDecryptOptions<TKey>,
        >,
    >,
    data: OmitStrict<EncryptionKeyCreateData, "strategy" | "value">,
    options?: BaseRepositoryOptions,
): Promise<EncryptionKey>
Creates a new encryption key for the given strategy.
Type Parameters
- TKey
Parameters
- strategyClass: Newable<
      EncryptionStrategyInterface<
          TKey,
          BaseEncryptOptions<TKey>,
          BaseDecryptOptions<TKey>,
      >,
  >
- data: OmitStrict<EncryptionKeyCreateData, "strategy" | "value">
- Optionaloptions: BaseRepositoryOptions
Returns Promise<EncryptionKey>
Implementation of EncryptionServiceInterface.createKey
- Defined in src/auth/encryption/encryption.service.ts:226

decrypt

decrypt<TDecryptOptions extends AnyObject>(
value: EncryptionString,
options?: TDecryptOptions,
): Promise<string>
Decrypts the given value using the provided options.
Type Parameters
- TDecryptOptions extends AnyObject
Parameters
- value: EncryptionString
- Optionaloptions: TDecryptOptions
Returns Promise<string>
Implementation of EncryptionServiceInterface.decrypt
- Defined in src/auth/encryption/encryption.service.ts:215

decryptKey

decryptKey<TKey, TEncryptOptions extends BaseEncryptOptions<TKey>>(
    strategy: Newable<
        EncryptionStrategyInterface<
            TKey,
            TEncryptOptions,
            BaseDecryptOptions<TKey>,
        >,
    >,
    encryptedKey: EncryptionString,
): Promise<TKey>
Decrypts the key of the given strategy.
Type Parameters
- TKey
- TEncryptOptions extends BaseEncryptOptions<TKey>
Parameters
- strategy: Newable<
      EncryptionStrategyInterface<
          TKey,
          TEncryptOptions,
          BaseDecryptOptions<TKey>,
      >,
  >
- encryptedKey: EncryptionString
Returns Promise<TKey>
Implementation of EncryptionServiceInterface.decryptKey
- Defined in src/auth/encryption/encryption.service.ts:329

deleteAllKeys

deleteAllKeys(
where: Where<EncryptionKey>,
options?: DeleteEncryptionKeyOptions,
): Promise<void>
Deletes all keys that match the given where clause.
Parameters
- where: Where<EncryptionKey>
- options: DeleteEncryptionKeyOptions = {}
Returns Promise<void>
Implementation of EncryptionServiceInterface.deleteAllKeys
- Defined in src/auth/encryption/encryption.service.ts:260

deleteKey

deleteKey(keyId: string, options?: DeleteEncryptionKeyOptions): Promise<void>
Deletes the key with the given id.
Parameters
- keyId: string
- Optionaloptions: DeleteEncryptionKeyOptions
Returns Promise<void>
Implementation of EncryptionServiceInterface.deleteKey
- Defined in src/auth/encryption/encryption.service.ts:247

encrypt

encrypt<TKey, TEncryptOptions extends BaseEncryptOptions<TKey>>(
value: string,
options?: EncryptOptions<TKey, TEncryptOptions>,
): Promise<EncryptionString>
Encrypts the given value using the provided options.
Type Parameters
- TKey
- TEncryptOptions extends BaseEncryptOptions<TKey>
Parameters
- value: string
- Optionaloptions: EncryptOptions<TKey, TEncryptOptions>
Returns Promise<EncryptionString>
Implementation of EncryptionServiceInterface.encrypt
- Defined in src/auth/encryption/encryption.service.ts:120

markKeyAsDefaultForStrategy

markKeyAsDefaultForStrategy<TKey>(
    keyId: string,
    strategyClass: Newable<
        EncryptionStrategyInterface<
            TKey,
            BaseEncryptOptions<TKey>,
            BaseDecryptOptions<TKey>,
        >,
    >,
    options?: BaseRepositoryOptions,
): Promise<void>
Marks the key with the given id as the default key for the given strategy.
Type Parameters
- TKey
Parameters
- keyId: string
- strategyClass: Newable<
      EncryptionStrategyInterface<
          TKey,
          BaseEncryptOptions<TKey>,
          BaseDecryptOptions<TKey>,
      >,
  >
- options: BaseRepositoryOptions = {}
Returns Promise<void>
Implementation of EncryptionServiceInterface.markKeyAsDefaultForStrategy
- Defined in src/auth/encryption/encryption.service.ts:286

needsReEncryption

needsReEncryption(encrypted: EncryptionString): Promise<boolean>
Checks whether or not the given encryption string should be re-encrypted.
Parameters
- encrypted: EncryptionString
Returns Promise<boolean>
Implementation of EncryptionServiceInterface.needsReEncryption
- Defined in src/auth/encryption/encryption.service.ts:339

onAppInit

onAppInit(): Promise<void>
Runs when the app initializes.

Returns Promise<void>
Implementation of OnAppInit.onAppInit
- Defined in src/auth/encryption/encryption.service.ts:96

Class EncryptionService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EncryptionService

Methods

createKey

Type Parameters

Parameters

Returns Promise<EncryptionKey>

decrypt

Type Parameters

Parameters

Returns Promise<string>

decryptKey

Type Parameters

Parameters

Returns Promise<TKey>

deleteAllKeys

Parameters

Returns Promise<void>

deleteKey

Parameters

Returns Promise<void>

encrypt

Type Parameters

Parameters

Returns Promise<EncryptionString>

markKeyAsDefaultForStrategy

Type Parameters

Parameters

Returns Promise<void>

needsReEncryption

Parameters

Returns Promise<boolean>

onAppInit

Returns Promise<void>

Settings

On This Page