Enum MLDSAPrivateKey

pub enum MLDSAPrivateKey {
    MLDSA44(Box<SecretKey>),
    MLDSA65(Box<SecretKey>),
    MLDSA87(Box<SecretKey>),
}

A private key for the ML-DSA post-quantum digital signature algorithm.

MLDSAPrivateKey represents a private key that can be used to create digital signatures using the ML-DSA (Module Lattice-based Digital Signature Algorithm) post-quantum algorithm. It supports multiple security levels through the variants:

• MLDSA44: NIST security level 2 (roughly equivalent to AES-128)
• MLDSA65: NIST security level 3 (roughly equivalent to AES-192)
• MLDSA87: NIST security level 5 (roughly equivalent to AES-256)

Security

ML-DSA private keys should be kept secure and never exposed. They provide resistance against attacks from both classical and quantum computers.

Examples

use bc_components::MLDSA;

// Generate a keypair
let (private_key, public_key) = MLDSA::MLDSA44.keypair();

// Sign a message
let message = b"Hello, post-quantum world!";
let signature = private_key.sign(message);

Variants

MLDSA44(Box<SecretKey>)

An ML-DSA44 private key (NIST security level 2)

MLDSA65(Box<SecretKey>)

An ML-DSA65 private key (NIST security level 3)

MLDSA87(Box<SecretKey>)

An ML-DSA87 private key (NIST security level 5)

Implementations

impl MLDSAPrivateKey

pub fn sign(&self, message: impl AsRef<[u8]>) -> MLDSASignature

Signs a message using this ML-DSA private key.

Parameters

• message - The message to sign.

Returns

An MLDSASignature for the message, using the same security level as this private key.

Examples

use bc_components::MLDSA;

let (private_key, _) = MLDSA::MLDSA44.keypair();
let message = b"Hello, world!";
let signature = private_key.sign(message);

pub fn level(&self) -> MLDSA

Returns the security level of this ML-DSA private key.

pub fn size(&self) -> usize

Returns the size of this ML-DSA private key in bytes.

pub fn as_bytes(&self) -> &[u8]

Returns the raw bytes of this ML-DSA private key.

pub fn from_bytes(level: MLDSA, bytes: &[u8]) -> Result<Self>

Creates an ML-DSA private key from raw bytes and a security level.

Parameters

• level - The security level of the key.
• bytes - The raw bytes of the key.

Returns

An MLDSAPrivateKey if the bytes represent a valid key for the given level, or an error otherwise.

Errors

Returns an error if the bytes do not represent a valid ML-DSA private key for the specified security level.

Trait Implementations

impl CBORTagged for MLDSAPrivateKey

Defines CBOR tags for ML-DSA private keys.

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tag for ML-DSA private keys.

impl CBORTaggedDecodable for MLDSAPrivateKey

Implements CBOR decoding for ML-DSA private keys.

fn from_untagged_cbor(untagged_cbor: CBOR) -> Result<Self>

Creates an MLDSAPrivateKey from untagged CBOR.

Errors

Returns an error if the CBOR value doesn’t represent a valid ML-DSA private key.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for MLDSAPrivateKey

Implements CBOR encoding for ML-DSA private keys.

fn untagged_cbor(&self) -> CBOR

Creates the untagged CBOR representation as an array with level and key bytes.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for MLDSAPrivateKey

fn clone(&self) -> MLDSAPrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MLDSAPrivateKey

Provides debug formatting for ML-DSA private keys.

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

Formats the private key as a string for debugging purposes.

impl From<MLDSAPrivateKey> for CBOR

Converts an MLDSAPrivateKey to CBOR.

fn from(value: MLDSAPrivateKey) -> Self

Converts to tagged CBOR.

impl PartialEq for MLDSAPrivateKey

fn eq(&self, other: &MLDSAPrivateKey) -> 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 TryFrom<CBOR> for MLDSAPrivateKey

Attempts to convert CBOR to an MLDSAPrivateKey.

fn try_from(cbor: CBOR) -> Result<Self>

Converts from tagged CBOR.

type Error = Error

The type returned in the event of a conversion error.

impl StructuralPartialEq for MLDSAPrivateKey