Skip to content

Commit cf1bb5b

Browse files
jacksonwaltersjacksonwalters
authored
Merge pull request #76 from lattice-based-cryptography/change_crate_name
change crate name from `mlkem` to `mlkem-fips203`
2 parents 5ed3323 + 490c38f commit cf1bb5b

File tree

8 files changed

+70
-70
lines changed

8 files changed

+70
-70
lines changed

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "ml-kem"
2+
name = "mlkem-fips203"
33
version = "0.1.0"
44
edition = "2021"
55
description = "MLKEM [512, 768, 1024] module-lattice key encapsulation mechanism following the FIPS 203 standard."

‎benches/benchmark_decaps.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use criterion::{criterion_group, criterion_main, Criterion};
2-
use ml_kem::ml_kem::MLKEM;
3-
use ml_kem::parameters::Parameters;
2+
use mlkem_fips203::ml_kem::MLKEM;
3+
use mlkem_fips203::parameters::Parameters;
44

55
// benchmark decaps for 512
66
fn bench_decaps_512(crit: &mut Criterion) {

‎benches/benchmark_encaps.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use criterion::{criterion_group, criterion_main, Criterion};
2-
use ml_kem::ml_kem::MLKEM;
3-
use ml_kem::parameters::Parameters;
2+
use mlkem_fips203::ml_kem::MLKEM;
3+
use mlkem_fips203::parameters::Parameters;
44

55
// benchmark encaps for 512
66
fn bench_encaps_512(c: &mut Criterion) {

‎benches/benchmark_keygen.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use criterion::{criterion_group, criterion_main, Criterion};
2-
use ml_kem::ml_kem::MLKEM;
3-
use ml_kem::parameters::Parameters;
2+
use mlkem_fips203::ml_kem::MLKEM;
3+
use mlkem_fips203::parameters::Parameters;
44

55
// benchmark keygen for 512
66
fn bench_keygen_512(c: &mut Criterion) {

‎src/main.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
use ml_kem::ml_kem::MLKEM;
2-
use ml_kem::parameters::Parameters;
3-
use ml_kem::utils::{encode_poly,compress_poly};
1+
use mlkem_fips203::ml_kem::MLKEM;
2+
use mlkem_fips203::parameters::Parameters;
3+
use mlkem_fips203::utils::{encode_poly,compress_poly};
44
use polynomial_ring::Polynomial;
55
mod tests;
66

‎src/ml_kem.rs‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ impl MLKEM {
3939
///
4040
/// # Example
4141
/// ```
42-
/// use ml_kem::ml_kem::MLKEM;
43-
/// let params = ml_kem::parameters::Parameters::mlkem512();
42+
/// use mlkem_fips203::ml_kem::MLKEM;
43+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
4444
/// let mlkem = MLKEM::new(params);
4545
/// let d = vec![0x01, 0x02, 0x03, 0x04];
4646
/// let (ek_pke, dk_pke) = mlkem._k_pke_keygen(d);
@@ -102,10 +102,10 @@ impl MLKEM {
102102
///
103103
/// # Example
104104
/// ```
105-
/// use ml_kem::ml_kem::MLKEM;
106-
/// use ml_kem::utils::{encode_poly,compress_poly, generate_polynomial};
105+
/// use mlkem_fips203::ml_kem::MLKEM;
106+
/// use mlkem_fips203::utils::{encode_poly,compress_poly, generate_polynomial};
107107
/// use polynomial_ring::Polynomial;
108-
/// let params = ml_kem::parameters::Parameters::mlkem512();
108+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
109109
/// let mlkem = MLKEM::new(params);
110110
/// let d = vec![0x01, 0x02, 0x03, 0x04];
111111
/// let (ek_pke, _dk_pke) = mlkem._k_pke_keygen(d);
@@ -197,10 +197,10 @@ impl MLKEM {
197197
///
198198
/// # Examples
199199
/// ```
200-
/// use ml_kem::ml_kem::MLKEM;
201-
/// use ml_kem::utils::{encode_poly,generate_polynomial,compress_poly};
200+
/// use mlkem_fips203::ml_kem::MLKEM;
201+
/// use mlkem_fips203::utils::{encode_poly,generate_polynomial,compress_poly};
202202
/// use polynomial_ring::Polynomial;
203-
/// let params = ml_kem::parameters::Parameters::mlkem512();
203+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
204204
/// let mlkem = MLKEM::new(params);
205205
/// let d = vec![0x01, 0x02, 0x03, 0x04];
206206
/// let (ek_pke, dk_pke) = mlkem._k_pke_keygen(d);
@@ -256,8 +256,8 @@ impl MLKEM {
256256
/// `(Vec<u8>, Vec<u8>)` - encapsulation key and decapsulation key (ek, dk)
257257
/// # Examples
258258
/// ```
259-
/// let params = ml_kem::parameters::Parameters::mlkem512();
260-
/// let mlkem = ml_kem::ml_kem::MLKEM::new(params);
259+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
260+
/// let mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
261261
/// let d = vec![0x00; 32];
262262
/// let z = vec![0x01; 32];
263263
/// let (ek, dk) = mlkem._keygen_internal(d,z);
@@ -282,8 +282,8 @@ impl MLKEM {
282282
/// `(Vec<u8>, Vec<u8>)` - (32 byte shared key `K`, 32*(d_u*k+d_v)-byte ciphertext `c`)
283283
/// # Examples
284284
/// ```
285-
/// let params = ml_kem::parameters::Parameters::mlkem512();
286-
/// let mlkem = ml_kem::ml_kem::MLKEM::new(params);
285+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
286+
/// let mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
287287
/// let d = vec![0x00; 32];
288288
/// let z = vec![0x01; 32];
289289
/// let m = vec![0x02; 32];
@@ -311,8 +311,8 @@ impl MLKEM {
311311
/// `Vec<u8>` - 32 byte decapulated shared key
312312
/// # Examples
313313
/// ```
314-
/// let params = ml_kem::parameters::Parameters::mlkem512();
315-
/// let mlkem = ml_kem::ml_kem::MLKEM::new(params);
314+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
315+
/// let mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
316316
/// let d = vec![0x00; 32];
317317
/// let z = vec![0x01; 32];
318318
/// let m = vec![0x02; 32];
@@ -396,8 +396,8 @@ impl MLKEM {
396396
/// `(Vec<u8>, Vec<u8>)` - encapsulation key and decapsulation key (ek, dk)
397397
/// # Examples
398398
/// ```
399-
/// let params = ml_kem::parameters::Parameters::mlkem512();
400-
/// let mut mlkem = ml_kem::ml_kem::MLKEM::new(params);
399+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
400+
/// let mut mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
401401
/// let (ek, dk) = mlkem.keygen();
402402
/// ```
403403
pub fn keygen(&mut self) -> (Vec<u8>, Vec<u8>) {
@@ -417,8 +417,8 @@ impl MLKEM {
417417
/// `(Vec<u8>, Vec<u8>)` - encapsulation key and decapsulation key (ek, dk)
418418
/// # Examples
419419
/// ```
420-
/// let params = ml_kem::parameters::Parameters::mlkem512();
421-
/// let mut mlkem = ml_kem::ml_kem::MLKEM::new(params);
420+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
421+
/// let mut mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
422422
/// let seed = vec![0x00; 64];
423423
/// let (ek, dk) = match mlkem.key_derive(seed) {
424424
/// Ok(keys) => (keys),
@@ -444,8 +444,8 @@ impl MLKEM {
444444
/// `(Vec<u8>, Vec<u8>)` - (32 byte shared key `K`, 32*(d_u*k+d_v)-byte ciphertext `c`)
445445
/// # Examples
446446
/// ```
447-
/// let params = ml_kem::parameters::Parameters::mlkem512();
448-
/// let mut mlkem = ml_kem::ml_kem::MLKEM::new(params);
447+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
448+
/// let mut mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
449449
/// let (ek, _dk) = mlkem.keygen();
450450
/// let (shared_k,c) = match mlkem.encaps(ek) {
451451
/// Ok(ciphertext) => ciphertext,
@@ -468,8 +468,8 @@ impl MLKEM {
468468
/// `Vec<u8>` - 32 byte decapulated shared key
469469
/// # Examples
470470
/// ```
471-
/// let params = ml_kem::parameters::Parameters::mlkem512();
472-
/// let mut mlkem = ml_kem::ml_kem::MLKEM::new(params);
471+
/// let params = mlkem_fips203::parameters::Parameters::mlkem512();
472+
/// let mut mlkem = mlkem_fips203::ml_kem::MLKEM::new(params);
473473
/// let (ek, dk) = mlkem.keygen();
474474
/// let (shared_k,c) = match mlkem.encaps(ek) {
475475
/// Ok(ciphertext) => ciphertext,

‎src/tests.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#[cfg(test)] // This makes the following module compile only during tests
22
mod tests {
3-
use ml_kem::parameters::Parameters;
4-
use ml_kem::utils::{encode_poly,compress_poly};
5-
use ml_kem::ml_kem::MLKEM;
3+
use mlkem_fips203::parameters::Parameters;
4+
use mlkem_fips203::utils::{encode_poly,compress_poly};
5+
use mlkem_fips203::ml_kem::MLKEM;
66
use polynomial_ring::Polynomial;
77

88
// test for setting the DRBG seed

0 commit comments

Comments
 (0)