Skip to content

[WIP] ml-kem: use kem traits in docs #161

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

Closed
wants to merge 1 commit into from
Closed

[WIP] ml-kem: use kem traits in docs #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion ml-kem/src/kem.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use crate::{Encoded, EncodedSizeUser, Seed};
use zeroize::{Zeroize, ZeroizeOnDrop};

// Re-export traits from the `kem` crate
pub use ::kem::{Decapsulate, Encapsulate};
pub use ::kem::{Decapsulate, Encapsulate, KeyInit, KeySizeUser};

/// A shared key resulting from an ML-KEM transaction
pub(crate) type SharedKey = B32;
Expand Down
14 changes: 10 additions & 4 deletions ml-kem/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@
//! computers.
//!
//! ```
//! # use ml_kem::*;
//! # use ::kem::{Decapsulate, Encapsulate};
//! let mut rng = rand::rng();
//! use ml_kem::{
//! MlKem768Params,
//! kem::{Decapsulate, Encapsulate, KeyInit}
//! };
//!
//! type DecapsulationKey = ml_kem::kem::DecapsulationKey<MlKem768Params>;
Copy link
Member Author

@tarcieri tarcieri Oct 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could put these type aliases together for people so they don't have to assemble them like this?

Suggested change
//! type DecapsulationKey = ml_kem::kem::DecapsulationKey<MlKem768Params>;
//! use ml_kem::ml_kem_768::DecapsulationKey;

//!
//! // Generate a (decapsulation key, encapsulation key) pair
//! let (dk, ek) = MlKem768::generate(&mut rng);
//! let mut rng = rand::rng();
//! let seed = DecapsulationKey::generate_key_with_rng(&mut rng);
//! let dk = DecapsulationKey::new(&seed);
//! let ek = dk.encapsulator();
//!
//! // Encapsulate a shared key to the holder of the decapsulation key, receive the shared
//! // secret `k_send` and the encapsulated form `ct`.
Expand Down