Struct SigningKey 

pub struct SigningKey<P: MlDsaParams> { /* private fields */ }

An ML-DSA signing key

Implementations

impl<P: MlDsaParams> SigningKey<P>

pub fn sign_internal(&self, Mp: &[&[u8]], rnd: &B32) -> Signature<P>

where P: MlDsaParams,

This method reflects the ML-DSA.Sign_internal algorithm from FIPS 204. It does not include the domain separator that distinguishes between the normal and pre-hashed cases, and it does not separate the context string from the rest of the message.

pub fn sign_randomized<R: RngCore + CryptoRng + ?Sized>( &self, M: &[u8], ctx: &[u8], rng: &mut R, ) -> Result<Signature<P>, Error>

Available on crate feature rand_core only.

This method reflects the randomized ML-DSA.Sign algorithm.

Errors

This method will return an opaque error if the context string is more than 255 bytes long, or if it fails to get enough randomness.

pub fn sign_deterministic( &self, M: &[u8], ctx: &[u8], ) -> Result<Signature<P>, Error>

This method reflects the optional deterministic variant of the ML-DSA.Sign algorithm.

Errors

This method will return an opaque error if the context string is more than 255 bytes long.

pub fn encode(&self) -> EncodedSigningKey<P>

where P: MlDsaParams,

Encode the key in a fixed-size byte array.

pub fn decode(enc: &EncodedSigningKey<P>) -> Self

where P: MlDsaParams,

Decode the key from an appropriately sized byte array.

Trait Implementations

impl<P: Clone + MlDsaParams> Clone for SigningKey<P>

where P::L: Clone, P::K: Clone,

fn clone(&self) -> SigningKey<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: MlDsaParams> Debug for SigningKey<P>

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

Formats the value using the given formatter.

impl<P: PartialEq + MlDsaParams> PartialEq for SigningKey<P>

where P::L: PartialEq, P::K: PartialEq,

fn eq(&self, other: &SigningKey<P>) -> 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<P: MlDsaParams> RandomizedSigner<Signature<P>> for SigningKey<P>

Available on crate feature rand_core only.

The RandomizedSigner implementation for SigningKey only supports signing with an empty context string. If you would like to include a context string, use the [SigningKey::sign] method.

fn try_sign_with_rng( &self, rng: &mut impl CryptoRngCore, msg: &[u8], ) -> Result<Signature<P>, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_rng(&self, rng: &mut impl CryptoRngCore, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<P> SignatureAlgorithmIdentifier for SigningKey<P>

where P: MlDsaParams + AssociatedAlgorithmIdentifier<Params = AnyRef<'static>>,

Available on crate feature pkcs8 only.

const SIGNATURE_ALGORITHM_IDENTIFIER: AlgorithmIdentifier<Self::Params> = Signature<P>::ALGORITHM_IDENTIFIER

AlgorithmIdentifier for the corresponding singature system.

type Params = AnyRef<'static>

Algorithm parameters.

impl<P: MlDsaParams> Signer<Signature<P>> for SigningKey<P>

The Signer implementation for SigningKey uses the optional deterministic variant of ML-DSA, and only supports signing with an empty context string. If you would like to include a context string, use the SigningKey::sign_deterministic method.

fn try_sign(&self, msg: &[u8]) -> Result<Signature<P>, Error>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<P> TryFrom<PrivateKeyInfo<'_>> for SigningKey<P>

where P: MlDsaParams + AssociatedAlgorithmIdentifier<Params = AnyRef<'static>>,

Available on crate feature pkcs8 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(private_key_info: PrivateKeyInfo<'_>) -> Result<Self>

Performs the conversion.

impl<P: MlDsaParams> StructuralPartialEq for SigningKey<P>