7 unstable releases (3 breaking)
Uses new Rust 2021
|new 0.4.0||Sep 29, 2022|
|0.3.0||May 31, 2022|
|0.2.0||Apr 22, 2022|
|0.1.3||Apr 22, 2022|
#141 in Cryptography
1,548 downloads per month
Used in 3 crates (via janus_core)
Hybrid public key encryption with algorithms dispatched at runtime
This crate provides a generic-free interface to the
crate, a rust implementation of the draft RFC9180 hybrid public key
scheme. If you know the specific (aead, kdf, kem) triple at compile
time, you should use the
hpke crate directly.
Currently, this crate only exposes interfaces for the Base mode (0) described in the hpke draft, and within base mode, only stateless single-shot message encryption/decryption, as defined in RFC9180§6
This crate is also published to npm as
hpke as a
specific wasm use cases (omitting unused algorithms) with
wasm-pack. For an example of using the library from
node, see examples/example.ts
Nightly-only feature to work around a wasm-bindgen bug:
In order to opt out of
algo-all for a wasm build, you must use
nightly and enable the
cfg_eval cargo feature. This is due to
wasm-bindgen#2058. This is not necessary for use
from rust, even when opting out of
Available cargo features:
cfg_eval: allows this crate to be built on nightly rust for wasm without
algo-all. Note that
algo-all(all algorithms) will build for wasm on any channel without this feature. disabled by default. Attempting to build for wasm with a subset.
base-mode-open: Enables hpke base-mode one-shot open behavior (receiver functionality). Enabled by default.
base-mode-seal: Enables hpke base-mode one-shot seal behavior (sender functionality). Enabled by default.
algo-all: enables all aead, kdf, and kem algorithms. enabled by default.
aead-chacha-20-poly-1305algorithm features. Enabled by default.
kdf-sha512algorithm features. Enabled by default.
kem-all: Enables both
kem-x25519-hkdf-sha256algorithm features. Enabled by default.
serde: enables derived serde serialization and deserialization for all public structs and enums. Disabled by default.
Example feature usage:
To depend on this crate from rust with all algorithms,
base-mode-seal, use default features.
To depend on this crate from rust with all algorithms and serde
enabled, but without
default-features = false, features = ["algo-all", "base-mode-open", "serde"]
To build for wasm without
wasm-pack build --no-default-features --features aead-all,kdf-all,kem-dh-p256-hkdf-sha256,base-mode-seal,cfg_eval
To build for wasm with all algorithms but without base-mode-open:
wasm-pack build --no-default-features --features algo-all,base-mode-seal