Tony Arcieri bbcb9c2306
Migrate to doc_auto_cfg ()
Migrates the `aead`, `cipher`, `crypto-common`, `digest`, and
`universal-hash` crates to use the `doc_auto_cfg` feature which
automatically generates documentation for `cfg`-gated code, which in our
uses is almost exclusively gated on crate features.

This allows the previous manual `doc_cfg` annotations to be removed,
which is nice as they otherwise duplicate work whenever `cfg`-gated code
is used.
2023-10-31 08:42:52 -06:00
..
2023-10-31 08:42:52 -06:00
2023-08-07 14:53:15 +00:00
2022-05-26 09:55:48 -06:00
2021-12-31 07:30:28 -07:00
2022-01-03 09:13:19 -07:00

RustCrypto: Key Encapsulation Mechanisms (KEMs)

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

This crate provides a common set of traits for key encapsulation mechanisms—algorithms for non-interactively establishing secrets between peers. This is intended to be implemented by libraries which produce or contain implementations of key encapsulation mechanisms, and used by libraries which want to produce or consume encapsulated secrets while generically supporting any compatible backend.

The crate exposes four traits, Encapsulator, Decapsulator, AuthEncapsulator, and AuthDecapsulator. These traits represent the ability to initiate a key exchange and complete a key exchange, in the case where the sender is authenticated to the receiver and in the case where the sender is not.

Documentation

Minimum Supported Rust Version

Rust 1.60 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.