Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.72 KB

README.md

File metadata and controls

95 lines (67 loc) · 3.72 KB

RustCrypto: crypto crate

crate Docs Apache2/MIT licensed Rust Version Project Chat Build Status

Facade crate for RustCrypto Traits, providing a single place to access compatible versions of all traits from the Rust Crypto project.

Documentation

About

Facade crate for RustCrypto Traits, providing a single place to access compatible versions of all traits from the Rust Crypto project.

About

The RustCrypto Project publishes and maintains independently versioned crates containing traits for many different kinds of cryptographic algorithms.

However, these algorithms are often interdependent (e.g. many depend on digest algorithms), which requires figuring out which versions of the trait crates are compatible with each other.

This crate will automatically pull in compatible versions of these crates, with each one gated under a cargo feature, providing a single place to both import and upgrade these crates while ensuring they remain compatible.

Traits

The following traits are available as re-exports of RustCrypto crates through this crate's facade. To access a particular re-export you (or a crate you depend on) must enable the associated Cargo feature named below.

Re-export Cargo feature Description
aead aead Authenticated Encryption with Associated Data (i.e. high-level symmetric encryption)
cipher cipher Block and stream ciphers (i.e. low-level symmetric encryption)
digest digest Cryptographic hash functions
elliptic_curve elliptic-curve Elliptic curve cryptography
password_hash password-hash Password hashing functions
signature signature Digital signatures (i.e. public key-based message authentication)
universal_hash universal‑hash Universal Hash Functions (used to build MACs)

Minimum Supported Rust Version

Rust 1.65 or higher.

Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump.

SemVer Policy

  • All on-by-default features of this library are covered by SemVer
  • MSRV is considered exempt from SemVer as noted above

License

Licensed under either of:

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.