Interface CreateSecretStorageOpts

Parameter of CryptoApi#bootstrapSecretStorage

interface CreateSecretStorageOpts {
    createSecretStorageKey?: (() => Promise<GeneratedSecretStorageKey>);
    getKeyBackupPassphrase?: (() => Promise<Uint8Array>);
    keyBackupInfo?: KeyBackupInfo;
    setupNewKeyBackup?: boolean;
    setupNewSecretStorage?: boolean;
}

Properties

createSecretStorageKey? getKeyBackupPassphrase? keyBackupInfo? setupNewKeyBackup? setupNewSecretStorage?

Properties

Optional createSecretStorageKey

createSecretStorageKey?: (() => Promise<GeneratedSecretStorageKey>)

Function called to await a secret storage key creation flow.

Type declaration

Returns

Promise resolving to an object with public key metadata, encoded private recovery key which should be disposed of after displaying to the user, and raw private key to avoid round tripping if needed.

Optional getKeyBackupPassphrase

getKeyBackupPassphrase?: (() => Promise<Uint8Array>)

Function called to get the user's current key backup passphrase. Should return a promise that resolves with a Uint8Array containing the key, or rejects if the key cannot be obtained.

Type declaration

Optional keyBackupInfo

keyBackupInfo?: KeyBackupInfo

The current key backup object. If passed, the passphrase and recovery key from this backup will be used.

Optional setupNewKeyBackup

setupNewKeyBackup?: boolean

If true, a new key backup version will be created and the private key stored in the new SSSS store. Ignored if keyBackupInfo is supplied.

Optional setupNewSecretStorage

setupNewSecretStorage?: boolean

Reset even if keys already exist.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc