rustpq 0.3.0

Pure Rust post-quantum cryptography suite - ML-KEM, ML-DSA, and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! ML-KEM (Module-Lattice-Based Key-Encapsulation Mechanism) implementation.
//!
//! This module implements FIPS 203 (ML-KEM), formerly known as CRYSTALS-Kyber.
//!
//! # Parameter Sets
//!
//! | Parameter Set | Security Level | Feature Flag |
//! |--------------|----------------|--------------|
//! | ML-KEM-512   | NIST Level 1   | `mlkem512`   |
//! | ML-KEM-768   | NIST Level 3   | `mlkem768`   |
//! | ML-KEM-1024  | NIST Level 5   | `mlkem1024`  |
//!
//! # Example
//!
//! ```
//! use rustpq::ml_kem::mlkem768::{generate, encapsulate, decapsulate};
//! use rand::rngs::OsRng;
//!
//! let (pk, sk) = generate(&mut OsRng);
//! let (ct, ss_sender) = encapsulate(&pk, &mut OsRng);
//! let ss_receiver = decapsulate(&sk, &ct);
//!
//! assert_eq!(ss_sender.as_bytes(), ss_receiver.as_bytes());
//! ```

#![allow(clippy::needless_range_loop)]

mod compress;
mod encode;
mod error;
mod indcpa;
mod kem;
mod ntt;
mod params;
mod poly;
mod polyvec;
mod reduce;
mod sampling;
mod symmetric;

pub use error::Error;

#[cfg(feature = "mlkem512")]
pub mod mlkem512 {
    //! ML-KEM-512 (NIST Level 1 security).
    pub use super::kem::mlkem512::*;
}

#[cfg(feature = "mlkem768")]
pub mod mlkem768 {
    //! ML-KEM-768 (NIST Level 3 security).
    pub use super::kem::mlkem768::*;
}

#[cfg(feature = "mlkem1024")]
pub mod mlkem1024 {
    //! ML-KEM-1024 (NIST Level 5 security).
    pub use super::kem::mlkem1024::*;
}