Skip to content

Commit

Permalink
Deprecate CreateSecretStorageOpts.getKeyBackupPassphrase (#4313)
Browse files Browse the repository at this point in the history
it doesn't work in rust crypto, and we have no plans to fix it
(element-hq/element-web#27455)
  • Loading branch information
richvdh authored Jul 13, 2024
1 parent f17a4fe commit 30a2681
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions src/crypto-api/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -854,9 +854,14 @@ export interface CreateSecretStorageOpts {
setupNewSecretStorage?: boolean;

/**
* Function called to get the user's
* current key backup passphrase. Should return a promise that resolves with a 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.
*
* Only used when the client has existing key backup, but no secret storage.
*
* @deprecated Not used by the Rust crypto stack.
*/
getKeyBackupPassphrase?: () => Promise<Uint8Array>;
}
Expand Down

0 comments on commit 30a2681

Please sign in to comment.