File: test_vectors_musig2_generate.py

package info (click to toggle)
libsecp256k1 0.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 6,368 kB
  • sloc: ansic: 44,731; python: 772; asm: 736; makefile: 282; sh: 227
file content (656 lines) | stat: -rwxr-xr-x 18,445 bytes parent folder | download | duplicates (2)
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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
#!/usr/bin/env python3

import sys
import json
import textwrap

max_pubkeys = 0

if len(sys.argv) < 2:
    print(
        "This script converts BIP MuSig2 test vectors in a given directory to a C file that can be used in the test framework."
    )
    print("Usage: %s <dir>" % sys.argv[0])
    sys.exit(1)


def hexstr_to_intarray(str):
    return ", ".join([f"0x{b:02X}" for b in bytes.fromhex(str)])


def create_init(name):
    return """
static const struct musig_%s_vector musig_%s_vector = {
""" % (
        name,
        name,
    )


def init_array(key):
    return textwrap.indent("{ %s },\n" % hexstr_to_intarray(data[key]), 4 * " ")


def init_arrays(key):
    s = textwrap.indent("{\n", 4 * " ")
    s += textwrap.indent(
        ",\n".join(["{ %s }" % hexstr_to_intarray(x) for x in data[key]]), 8 * " "
    )
    s += textwrap.indent("\n},\n", 4 * " ")
    return s


def init_indices(array):
    return " %d, { %s }" % (
        len(array),
        ", ".join(map(str, array) if len(array) > 0 else "0"),
    )


def init_is_xonly(case):
    if len(case["tweak_indices"]) > 0:
        return ", ".join(map(lambda x: "1" if x else "0", case["is_xonly"]))
    return "0"


def init_optional_expected(case):
    return hexstr_to_intarray(case["expected"]) if "expected" in case else 0


def init_cases(cases, f):
    s = textwrap.indent("{\n", 4 * " ")
    for (i, case) in enumerate(cases):
        s += textwrap.indent("%s\n" % f(case), 8 * " ")
    s += textwrap.indent("},\n", 4 * " ")
    return s


def finish_init():
    return "};\n"


s = (
    """/**
 * Automatically generated by %s.
 *
 * The test vectors for the KeySort function are included in this file. They can
 * be found in src/modules/extrakeys/tests_impl.h. */
"""
    % sys.argv[0]
)


s += """
enum MUSIG_ERROR {
    MUSIG_PUBKEY,
    MUSIG_TWEAK,
    MUSIG_PUBNONCE,
    MUSIG_AGGNONCE,
    MUSIG_SECNONCE,
    MUSIG_SIG,
    MUSIG_SIG_VERIFY,
    MUSIG_OTHER
};
"""

# key agg vectors
with open(sys.argv[1] + "/key_agg_vectors.json", "r") as f:
    data = json.load(f)

    max_key_indices = max(
        len(test_case["key_indices"]) for test_case in data["valid_test_cases"]
    )
    max_tweak_indices = max(
        len(test_case["tweak_indices"]) for test_case in data["error_test_cases"]
    )
    num_pubkeys = len(data["pubkeys"])
    max_pubkeys = max(num_pubkeys, max_pubkeys)
    num_tweaks = len(data["tweaks"])
    num_valid_cases = len(data["valid_test_cases"])
    num_error_cases = len(data["error_test_cases"])

    # Add structures for valid and error cases
    s += (
        """
struct musig_key_agg_valid_test_case {
    size_t key_indices_len;
    size_t key_indices[%d];
    unsigned char expected[32];
};
"""
        % max_key_indices
    )
    s += """
struct musig_key_agg_error_test_case {
    size_t key_indices_len;
    size_t key_indices[%d];
    size_t tweak_indices_len;
    size_t tweak_indices[%d];
    int is_xonly[%d];
    enum MUSIG_ERROR error;
};
""" % (
        max_key_indices,
        max_tweak_indices,
        max_tweak_indices,
    )

    # Add structure for entire vector
    s += """
struct musig_key_agg_vector {
    unsigned char pubkeys[%d][33];
    unsigned char tweaks[%d][32];
    struct musig_key_agg_valid_test_case valid_case[%d];
    struct musig_key_agg_error_test_case error_case[%d];
};
""" % (
        num_pubkeys,
        num_tweaks,
        num_valid_cases,
        num_error_cases,
    )

    s += create_init("key_agg")
    # Add pubkeys and tweaks to the vector
    s += init_arrays("pubkeys")
    s += init_arrays("tweaks")

    # Add valid cases to the vector
    s += init_cases(
        data["valid_test_cases"],
        lambda case: "{ %s, { %s }},"
        % (init_indices(case["key_indices"]), hexstr_to_intarray(case["expected"])),
    )

    def comment_to_error(case):
        comment = case["comment"]
        if "public key" in comment.lower():
            return "MUSIG_PUBKEY"
        elif "tweak" in comment.lower():
            return "MUSIG_TWEAK"
        else:
            sys.exit("Unknown error")

    # Add error cases to the vector
    s += init_cases(
        data["error_test_cases"],
        lambda case: "{ %s, %s, { %s }, %s },"
        % (
            init_indices(case["key_indices"]),
            init_indices(case["tweak_indices"]),
            init_is_xonly(case),
            comment_to_error(case),
        ),
    )

    s += finish_init()

# nonce gen vectors
with open(sys.argv[1] + "/nonce_gen_vectors.json", "r") as f:
    data = json.load(f)

    # The MuSig2 implementation only allows messages of length 32
    data["test_cases"] = list(
        filter(lambda c: c["msg"] is None or len(c["msg"]) == 64, data["test_cases"])
    )

    num_tests = len(data["test_cases"])

    s += """
struct musig_nonce_gen_test_case {
    unsigned char rand_[32];
    int has_sk;
    unsigned char sk[32];
    unsigned char pk[33];
    int has_aggpk;
    unsigned char aggpk[32];
    int has_msg;
    unsigned char msg[32];
    int has_extra_in;
    unsigned char extra_in[32];
    unsigned char expected_secnonce[97];
    unsigned char expected_pubnonce[66];
};
"""

    s += (
        """
struct musig_nonce_gen_vector {
    struct musig_nonce_gen_test_case test_case[%d];
};
"""
        % num_tests
    )

    s += create_init("nonce_gen")

    def init_array_maybe(array):
        return "%d , { %s }" % (
            0 if array is None else 1,
            hexstr_to_intarray(array) if array is not None else 0,
        )

    s += init_cases(
        data["test_cases"],
        lambda case: "{ { %s },  %s, { %s }, %s, %s, %s, { %s }, { %s } },"
        % (
            hexstr_to_intarray(case["rand_"]),
            init_array_maybe(case["sk"]),
            hexstr_to_intarray(case["pk"]),
            init_array_maybe(case["aggpk"]),
            init_array_maybe(case["msg"]),
            init_array_maybe(case["extra_in"]),
            hexstr_to_intarray(case["expected_secnonce"]),
            hexstr_to_intarray(case["expected_pubnonce"]),
        ),
    )

    s += finish_init()

# nonce agg vectors
with open(sys.argv[1] + "/nonce_agg_vectors.json", "r") as f:
    data = json.load(f)

    num_pnonces = len(data["pnonces"])
    num_valid_cases = len(data["valid_test_cases"])
    num_error_cases = len(data["error_test_cases"])

    pnonce_indices_len = 2
    for case in data["valid_test_cases"] + data["error_test_cases"]:
        assert len(case["pnonce_indices"]) == pnonce_indices_len

    # Add structures for valid and error cases
    s += """
struct musig_nonce_agg_test_case {
    size_t pnonce_indices[2];
    /* if valid case */
    unsigned char expected[66];
    /* if error case */
    int invalid_nonce_idx;
};
"""
    # Add structure for entire vector
    s += """
struct musig_nonce_agg_vector {
    unsigned char pnonces[%d][66];
    struct musig_nonce_agg_test_case valid_case[%d];
    struct musig_nonce_agg_test_case error_case[%d];
};
""" % (
        num_pnonces,
        num_valid_cases,
        num_error_cases,
    )

    s += create_init("nonce_agg")
    s += init_arrays("pnonces")

    for cases in (data["valid_test_cases"], data["error_test_cases"]):
        s += init_cases(
            cases,
            lambda case: "{ { %s }, { %s }, %d },"
            % (
                ", ".join(map(str, case["pnonce_indices"])),
                init_optional_expected(case),
                case["error"]["signer"] if "error" in case else 0,
            ),
        )
    s += finish_init()

# sign/verify vectors
with open(sys.argv[1] + "/sign_verify_vectors.json", "r") as f:
    data = json.load(f)

    # The MuSig2 implementation only allows messages of length 32
    assert list(filter(lambda x: len(x) == 64, data["msgs"]))[0] == data["msgs"][0]
    data["msgs"] = [data["msgs"][0]]

    def filter_msg32(k):
        return list(filter(lambda x: x["msg_index"] == 0, data[k]))

    data["valid_test_cases"] = filter_msg32("valid_test_cases")
    data["sign_error_test_cases"] = filter_msg32("sign_error_test_cases")
    data["verify_error_test_cases"] = filter_msg32("verify_error_test_cases")
    data["verify_fail_test_cases"] = filter_msg32("verify_fail_test_cases")

    num_pubkeys = len(data["pubkeys"])
    max_pubkeys = max(num_pubkeys, max_pubkeys)
    num_secnonces = len(data["secnonces"])
    num_pubnonces = len(data["pnonces"])
    num_aggnonces = len(data["aggnonces"])
    num_msgs = len(data["msgs"])
    num_valid_cases = len(data["valid_test_cases"])
    num_sign_error_cases = len(data["sign_error_test_cases"])
    num_verify_fail_cases = len(data["verify_fail_test_cases"])
    num_verify_error_cases = len(data["verify_error_test_cases"])

    all_cases = (
        data["valid_test_cases"]
        + data["sign_error_test_cases"]
        + data["verify_error_test_cases"]
        + data["verify_fail_test_cases"]
    )
    max_key_indices = max(len(test_case["key_indices"]) for test_case in all_cases)
    max_nonce_indices = max(
        len(test_case["nonce_indices"]) if "nonce_indices" in test_case else 0
        for test_case in all_cases
    )
    # Add structures for valid and error cases
    s += (
        """
/* Omit pubnonces in the test vectors because our partial signature verification
 * implementation is able to accept the aggnonce directly. */
struct musig_valid_case {
    size_t key_indices_len;
    size_t key_indices[%d];
    size_t aggnonce_index;
    size_t msg_index;
    size_t signer_index;
    unsigned char expected[32];
};
"""
        % max_key_indices
    )

    s += (
        """
struct musig_sign_error_case {
    size_t key_indices_len;
    size_t key_indices[%d];
    size_t aggnonce_index;
    size_t msg_index;
    size_t secnonce_index;
    enum MUSIG_ERROR error;
};
"""
        % max_key_indices
    )

    s += """
struct musig_verify_fail_error_case {
    unsigned char sig[32];
    size_t key_indices_len;
    size_t key_indices[%d];
    size_t nonce_indices_len;
    size_t nonce_indices[%d];
    size_t msg_index;
    size_t signer_index;
    enum MUSIG_ERROR error;
};
""" % (
        max_key_indices,
        max_nonce_indices,
    )

    # Add structure for entire vector
    s += """
struct musig_sign_verify_vector {
    unsigned char sk[32];
    unsigned char pubkeys[%d][33];
    unsigned char secnonces[%d][194];
    unsigned char pubnonces[%d][194];
    unsigned char aggnonces[%d][66];
    unsigned char msgs[%d][32];
    struct musig_valid_case valid_case[%d];
    struct musig_sign_error_case sign_error_case[%d];
    struct musig_verify_fail_error_case verify_fail_case[%d];
    struct musig_verify_fail_error_case verify_error_case[%d];
};
""" % (
        num_pubkeys,
        num_secnonces,
        num_pubnonces,
        num_aggnonces,
        num_msgs,
        num_valid_cases,
        num_sign_error_cases,
        num_verify_fail_cases,
        num_verify_error_cases,
    )

    s += create_init("sign_verify")
    s += init_array("sk")
    s += init_arrays("pubkeys")
    s += init_arrays("secnonces")
    s += init_arrays("pnonces")
    s += init_arrays("aggnonces")
    s += init_arrays("msgs")

    s += init_cases(
        data["valid_test_cases"],
        lambda case: "{ %s, %d, %d, %d, { %s }},"
        % (
            init_indices(case["key_indices"]),
            case["aggnonce_index"],
            case["msg_index"],
            case["signer_index"],
            init_optional_expected(case),
        ),
    )

    def sign_error(case):
        comment = case["comment"]
        if "pubkey" in comment or "public key" in comment:
            return "MUSIG_PUBKEY"
        elif "Aggregate nonce" in comment:
            return "MUSIG_AGGNONCE"
        elif "Secnonce" in comment:
            return "MUSIG_SECNONCE"
        else:
            sys.exit("Unknown sign error")

    s += init_cases(
        data["sign_error_test_cases"],
        lambda case: "{ %s, %d, %d, %d, %s },"
        % (
            init_indices(case["key_indices"]),
            case["aggnonce_index"],
            case["msg_index"],
            case["secnonce_index"],
            sign_error(case),
        ),
    )

    def verify_error(case):
        comment = case["comment"]
        if "exceeds" in comment:
            return "MUSIG_SIG"
        elif "Wrong signer" in comment or "Wrong signature" in comment:
            return "MUSIG_SIG_VERIFY"
        elif "pubnonce" in comment:
            return "MUSIG_PUBNONCE"
        elif "pubkey" in comment:
            return "MUSIG_PUBKEY"
        else:
            sys.exit("Unknown verify error")

    for cases in ("verify_fail_test_cases", "verify_error_test_cases"):
        s += init_cases(
            data[cases],
            lambda case: "{ { %s }, %s, %s, %d, %d, %s },"
            % (
                hexstr_to_intarray(case["sig"]),
                init_indices(case["key_indices"]),
                init_indices(case["nonce_indices"]),
                case["msg_index"],
                case["signer_index"],
                verify_error(case),
            ),
        )

    s += finish_init()

# tweak vectors
with open(sys.argv[1] + "/tweak_vectors.json", "r") as f:
    data = json.load(f)

    num_pubkeys = len(data["pubkeys"])
    max_pubkeys = max(num_pubkeys, max_pubkeys)
    num_pubnonces = len(data["pnonces"])
    num_tweaks = len(data["tweaks"])
    num_valid_cases = len(data["valid_test_cases"])
    num_error_cases = len(data["error_test_cases"])

    all_cases = data["valid_test_cases"] + data["error_test_cases"]
    max_key_indices = max(len(test_case["key_indices"]) for test_case in all_cases)
    max_tweak_indices = max(len(test_case["tweak_indices"]) for test_case in all_cases)
    max_nonce_indices = max(len(test_case["nonce_indices"]) for test_case in all_cases)
    # Add structures for valid and error cases
    s += """
struct musig_tweak_case {
    size_t key_indices_len;
    size_t key_indices[%d];
    size_t nonce_indices_len;
    size_t nonce_indices[%d];
    size_t tweak_indices_len;
    size_t tweak_indices[%d];
    int is_xonly[%d];
    size_t signer_index;
    unsigned char expected[32];
};
""" % (
        max_key_indices,
        max_nonce_indices,
        max_tweak_indices,
        max_tweak_indices,
    )

    # Add structure for entire vector
    s += """
struct musig_tweak_vector {
    unsigned char sk[32];
    unsigned char secnonce[97];
    unsigned char aggnonce[66];
    unsigned char msg[32];
    unsigned char pubkeys[%d][33];
    unsigned char pubnonces[%d][194];
    unsigned char tweaks[%d][32];
    struct musig_tweak_case valid_case[%d];
    struct musig_tweak_case error_case[%d];
};
""" % (
        num_pubkeys,
        num_pubnonces,
        num_tweaks,
        num_valid_cases,
        num_error_cases,
    )
    s += create_init("tweak")
    s += init_array("sk")
    s += init_array("secnonce")
    s += init_array("aggnonce")
    s += init_array("msg")
    s += init_arrays("pubkeys")
    s += init_arrays("pnonces")
    s += init_arrays("tweaks")

    s += init_cases(
        data["valid_test_cases"],
        lambda case: "{ %s, %s, %s, { %s }, %d, { %s }},"
        % (
            init_indices(case["key_indices"]),
            init_indices(case["nonce_indices"]),
            init_indices(case["tweak_indices"]),
            init_is_xonly(case),
            case["signer_index"],
            init_optional_expected(case),
        ),
    )

    s += init_cases(
        data["error_test_cases"],
        lambda case: "{ %s, %s, %s, { %s }, %d, { %s }},"
        % (
            init_indices(case["key_indices"]),
            init_indices(case["nonce_indices"]),
            init_indices(case["tweak_indices"]),
            init_is_xonly(case),
            case["signer_index"],
            init_optional_expected(case),
        ),
    )

    s += finish_init()

# sigagg vectors
with open(sys.argv[1] + "/sig_agg_vectors.json", "r") as f:
    data = json.load(f)

    num_pubkeys = len(data["pubkeys"])
    max_pubkeys = max(num_pubkeys, max_pubkeys)
    num_tweaks = len(data["tweaks"])
    num_psigs = len(data["psigs"])
    num_valid_cases = len(data["valid_test_cases"])
    num_error_cases = len(data["error_test_cases"])

    all_cases = data["valid_test_cases"] + data["error_test_cases"]
    max_key_indices = max(len(test_case["key_indices"]) for test_case in all_cases)
    max_tweak_indices = max(len(test_case["tweak_indices"]) for test_case in all_cases)
    max_psig_indices = max(len(test_case["psig_indices"]) for test_case in all_cases)

    # Add structures for valid and error cases
    s += """
/* Omit pubnonces in the test vectors because they're only needed for
 * implementations that do not directly accept an aggnonce. */
struct musig_sig_agg_case {
    size_t key_indices_len;
    size_t key_indices[%d];
    size_t tweak_indices_len;
    size_t tweak_indices[%d];
    int is_xonly[%d];
    unsigned char aggnonce[66];
    size_t psig_indices_len;
    size_t psig_indices[%d];
    /* if valid case */
    unsigned char expected[64];
    /* if error case */
    int invalid_sig_idx;
};
""" % (
        max_key_indices,
        max_tweak_indices,
        max_tweak_indices,
        max_psig_indices,
    )

    # Add structure for entire vector
    s += """
struct musig_sig_agg_vector {
    unsigned char pubkeys[%d][33];
    unsigned char tweaks[%d][32];
    unsigned char psigs[%d][32];
    unsigned char msg[32];
    struct musig_sig_agg_case valid_case[%d];
    struct musig_sig_agg_case error_case[%d];
};
""" % (
        num_pubkeys,
        num_tweaks,
        num_psigs,
        num_valid_cases,
        num_error_cases,
    )

    s += create_init("sig_agg")
    s += init_arrays("pubkeys")
    s += init_arrays("tweaks")
    s += init_arrays("psigs")
    s += init_array("msg")

    for cases in (data["valid_test_cases"], data["error_test_cases"]):
        s += init_cases(
            cases,
            lambda case: "{ %s, %s, { %s }, { %s }, %s, { %s }, %d },"
            % (
                init_indices(case["key_indices"]),
                init_indices(case["tweak_indices"]),
                init_is_xonly(case),
                hexstr_to_intarray(case["aggnonce"]),
                init_indices(case["psig_indices"]),
                init_optional_expected(case),
                case["error"]["signer"] if "error" in case else 0,
            ),
        )
    s += finish_init()
s += "enum { MUSIG_VECTORS_MAX_PUBKEYS = %d };" % max_pubkeys
print(s)