ruma/crates/ruma-signatures/CHANGELOG.md

Changelog

Unreleased

0.20.0

Breaking changes:

• Refactor and improve the variants of JsonError:
  • NotOfType and NotMultiplesOfType were merged into a single InvalidType variant and provide more details about the invalid field.
  • JsonFieldMissingFromObject was renamed to MissingField an provides the full path of the missing field.
• The methods on Ed25519KeyPair use a separate error enum named Ed25519KeyPairParseError.
  • Error::DerParse is now Ed25519KeyPairParseError::Pkcs8.
  • ParseError::DerivedPublicKeyDoesNotMatchParsedKey is now Ed25519KeyPairParseError::PublicKeyMismatch.
  • ParseError::Oid is now Ed25519KeyPairParseError::InvalidOid.
  • ParseError::SecretKey is now Ed25519KeyPairParseError::InvalidSecretKey.
• The error variants returned specifically when verifying an ed25519 signature use a separate error enum named Ed25519VerificationError, which is exposed as VerificationError::Ed25519.
  • ParseError::PublicKey is now Ed25519VerificationError::InvalidPublicKey.
  • ParseError::Signature is now Ed25519VerificationError::InvalidSignatureLength.
  • VerificationError::Signature is now Ed25519VerificationError::SignatureVerification.
• Error::PduSize is now JsonError::PduTooLarge allowing the following functions to return JsonError as an error type:
  • to_canonical_json_string_for_signing()
  • reference_hash()
  • content_hash()
  • sign_json()
  • hash_and_sign_event()
• The remaining variants of Error and ParseError were merged into VerificationError. This is now the error type returned by:
  • verify_canonical_json_bytes()
  • verify_event()
  • verify_json()
• When verifying the signatures on a JSON object, signatures of keys that are not in the key map are ignored rather than returning an error. The VerificationError::PublicKeyNotFound variant was removed.
• Ed25519KeyPair was moved under the new ed25519 module with its error types.
• Signature::new() takes an OwnedSigningKeyId<AnyKeyName> and a Vec<u8> and is now infallible.
• canonical_json() was renamed to to_canonical_json_string_for_signing() to clarify that is is not to be used outside of the signing/verifying context.
• Update Ed25519KeyPair::generate to return bytes directly, not a Result
  • The previous implementation should have never returned an Err anyways

Improvements:

• Get a better error message when verifying a signature with a public key that has the wrong length.
• Make required_server_signatures_to_verify_event() public, for homeservers to get the list of servers whose public keys they need to provide to verify_event().

0.19.0

No changes for this version

0.18.0

Breaking changes:

• Algorithm is replaced by SigningKeyAlgorithm from ruma-common.
  • Signature::new() returns an IdParseError.
  • Error::UnsupportedAlgorithm is removed since it is now unused.
• The compat-signature-id cargo feature was removed. No validation is done on the key name of a key ID, to stop assuming that this crate is only used to check server signatures.
• The variants of VerificationError were changed to be clearer, have more details about the error, and to support any type of entity.
• JsonError::JsonKeyMissing was replaced by VerificationError::PublicKeyNotFound
• reference_hash and verify_event take RoomVersionRules instead of RoomVersionId. This avoids undefined behavior for unknown room versions.
• hash_and_sign_event take RedactionRules instead of RoomVersionId. This avoids undefined behavior for unknown room versions.
• The ServerNameFromEventIdByRoomVersion variant of ParseError was renamed to ServerNameFromEventId, and doesn't hold a RoomVersionId anymore.

Improvements:

• Add verify_canonical_json_bytes() as a low-level function to check the signature of canonical JSON bytes.

0.17.1

Bug fixes:

• Do not check the signature of the server of the sender of m.room.member invite events with a third_party_invite field.

0.17.0

Improvements:

• The unstable-exhaustive-types cargo feature was replaced by the ruma_unstable_exhaustive_types compile-time cfg setting. Like all cfg settings, it can be enabled at compile-time with the RUSTFLAGS environment variable, or inside .cargo/config.toml. It can also be enabled by setting the RUMA_UNSTABLE_EXHAUSTIVE_TYPES environment variable.

0.16.0

Upgrade ruma-common to 0.14.0.

0.15.0

No changes for this version

0.14.0

Breaking changes:

• Update ed25519-dalek crate
  • Ed25519KeyPair::generate() returns a Zeroizing<Vec<u8>> on success
  • Ed25519KeyPair::public_key() returns an array instead of a slice

Bug fixes:

• Ignore keys with unknown algorithms in verify_events

Improvements:

• Remove age_ts from REFERENCE_HASH_FIELDS_TO_REMOVE according to a spec clarification

0.13.1

No changes for this version

0.13.0

No changes for this version

0.12.0

Breaking changes:

• Remove pointless PartialEq implementation for Ed25519Verifier

0.11.0

Breaking changes:

• Upgrade dependencies

0.10.0

Breaking changes:

• Merge SplitError into Error
• Update some function signatures to use the new Base64 type

Improvements:

• Move Room Version 9 keys out of unstable-pre-spec in allowed_content_keys_for

0.9.0

Breaking changes:

• Change a few functions to return Results
  • See each function's documentation for how it can fail

Bug fixes:

• Don't check stringified JSON size <= 65535 bytes for verify_json and sign_json since these functions may be used for things other than PDUs

0.8.0

Breaking changes:

• Replace ring dependency with ed25519-dalek and pkcs8
• canonical_json and content_hash now return Error when JSON is not canonical

0.7.2

Improvements:

• Add a compat feature

  When enabled, ruma-signatures will accept slightly malformed base64 input.

0.7.1

Improvements:

• Fix verify_json signature check algorithm
• Bump dependency versions

0.7.0

Breaking changes:

• Upgrade ruma-identifiers dependency to 0.19.0

0.6.0

Breaking changes:

• Remove Copy implementation for Algorithm
• Remove Copy and Clone implementations for Ed25519Verifier
• Upgrade ruma-identifiers

Bug fixes:

• Verify only the required signatures on verify_event
• Fix redactions for aliases events