README changes for 2.0 (dalek-cryptography#275)

* Added items to changelog for 2.0 release

* Removed unnecessary uses of std in doctests

* Gated `Context` behind `digest`

* Fixed noncompiling doctest when only `digest` is enabled

* README feature flag list mostly done

* Copied changelog to readme

* Redid the malleability section in README

* Added CONTRIBUTING.md

* Bumped version number to 2.0.0-pre.0; small changes to README

* Updated changelog for dalek-cryptography#277

* Added pem feature description

Co-authored-by: pinkforest(she/her) <[email protected]>

Author: rozbb

CHANGELOG.md

@@ -4,9 +4,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+Entries are listed in reverse chronological order per undeprecated major series.
 
-### Changes
-* Bumped MSRV from 1.41 to 1.60.0
-* Removed `ExpandedSecretKey` API ((#205)[https://github.com/dalek-cryptography/ed25519-dalek/pull/205])
-* Implemented `Clone` for `SigningKey`
+# 2.x series
+
+##  2.0.0
+
+### Breaking changes
+
+* Bump MSRV from 1.41 to 1.60.0
+* Bump Rust edition
+* Bump `signature` dependency to 2.0
+* Make [curve25519-backend selection](https://github.com/dalek-cryptography/curve25519-dalek/#backends) more automatic
+* Make `digest` an optional dependency
+* Make `zeroize` an optional dependency
+* Make `rand_core` an optional dependency
+* Make all batch verification deterministic remove `batch_deterministic` ([#256](https://github.com/dalek-cryptography/ed25519-dalek/pull/256))
+* Remove `ExpandedSecretKey` API ((#205)[https://github.com/dalek-cryptography/ed25519-dalek/pull/205])
+* Rename `Keypair` → `SigningKey` and `PublicKey` → `VerifyingKey`
+
+### Other changes
+
+* Add `Context` type for prehashed signing
+* Add `VerifyingKey::{verify_prehash_strict, is_weak}`
+* Add `pkcs` feature to support PKCS #8 (de)serialization of `SigningKey` and `VerifyingKey`
+* Add `fast` feature to include basepoint tables
+* Add tests for validation criteria
+* Impl `DigestSigner`/`DigestVerifier` for `SigningKey`/`VerifyingKey`, respectively
+* Impl `Hash` for `VerifyingKey`
+* Impl `Clone`, `Drop`, and `ZeroizeOnDrop` for `SigningKey`
+* Remove `rand` dependency

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to ed25519-dalek
+
+If you have questions or comments, please feel free to email the
+authors. 
+
+For feature requests, suggestions, and bug reports, please open an issue on
+[our Github](https://github.com/dalek-cryptography/ed25519-dalek).  (Or, send us
+an email if you're opposed to using Github for whatever reason.)
+
+Patches are welcomed as pull requests on
+[our Github](https://github.com/dalek-cryptography/ed25519-dalek), as well as by
+email (preferably sent to all of the authors listed in `Cargo.toml`).
+
+All issues on ed25519-dalek are mentored, if you want help with a bug just
+ask @tarcieri or @rozbb.
+
+Some issues are easier than others. The `easy` label can be used to find the
+easy issues. If you want to work on an issue, please leave a comment so that we
+can assign it to you!

Cargo.lock

@@ -1,12 +1,15 @@
 [package]
 name = "ed25519-dalek"
-version = "1.0.1"
+version = "2.0.0-pre.0"
 edition = "2021"
-authors = ["isis lovecruft <[email protected]>"]
+authors = [
+    "isis lovecruft <[email protected]>",
+    "Tony Arcieri <[email protected]>",
+    "Michael Rosenberg <[email protected]>"
+]
 readme = "README.md"
 license = "BSD-3-Clause"
 repository = "https://github.com/dalek-cryptography/ed25519-dalek"
-homepage = "https://dalek.rs"
 documentation = "https://docs.rs/ed25519-dalek"
 keywords = ["cryptography", "ed25519", "curve25519", "signature", "ECC"]
 categories = ["cryptography", "no-std"]

Cargo.toml

@@ -15,8 +15,11 @@ use crate::{InternalError, SignatureError};
 ///
 /// # Example
 ///
-#[cfg_attr(feature = "digest", doc = "```")]
-#[cfg_attr(not(feature = "digest"), doc = "```ignore")]
+#[cfg_attr(all(feature = "digest", feature = "rand_core"), doc = "```")]
+#[cfg_attr(
+    any(not(feature = "digest"), not(feature = "rand_core")),
+    doc = "```ignore"
+)]
 /// # fn main() {
 /// use ed25519_dalek::{Signature, SigningKey, VerifyingKey, Sha512};
 /// # use curve25519_dalek::digest::Digest;

README.md

@@ -48,6 +48,7 @@ pub(crate) enum InternalError {
         length_c: usize,
     },
     /// An ed25519ph signature can only take up to 255 octets of context.
+    #[cfg(feature = "digest")]
     PrehashedContextLength,
     /// A mismatched (public, secret) key pair.
     MismatchedKeypair,
@@ -76,6 +77,7 @@ impl Display for InternalError {
                               {} has length {}, {} has length {}.",
                 na, la, nb, lb, nc, lc
             ),
+            #[cfg(feature = "digest")]
             InternalError::PrehashedContextLength => write!(
                 f,
                 "An ed25519ph signature can only take up to 255 octets of context"

src/context.rs

@@ -113,9 +113,8 @@
 //!
 #![cfg_attr(feature = "rand_core", doc = "```")]
 #![cfg_attr(not(feature = "rand_core"), doc = "```ignore")]
-//! # use std::convert::TryFrom;
+//! # use core::convert::{TryFrom, TryInto};
 //! # use rand::rngs::OsRng;
-//! # use std::convert::TryInto;
 //! # use ed25519_dalek::{SigningKey, Signature, Signer, VerifyingKey, SecretKey, SignatureError};
 //! # use ed25519_dalek::{PUBLIC_KEY_LENGTH, SECRET_KEY_LENGTH, KEYPAIR_LENGTH, SIGNATURE_LENGTH};
 //! # fn do_test() -> Result<(SigningKey, VerifyingKey, Signature), SignatureError> {
@@ -258,6 +257,7 @@ pub use ed25519;
 #[cfg(feature = "batch")]
 mod batch;
 mod constants;
+#[cfg(feature = "digest")]
 mod context;
 mod errors;
 mod signature;
@@ -272,6 +272,7 @@ pub use sha2::Sha512;
 #[cfg(feature = "batch")]
 pub use crate::batch::*;
 pub use crate::constants::*;
+#[cfg(feature = "digest")]
 pub use crate::context::Context;
 pub use crate::errors::*;
 pub use crate::signing::*;

src/errors.rs

@@ -33,14 +33,15 @@ use curve25519_dalek::scalar::Scalar;
 
 use ed25519::signature::{KeypairRef, Signer, Verifier};
 
+#[cfg(feature = "digest")]
+use crate::context::Context;
 #[cfg(feature = "digest")]
 use signature::DigestSigner;
 
 #[cfg(feature = "zeroize")]
 use zeroize::{Zeroize, ZeroizeOnDrop};
 
 use crate::constants::*;
-use crate::context::Context;
 use crate::errors::*;
 use crate::signature::*;
 use crate::verifying::*;
@@ -161,6 +162,7 @@ impl SigningKey {
 
     /// Create a signing context that can be used for Ed25519ph with
     /// [`DigestSigner`].
+    #[cfg(feature = "digest")]
     pub fn with_context<'k, 'v>(
         &'k self,
         context_value: &'v [u8],
@@ -172,21 +174,15 @@ impl SigningKey {
     ///
     /// # Example
     ///
-    /// ```
-    /// # #[cfg(feature = "std")]
+    #[cfg_attr(feature = "rand_core", doc = "```")]
+    #[cfg_attr(not(feature = "rand_core"), doc = "```ignore")]
     /// # fn main() {
-    ///
     /// use rand::rngs::OsRng;
-    /// use ed25519_dalek::SigningKey;
-    /// use ed25519_dalek::Signature;
+    /// use ed25519_dalek::{Signature, SigningKey};
     ///
     /// let mut csprng = OsRng;
     /// let signing_key: SigningKey = SigningKey::generate(&mut csprng);
-    ///
     /// # }
-    /// #
-    /// # #[cfg(not(feature = "std"))]
-    /// # fn main() { }
     /// ```
     ///
     /// # Input
@@ -239,7 +235,6 @@ impl SigningKey {
     /// use sha2::Sha512;
     /// use rand::rngs::OsRng;
     ///
-    /// # #[cfg(feature = "std")]
     /// # fn main() {
     /// let mut csprng = OsRng;
     /// let signing_key: SigningKey = SigningKey::generate(&mut csprng);
@@ -250,9 +245,6 @@ impl SigningKey {
     ///
     /// prehashed.update(message);
     /// # }
-    /// #
-    /// # #[cfg(not(feature = "std"))]
-    /// # fn main() { }
     /// ```
     ///
     /// If you want, you can optionally pass a "context".  It is generally a
@@ -301,13 +293,9 @@ impl SigningKey {
     /// #
     /// # Ok(sig)
     /// # }
-    /// # #[cfg(feature = "std")]
     /// # fn main() {
     /// #     do_test();
     /// # }
-    /// #
-    /// # #[cfg(not(feature = "std"))]
-    /// # fn main() { }
     /// ```
     ///
     /// [rfc8032]: https://tools.ietf.org/html/rfc8032#section-5.1
@@ -385,13 +373,9 @@ impl SigningKey {
     /// # verified
     /// # }
     /// #
-    /// # #[cfg(feature = "std")]
     /// # fn main() {
     /// #     do_test();
     /// # }
-    /// #
-    /// # #[cfg(not(feature = "std"))]
-    /// # fn main() { }
     /// ```
     ///
     /// [rfc8032]: https://tools.ietf.org/html/rfc8032#section-5.1

src/lib.rs

@@ -34,11 +34,12 @@ use serde::{Deserialize, Deserializer, Serialize, Serializer};
 #[cfg(feature = "serde")]
 use serde_bytes::{ByteBuf as SerdeByteBuf, Bytes as SerdeBytes};
 
+#[cfg(feature = "digest")]
+use crate::context::Context;
 #[cfg(feature = "digest")]
 use signature::DigestVerifier;
 
 use crate::constants::*;
-use crate::context::Context;
 use crate::errors::*;
 use crate::signature::*;
 use crate::signing::*;
@@ -156,6 +157,7 @@ impl VerifyingKey {
 
     /// Create a verifying context that can be used for Ed25519ph with
     /// [`DigestVerifier`].
+    #[cfg(feature = "digest")]
     pub fn with_context<'k, 'v>(
         &'k self,
         context_value: &'v [u8],