Uses new Rust 2021
|new 0.10.0||Oct 2, 2022|
|0.9.0||May 5, 2022|
|0.8.0||Dec 5, 2021|
|0.7.1||Sep 1, 2021|
|0.1.8||Jul 17, 2020|
#32 in Cryptography
4,857 downloads per month
Used in 15 crates (7 directly)
This is an implementation of the HPKE hybrid encryption standard (RFC 9180).
This crate has not been formally audited. Cloudflare did a security review of version 0.8, though:
The HPKE implementation we decided on comes with the caveat of not yet being formally audited, so we performed our own internal security review. We analyzed the cryptography primitives being used and the corresponding libraries. Between the composition of said primitives and secure programming practices like correctly zeroing memory and safe usage of random number generators, we found no security issues.
What it implements
This implementation complies with the HPKE standard (RFC 9180).
Here are all the primitives listed in the spec. The primitives with checked boxes are the ones that are implemented.
- DHKEM(Curve25519, HKDF-SHA256)
- DHKEM(Curve448, HKDF-SHA512)
- DHKEM(P-256, HKDF-SHA256)
- DHKEM(P-384, HKDF-SHA384)
- DHKEM(P-521, HKDF-SHA512)
Default features flags:
Feature flag list:
alloc- Includes allocating methods like
x25519- Enables X25519-based KEMs
p256- Enables NIST P-256-based KEMs
serde_impls- Includes implementations of
std- Includes an implementation of
HpkeError. Also does what
For info on how to omit or include feature flags, see the cargo docs on features.
See the client-server example for an idea of how to use HPKE.
The current minimum supported Rust version (MSRV) is 1.57.0 (
See CHANGELOG.md for a list of changes made throughout past versions.
To run all tests, execute
cargo test --all-features. This includes known-answer tests, which test against
COMMIT_ID is the short commit of the version of the spec that the test vectors came from. The finalized spec uses commit 5f503c5. See the reference implementation for information on how to generate a test vector.
To run all benchmarks, execute
cargo bench --all-features. If you set your own feature flags, the benchmarks will still work, and run the subset of benches that it is able to. The results of a benchmark can be read as a neat webpage at
- NIST Ciphersuite with 128-bit security: AES-GCM-128, HKDF-SHA256, ECDH-P256
- Non-NIST Ciphersuite with 128-bit security: ChaCha20-Poly1305, HKDF-SHA256, X25519
Functions benchmarked in each ciphersuite:
setup_senderwith OpModes of Base, Auth, Psk, and AuthPsk
setup_receiverwith OpModes of Base, Auth, Psk, and AuthPsk
AeadCtxS::sealwith plaintext length 64 and AAD length 64
AeadCtxR::openwith ciphertext length 64 and AAD length 64
A definition: crypto agility refers to the ability of a cryptosystem or protocol to vary its underlying primitives. For example, TLS has "crypto agility" in that you can run the protocol with many different ciphersuites.
This crate does not support crypto agility out of the box. This is because the cryptographic primitives are encoded as types satisfying certain constraints, and types need to be determined at compile time (broadly speaking). That said, there is nothing preventing you from implementing agility yourself. There is a sample implementation in the examples folder. The sample implementation is messy because agility is messy.
Licensed under either of
at your option.