chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

signatures: Update docs

Browse Source
This commit is contained in:
Jonas Platte 2020-10-29 21:01:43 +01:00
parent bc43e94d7e
commit 6877115109
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
ruma-signatures/src/functions.rs
View File

@ -174,8 +174,9 @@ where
Ok(()) Ok(())
} }
/// Converts a JSON object into the /// Converts an event into the [canonical] string form.
/// [canonical](https://matrix.org/docs/spec/appendices#canonical-json) string form. ///
/// [canonical]: https://matrix.org/docs/spec/appendices#canonical-json
/// ///
/// # Parameters /// # Parameters
/// ///
@ -326,7 +327,7 @@ where
verifier.verify_json(public_key, signature, canonical_json(object).as_bytes()) verifier.verify_json(public_key, signature, canonical_json(object).as_bytes())
} }
/// Creates a *content hash* for the JSON representation of an event. /// Creates a *content hash* for an event.
/// ///
/// Returns the hash as a Base64-encoded string, using the standard character set, without padding. /// Returns the hash as a Base64-encoded string, using the standard character set, without padding.
/// ///
@ -343,7 +344,7 @@ pub fn content_hash(object: &CanonicalJsonObject) -> String {
encode_config(&hash, STANDARD_NO_PAD) encode_config(&hash, STANDARD_NO_PAD)
} }
/// Creates a *reference hash* for the JSON representation of an event. /// Creates a *reference hash* for an event.
/// ///
/// Returns the hash as a Base64-encoded string, using the standard character set, without padding. /// Returns the hash as a Base64-encoded string, using the standard character set, without padding.
/// ///
@ -381,8 +382,8 @@ pub fn reference_hash(
)) ))
} }
/// Hashes and signs the JSON representation of an event and adds the hash and signature to objects /// Hashes and signs an event and adds the hash and signature to objects under the keys `hashes` and
/// under the keys `hashes` and `signatures`, respectively. /// `signatures`, respectively.
/// ///
/// If `hashes` and/or `signatures` are already present, the new data will be appended to the /// If `hashes` and/or `signatures` are already present, the new data will be appended to the
/// existing data. /// existing data.
@ -505,7 +506,7 @@ where
Ok(()) Ok(())
} }
/// Uses a set of public keys to verify a signed JSON representation of an event. /// Uses a set of public keys to verify a signed event.
/// ///
/// Some room versions may require signatures from multiple homeservers, so this function takes a /// Some room versions may require signatures from multiple homeservers, so this function takes a
/// map from servers to sets of public keys. For each homeserver present in the map, this function /// map from servers to sets of public keys. For each homeserver present in the map, this function
@ -667,8 +668,7 @@ fn canonical_json_with_fields_to_remove(object: &CanonicalJsonObject, fields: &[
to_canonical_json_string(&owned_object).expect("JSON object serialization to succeed") to_canonical_json_string(&owned_object).expect("JSON object serialization to succeed")
} }
/// Redacts the JSON representation of an event using the rules specified in the Matrix /// Redacts an event using the rules specified in the Matrix client-server specification.
/// client-server specification.
/// ///
/// This is part of the process of signing an event. /// This is part of the process of signing an event.
/// ///