Interface CreateSecretStorageOpts

Parameter of CryptoApi#bootstrapSecretStorage

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

Index

Properties

createSecretStorageKey? setupNewKeyBackup? setupNewSecretStorage?

Properties

`Optional`createSecretStorageKey

createSecretStorageKey?: () => Promise<GeneratedSecretStorageKey>

Function called to await a secret storage key creation flow.

Type declaration

- (): Promise<GeneratedSecretStorageKey>
- Returns Promise<GeneratedSecretStorageKey>
  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`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.