rage/age-core/CHANGELOG.md

Changelog

All notable changes to the age-core crate will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Rust's notion of Semantic Versioning. All versions prior to 1.0.0 are beta releases.

[Unreleased]

Added

• age_core::format:
  • FileKey::new
  • FileKey::init_with_mut
  • FileKey::try_init_with_mut
  • is_arbitrary_string

Changed

• Migrated to secrecy 0.10.
• age::plugin::Connection::unidir_receive now takes an additional argument to enable handling an optional fourth command.

[0.10.0] - 2024-02-04

Added

• impl Eq for age_core::format::Stanza

Changed

• MSRV is now 1.65.0.

[0.9.0] - 2022-10-27

Changed

• MSRV is now 1.59.0.
• Migrated to aead 0.5.

[0.8.0] - 2022-05-02

Added

• age_core::io::{DebugReader, DebugWriter}
• age_core::plugin::Error::Unsupported
• age_core::plugin::Reply::ok_with_metadata

Changed

• MSRV is now 1.56.0.
• age_core::plugin:
  • Connection::open now returns the debugging-friendly concrete type Connection<DebugReader<ChildStdout>, DebugWriter<ChildStdin>>.
  • BidirSend::{send, send_stanza} now return Ok(Error::Unsupported) when an unsupported response is received, instead of Err(io::Error), making it easier for plugins to implement fallback strategies.

[0.7.1] - 2021-12-27

Fixed

• In 0.7.0, Base64 decoding was moved to the AgeStanza::body method, with the stanza parser only checking for valid Base64 characters. This caused the parser to start accepting stanzas with non-canonical last body lines (where the Base64 encoding would have trailing bits that could not be decoded into full bytes); calling AgeStanza::body on these stanzas would cause a panic. This release fixes the parser to reject non-canonical last body lines, turning the panic back into an error.

[0.7.0] - 2021-10-18

Added

• age_core::secrecy, which re-exports the secrecy crate.
• age_core::plugin::Error

Changed

• MSRV is now 1.51.0.
• The body property of age_core::format::AgeStanza has been replaced by the AgeStanza::body method, to enable enclosing parsers to defer Base64 decoding until the very end.
• age_core::plugin::Result now only takes a single generic argument, and uses age_core::plugin::Error for its inner error type.

[0.6.0] - 2021-05-02

Security

• age_core::primitives::aead_decrypt now takes a size argument, checked against the plaintext length. This is to mitigate multi-key attacks, where a ciphertext can be crafted that decrypts successfully under multiple keys. Short ciphertexts can only target two keys, which has limited impact. See this commit message for more details.

Added

• age_core::format::FILE_KEY_BYTES constant.
• age_core::plugin module, which contains common backend logic used by both the age library (to implement client support for plugins) and the age-plugin library.

Changed

• The stanza prefix -> and trailing newline are now formal parts of the age stanza; age_core::format::write::age_stanza now includes them in its output, and age_core::format::read::age_stanza expects them to be present.
• Stanza bodies are now canonically serialized with a short (empty if necessary) last line. age_core::format::write::age_stanza outputs the new encoding, and age_core::format::read::age_stanza accepts only the new encoding. The new API age_core::format::read::legacy_age_stanza accepts either kind of stanza body encoding (the legacy minimal encoding, and the new explicit encoding).

[0.5.0] - 2020-11-22

Added

• Several structs used when implementing the age::Identity and age::Recipient traits:
  • age_core::format::FileKey
  • age_core::format::Stanza
• age_core::format::grease_the_joint, for generating a random valid recipient stanza. No other guarantees are made about the stanza's fields.
• age_core::primitives::{aead_decrypt, aead_encrypt, hkdf}, to enable these common primitives to be reused in plugins.

Changed

• MSRV is now 1.41.0.
• age_core::format::write::age_stanza now takes args: &[impl AsRef<str>].

[0.4.0] - 2020-03-25

No changes; version bumped to keep it in sync with age.

[0.3.1] - 2020-02-11

Fixed

• Bumped dependencies to cookie-factory ^0.3.1 to fix nightly builds.

[0.3.0] - 2020-02-09

(relative to age 0.2.0)

Fixed

• Base64 padding is now correctly rejected by the age stanza parser.