matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-12-05 17:02:07 +03:00
Code Activity

Fix type docs for checkPrivateKey

Browse Source
This commit is contained in:
J. Ryan Stinnett
2019-12-06 14:41:29 +00:00
parent 14a2d7e860
commit 1df12d1677
3 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/client.js
View File

@@ -1027,14 +1027,15 @@ function wrapCryptoFuncs(MatrixClient, names) {
*/
/**
* Checks that a given private key matches a given public key
* This can be used by the getCrossSigningKey callback to verify that the
* private key it is about to supply is the one that was requested.
* Checks that a given private key matches a given public key.
* This can be used by the getCrossSigningKey or getSecretStorageKey callbacks
* to verify that the private key it is about to supply is the one that was
* requested.
* The cross-signing API is currently UNSTABLE and may change without notice.
*
* @function module:client~MatrixClient#checkPrivateKey
* @param {Uint8Array} privateKey The private key
* @param {Uint8Array} expectedPublicKey The public key supplied by the getCrossSigningKey callback
* @param {string} expectedPublicKey The public key
* @returns {boolean} true if the key matches, otherwise false
*/