diff --git a/Cargo.toml b/Cargo.toml index 57fc216..a85413a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,25 +6,28 @@ Compatibility crate for using RustCrypto's traits with the cryptographic algorithm implementations from *ring* """ authors = ["RustCrypto Developers"] -edition = "2018" license = "Apache-2.0 OR MIT" readme = "README.md" documentation = "https://docs.rs/ring-compat" repository = "https://github.com/RustCrypto/ring-compat" categories = ["cryptography", "no-std"] keywords = ["aead", "digest", "crypto", "ring", "signature"] +edition = "2021" +rust-version = "1.56" [dependencies] +generic-array = { version = "0.14", default-features = false } +opaque-debug = "0.3" +ring = { version = "0.16", default-features = false } +zeroize = { version = "1", default-features = false } + +# optional features aead = { version = "0.4", optional = true, default-features = false } digest = { version = "0.9", optional = true } ecdsa = { version = "0.13", optional = true, default-features = false } ed25519 = { version = "1.3", optional = true, default-features = false } -generic-array = { version = "0.14", default-features = false } -opaque-debug = "0.3" p256 = { version = "0.10", optional = true, default-features = false, features = ["ecdsa-core"] } p384 = { version = "0.9", optional = true, default-features = false, features = ["ecdsa"] } -ring = { version = "0.16", default-features = false } -zeroize = { version = "1", default-features = false } [dev-dependencies] hex-literal = "0.3" diff --git a/src/lib.rs b/src/lib.rs index 8c72c43..dbddc6d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,8 +1,16 @@ -//! Compatibility crate for using [RustCrypto traits] with the cryptographic -//! algorithm implementations from [*ring*]. +#![doc = include_str!("../README.md")] + +//! # Features +//! +//! Functionality in this crate is gated under the following features: //! -//! [RustCrypto traits]: https://github.com/RustCrypto/traits -//! [*ring*]: https://github.com/briansmith/ring +//! - `aead`: Authenticated Encryption with Associated Data algorithms: AES-GCM, ChaCha20Poly1305 +//! - `digest`: Cryptographic Hash Functions: SHA-1, SHA-256, SHA-384, SHA-512, SHA-512/256 +//! - `signature`: Digital Signature Algorithms, gated under the following features: +//! - `ecdsa`: Elliptic Curve Digital Signature Algorithm +//! - `ed25519`: Edwards Digital Signature Algorithm instantiated over Curve25519 +//! - `p256`: ECDSA/NIST P-256 +//! - `p384`: ECDSA/NIST P-384 #![no_std] #![cfg_attr(docsrs, feature(doc_cfg))]