READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

5,964 bytes · SHA-256 37cff9794b376661… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2024 Random "Randy" Lattice and Sean Andersen
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or https://www.opensource.org/licenses/mit-license.php.
5'''
6Generate a C file with ECDH testvectors from the Wycheproof project.
7'''
8
9import json
10import sys
11
12from binascii import hexlify, unhexlify
13from wycheproof_utils import to_c_array
14
15def should_skip_flags(test_vector_flags):
16    # skip these vectors because they are for ASN.1 encoding issues and other curves.
17    # for more details, see https://github.com/bitcoin-core/secp256k1/pull/1492#discussion_r1572491546
18    flags_to_skip = {"InvalidAsn", "WrongCurve"}
19    return any(flag in test_vector_flags for flag in flags_to_skip)
20
21def should_skip_tcid(test_vector_tcid):
22    # We skip some test case IDs that have a public key whose custom ASN.1 representation explicitly
23    # encodes some curve parameters that are invalid. libsecp256k1 never parses this part so we do
24    # not care testing those. See https://github.com/bitcoin-core/secp256k1/pull/1492#discussion_r1572491546
25    tcids_to_skip = [496, 497, 502, 503, 504, 505, 507]
26    return test_vector_tcid in tcids_to_skip
27
28# Rudimentary ASN.1 DER public key parser.
29# This should not be used for anything other than parsing Wycheproof test vectors.
30def parse_der_pk(s):
31    tag = s[0]
32    L = int(s[1])
33    offset = 0
34    if L & 0x80:
35        if L == 0x81:
36            L = int(s[2])
37            offset = 1
38        elif L == 0x82:
39            L = 256 * int(s[2]) + int(s[3])
40            offset = 2
41        else:
42            raise ValueError("invalid L")
43    value = s[(offset + 2):(L + 2 + offset)]
44    rest = s[(L + 2 + offset):]
45
46    if len(rest) > 0 or tag == 0x06: # OBJECT IDENTIFIER
47        return parse_der_pk(rest)
48    if tag == 0x03: # BIT STRING
49        return value
50    if tag == 0x30: # SEQUENCE
51        return parse_der_pk(value)
52    raise ValueError("unknown tag")
53
54def parse_public_key(pk):
55    der_pub_key = parse_der_pk(unhexlify(pk))   # Convert back to str and strip off the `0x`
56    return hexlify(der_pub_key).decode()[2:]
57
58def normalize_private_key(sk):
59    # Ensure the private key is at most 64 characters long, retaining the last 64 if longer.
60    # In the wycheproof test vectors, some private keys have leading zeroes
61    normalized = sk[-64:].zfill(64)
62    if len(normalized) != 64:
63        raise ValueError("private key must be exactly 64 characters long.")
64    return normalized
65
66def normalize_expected_result(er):
67    result_mapping = {"invalid": 0, "valid": 1, "acceptable": 1}
68    return result_mapping[er]
69
70filename_input = sys.argv[1]
71
72with open(filename_input) as f:
73    doc = json.load(f)
74
75num_vectors = 0
76offset_sk_running, offset_pk_running, offset_shared = 0, 0, 0
77test_vectors_out = ""
78private_keys = ""
79shared_secrets = ""
80public_keys = ""
81cache_sks = {}
82cache_public_keys = {}
83
84for group in doc['testGroups']:
85    assert group["type"] == "EcdhTest"
86    assert group["curve"] == "secp256k1"
87    for test_vector in group['tests']:
88        if should_skip_flags(test_vector['flags']) or should_skip_tcid(test_vector['tcId']):
89            continue
90
91        public_key = parse_public_key(test_vector['public'])
92        private_key = normalize_private_key(test_vector['private'])
93        expected_result = normalize_expected_result(test_vector['result'])
94
95        # // 2 to convert hex to byte length
96        shared_size = len(test_vector['shared']) // 2
97        sk_size = len(private_key) // 2
98        pk_size = len(public_key) // 2
99
100        new_sk = False
101        sk = to_c_array(private_key)
102        sk_offset = offset_sk_running
103
104        # check for repeated sk
105        if sk not in cache_sks:
106            if num_vectors != 0 and sk_size != 0:
107                private_keys += ",\n  "
108            cache_sks[sk] = offset_sk_running
109            private_keys += sk
110            new_sk = True
111        else:
112            sk_offset = cache_sks[sk]
113
114        new_pk = False
115        pk = to_c_array(public_key) if public_key != '0x' else ''
116
117        pk_offset = offset_pk_running
118        # check for repeated pk
119        if pk not in cache_public_keys:
120            if num_vectors != 0 and len(pk) != 0:
121                public_keys += ",\n  "
122            cache_public_keys[pk] = offset_pk_running
123            public_keys += pk
124            new_pk = True
125        else:
126            pk_offset = cache_public_keys[pk]
127
128
129        shared_secrets += ",\n  " if num_vectors and shared_size else ""
130        shared_secrets += to_c_array(test_vector['shared'])
131        wycheproof_tcid = test_vector['tcId']
132
133        test_vectors_out += "  /" + "* tcId: " + str(test_vector['tcId']) + ". " + test_vector['comment'] + " *" + "/\n"
134        test_vectors_out += f"  {{{pk_offset}, {pk_size}, {sk_offset}, {sk_size}, {offset_shared}, {shared_size}, {expected_result}, {wycheproof_tcid} }},\n"
135        if new_sk:
136            offset_sk_running += sk_size
137        if new_pk:
138            offset_pk_running += pk_size
139        offset_shared += shared_size
140        num_vectors += 1
141
142struct_definition = """
143typedef struct {
144    size_t pk_offset;
145    size_t pk_len;
146    size_t sk_offset;
147    size_t sk_len;
148    size_t shared_offset;
149    size_t shared_len;
150    int expected_result;
151    int wycheproof_tcid;
152} wycheproof_ecdh_testvector;
153"""
154
155print("/* Note: this file was autogenerated using tests_wycheproof_ecdh.py. Do not edit. */")
156print(f"#define SECP256K1_ECDH_WYCHEPROOF_NUMBER_TESTVECTORS ({num_vectors})")
157
158print(struct_definition)
159
160print("static const unsigned char wycheproof_ecdh_private_keys[]    = { " + private_keys + "};\n")
161print("static const unsigned char wycheproof_ecdh_public_keys[] = { " + public_keys + "};\n")
162print("static const unsigned char wycheproof_ecdh_shared_secrets[]  = { " + shared_secrets + "};\n")
163
164print("static const wycheproof_ecdh_testvector testvectors[SECP256K1_ECDH_WYCHEPROOF_NUMBER_TESTVECTORS] = {")
165print(test_vectors_out)
166print("};")
167

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.