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

Be more clear about the Base64 encoding of signatures and hashes.

Browse Source
This commit is contained in:
Jimmy Cuadra 2019-07-09 15:33:03 -07:00
parent 8c102d11bb
commit 30f830bd5e
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/functions.rs
View File

@ -160,7 +160,7 @@ where
/// Creates a *content hash* for the JSON representation of an event.
///
/// Returns the hash as a Base64-encoded string without padding.
/// Returns the hash as a Base64-encoded string, using the standard character set, without padding.
///
/// The content hash of an event covers the complete event including the unredacted contents. It is
/// used during federation and is described in the Matrix server-server specification.
@ -182,7 +182,7 @@ pub fn content_hash(value: &Value) -> Result<String, Error> {
/// Creates a *reference hash* for the JSON representation of an event.
///
/// Returns the hash as a Base64-encoded string without padding.
/// Returns the hash as a Base64-encoded string, using the standard character set, without padding.
///
/// The reference hash of an event covers the essential fields of an event, including content
/// hashes. It is used to generate event identifiers and is described in the Matrix server-server

3
src/lib.rs
View File

@ -11,6 +11,9 @@
//! algorithm it uses and a "version" string, separated by a colon. The version is an arbitrary
//! identifier used to distinguish key pairs using the same algorithm from the same homeserver.
//!
//! In JSON representations, signatures and hashes appear as Base64-encoded strings, using the
//! standard character set, without padding.
//!
//! # Signing JSON
//!
//! A homeserver signs JSON with a key pair: