Skip to content

ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarcieri merged 5 commits into from
Aug 16, 2024
Merged

ml-kem: Update to FIPS 203 #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffd2239
Add domain separation to K-PKE generation
bifurcation Aug 15, 2024
cc1bc83
Clarify index ordering and remove cautionary comment
bifurcation Aug 15, 2024
56f104a
Update documentation
bifurcation Aug 16, 2024
6337c00
Update to use latest test vectors, in ACVP format
bifurcation Aug 16, 2024
a96cf4b
Exclude test vectors from published crates
bifurcation Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions ml-kem/Cargo.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down
4 changes: 2 additions & 2 deletions ml-kem/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final
11 changes: 5 additions & 6 deletions ml-kem/src/algebra.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
// Note the transpose here: Apparently the specification is incorrect, and the proper order
// of indices is reversed.
//
// https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
Self(Array::from_fn(|j| {
let (i, j) = if transpose { (i, j) } else { (j, i) };
let mut xof = XOF(rho, i.truncate(), j.truncate());
let (i, j) = if transpose { (j, i) } else { (i, j) };
let mut xof = XOF(rho, j.truncate(), i.truncate());
NttPolynomial::sample_uniform(&mut xof)
}))
}
Expand Down
3 changes: 2 additions & 1 deletion ml-kem/src/pke.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
// Algorithm 12. K-PKE.KeyGen()
pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
// Generate random seeds
let (rho, sigma) = G(&[d]);
let k = P::K::U8;
let (rho, sigma) = G(&[&d[..], &[k]]);

// Sample pseudo-random matrix and vectors
let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down
18 changes: 18 additions & 0 deletions ml-kem/tests/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
ml-kem: Update to FIPS 203 by bifurcation · Pull Request #47 · RustCrypto/KEMs · GitHub
Skip to content
ml-kem: Update to FIPS 203#47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tarcieri
merged 5 commits into

from

Aug 16, 2024
 Merged


ml-kem: Update to FIPS 203
#47
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
ffd2239

Add domain separation to K-PKE generation


bifurcation Aug 15, 2024
cc1bc83

Clarify index ordering and remove cautionary comment


bifurcation Aug 15, 2024
56f104a

Update documentation


bifurcation Aug 16, 2024
6337c00

Update to use latest test vectors, in ACVP format


bifurcation Aug 16, 2024
a96cf4b

Exclude test vectors from published crates


bifurcation Aug 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 12 additions & 6 deletions
Cargo.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


7 changes: 5 additions & 2 deletions
ml-kem/Cargo.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
name = "ml-kem"
description = """
Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the FIPS 203 Initial Public Draft
(formerly known as Kyber) as described in FIPS 203
"""
version = "0.1.1"
edition = "2021"
Expand All@@ -13,6 +13,7 @@ homepage = "https://github.com/RustCrypto/KEMs/tree/master/ml-kem"
repository = "https://github.com/RustCrypto/KEMs"
categories = ["cryptography", "no-std"]
keywords = ["crypto", "kyber", "lattice", "post-quantum"]
exclude = ["tests/key-gen.rs", "tests/key-gen.json", "tests/encap-decap.rs", "tests/encap-decap.json"]

[features]
default = ["std"]
Expand All@@ -27,11 +28,13 @@ sha3 = { version = "0.10.8", default-features = false }

[dev-dependencies]
criterion = "0.5.1"
hex = "0.4.3"
hex = { version = "0.4.3", features = ["serde"] }
hex-literal = "0.4.1"
num-rational = { version = "0.4.2", default-features = false, features = ["num-bigint"] }
rand = "0.8.5"
crypto-common = { version = "0.1.6", features = ["rand_core"] }
serde = { version = "1.0.208", features = ["derive"] }
serde_json = "1.0.125"

[[bench]]
name = "mlkem"
Expand Down

4 changes: 2 additions & 2 deletions
ml-kem/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@
[![Project Chat][chat-image]][chat-link]

Pure Rust implementation of the Module-Lattice-Based Key-Encapsulation Mechanism Standard
(formerly known as Kyber) as described in the [FIPS 203 Initial Public Draft].
(formerly known as Kyber) as described in [FIPS 203].

[Documentation][docs-link]

Expand DownExpand Up@@ -73,4 +73,4 @@ dual licensed as above, without any additional terms or conditions.
[//]: # (links)

[RustCrypto]: https://github.com/rustcrypto
[FIPS 203 Initial Public Draft]: https://csrc.nist.gov/pubs/fips/203/ipd
[FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final

11 changes: 5 additions & 6 deletions
ml-kem/src/algebra.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -261,6 +261,9 @@ impl NttPolynomial {
// Note that the const environment here imposes some annoying conditions. Because operator
// overloading can't be const, we have to do all the reductions here manually. Because `for` loops
// are forbidden in `const` functions, we do them manually with `while` loops.
//
// The values computed here match those provided in Appendix A of FIPS 203. ZETA_POW_BITREV
// corresponds to the first table, and GAMMA to the second table.
#[allow(clippy::cast_possible_truncation)]
const ZETA_POW_BITREV: [FieldElement; 128] = {
 const ZETA: u64 = 17;
Expand DownExpand Up@@ -398,14 +401,10 @@ impl NttPolynomial {
pub struct NttVector<K: ArraySize>(pub Array<NttPolynomial, K>);

impl<K: ArraySize> NttVector<K> {
 // Note the transpose here: Apparently the specification is incorrect, and the proper order
 // of indices is reversed.
 //
 // https://github.com/FiloSottile/mlkem768/blob/main/mlkem768.go#L110C4-L112C51
 pub fn sample_uniform(rho: &B32, i: usize, transpose: bool) -> Self {
 Self(Array::from_fn(|j| {
 let (i, j) = if transpose { (i, j) } else { (j, i) };
 let mut xof = XOF(rho, i.truncate(), j.truncate());
 let (i, j) = if transpose { (j, i) } else { (i, j) };
 let mut xof = XOF(rho, j.truncate(), i.truncate());
 NttPolynomial::sample_uniform(&mut xof)
 }))
 }
Expand Down

3 changes: 2 additions & 1 deletion
ml-kem/src/pke.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,8 @@ where
 // Algorithm 12. K-PKE.KeyGen()
 pub fn generate(d: &B32) -> (Self, EncryptionKey<P>) {
 // Generate random seeds
 let (rho, sigma) = G(&[d]);
 let k = P::K::U8;
 let (rho, sigma) = G(&[&d[..], &[k]]);

 // Sample pseudo-random matrix and vectors
 let A_hat: NttMatrix<P::K> = NttMatrix::sample_uniform(&rho, false);
Expand Down

18 changes: 18 additions & 0 deletions
ml-kem/tests/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
ML-KEM Test Vectors
===================

The tests in this directory validate that our ML-KEM implementation successfully
validates the NIST test vectors. The JSON test vector files are taken from the
[NIST ACVP repository]. Specifically, `key-gen.json` and `encap-decap.json` are
the "internal projection" files from the [ML-KEM key generation test
directory][keyGen] and [encap/decap test directory][encapDecap], respectively.

The current copies of these files were taken from commit [65370b8] of that repo.

The actual tests to be performed are described in the [ACVP documentation].

[NIST ACVP repository]: https://github.com/usnistgov/ACVP-Server/tree/master
[keyGen]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-keyGen-FIPS203
[encapDecap]: https://github.com/usnistgov/ACVP-Server/tree/master/gen-val/json-files/ML-KEM-encapDecap-FIPS203
[65370b8]: https://github.com/usnistgov/ACVP-Server/commit/65370b861b96efd30dfe0daae607bde26a78a5c8
[ACVP documentation]: https://github.com/usnistgov/ACVP/tree/2f786fac5b516733b58889d61a8473113ed62ee3/src/ml-kem/sections
Loading