Struct ExpandedSigningKey 

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

An ML-DSA signing key

Implementations

impl<P: MlDsaParams> ExpandedSigningKey<P>

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

Deterministically generate an expanded signing key from the specified seed.

This method reflects the ML-DSA.KeyGen_internal algorithm from FIPS 204, but only returns a signing key.

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: TryCryptoRng + ?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_mu_randomized<R: TryCryptoRng + ?Sized>( &self, mu: &Array<u8, U64>, rng: &mut R, ) -> Result<Signature<P>, Error>

Available on crate feature rand_core only.

This method reflects the randomized ML-DSA.Sign algorithm with a pre-computed μ.

Errors

This method can return an opaque error 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 sign_mu_deterministic(&self, mu: &Array<u8, U64>) -> Signature<P>

This method reflects the optional deterministic variant of the ML-DSA.Sign algorithm with a pre-computed μ.

pub fn verifying_key(&self) -> VerifyingKey<P>

This auxiliary function derives a VerifyingKey from a bare ExpandedSigningKey (even in the absence of the original seed).

This is a utility function that is useful when importing the private key from an external source which does not export the seed and does not provide the precomputed public key associated with the private key itself.

ExpandedSigningKey implements signature::Keypair: this inherent method is retained for convenience, so it is available for callers even when the signature::Keypair trait is out-of-scope.

pub fn from_expanded(enc: &ExpandedSigningKeyBytes<P>) -> Self

where P: MlDsaParams,

👎Deprecated since 0.1.0:

use ExpandedSigningKey::from_seed instead

DEPRECATED: decode the key from an appropriately sized byte array.

Note that this form is deprecated in practice; prefer to use ExpandedSigningKey::from_seed.

Panics

This API does not validate expanded signing keys and can potentially panic if keys are malformed or maliciously generated.

To avoid panics, use ExpandedSigningKey::from_seed instead.

pub fn to_expanded(&self) -> ExpandedSigningKeyBytes<P>

where P: MlDsaParams,

👎Deprecated since 0.1.0:

use SigningKey::to_seed instead

DEPRECATED: encode the key in a fixed-size byte array.

Note that this form is deprecated in practice; prefer to use SigningKey::to_seed.

Trait Implementations

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

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: MlDsaParams> CtEq for ExpandedSigningKey<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 ExpandedSigningKey<P>

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

Formats the value using the given formatter.

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

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

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 ExpandedSigningKey<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: MlDsaParams> Keypair for ExpandedSigningKey<P>

The signature::Keypair implementation for ExpandedSigningKey allows to derive a VerifyingKey from a bare ExpandedSigningKey (even in the absence of the original seed).

fn verifying_key(&self) -> Self::VerifyingKey

This is a utility function that is useful when importing the private key from an external source which does not export the seed and does not provide the precomputed public key associated with the private key itself.

type VerifyingKey = VerifyingKey<P>

Verifying key type for this keypair.

impl<P: MlDsaParams> MultipartSigner<Signature<P>> for ExpandedSigningKey<P>

The Signer implementation for ExpandedSigningKey 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 ExpandedSigningKey::sign_deterministic method.

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 ExpandedSigningKey<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: MlDsaParams> RandomizedDigestSigner<Shake<136>, Signature<P>> for ExpandedSigningKey<P>

Available on crate feature rand_core only.

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

fn try_sign_digest_with_rng<R: TryCryptoRng + ?Sized, F: Fn(&mut Shake256) -> Result<(), Error>>( &self, rng: &mut R, 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_with_rng<R, F>(&self, rng: &mut R, f: F) -> S

where R: CryptoRng + ?Sized, F: Fn(&mut D),

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

impl<P: MlDsaParams> RandomizedMultipartSigner<Signature<P>> for ExpandedSigningKey<P>

Available on crate feature rand_core only.

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

fn try_multipart_sign_with_rng<R: TryCryptoRng + ?Sized>( &self, rng: &mut R, msg: &[&[u8]], ) -> Result<Signature<P>, Error>

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

fn multipart_sign_with_rng<R>(&self, rng: &mut R, msg: &[&[u8]]) -> S

where R: CryptoRng + ?Sized,

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

impl<P: MlDsaParams> RandomizedSigner<Signature<P>> for ExpandedSigningKey<P>

Available on crate feature rand_core only.

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

fn try_sign_with_rng<R: TryCryptoRng + ?Sized>( &self, rng: &mut R, 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<R>(&self, rng: &mut R, msg: &[u8]) -> S

where R: CryptoRng + ?Sized,

Sign the given message and return a digital signature

impl<P> SignatureAlgorithmIdentifier for ExpandedSigningKey<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 ExpandedSigningKey<P>

The Signer implementation for ExpandedSigningKey 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 ExpandedSigningKey::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<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> for ExpandedSigningKey<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 ExpandedSigningKey<P>

Available on crate feature zeroize only.