Type Alias EncryptionMasterOptions<TKey, TEncryptOptions, TDecryptOptions>

Options on how encryption keys should be encrypted.

type EncryptionMasterOptions<
    TKey,
    TEncryptOptions extends BaseEncryptOptions<TKey> = BaseEncryptOptions<TKey>,
    TDecryptOptions extends BaseDecryptOptions<TKey> = BaseEncryptOptions<TKey>,
> = {
    currentMasterKey: EncryptionMasterKey<TKey>;
    currentMasterStrategy: EncryptionStrategyInterface<
        TKey,
        TEncryptOptions,
        TDecryptOptions,
    >;
    oldMasterKeys?: EncryptionMasterKey<unknown>[];
    oldMasterStrategies?: EncryptionStrategyInterface<unknown>[];
}

Type Parameters

TKey
TEncryptOptions extends BaseEncryptOptions<TKey> = BaseEncryptOptions<TKey>
TDecryptOptions extends BaseDecryptOptions<TKey> = BaseEncryptOptions<TKey>

Index

Properties

currentMasterKey currentMasterStrategy oldMasterKeys? oldMasterStrategies?

Properties

currentMasterKey

currentMasterKey: EncryptionMasterKey<TKey>

The current master key for encrypting encryption keys.

currentMasterStrategy

currentMasterStrategy: EncryptionStrategyInterface<
    TKey,
    TEncryptOptions,
    TDecryptOptions,
>

The strategy that is used to encrypt encryption keys.

`Optional`oldMasterKeys

oldMasterKeys?: EncryptionMasterKey<unknown>[]

Any old master keys.

`Optional`oldMasterStrategies

oldMasterStrategies?: EncryptionStrategyInterface<unknown>[]

Any old master strategies.