From 2ea17d554a54066efb3bc4895bee92e5b2e1bd50 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 14 Apr 2021 01:30:57 +0000 Subject: [PATCH] Update CHANGELOG and README; bump to 3.1.0. --- CHANGELOG.md | 15 +++++++++++++++ Cargo.toml | 2 +- README.md | 16 +++++++++++++--- src/lib.rs | 2 +- 4 files changed, 30 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 90ac99b..1d42492 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,21 @@ major series. ## 3.x series +### 3.1.0 + +* Add support for the Elligator2 encoding for Edwards points. +* Add two optional formally-verified field arithmetic backends which + use the Fiat Crypto project's Rust code, which is generated from + proofs of functional correctness checked by the Coq theorem proving + system. +* Add support for additional sizes of precomputed tables for basepoint + scalar multiplication. +* Fix an unused import. +* Add support for using the `zeroize` traits with all point types. + Note that points are not automatically zeroized on Drop, but that + consumers of `curve25519-dalek` should call these methods manually + when needed. + ### 3.0.2 * Fixes to make using alloc+no_std possible for stable Rust. diff --git a/Cargo.toml b/Cargo.toml index 75e9af5..fb6f627 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,7 +4,7 @@ name = "curve25519-dalek" # - update CHANGELOG # - update html_root_url # - update README if required by semver -version = "3.0.2" +version = "3.1.0" authors = ["Isis Lovecruft ", "Henry de Valence "] readme = "README.md" diff --git a/README.md b/README.md index 0f35b5a..19679f9 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,19 @@ your project's `Cargo.toml`: curve25519-dalek = "3" ``` -The `3.x` series has API almost entirely unchanged from the `2.x` series, -except that the `digest` version was updated. +The sole breaking change in the `3.x` series was an update to the `digest` +version, and in terms of non-breaking changes it includes: + +* support for using `alloc` instead of `std` on stable Rust, +* the Elligator2 encoding for Edwards points, +* a fix to use `packed_simd2`, +* various documentation fixes and improvements, +* support for configurably-sized, precomputed lookup tables for basepoint scalar + multiplication, +* two new formally-verified field arithmetic backends which use the Fiat Crypto + Rust code, which is generated from proofs of functional correctness checked by + the Coq theorem proving system, and +* support for explicitly calling the `zeroize` traits for all point types. The `2.x` series has API almost entirely unchanged from the `1.x` series, except that: @@ -58,7 +69,6 @@ except that: corrected, so that when the `2.x`-series `serde` implementation is used with `serde-bincode`, the derived serialization matches the usual X/Ed25519 formats; - * the `rand` version was updated. See `CHANGELOG.md` for more details. diff --git a/src/lib.rs b/src/lib.rs index f47130a..13f9393 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -22,7 +22,7 @@ #![cfg_attr(feature = "nightly", doc(include = "../README.md"))] #![doc(html_logo_url = "https://doc.dalek.rs/assets/dalek-logo-clear.png")] -#![doc(html_root_url = "https://docs.rs/curve25519-dalek/3.0.2")] +#![doc(html_root_url = "https://docs.rs/curve25519-dalek/3.1.0")] //! Note that docs will only build on nightly Rust until //! [RFC 1990 stabilizes](https://github.com/rust-lang/rust/issues/44732).