enc_rust 0.2.2

A pure rust implementation of the Module-Lattice-based standards ML-KEM and (soon) ML-DSA, also known as the PQC scheme Crystals Kyber and Dilithium.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

#![forbid(unsafe_code)]
#![warn(
    clippy::cast_lossless,
    clippy::cast_possible_truncation,
    clippy::cast_possible_wrap,
    clippy::cast_precision_loss,
    clippy::cast_sign_loss,
    clippy::checked_conversions,
    clippy::implicit_saturating_sub,
    clippy::panic,
    clippy::panic_in_result_fn,
    clippy::unwrap_used,
    clippy::pedantic,
    clippy::nursery,
    rust_2018_idioms,
    unused_lifetimes,
    unused_qualifications
)]
#![allow(clippy::too_long_first_doc_paragraph)]
#![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

//! ### About

//! A pure rust implementation of the Module-Lattice-based standards [ML-KEM](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.203.ipd.pdf) and (soon) [ML-DSA](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.204.ipd.pdf), also known as the PQC scheme [Crystals](https://pq-crystals.org/).
//!
//! This package consists of a library (`enc_rust`), and (soon :TM:) a binary wrapper. The library currently contains implementations for ML-KEM (Kyber), and will in the future also support ML-DSA (Dilithium).
//!
//! ---
//!
//! ### Why `enc_rust`?
//!
//! `enc_rust` aims to provide a secure, efficient, and ergonomic solution to any problem that requires quantum secure cryptography.
//!
//! - No unsafe code
//! - `no_std` compatible
//! - ergonomic
//!
//! `enc_rust` currently supports:
//! - ML-KEM
//!
//! but will provide:
//!
//! - ML-KEM in hybrid with x25519
//! - ML-DSA
//! - ML-DSA in hybrid with Ed25519
//!
//! ---
//!
//! ### How to use
//!
//! Currently, `enc_rust` is not released as a crate, but plans to launch soon. In its current state, it can be used with `cargo add --git https://github.com/supinie/enc_rust`.
//!
//! #### Example
//!
//! ```rust
//! use enc_rust::kem::*;
//!
//! fn alice(pk: PublicKey) -> (Ciphertext, [u8; 32]) {
//!     let (ciphertext, shared_secret) = pk.encapsulate(None, None).unwrap();
//!
//!     (ciphertext, shared_secret)
//! }
//!
//! fn bob(sk: PrivateKey, ciphertext: &[u8]) -> [u8; 32] {
//!     let shared_secret = sk.decapsulate(ciphertext).unwrap();
//!
//!     shared_secret
//! }
//!
//!
//! fn main() {
//!     let (pk, sk) = generate_keypair_768(None).unwrap();
//!
//!     let (ciphertext, alice_secret) = alice(pk);
//!
//!     let bob_secret = bob(sk, ciphertext.as_bytes());
//!
//!     assert_eq!(alice_secret, bob_secret);
//! }
//! ```
//!
//! ### Disclaimer
//!
//! This library and binary wrapper is offered as-is, and without a guarantee. Please exercise caution when using this library in a production application, and we accept no liability for any security issues related to the use of this code.
//!
//! ---
//!
//! ### Kyber Algorithm Authors:
//!
//! - Roberto Avanzi, ARM Limited (DE)
//! - Joppe Bos, NXP Semiconductors (BE)
//! - Léo Ducas, CWI Amsterdam (NL)
//! - Eike Kiltz, Ruhr University Bochum (DE)
//! - Tancrède Lepoint, SRI International (US)
//! - Vadim Lyubashevsky, IBM Research Zurich (CH)
//! - John M. Schanck, University of Waterloo (CA)
//! - Peter Schwabe, MPI-SP (DE) & Radboud University (NL)
//! - Gregor Seiler, IBM Research Zurich (CH)
//! - Damien Stehle, ENS Lyon (FR)

pub mod errors;
mod field_operations;
mod indcpa;
pub mod kem;
mod matrix;
pub(crate) mod params;
mod polynomials;
mod vectors;

mod tests {
    mod field_operations;
    mod indcpa;
    mod kem;
    mod matrix;
    mod ntt;
    mod params;
    mod polynomials;
    mod sample;
    mod vectors;
}