module-lattice 0.1.0

Functionality shared between the `ml-kem` and `ml-dsa` crates, including linear algebra with degree-256 polynomials over a prime-order field, vectors of such polynomials, and NTT polynomials / vectors, as well as packing of polynomials into coefficients with a specified number of bits.
Documentation

RustCrypto: Module Lattice

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

Functionality shared between the ml-kem and ml-dsa crates, which provide implementations of post-quantum secure algorithms for key encapsulation and digital signatures respectively.

About

The "ML" in ML-KEM and ML-DSA stands for "module lattice". This crate contains the following common functionality for these algorithms:

  • Linear algebra with degree-256 polynomials over a prime-order field, vectors of such polynomials, and NTT polynomials / vectors.
  • Packing of polynomials into coefficients with a specified number of bits.
  • Utility functions such as truncating integers, flattening arrays of arrays, and unflattening arrays into arrays of arrays.

⚠️ Warning: Hazmat!

This crate is intended solely for the purposes of implementing the ml-kem and ml-dsa crates and should not be used outside of that purpose.

Minimum Supported Rust Version (MSRV) Policy

MSRV increases are not considered breaking changes and can happen in patch releases.

The crate MSRV accounts for all supported targets and crate feature combinations, excluding explicitly unstable features.

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.