Interface CreateSecretStorageOpts

Parameter of bootstrapSecretStorage

Hierarchy

CreateSecretStorageOpts

Index

Properties

createSecretStorageKey? getKeyBackupPassphrase? keyBackupInfo? setupNewKeyBackup? setupNewSecretStorage?

Properties

`Optional` createSecretStorageKey

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

Type declaration

- (): Promise<GeneratedSecretStorageKey>
- Function called to await a secret storage key creation flow.
  
  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` getKeyBackupPassphrase

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

Type declaration

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

`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.

Generated using TypeDoc