Skip to content

Commit 30a2681

Browse files
authored
Deprecate CreateSecretStorageOpts.getKeyBackupPassphrase (#4313)
it doesn't work in rust crypto, and we have no plans to fix it (element-hq/element-web#27455)
1 parent f17a4fe commit 30a2681

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/crypto-api/index.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -854,9 +854,14 @@ export interface CreateSecretStorageOpts {
854854
setupNewSecretStorage?: boolean;
855855

856856
/**
857-
* Function called to get the user's
858-
* current key backup passphrase. Should return a promise that resolves with a Uint8Array
857+
* Function called to get the user's current key backup passphrase.
858+
*
859+
* Should return a promise that resolves with a Uint8Array
859860
* containing the key, or rejects if the key cannot be obtained.
861+
*
862+
* Only used when the client has existing key backup, but no secret storage.
863+
*
864+
* @deprecated Not used by the Rust crypto stack.
860865
*/
861866
getKeyBackupPassphrase?: () => Promise<Uint8Array>;
862867
}

0 commit comments

Comments
 (0)