fips204 0.5.0

FIPS 204: Module-Lattice-Based Digital Signature Standard
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
//! Public traits for key generation, signing, verification, and serialization.

#[cfg(feature = "default-rng")]
use rand_core::OsRng;
use rand_core::{CryptoRng, CryptoRngCore, RngCore};
use zeroize::{Zeroize, ZeroizeOnDrop};


/// The `KeyGen` trait defines methods for generating public and private key pairs.
pub trait KeyGen {
    /// The public key type for this security parameter set (used for verification).
    type PublicKey;

    /// The private key type for this security parameter set (used for signing).
    type PrivateKey;


    /// Generates a public and private key pair specific to this security parameter set.
    /// This function utilizes the **OS default** random number generator. Within one attempt,
    /// key generation avoids branches on secret data. Sampling `s_1` and `s_2` in FIPS 204
    /// `ExpandS` (Algorithm 33) may repeat. The OS random number generator and `rho` (stored
    /// in the public key) are not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the random number generator fails.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-44", feature = "default-rng"))] {
    /// use fips204::ml_dsa_44; // Could also be ml_dsa_65 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_44::KG::try_keygen()?; // Generate both public and secret keys
    /// let sig = sk.try_sign(&message, &[0])?; // Use the secret key to generate a message signature
    /// # }
    /// # Ok(())}
    /// ```
    #[cfg(feature = "default-rng")]
    fn try_keygen() -> Result<(Self::PublicKey, Self::PrivateKey), &'static str> {
        Self::try_keygen_with_rng(&mut OsRng)
    }


    /// Generates a public and private key pair specific to this security parameter set.
    /// This function utilizes the **provided** random number generator. Within one attempt,
    /// key generation avoids branches on secret data. Sampling `s_1` and `s_2` in FIPS 204
    /// `ExpandS` (Algorithm 33) may repeat. The provided random number generator and `rho`
    /// (stored in the public key) are not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the random number generator fails.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-44")] {
    /// use fips204::ml_dsa_44; // Could also be ml_dsa_65 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use rand_chacha::rand_core::SeedableRng;
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(123);
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_44::KG::try_keygen_with_rng(&mut rng)?;  // Generate both public and secret keys
    /// let sig = sk.try_sign_with_rng(&mut rng, &message, &[0])?;  // Use the secret key to generate a message signature
    /// # }
    /// # Ok(())}
    /// ```
    fn try_keygen_with_rng(
        rng: &mut impl CryptoRngCore,
    ) -> Result<(Self::PublicKey, Self::PrivateKey), &'static str>;


    /// Generates a public and private key pair specific to this security parameter set
    /// based on a provided seed. <br>
    /// Within one attempt, key generation avoids branches on secret data. Sampling `s_1` and
    /// `s_2` in FIPS 204 `ExpandS` (Algorithm 33) may repeat. `rho`, stored in the public key,
    /// is not treated as secret.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-44")] {
    /// use crate::fips204::RngCore;
    /// use fips204::ml_dsa_44; // Could also be ml_dsa_65 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, Signer, Verifier};
    ///
    /// // Example seed (in production, draw 32 bytes from a CSPRNG)
    /// let xi = [0u8; 32];
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    ///
    /// // Generate key pair from the seed, then form a deterministic signature
    /// let (pk, sk) = ml_dsa_44::KG::keygen_from_seed(&xi);
    /// let sig = sk.try_sign_with_seed(&[0u8; 32], &message, &[0])?;
    ///
    /// let res = pk.verify(&message, &sig, &[0]);
    /// assert!(res); // Signature accepted
    /// # }
    /// # Ok(())}
    /// ```
    #[must_use]
    fn keygen_from_seed(xi: &[u8; 32]) -> (Self::PublicKey, Self::PrivateKey);
}


/// The Signer trait is implemented for the `PrivateKey` struct on each of the security parameter sets.
pub trait Signer {
    /// The signature is specific to the chosen security parameter set, e.g., ml-dsa-44, ml-dsa-65 or ml-dsa-87
    type Signature;

    /// The public key that corresponds to the private/secret key
    type PublicKey;


    /// Attempt to sign the given message, returning a digital signature on success, or an error if
    /// something went wrong. This function utilizes the **OS default** random number generator.
    /// Within one attempt, signing avoids branches on secret data. The rejection loop in
    /// FIPS 204 Algorithm 7, `ML-DSA.Sign_internal`, may repeat, so the number of attempts is
    /// not constant. The OS random number generator and `rho` (stored in the public key) are
    /// not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the random number generator fails or the `ctx` is longer than 255 bytes,
    /// or when signing exceeds the FIPS 204 Appendix C limit of 814 attempts, which only a malformed
    /// private key reaches; propagates internal errors.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-65", feature = "default-rng"))] {
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen()?; // Generate both public and secret keys
    /// let sig = sk.try_sign(&message, &[0])?; // Use the secret key to generate a message signature
    /// let v = pk.verify(&message, &sig, &[0]); // Use the public to verify message signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    #[cfg(feature = "default-rng")]
    fn try_sign(&self, message: &[u8], ctx: &[u8]) -> Result<Self::Signature, &'static str> {
        self.try_sign_with_rng(&mut OsRng, message, ctx)
    }


    /// Attempt to sign the given message, returning a digital signature on success, or an error if
    /// something went wrong. This function utilizes the **provided** random number generator.
    /// Within one attempt, signing avoids branches on secret data. The rejection loop in
    /// FIPS 204 Algorithm 7, `ML-DSA.Sign_internal`, may repeat, so the number of attempts is
    /// not constant. The provided random number generator and `rho` (stored in the public key)
    /// are not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the random number generator fails or the `ctx` is longer than 255 bytes,
    /// or when signing exceeds the FIPS 204 Appendix C limit of 814 attempts, which only a malformed
    /// private key reaches; propagates internal errors.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-65")] {
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use rand_chacha::rand_core::SeedableRng;
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(123);
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen_with_rng(&mut rng)?;  // Generate both public and secret keys
    /// let sig = sk.try_sign_with_rng(&mut rng, &message, &[0])?;  // Use the secret key to generate a message signature
    /// let v = pk.verify(&message, &sig, &[0]); // Use the public to verify message signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    fn try_sign_with_rng(
        &self, rng: &mut impl CryptoRngCore, message: &[u8], ctx: &[u8],
    ) -> Result<Self::Signature, &'static str>;


    /// Attempt to sign the given message, returning a digital signature on success, or an error if
    /// something went wrong. This function utilizes the **provided seed to support (less common)
    /// deterministic signatures**. Within one attempt, signing avoids branches on secret data.
    /// The rejection loop in FIPS 204 Algorithm 7, `ML-DSA.Sign_internal`, may repeat, so the
    /// number of attempts is not constant. `rho`, stored in the public key, is not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the `ctx` is longer than 255 bytes, or when signing exceeds the
    /// FIPS 204 Appendix C limit of 814 attempts, which only a malformed private key reaches;
    /// propagates internal errors.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-65")] {
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use rand_chacha::rand_core::SeedableRng;
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(123);
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen_with_rng(&mut rng)?;  // Generate both public and secret keys
    /// let sig = sk.try_sign_with_seed(&[0u8;32], &message, &[0])?;  // Use the secret key to generate a message signature
    /// let v = pk.verify(&message, &sig, &[0]); // Use the public to verify message signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    fn try_sign_with_seed(
        &self, seed: &[u8; 32], message: &[u8], ctx: &[u8],
    ) -> Result<Self::Signature, &'static str> {
        self.try_sign_with_rng(&mut DummyRng { data: *seed }, message, ctx)
    }


    /// Attempt to sign a precomputed digest, returning a HashML-DSA signature on success, or an
    /// error if something went wrong. `hash` is `PH(M)` and `hash_oid` is the DER encoding of that
    /// pre-hash, including the tag and length. [`crate::pre_hash`] provides the NIST CSOR encodings,
    /// and for those `hash` must be the whole digest. This function does not hash `hash` again. It utilizes the **default OS** random number
    /// generator. Within one attempt, signing avoids branches on secret data. The rejection loop
    /// in FIPS 204 Algorithm 7, `ML-DSA.Sign_internal`, may repeat, so the number of attempts is
    /// not constant. The OS random number generator and `rho` (stored in the public key) are
    /// not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the random number generator fails, the `ctx` is longer than 255 bytes,
    /// `hash_oid` is not a DER-encoded OID, `hash` is not the output length of a [`crate::pre_hash`]
    /// OID or is longer than 1024 bytes, or signing exceeds its attempt limit; propagates internal
    /// errors.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-65", feature = "default-rng"))] {
    /// use fips204::pre_hash;
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use sha2::{Digest, Sha512};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let digest = Sha512::digest(message); // The caller hashes the message
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen()?; // Generate both public and secret keys
    /// let sig = sk.try_hash_sign(&digest, &[0], &pre_hash::SHA2_512)?; // Use the secret key to sign the digest
    /// let v = pk.hash_verify(&digest, &sig, &[0], &pre_hash::SHA2_512); // Use the public key to verify the digest signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    #[cfg(feature = "default-rng")]
    fn try_hash_sign(
        &self, hash: &[u8], ctx: &[u8], hash_oid: &[u8],
    ) -> Result<Self::Signature, &'static str> {
        self.try_hash_sign_with_rng(&mut OsRng, hash, ctx, hash_oid)
    }


    /// Attempt to sign a precomputed digest, returning a HashML-DSA signature on success, or an
    /// error if something went wrong. `hash` is `PH(M)` and `hash_oid` is the DER encoding of that
    /// pre-hash, including the tag and length. [`crate::pre_hash`] provides the NIST CSOR encodings,
    /// and for those `hash` must be the whole digest. This function does not hash `hash` again. It utilizes the **provided** random number
    /// generator. Within one attempt, signing avoids branches on secret data. The rejection loop
    /// in FIPS 204 Algorithm 7, `ML-DSA.Sign_internal`, may repeat, so the number of attempts is
    /// not constant. The provided random number generator and `rho` (stored in the public key)
    /// are not treated as secret.
    ///
    /// # Errors
    /// Returns an error when the random number generator fails, the `ctx` is longer than 255 bytes,
    /// `hash_oid` is not a DER-encoded OID, `hash` is not the output length of a [`crate::pre_hash`]
    /// OID or is longer than 1024 bytes, or signing exceeds its attempt limit; propagates internal
    /// errors.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-65")] {
    /// use fips204::pre_hash;
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use rand_chacha::rand_core::SeedableRng;
    /// use sha2::{Digest, Sha512};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let digest = Sha512::digest(message); // The caller hashes the message
    /// let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(123);
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen_with_rng(&mut rng)?;  // Generate both public and secret keys
    /// let sig = sk.try_hash_sign_with_rng(&mut rng, &digest, &[0], &pre_hash::SHA2_512)?;  // Use the secret key to sign the digest
    /// let v = pk.hash_verify(&digest, &sig, &[0], &pre_hash::SHA2_512); // Use the public key to verify the digest signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    fn try_hash_sign_with_rng(
        &self, rng: &mut impl CryptoRngCore, hash: &[u8], ctx: &[u8], hash_oid: &[u8],
    ) -> Result<Self::Signature, &'static str>;


    /// Attempt to sign a precomputed digest, returning a HashML-DSA signature on success, or an
    /// error if something went wrong. `hash` is `PH(M)` and `hash_oid` is the DER encoding of that
    /// pre-hash, including the tag and length. [`crate::pre_hash`] provides the NIST CSOR encodings,
    /// and for those `hash` must be the whole digest. This function does not hash `hash` again. It utilizes the **provided seed to support (less
    /// common) deterministic signatures**. Within one attempt, signing avoids branches on secret
    /// data. The rejection loop in FIPS 204 Algorithm 7, `ML-DSA.Sign_internal`, may repeat, so
    /// the number of attempts is not constant. `rho`, stored in the public key, is not treated
    /// as secret.
    ///
    /// # Errors
    /// Returns an error when the `ctx` is longer than 255 bytes, `hash_oid` is not a DER-encoded OID,
    /// `hash` is not the output length of a [`crate::pre_hash`] OID or is longer than 1024 bytes, or
    /// signing exceeds its attempt limit; propagates internal errors.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-65")] {
    /// use fips204::pre_hash;
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use rand_chacha::rand_core::SeedableRng;
    /// use sha2::{Digest, Sha512};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let digest = Sha512::digest(message); // The caller hashes the message
    /// let mut rng = rand_chacha::ChaCha8Rng::seed_from_u64(123);
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen_with_rng(&mut rng)?;  // Generate both public and secret keys
    /// let sig = sk.try_hash_sign_with_seed(&[0u8;32], &digest, &[0], &pre_hash::SHA2_512)?;  // Use the secret key to sign the digest
    /// let v = pk.hash_verify(&digest, &sig, &[0], &pre_hash::SHA2_512); // Use the public key to verify the digest signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    fn try_hash_sign_with_seed(
        &self, seed: &[u8; 32], hash: &[u8], ctx: &[u8], hash_oid: &[u8],
    ) -> Result<Self::Signature, &'static str> {
        self.try_hash_sign_with_rng(&mut DummyRng { data: *seed }, hash, ctx, hash_oid)
    }


    /// Retrieves the public key associated with this private/secret key
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(feature = "ml-dsa-65")] {
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer};
    ///
    /// let (pk1, sk) = ml_dsa_65::KG::keygen_from_seed(&[0u8; 32]);
    ///
    /// // The public key can be derived from the secret key
    /// let pk2 = sk.get_public_key();
    /// assert_eq!(pk1.into_bytes(), pk2.into_bytes());
    /// # }
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    fn get_public_key(&self) -> Self::PublicKey;
}

// This is for the deterministic signing functions
// It holds a copy of the signing seed rnd, so it wipes itself on drop (FIPS 204 §3.6.3).
#[derive(Zeroize, ZeroizeOnDrop)]
struct DummyRng {
    data: [u8; 32],
}

impl RngCore for DummyRng {
    fn next_u32(&mut self) -> u32 { unimplemented!() }

    fn next_u64(&mut self) -> u64 { unimplemented!() }

    fn fill_bytes(&mut self, _out: &mut [u8]) { unimplemented!() }

    fn try_fill_bytes(&mut self, out: &mut [u8]) -> Result<(), rand_core::Error> {
        out.copy_from_slice(&self.data);
        Ok(())
    }
}

impl CryptoRng for DummyRng {}


/// The Verifier trait is implemented for `PublicKey` on each of the security parameter sets.
pub trait Verifier {
    /// The signature is specific to the chosen security parameter set, e.g., ml-dsa-44, ml-dsa-65
    /// or ml-dsa-87
    type Signature;

    /// Verifies a digital signature on a message with respect to a `PublicKey`. As this function
    /// operates on purely public data, it does not provide constant-time assurances.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-65", feature = "default-rng"))] {
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen()?; // Generate both public and secret keys
    /// let sig = sk.try_sign(&message, &[0])?; // Use the secret key to generate a message signature
    /// let v = pk.verify(&message, &sig, &[0]); // Use the public to verify message signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    #[must_use]
    fn verify(&self, message: &[u8], signature: &Self::Signature, ctx: &[u8]) -> bool;


    /// Verifies a HashML-DSA signature over a precomputed digest. `hash` is `PH(M)` and `hash_oid`
    /// is the DER encoding of that pre-hash, including the tag and length; see [`crate::pre_hash`].
    /// The caller must supply the same digest and OID that were signed. As this function operates on
    /// purely public data, it does not provide constant-time assurances. Returns `false` when `ctx`
    /// is longer than 255 bytes, `hash_oid` is not a DER-encoded OID, `hash` is not the output length
    /// of a [`crate::pre_hash`] OID or is longer than 1024 bytes, or the signature does not verify.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-65", feature = "default-rng"))] {
    /// use fips204::pre_hash;
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    /// use sha2::{Digest, Sha512};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    /// let digest = Sha512::digest(message); // The caller hashes the message
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen()?; // Generate both public and secret keys
    /// let sig = sk.try_hash_sign(&digest, &[0], &pre_hash::SHA2_512)?; // Use the secret key to sign the digest
    /// let v = pk.hash_verify(&digest, &sig, &[0], &pre_hash::SHA2_512); // Use the public key to verify the digest signature
    /// assert!(v);
    /// # }
    /// # Ok(())}
    /// ```
    #[must_use]
    fn hash_verify(
        &self, hash: &[u8], signature: &Self::Signature, ctx: &[u8], hash_oid: &[u8],
    ) -> bool;
}


/// The `SerDes` trait provides for validated serialization and deserialization of fixed- and correctly-size elements.
///
/// Note that FIPS 204 (section 3.6.2) specifies only exact length checks for the public key and signature, which the
/// fixed-size byte arrays enforce. Nonetheless, a `Result()` is returned during all deserialization operations to
/// preserve the ability to add future checks (and for symmetry across structures). Private key deserialization
/// also rejects a key whose `s1` or `s2` has a coefficient outside `[−η, η]`, which a malformed key can encode
/// (FIPS 204 section 7.2).
pub trait SerDes {
    /// The fixed-size byte array to be serialized or deserialized
    type ByteArray;


    /// Produces a byte array of fixed-size specific to the struct being serialized.
    ///
    /// Encoding undoes the cached transform. Encode a key once when the bytes are
    /// needed, and verify from the `PublicKey` rather than serializing it on each verify.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-65", feature = "default-rng"))] {
    /// use fips204::ml_dsa_65; // Could also be ml_dsa_44 or ml_dsa_87.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    ///
    /// let message = [0u8, 1, 2, 3, 4, 5, 6, 7];
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_65::KG::try_keygen()?; // Generate both public and secret keys
    /// let pk_bytes = pk.into_bytes(); // Serialize the public key
    /// let sk_bytes = sk.into_bytes(); // Serialize the private key
    /// # }
    /// # Ok(())}
    /// ```
    fn into_bytes(self) -> Self::ByteArray;


    /// Consumes a byte array of fixed-size specific to the struct being deserialized; performs validation
    ///
    /// # Errors
    /// Returns an error on malformed input.
    ///
    /// # Examples
    /// ```rust
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// # #[cfg(all(feature = "ml-dsa-87", feature = "default-rng"))] {
    /// use fips204::ml_dsa_87; // Could also be ml_dsa_44 or ml_dsa_65.
    /// use fips204::traits::{KeyGen, SerDes, Signer, Verifier};
    ///
    /// // Generate key pair and signature
    /// let (pk, sk) = ml_dsa_87::try_keygen()?; // Generate both public and secret keys
    /// let pk_bytes = pk.into_bytes(); // Serialize the public key
    /// let sk_bytes = sk.into_bytes(); // Serialize the private key
    /// let pk2 = ml_dsa_87::PublicKey::try_from_bytes(pk_bytes)?;
    /// let sk2 = ml_dsa_87::PrivateKey::try_from_bytes(sk_bytes)?;
    /// # }
    /// # Ok(())}
    /// ```
    fn try_from_bytes(ba: Self::ByteArray) -> Result<Self, &'static str>
    where
        Self: Sized;
}