Skip to content

Commit

Permalink
Call out the kyber feature more prominently
Browse files Browse the repository at this point in the history
  • Loading branch information
jschneider-bensch committed Jun 27, 2024
1 parent bd14f8d commit c7ca638
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions libcrux-ml-kem/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
//! # ML-KEM
//!
//! This crate implements all three ML-KEM variants 512, 768, and 1024. It is
//! formally verified using [hax](https://cryspen.com/hax) and [F*](https://fstar-lang.org).
//! formally verified using [hax](https://cryspen.com/hax) and
//! [F*](https://fstar-lang.org).
//!
//! ```
//! use rand::{rngs::OsRng, RngCore};
Expand Down Expand Up @@ -41,10 +42,12 @@
//!
//! In addition to the verified implementations of the ML-KEM variants, the
//! feature flag `pre-verification` gives access to, as yet, unverified
//! implementations of ML-KEM that are optimized for SIMD instruction sets. The
//! `pre-verification` flag in combination with the `kyber` flag also gives
//! access to an, as yet, unverified implementation of Kyber as submitted in
//! Round 3 of the NIST PQ competition.
//! implementations of ML-KEM that are optimized for SIMD instruction sets.
//!
//! ### Kyber Round 3
//! The `kyber` flag (in combination with `pre-verification`) also gives access
//! to an, as yet, unverified implementation of Kyber as submitted in Round 3 of
//! the NIST PQ competition.
//!
#![no_std]
Expand Down

0 comments on commit c7ca638

Please sign in to comment.