Struct SigningKey 

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

ML-DSA signing key (i.e. private/secret key).

This type is initialized through a Seed, and can be used to generate ML-DSA signatures.

Implementations

impl<P: MlDsaParams> SigningKey<P>

pub fn from_seed(xi: &Seed) -> Self

Deterministically generate a signing key pair from the specified Seed.

This method reflects the ML-DSA.KeyGen_internal algorithm from FIPS 204 (Algorithm 6).

pub fn as_seed(&self) -> &Seed

Borrow the Seed value: 32-bytes which can be used to reconstruct the SigningKey.

Warning

This value is key material. Please treat it with care.

pub fn to_seed(&self) -> Seed

Serialize the Seed value: 32-bytes which can be used to reconstruct the SigningKey.

Warning

This value is key material. Please treat it with care.

Trait Implementations

impl<P: MlDsaParams> AsRef<VerifyingKey<P>> for SigningKey<P>

Available on crate feature alloc only.

fn as_ref(&self) -> &VerifyingKey<P>

Converts this type into a shared reference of the (usually inferred) input type.

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

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> CtEq for SigningKey<P>

fn ct_eq(&self, other: &Self) -> Choice

Determine if self is equal to other in constant-time.

fn ct_ne(&self, other: &Rhs) -> Choice

Determine if self is NOT equal to other in constant-time.

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

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

Formats the value using the given formatter.

impl<P: MlDsaParams> DigestSigner<Shake<136>, Signature<P>> for SigningKey<P>

The DigestSigner implementation for SigningKey uses the optional deterministic variant of ML-DSA with a pre-computed μ, and only supports signing with an empty context string.

fn try_sign_digest<F: Fn(&mut Shake256) -> Result<(), Error>>( &self, f: F, ) -> Result<Signature<P>, Error>

Attempt to sign a message by updating the received Digest with it, returning a digital signature on success, or an error if something went wrong.

fn sign_digest<F>(&self, f: F) -> S

where F: Fn(&mut D),

Sign a message by updating the received Digest with it, returning a signature.

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<P> EncodePrivateKey for SigningKey<P>

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

Available on crate features pkcs8 and alloc only.

fn to_pkcs8_der(&self) -> Result<SecretDocument>

Serialize a SecretDocument containing a PKCS#8-encoded private key.

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

Available on crate feature rand_core only.

Algorithm 1: ML-DSA.KeyGen().

fn try_generate_from_rng<R: TryCryptoRng + ?Sized>( rng: &mut R, ) -> Result<Self, R::Error>

Generate random key using the provided TryCryptoRng.

fn generate_from_rng<R>(rng: &mut R) -> Self

where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.

fn try_generate() -> Result<Self, Error>

Available on crate feature getrandom only.

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

fn generate() -> Self

Available on crate feature getrandom only.

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

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

fn to_bytes(&self) -> Seed

Serialize this key as a byte array.

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

fn new(seed: &Seed) -> Self

Create new value from fixed size key.

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidLength>

Create new value from variable size key.

fn generate_key<R>(rng: &mut R) -> Array<u8, Self::KeySize>

where R: CryptoRng,

👎Deprecated since 0.2.0:

use the Generate trait impl on Key instead

Available on crate feature rand_core only.

DEPRECATED: generate random key using the provided CryptoRng.

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

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.

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

Available on crate feature alloc only.

type VerifyingKey = VerifyingKey<P>

Verifying key type for this keypair.

impl<P: MlDsaParams> MultipartSigner<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.

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

Equivalent of Signer::try_sign() but the message is provided in non-contiguous byte slices.

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

Equivalent of Signer::sign() but the message is provided in non-contiguous byte slices.

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

fn eq(&self, other: &Self) -> 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> 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 signature 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.

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<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> 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: PrivateKeyInfoRef<'_>) -> Result<Self>

Performs the conversion.

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

Available on crate feature zeroize only.