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
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
use crate::forge::crypto::signature;
use wycheproof::{
composite_mldsa_sign, composite_mldsa_verify, mldsa_sign, mldsa_verify, TestResult,
};
pub trait SigAlgVerifyVariant {
type PublicKey;
type Signature;
fn decode_pubkey(bytes: &[u8]) -> anyhow::Result<Self::PublicKey>;
fn decode_signature(bytes: &[u8]) -> anyhow::Result<Self::Signature>;
fn verify(
pubkey: &Self::PublicKey,
msg: &[u8],
sig: &Self::Signature,
) -> Result<(), signature::Error>;
fn verify_with_ctx(
pubkey: &Self::PublicKey,
msg: &[u8],
sig: &Self::Signature,
ctx: &[u8],
) -> Result<(), signature::Error>;
}
macro_rules! impl_sigalg_verify_variant {
($variant:ident, $pubkey:ty, $sig:ty) => {
impl $crate::adapters::common::wycheproof::SigAlgVerifyVariant for $variant {
type PublicKey = $pubkey;
type Signature = $sig;
fn decode_pubkey(bytes: &[u8]) -> anyhow::Result<Self::PublicKey> {
<$pubkey>::decode(bytes)
}
fn decode_signature(bytes: &[u8]) -> anyhow::Result<Self::Signature> {
<$sig>::try_from(bytes)
}
fn verify(
pubkey: &Self::PublicKey,
msg: &[u8],
sig: &Self::Signature,
) -> Result<(), signature::Error> {
pubkey.verify(msg, sig)
}
fn verify_with_ctx(
pubkey: &Self::PublicKey,
msg: &[u8],
sig: &Self::Signature,
ctx: &[u8],
) -> Result<(), signature::Error> {
pubkey.verify_with_ctx(msg, sig, ctx)
}
}
};
}
pub(crate) use impl_sigalg_verify_variant;
/// Borrowed from https://gitlab.com/nisec/qubip/qryptotoken/-/tree/06725b053d280c91a51d8b31775c5360aed9dc50/src/mldsa/wycheproof
/// with some changes, most notably that the tests for error conditions are much shorter because
/// the errors returned from our adapters aren't represented with a principled enum type like the
/// ones in qryptotoken are (so we don't have branching to check against specific error flags).
///
/// Tests are designed to continue running after a failure rather than panicking, so that all
/// failures can be reported together.
pub fn run_mldsa_wycheproof_verify_tests<MlDsaParamSet: SigAlgVerifyVariant>(
test_name: mldsa_verify::TestName,
) {
use mldsa_verify::{TestFlag, TestSet};
let test_set =
TestSet::load(test_name).unwrap_or_else(|e| panic!("Failed to load verify test set: {e}"));
let mut passed = 0;
let mut failed = 0;
for group in test_set.test_groups {
/*
* In Wycheproof, each entry in "testGroups" defines a public key that
* is used for all tests in the associated "tests" array. If the public
* key is invalid, the "tests" array usually contains only one test
* case explaining the reason for the invalid key.
*
* Therefore, when public key decoding fails, we immediately validate
* that this failure matches the expected outcome for all tests in the
* group, then skip to the next "testGroup". If the public key is
* valid, we continue and execute all tests within that group.
*/
let pubkey_bytes = group.pubkey.as_ref();
let pubkey = match MlDsaParamSet::decode_pubkey(&pubkey_bytes) {
Ok(pk) => pk,
Err(e) => {
for test in &group.tests {
if test.result == TestResult::Invalid
&& test.flags.contains(&TestFlag::IncorrectPublicKeyLength)
{
println!(
"✅ tcId {}: {} — pubkey decode failed as expected",
test.tc_id, test.comment,
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — expected Valid, but pubkey \
decode failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
}
/* Jump to next group */
continue;
}
};
for test in &group.tests {
let msg = test.msg.as_ref();
let input_sig = test.sig.as_ref();
let sig = match MlDsaParamSet::decode_signature(&input_sig) {
Ok(sig) => sig,
Err(e) => {
let invalid = TestResult::Invalid == test.result;
if invalid {
println!(
"✅ tcId {}: {} — signature decode failed as \
expected",
test.tc_id, test.comment
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — Expected Valid, but signature \
decode failed: {}",
test.tc_id, test.comment, e
);
failed += 1;
}
continue;
}
};
let ctx = test.ctx.as_ref().map_or(&[][..], |c| c.as_ref());
let result = if !ctx.is_empty() {
MlDsaParamSet::verify_with_ctx(&pubkey, &msg, &sig, &ctx)
} else {
MlDsaParamSet::verify(&pubkey, &msg, &sig)
};
let expected = &test.result;
let passed_case = match (expected, result.is_ok()) {
(TestResult::Valid, true) => true,
(TestResult::Invalid, false) => true,
_ => false,
};
if passed_case {
println!("✅ tcId {}: {}", test.tc_id, test.comment);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — expected {:?}, got {:?}",
test.tc_id, test.comment, expected, result
);
failed += 1;
}
continue;
}
}
println!(
"\n✔️ Passed: {passed} | ❌ Failed: {failed} | Total: {}",
passed + failed
);
assert_eq!(failed, 0, "Some Wycheproof test cases failed");
}
pub fn run_composite_mldsa_wycheproof_verify_tests<CompositeMlDsaParamSet: SigAlgVerifyVariant>(
test_name: composite_mldsa_verify::TestName,
) {
let test_set = composite_mldsa_verify::TestSet::load(test_name)
.unwrap_or_else(|e| panic!("Failed to load verify test set: {e}"));
let mut passed = 0;
let mut failed = 0;
for group in test_set.test_groups {
/*
* In Wycheproof, each entry in "testGroups" defines a public key that
* is used for all tests in the associated "tests" array. If the public
* key is invalid, the "tests" array usually contains only one test
* case explaining the reason for the invalid key.
*
* Therefore, when public key decoding fails, we immediately validate
* that this failure matches the expected outcome for all tests in the
* group, then skip to the next "testGroup". If the public key is
* valid, we continue and execute all tests within that group.
*/
let pubkey_bytes = group.pubkey.as_ref();
let pubkey = match CompositeMlDsaParamSet::decode_pubkey(&pubkey_bytes) {
Ok(pk) => pk,
Err(e) => {
for test in &group.tests {
if test.result == TestResult::Invalid {
println!(
"✅ tcId {}: {} — pubkey decode failed as expected",
test.tc_id, test.comment,
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — expected Valid, but pubkey \
decode failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
}
/* Jump to next group */
continue;
}
};
for test in &group.tests {
let msg = test.msg.as_ref();
let input_sig = test.sig.as_ref();
let sig = match CompositeMlDsaParamSet::decode_signature(&input_sig) {
Ok(sig) => sig,
Err(e) => {
let invalid = TestResult::Invalid == test.result;
if invalid {
println!(
"✅ tcId {}: {} — signature decode failed as \
expected",
test.tc_id, test.comment
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — Expected Valid, but signature \
decode failed: {}",
test.tc_id, test.comment, e
);
failed += 1;
}
continue;
}
};
// the composite tests don't have a `ctx` field, so we always use the "plain" `verify`
let result = CompositeMlDsaParamSet::verify(&pubkey, &msg, &sig);
let expected = &test.result;
let passed_case = match (expected, result.is_ok()) {
(TestResult::Valid, true) => true,
(TestResult::Invalid, false) => true,
_ => false,
};
if passed_case {
println!("✅ tcId {}: {}", test.tc_id, test.comment);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — expected {:?}, got {:?}",
test.tc_id, test.comment, expected, result
);
failed += 1;
}
continue;
}
}
println!(
"\n✔️ Passed: {passed} | ❌ Failed: {failed} | Total: {}",
passed + failed
);
assert_eq!(failed, 0, "Some Wycheproof test cases failed");
}
pub trait SigAlgSignVariant {
type PrivateKey;
type Signature;
/* It's up to the implementation to decide what to do with these bytes, e.g. in the ML-DSA case
* whether to treat them as a seed or as an expanded key.
*/
fn decode_privkey(bytes: &[u8]) -> anyhow::Result<Self::PrivateKey>;
fn try_sign(
privkey: &Self::PrivateKey,
msg: &[u8],
//deterministic: bool,
) -> Result<Self::Signature, signature::Error>;
fn try_sign_with_ctx(
privkey: &Self::PrivateKey,
msg: &[u8],
ctx: &[u8],
//deterministic: bool,
) -> Result<Self::Signature, signature::Error>;
fn encode_signature(sig: &Self::Signature) -> Vec<u8>;
}
macro_rules! impl_sigalg_sign_variant {
($variant:ident, $privkey:ty, $sig:ty) => {
impl $crate::adapters::common::wycheproof::SigAlgSignVariant for $variant {
type PrivateKey = $privkey;
type Signature = $sig;
fn decode_privkey(bytes: &[u8]) -> anyhow::Result<Self::PrivateKey> {
<$privkey>::decode(bytes)
}
fn try_sign(
privkey: &Self::PrivateKey,
msg: &[u8],
//deterministic: bool,
) -> Result<Self::Signature, signature::Error> {
Self::PrivateKey::try_sign(privkey, msg)
}
fn try_sign_with_ctx(
privkey: &Self::PrivateKey,
msg: &[u8],
ctx: &[u8],
//deterministic: bool,
) -> Result<Self::Signature, signature::Error> {
Self::PrivateKey::try_sign_with_ctx(privkey, msg, ctx)
}
fn encode_signature(sig: &Self::Signature) -> Vec<u8> {
Vec::from(sig.to_bytes().as_ref())
}
}
};
}
pub(crate) use impl_sigalg_sign_variant;
/// Borrowed from https://gitlab.com/nisec/qubip/qryptotoken/-/tree/06725b053d280c91a51d8b31775c5360aed9dc50/src/mldsa/wycheproof
/// with some changes, most notably that the tests for error conditions are much shorter because
/// the errors returned from our adapters aren't represented with a principled enum type like the
/// ones in qryptotoken are (so we don't have branching to check against specific error flags).
///
/// Tests are designed to continue running after a failure rather than panicking, so that all
/// failures can be reported together.
pub fn run_mldsa_wycheproof_sign_tests<MlDsaParamSet: SigAlgSignVariant>(
test_name: mldsa_sign::TestName,
deterministic: bool,
) {
use mldsa_sign::{TestFlag, TestSet};
let test_set =
TestSet::load(test_name).unwrap_or_else(|e| panic!("Failed to load sign test set: {e}"));
let mut passed = 0;
let mut failed = 0;
#[allow(unused_mut)] // Only mutated when `skip_troublesome_wycheproof` is enabled
let mut skipped = 0;
for group in test_set.test_groups {
/*
* In Wycheproof, each entry in "testGroups" defines a private key that
* is used for all tests in the associated "tests" array. If the
* private key is invalid, the "tests" array usually contains only one
* test case explaining the reason for the invalid key.
*
* Therefore, when private key decoding fails (or generation from seed)
* we immediately validate that this failure matches the expected
* outcome for all tests in the group, then skip to the next
* "testGroup". If the private key is valid, we continue and execute
* all tests within that group.
*/
/* Use privseed first, otherwise fallback to privkey */
let priv_bytes = group
.privseed
.as_ref()
.or(group.privkey.as_ref())
.map(|b| b.as_slice().to_vec())
.unwrap_or_else(|| panic!("Neither privateKey nor privateSeed present in test group"));
let privkey = match MlDsaParamSet::decode_privkey(&priv_bytes) {
Ok(sk) => sk,
Err(e) => {
for test in &group.tests {
if test.result == TestResult::Invalid {
if test.flags.iter().any(|&flag| {
flag == TestFlag::IncorrectPrivateKeyLength
|| flag == TestFlag::InvalidPrivateKey
}) {
println!(
"✅ tcId {}: {} — privkey decode failed \
as expected",
test.tc_id, test.comment
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — expected Invalid (with acceptable privkey), \
but privkey decode failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
} else {
println!(
"❌ tcId {}: {} — expected Valid, but privkey \
decode failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
}
/* Jump to next group */
continue;
}
};
for test in &group.tests {
let msg = test.msg.as_ref();
let ctx = test.ctx.as_ref().map_or(&[][..], |c| c.as_ref());
let sig_res = if ctx.is_empty() {
MlDsaParamSet::try_sign(&privkey, &msg)
} else {
MlDsaParamSet::try_sign_with_ctx(&privkey, &msg, &ctx)
};
#[cfg(feature = "skip_troublesome_wycheproof")]
if test.comment == "private key with s1 vector out of range"
|| test.comment == "private key with s2 vector out of range"
{
println!("⚠️ tcId {}: {} — skipped", test.tc_id, test.comment);
skipped += 1;
continue;
}
match (&sig_res, test.result) {
(Err(_), TestResult::Invalid) => {
println!(
"✅ tcId {}: {} — signing failed as expected",
test.tc_id, test.comment
);
passed += 1;
}
(Err(e), TestResult::Valid) => {
println!(
"❌ tcId {}: {} — expected Valid, but signing \
failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
(Ok(_), TestResult::Invalid) => {
println!(
"❌ tcId {}: {} — expected Invalid, but signing \
succeeded",
test.tc_id, test.comment
);
failed += 1;
}
(Ok(sig), TestResult::Valid) => {
if deterministic {
let expected = test.sig.as_ref();
let actual = MlDsaParamSet::encode_signature(sig);
if actual == expected {
println!(
"✅ tcId {}: {} — signature matches expected",
test.tc_id, test.comment
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — signature mismatch",
test.tc_id, test.comment
);
failed += 1;
}
} else {
println!("✅ tcId {}: {}", test.tc_id, test.comment);
passed += 1;
}
}
_ => {
println!(
"❌ tcId {}: {} — 'Acceptable' case not covered",
test.tc_id, test.comment
);
failed += 1;
}
}
}
}
println!(
"\n✔️ Passed: {passed} | ❌ Failed: {failed} | ⚠️ Skipped: {skipped} | Total: {}",
passed + failed + skipped
);
assert_eq!(failed, 0, "Some Wycheproof signing test cases failed");
}
pub fn run_composite_mldsa_wycheproof_sign_tests<CompositeMlDsaParamSet: SigAlgSignVariant>(
test_name: composite_mldsa_sign::TestName,
deterministic: bool,
) {
let test_set = composite_mldsa_sign::TestSet::load(test_name)
.unwrap_or_else(|e| panic!("Failed to load sign test set: {e}"));
let mut passed = 0;
let mut failed = 0;
for group in test_set.test_groups {
/*
* In Wycheproof, each entry in "testGroups" defines a private key that
* is used for all tests in the associated "tests" array. If the
* private key is invalid, the "tests" array usually contains only one
* test case explaining the reason for the invalid key.
*
* Therefore, when private key decoding fails (or generation from seed)
* we immediately validate that this failure matches the expected
* outcome for all tests in the group, then skip to the next
* "testGroup". If the private key is valid, we continue and execute
* all tests within that group.
*/
let privkey = match CompositeMlDsaParamSet::decode_privkey(&group.privkey) {
Ok(sk) => sk,
Err(e) => {
for test in &group.tests {
if test.result == TestResult::Invalid {
println!(
"✅ tcId {}: {} — privkey decode failed \
as expected",
test.tc_id, test.comment
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — expected Valid, but privkey \
decode failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
}
/* Jump to next group */
continue;
}
};
for test in &group.tests {
let msg = test.msg.as_ref();
let sig_res = CompositeMlDsaParamSet::try_sign(&privkey, &msg);
match (&sig_res, test.result) {
(Err(_), TestResult::Invalid) => {
println!(
"✅ tcId {}: {} — signing failed as expected",
test.tc_id, test.comment
);
passed += 1;
}
(Err(e), TestResult::Valid) => {
println!(
"❌ tcId {}: {} — expected Valid, but signing \
failed: {:?}",
test.tc_id, test.comment, e
);
failed += 1;
}
(Ok(_), TestResult::Invalid) => {
println!(
"❌ tcId {}: {} — expected Invalid, but signing \
succeeded",
test.tc_id, test.comment
);
failed += 1;
}
(Ok(sig), TestResult::Valid) => {
if deterministic {
let expected = test.sig.as_ref();
let actual = CompositeMlDsaParamSet::encode_signature(sig);
if actual == expected {
println!(
"✅ tcId {}: {} — signature matches expected",
test.tc_id, test.comment
);
passed += 1;
} else {
println!(
"❌ tcId {}: {} — signature mismatch",
test.tc_id, test.comment
);
failed += 1;
}
} else {
println!("✅ tcId {}: {}", test.tc_id, test.comment);
passed += 1;
}
}
_ => {
println!(
"❌ tcId {}: {} — 'Acceptable' case not covered",
test.tc_id, test.comment
);
failed += 1;
}
}
}
}
println!(
"\n✔️ Passed: {passed} | ❌ Failed: {failed} | Total: {}",
passed + failed
);
assert_eq!(failed, 0, "Some Wycheproof signing test cases failed");
}