From 03ef0b3f0b53ce08f404dfc61ecc03bc1b2da3b2 Mon Sep 17 00:00:00 2001 From: Tony Arcieri Date: Thu, 10 Oct 2019 08:55:45 -0700 Subject: [PATCH] ed25519 v0.2.0 --- ed25519/CHANGES.md | 16 +++++++++-- ed25519/Cargo.toml | 3 +- ed25519/README.md | 59 ++++++++++++++++++++++++++++++++++++++ ed25519/src/lib.rs | 13 +++++++++ signature-crate/src/lib.rs | 2 +- 5 files changed, 88 insertions(+), 5 deletions(-) create mode 100644 ed25519/README.md diff --git a/ed25519/CHANGES.md b/ed25519/CHANGES.md index a7314e19..1ca7cc47 100644 --- a/ed25519/CHANGES.md +++ b/ed25519/CHANGES.md @@ -1,5 +1,15 @@ -## [0.1.0] (2019-08-10) +# Changelog +All notable changes to this project will be documented in this file. -- Initial release +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). + +## 0.2.0 (2019-10-10) +### Changed +- Upgrade to `signature` v0.3; MSRV 1.36+ ([#29]) + +[#29]: https://github.com/RustCrypto/signatures/pull/29 -[0.1.0]: https://github.com/RustCrypto/signatures/pull/24 +## 0.1.0 (2019-08-10) + +- Initial release diff --git a/ed25519/Cargo.toml b/ed25519/Cargo.toml index 3c6a797c..2fa8c34a 100644 --- a/ed25519/Cargo.toml +++ b/ed25519/Cargo.toml @@ -1,12 +1,13 @@ [package] name = "ed25519" -version = "0.1.0" +version = "0.2.0" authors = ["RustCrypto Developers"] license = "Apache-2.0 OR MIT" description = "Edwards Digital Signature Algorithm (EdDSA) over Curve25519 (as specified in RFC 8032)" documentation = "https://docs.rs/ed25519" repository = "https://github.com/RustCrypto/signatures" edition = "2018" +readme = "README.md" categories = ["cryptography", "no-std"] keywords = ["crypto", "curve25519", "ecc", "signature", "signing"] diff --git a/ed25519/README.md b/ed25519/README.md new file mode 100644 index 00000000..29c3d7d5 --- /dev/null +++ b/ed25519/README.md @@ -0,0 +1,59 @@ +# `ed25519` crate + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Build Status][build-image]][build-link] + +Edwards Digital Signature Algorithm (EdDSA) over Curve25519 as specified in +[RFC 8032][1]. + +This crate doesn't contain an implementation of Ed25519, but instead +contains an [`ed25519::Signature`][2] type which other crates can use in +conjunction with the [`signature::Signer`][3] and [`signature::Verifier`][4] +traits. + +These traits allow crates which produce and consume Ed25519 signatures +to be written abstractly in such a way that different signer/verifier +providers can be plugged in, enabling support for using different +Ed25519 implementations, including HSMs or Cloud KMS services. + +[Documentation][docs-link] + +## Requirements + +- Rust **1.36+** + +## License + +All crates licensed under either of + + * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[//]: # (badges) + +[crate-image]: https://img.shields.io/crates/v/ed25519.svg +[crate-link]: https://crates.io/crates/ed25519 +[docs-image]: https://docs.rs/ed25519/badge.svg +[docs-link]: https://docs.rs/ed25519/ +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.36+-blue.svg +[build-image]: https://travis-ci.org/RustCrypto/signatures.svg?branch=master +[build-link]: https://travis-ci.org/RustCrypto/signatures + +[//]: # (general links) + +[1]: https://tools.ietf.org/html/rfc8032 +[2]: https://docs.rs/ed25519/latest/ed25519/struct.Signature.html +[3]: https://docs.rs/signature/latest/signature/trait.Signer.html +[4]: https://docs.rs/signature/latest/signature/trait.Verifier.html diff --git a/ed25519/src/lib.rs b/ed25519/src/lib.rs index 1cc7d1bc..48704a6e 100644 --- a/ed25519/src/lib.rs +++ b/ed25519/src/lib.rs @@ -2,8 +2,21 @@ //! //! Edwards Digital Signature Algorithm (EdDSA) over Curve25519 as specified in //! RFC 8032: +//! +//! This crate doesn't contain an implementation of Ed25519, but instead +//! contains an [`ed25519::Signature`] type which other crates can use in +//! conjunction with the [`signature::Signer`] and [`signature::Verifier`] +//! traits. +//! +//! These traits allow crates which produce and consume Ed25519 signatures +//! to be written abstractly in such a way that different signer/verifier +//! providers can be plugged in, enabling support for using different +//! Ed25519 implementations, including HSMs or Cloud KMS services. #![no_std] +#![forbid(unsafe_code)] +#![warn(missing_docs, rust_2018_idioms, unused_qualifications)] +#![doc(html_root_url = "https://docs.rs/ed25519/0.2.0")] /// Re-export the `signature` crate pub use signature::{self, Error}; diff --git a/signature-crate/src/lib.rs b/signature-crate/src/lib.rs index 05128acd..4c0da0af 100644 --- a/signature-crate/src/lib.rs +++ b/signature-crate/src/lib.rs @@ -5,7 +5,7 @@ #![no_std] #![forbid(unsafe_code)] #![warn(missing_docs, rust_2018_idioms, unused_qualifications)] -#![doc(html_root_url = "https://docs.rs/signature/0.2.0")] +#![doc(html_root_url = "https://docs.rs/signature/0.3.0")] #[cfg(feature = "alloc")] extern crate alloc;