MLDSAPrivateKey

Enum MLDSAPrivateKey 

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

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§

Source§

impl MLDSAPrivateKey

Source

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);
Source

pub fn level(&self) -> MLDSA

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

Source

pub fn size(&self) -> usize

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

Source

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

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

Source

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§

Source§

impl AsRef<[u8]> for MLDSAPrivateKey

Source§

fn as_ref(&self) -> &[u8]

Returns the private key as a byte slice.

Source§

impl CBORTagged for MLDSAPrivateKey

Defines CBOR tags for ML-DSA private keys.

Source§

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tag for ML-DSA private keys.

Source§

impl CBORTaggedDecodable for MLDSAPrivateKey

Implements CBOR decoding for ML-DSA private keys.

Source§

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.

Source§

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

Creates an instance of this type by decoding it from tagged CBOR. Read more
Source§

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. Read more
Source§

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. Read more
Source§

impl CBORTaggedEncodable for MLDSAPrivateKey

Implements CBOR encoding for ML-DSA private keys.

Source§

fn untagged_cbor(&self) -> CBOR

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

Source§

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance. Read more
Source§

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

Returns the tagged value in CBOR binary representation. Read more
Source§

impl Clone for MLDSAPrivateKey

Source§

fn clone(&self) -> MLDSAPrivateKey

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MLDSAPrivateKey

Provides debug formatting for ML-DSA private keys.

Source§

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

Formats the private key as a string for debugging purposes.

Source§

impl From<MLDSAPrivateKey> for CBOR

Converts an MLDSAPrivateKey to CBOR.

Source§

fn from(value: MLDSAPrivateKey) -> Self

Converts to tagged CBOR.

Source§

impl PartialEq for MLDSAPrivateKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl TryFrom<CBOR> for MLDSAPrivateKey

Attempts to convert CBOR to an MLDSAPrivateKey.

Source§

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

Converts from tagged CBOR.

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

impl StructuralPartialEq for MLDSAPrivateKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CBORDecodable for T
where T: TryFrom<CBOR, Error = Error>,

Source§

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

Source§

impl<T> CBOREncodable for T
where T: Into<CBOR> + Clone,

Source§

fn to_cbor(&self) -> CBOR

Converts this value to a CBOR object. Read more
Source§

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

Converts this value directly to binary CBOR data. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToHex for T
where T: AsRef<[u8]>,

Source§

fn encode_hex<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)
Source§

fn encode_hex_upper<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> URDecodable for T

Source§

fn from_ur(ur: impl AsRef<UR>) -> Result<Self, Error>
where Self: Sized,

Source§

fn from_ur_string(ur_string: impl Into<String>) -> Result<Self, Error>
where Self: Sized,

Source§

impl<T> UREncodable for T

Source§

fn ur(&self) -> UR

Returns the UR representation of the object.
Source§

fn ur_string(&self) -> String

Returns the UR string representation of the object.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> CBORCodable for T

Source§

impl<T> CBORTaggedCodable for T

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> URCodable for T