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

Add docs for more exported cross-signing APIs

Browse Source
This commit is contained in:
J. Ryan Stinnett
2019-12-06 13:20:57 +00:00
parent 3f2c05664f
commit 14a2d7e860
2 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/client.js
View File

@@ -1018,6 +1018,26 @@ function wrapCryptoFuncs(MatrixClient, names) {
* @returns {DeviceTrustLevel}
*/
/**
* Check the copy of our cross-signing key that we have in the device list and
* see if we can get the private key. If so, mark it as trusted.
* The cross-signing API is currently UNSTABLE and may change without notice.
*
* @function module:client~MatrixClient#checkOwnCrossSigningTrust
*/
/**
* 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.
* 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
* @returns {boolean} true if the key matches, otherwise false
*/
wrapCryptoFuncs(MatrixClient, [
"resetCrossSigningKeys",
"getCrossSigningId",