mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-04-28 02:59:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(crypto): Improve the signature verification docs some more

Browse Source 
Co-authored-by: Denis Kasak <dkasak@termina.org.uk>
This commit is contained in:
Damir Jelić
2022-06-13 11:55:39 +02:00
parent efc53569ed
commit fa3e192c37
4 changed files with 24 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
crates/matrix-sdk-crypto/src/identities/device.rs
View File

@@ -564,9 +564,9 @@ impl ReadOnlyDevice {
/// Check if the given JSON is signed by this device key.
///
/// This method should only be used if a signature of an object should be
/// checked multiple times and the canonicalization step wants to be done
/// only a single time.
/// This method should only be used if an object's signature needs to be
/// checked multiple times, and you'd like to avoid performing the
/// canonicalization step each time.
///
/// **Note**: Use this method with caution, the `canonical_json` needs to be
/// correctly canonicalized and make sure that the object you are checking

6
crates/matrix-sdk-crypto/src/identities/user.rs
View File

@@ -425,9 +425,9 @@ impl MasterPubkey {
/// Check if the given JSON is signed by this master key.
///
/// This method should only be used if a signature of an object should be
/// checked multiple times and the canonicalization step wants to be done
/// only a single time.
/// This method should only be used if an object's signature needs to be
/// checked multiple times, and you'd like to avoid performing the
/// canonicalization step each time.
///
/// **Note**: Use this method with caution, the `canonical_json` needs to be
/// correctly canonicalized and make sure that the object you are checking

6
crates/matrix-sdk-crypto/src/olm/account.rs
View File

@@ -677,9 +677,9 @@ impl ReadOnlyAccount {
/// Check if the given JSON is signed by this Account key.
///
/// This method should only be used if a signature of an object should be
/// checked multiple times and the canonicalization step wants to be done
/// only a single time.
/// This method should only be used if an object's signature needs to be
/// checked multiple times, and you'd like to avoid performing the
/// canonicalization step each time.
///
/// **Note**: Use this method with caution, the `canonical_json` needs to be
/// correctly canonicalized and make sure that the object you are checking

28
crates/matrix-sdk-crypto/src/olm/utility.rs
View File

@@ -63,9 +63,10 @@ pub trait VerifyJson {
/// * `user_id` - The user that claims to have signed this object.
///
/// * `key_id` - The ID of the key that was used to sign this object.
/// **Note**: The key ID must match the ID of the public key that is
/// verifying the signature. This is only used to find the correct
/// signature.
///
/// **Note**: The key ID must match the ID of the public key that is
/// verifying the signature. This is only used to find the correct
/// signature.
///
/// * `signed_object` - The signed object that we should check for a valid
/// signature.
@@ -87,17 +88,18 @@ pub trait VerifyJson {
/// * `user_id` - The user that claims to have signed this object.
///
/// * `key_id` - The ID of the key that was used to sign this object.
/// **Note**: The key ID must match the ID of the public key that is
/// verifying the signature. This is only used to find the correct
/// signature.
///
/// **Note**: The key ID must match the ID of the public key that is
/// verifying the signature. This is only used to find the correct
/// signature.
///
/// * `canonicalized_json` - The canonicalized version of a signed JSON
/// object.
///
/// This method should only be used if a signature of an object should be
/// checked multiple times and the canonicalization step wants to be done
/// only a single time. Prefer the [`VerifyJson::verify_json`] method
/// otherwise.
/// This method should only be used if an object's signature needs to be
/// checked multiple times, and you'd like to avoid performing the
/// canonicalization step each time. Otherwise, prefer the
/// [`VerifyJson::verify_json`] method
///
/// Returns Ok if the signature was successfully verified, otherwise an
/// SignatureError.
@@ -159,14 +161,14 @@ fn verify_signature(
}
/// A trait for Matrix objects that we can canonicalize, sign and verify
/// signatures for as described by the [spec].
/// signatures for, as described by the [spec].
///
/// [spec]: https://spec.matrix.org/unstable/appendices/#signing-json
pub trait SignedJsonObject: Serialize {
/// Get the collection of signatures this SignedJsonObject has.
/// Get the collection of signatures present on this signed JSON object.
fn signatures(&self) -> &Signatures;
/// Convert the SignedJsonObject to a canonicalized signed JSON string.
/// Convert this signed JSON object to a canonicalized signed JSON string.
fn to_canonical_json(&self) -> Result<String, SignatureError> {
let value = serde_json::to_value(self)?;
to_signable_json(value)