Trait MLDSAPrivateKeyTrait 

pub trait MLDSAPrivateKeyTrait<const k: usize, const l: usize, const S1_PACKED_LEN: usize, const S2_PACKED_LEN: usize, const T1_PACKED_LEN: usize, const PK_LEN: usize, const SK_LEN: usize, const FULL_SK_LEN: usize>: SignaturePrivateKey<SK_LEN> {
    // Required methods
    fn from_keymaterial(seed: &KeyMaterial<32>) -> Result<Self, SignatureError>;
    fn seed(&self) -> &KeyMaterial<32>;
    fn tr(&self) -> [u8; 64];
    fn derive_pk(&self) -> MLDSAPublicKey<k, T1_PACKED_LEN, PK_LEN>;
    fn sk_encode_out(&self, out: &mut [u8; SK_LEN]) -> usize;
    fn encode_full_sk_out(&self, out: &mut [u8; FULL_SK_LEN]);
    fn sk_decode(sk: &[u8; SK_LEN]) -> Self;

    // Provided method
    fn encode_full_sk(&self) -> [u8; FULL_SK_LEN] { ... }
}

General trait for all ML-DSA private keys types.

Required Methods

fn from_keymaterial(seed: &KeyMaterial<32>) -> Result<Self, SignatureError>

New from KeyMaterial. Can throw a SignatureError if the KeyMaterial does not contain sufficient entropy.

fn seed(&self) -> &KeyMaterial<32>

Get a ref to the seed, if there is one stored with this private key

fn tr(&self) -> [u8; 64]

Get a copy of the key hash tr. This is computationally intensive as it requires fully re-computing the public key (and then discarding it). It is highly recommended that if you already have a copy of the public key, get tr from that, or else compute tr once and store it.

fn derive_pk(&self) -> MLDSAPublicKey<k, T1_PACKED_LEN, PK_LEN>

Returns the full public key, and has the side-effect of setting the public key hash tr in this MLDSASeedSK object.

fn sk_encode_out(&self, out: &mut [u8; SK_LEN]) -> usize

Algorithm 24 skEncode(𝜌, 𝐾, 𝑡𝑟, 𝐬1, 𝐬2, 𝐭0) Encodes a secret key for ML-DSA into a byte string. Input: 𝜌 ∈ 𝔹32, 𝐾 ∈ 𝔹32, 𝑡𝑟 ∈ 𝔹64 , 𝐬1 ∈ 𝑅ℓ with coefficients in [−𝜂, 𝜂], 𝐬2 ∈ 𝑅𝑘 with coefficients in [−𝜂, 𝜂], 𝐭0 ∈ 𝑅𝑘 with coefficients in [−2𝑑−1 + 1, 2𝑑−1]. Output: Private key 𝑠𝑘 ∈ 𝔹32+32+64+32⋅((𝑘+ℓ)⋅bitlen (2𝜂)+𝑑𝑘).

fn encode_full_sk_out(&self, out: &mut [u8; FULL_SK_LEN])

This produces the full private key in the encoding specified in FIPS 204 Algorithm 24 skEncode() so that it is compatible with other implementations.

Note that since this encoding does not include the seed, this is a one-way operation; after exporting in this encoding, it will be impossible to re-import it into a MLDSASeedPrivateKey.

fn sk_decode(sk: &[u8; SK_LEN]) -> Self

Algorithm 25 skDecode(𝑠𝑘) Reverses the procedure skEncode. Input: Private key 𝑠𝑘 ∈ 𝔹32+32+64+32⋅((ℓ+𝑘)⋅bitlen (2𝜂)+𝑑𝑘). Output: 𝜌 ∈ 𝔹32, 𝐾 ∈ 𝔹32, 𝑡𝑟 ∈ 𝔹64 , 𝐬1 ∈ 𝑅ℓ , 𝐬2 ∈ 𝑅𝑘 , 𝐭0 ∈ 𝑅𝑘 with coefficients in [−2𝑑−1 + 1, 2𝑑−1].

Note: this object contains only the simple decoding routine to unpack a semi-expanded key. See MLDSATrait for key generation functions, including derive-from-seed and consistency-check functions.

Provided Methods

fn encode_full_sk(&self) -> [u8; FULL_SK_LEN]

This produces the full private key in the encoding specified in FIPS 204 Algorithm 24 skEncode() so that it is compatible with other implementations.

Note that since this encoding does not include the seed, this is a one-way operation; after exporting in this encoding, it will be impossible to re-import it into a MLDSASeedPrivateKey.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<const LAMBDA: i32, const GAMMA2: i32, const k: usize, const l: usize, const eta: usize, const S1_PACKED_LEN: usize, const S2_PACKED_LEN: usize, const T1_PACKED_LEN: usize, const PK_LEN: usize, const SK_LEN: usize, const FULL_SK_LEN: usize> MLDSAPrivateKeyTrait<k, l, S1_PACKED_LEN, S2_PACKED_LEN, T1_PACKED_LEN, PK_LEN, SK_LEN, FULL_SK_LEN> for MLDSASeedPrivateKey<LAMBDA, GAMMA2, k, l, eta, S1_PACKED_LEN, S2_PACKED_LEN, T1_PACKED_LEN, PK_LEN, SK_LEN, FULL_SK_LEN>