Enum EncapsulationScheme 

pub enum EncapsulationScheme {
    X25519,
    MLKEM512,
    MLKEM768,
    MLKEM1024,
}

Supported key encapsulation mechanisms.

Key Encapsulation Mechanisms (KEMs) are cryptographic algorithms designed to securely establish a shared secret between parties in public-key cryptography. They are often used to encapsulate (wrap) symmetric keys for secure key exchange.

This enum represents the various KEM schemes supported in this crate:

• X25519: A Diffie-Hellman key exchange mechanism using the Curve25519 elliptic curve
• ML-KEM (Module Lattice-based Key Encapsulation Mechanism): Post-quantum secure KEM at different security levels (512, 768, 1024)

Variants

X25519

X25519 key agreement (default)

MLKEM512

ML-KEM512 post-quantum key encapsulation (NIST level 1)

MLKEM768

ML-KEM768 post-quantum key encapsulation (NIST level 3)

MLKEM1024

ML-KEM1024 post-quantum key encapsulation (NIST level 5)

Implementations

impl EncapsulationScheme

pub fn keypair(self) -> (EncapsulationPrivateKey, EncapsulationPublicKey)

Generates a new random key pair for the specified encapsulation scheme.

Returns

A tuple containing the private key and public key for the selected encapsulation scheme.

Example

use bc_components::EncapsulationScheme;

// Generate a key pair using X25519 (default)
let (private_key, public_key) = EncapsulationScheme::default().keypair();

// Generate a key pair using ML-KEM768
let (private_key, public_key) = EncapsulationScheme::MLKEM768.keypair();

pub fn keypair_using( self, rng: &mut impl RandomNumberGenerator, ) -> Result<(EncapsulationPrivateKey, EncapsulationPublicKey)>

Generates a deterministic key pair using the provided random number generator.

Parameters

• rng - A mutable reference to a random number generator

Returns

A Result containing a tuple with the private key and public key if successful, or an error if deterministic key generation is not supported for the selected scheme.

Errors

Returns an error if deterministic key generation is not supported for the selected encapsulation scheme (currently only X25519 supports this).

Example

use bc_components::EncapsulationScheme;
use bc_rand::SecureRandomNumberGenerator;

let mut rng = SecureRandomNumberGenerator;
let result = EncapsulationScheme::X25519.keypair_using(&mut rng);
assert!(result.is_ok());

// ML-KEM schemes don't support deterministic key generation
let result = EncapsulationScheme::MLKEM512.keypair_using(&mut rng);
assert!(result.is_err());

Trait Implementations

impl Clone for EncapsulationScheme

fn clone(&self) -> EncapsulationScheme

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncapsulationScheme

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncapsulationScheme

fn default() -> EncapsulationScheme

Returns the “default value” for a type.

impl PartialEq for EncapsulationScheme

fn eq(&self, other: &EncapsulationScheme) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EncapsulationScheme

impl StructuralPartialEq for EncapsulationScheme