Class AesGcmEncryptionStrategy

Default aes-256-gcm encryption strategy implementation of Zibri.

Implements

EncryptionStrategyInterface<Buffer, AesGcmEncryptOptions, AesGcmDecryptOptions>

Index

Constructors

Properties

Methods

decrypt deserializeKey encrypt generateRandomKey serializeKey

Constructors

constructor

new AesGcmEncryptionStrategy(): AesGcmEncryptionStrategy
Returns AesGcmEncryptionStrategy

Properties

`Readonly`name

name: CipherGCMTypes = 'aes-256-gcm'

The name of the strategy.

`Readonly`version

version: string = 'v1'

The version of the strategy.

Methods

decrypt

decrypt(value: EncryptionString, options: AesGcmDecryptOptions): string
Decrypts the given value with the given options.
Parameters
- value: EncryptionString
- options: AesGcmDecryptOptions
Returns string
Implementation of EncryptionStrategyInterface.decrypt
- Defined in src/auth/encryption/strategies/aes-gcm.encryption-strategy.ts:72

deserializeKey

deserializeKey(raw: Buffer): Buffer
Resolves a key from the given Buffer.
Parameters
- raw: Buffer
Returns Buffer
Implementation of EncryptionStrategyInterface.deserializeKey
- Defined in src/auth/encryption/strategies/aes-gcm.encryption-strategy.ts:112

encrypt

encrypt(value: string, options: AesGcmEncryptOptions): EncryptionString
Encrypts the given value with the given options.
Parameters
- value: string
- options: AesGcmEncryptOptions
Returns EncryptionString
Implementation of EncryptionStrategyInterface.encrypt
- Defined in src/auth/encryption/strategies/aes-gcm.encryption-strategy.ts:42

generateRandomKey

generateRandomKey(): Buffer
Generates a new random key.

Returns Buffer
Implementation of EncryptionStrategyInterface.generateRandomKey
- Defined in src/auth/encryption/strategies/aes-gcm.encryption-strategy.ts:102

serializeKey

serializeKey(key: Buffer): Buffer
Serializes the given key into a Buffer.
Parameters
- key: Buffer
Returns Buffer
Implementation of EncryptionStrategyInterface.serializeKey
- Defined in src/auth/encryption/strategies/aes-gcm.encryption-strategy.ts:107