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.

6,320 bytes · SHA-256 13cd1e18d207f3aa… · View upstream ↗

1// Copyright (c) 2011-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <test/data/key_io_invalid.json.h>
6#include <test/data/key_io_valid.json.h>
7
8#include <key.h>
9#include <key_io.h>
10#include <script/script.h>
11#include <test/util/json.h>
12#include <test/util/setup_common.h>
13#include <univalue.h>
14#include <util/chaintype.h>
15#include <util/strencodings.h>
16
17#include <boost/test/unit_test.hpp>
18
19#include <algorithm>
20
21BOOST_FIXTURE_TEST_SUITE(key_io_tests, BasicTestingSetup)
22
23// Goal: check that parsed keys match test payload
24BOOST_AUTO_TEST_CASE(key_io_valid_parse)
25{
26    UniValue tests = read_json(json_tests::key_io_valid);
27    CKey privkey;
28    CTxDestination destination;
29    SelectParams(ChainType::MAIN);
30
31    for (unsigned int idx = 0; idx < tests.size(); idx++) {
32        const UniValue& test = tests[idx];
33        std::string strTest = test.write();
34        if (test.size() < 3) { // Allow for extra stuff (useful for comments)
35            BOOST_ERROR("Bad test: " << strTest);
36            continue;
37        }
38        std::string exp_base58string = test[0].get_str();
39        const std::vector<std::byte> exp_payload{ParseHex<std::byte>(test[1].get_str())};
40        const UniValue &metadata = test[2].get_obj();
41        bool isPrivkey = metadata.find_value("isPrivkey").get_bool();
42        SelectParams(ChainTypeFromString(metadata.find_value("chain").get_str()).value());
43        bool try_case_flip = metadata.find_value("tryCaseFlip").isNull() ? false : metadata.find_value("tryCaseFlip").get_bool();
44        if (isPrivkey) {
45            bool isCompressed = metadata.find_value("isCompressed").get_bool();
46            // Must be valid private key
47            privkey = DecodeSecret(exp_base58string);
48            BOOST_CHECK_MESSAGE(privkey.IsValid(), "!IsValid:" + strTest);
49            BOOST_CHECK_MESSAGE(privkey.IsCompressed() == isCompressed, "compressed mismatch:" + strTest);
50            BOOST_CHECK_MESSAGE(std::ranges::equal(privkey, exp_payload), "key mismatch:" + strTest);
51
52            // Private key must be invalid public key
53            destination = DecodeDestination(exp_base58string);
54            BOOST_CHECK_MESSAGE(!IsValidDestination(destination), "IsValid privkey as pubkey:" + strTest);
55        } else {
56            // Must be valid public key
57            destination = DecodeDestination(exp_base58string);
58            CScript script = GetScriptForDestination(destination);
59            BOOST_CHECK_MESSAGE(IsValidDestination(destination), "!IsValid:" + strTest);
60            BOOST_CHECK_EQUAL(HexStr(script), HexStr(exp_payload));
61
62            // Try flipped case version
63            for (char& c : exp_base58string) {
64                if (c >= 'a' && c <= 'z') {
65                    c = (c - 'a') + 'A';
66                } else if (c >= 'A' && c <= 'Z') {
67                    c = (c - 'A') + 'a';
68                }
69            }
70            destination = DecodeDestination(exp_base58string);
71            BOOST_CHECK_MESSAGE(IsValidDestination(destination) == try_case_flip, "!IsValid case flipped:" + strTest);
72            if (IsValidDestination(destination)) {
73                script = GetScriptForDestination(destination);
74                BOOST_CHECK_EQUAL(HexStr(script), HexStr(exp_payload));
75            }
76
77            // Public key must be invalid private key
78            privkey = DecodeSecret(exp_base58string);
79            BOOST_CHECK_MESSAGE(!privkey.IsValid(), "IsValid pubkey as privkey:" + strTest);
80        }
81    }
82}
83
84// Goal: check that generated keys match test vectors
85BOOST_AUTO_TEST_CASE(key_io_valid_gen)
86{
87    UniValue tests = read_json(json_tests::key_io_valid);
88
89    for (unsigned int idx = 0; idx < tests.size(); idx++) {
90        const UniValue& test = tests[idx];
91        std::string strTest = test.write();
92        if (test.size() < 3) // Allow for extra stuff (useful for comments)
93        {
94            BOOST_ERROR("Bad test: " << strTest);
95            continue;
96        }
97        std::string exp_base58string = test[0].get_str();
98        std::vector<unsigned char> exp_payload = ParseHex(test[1].get_str());
99        const UniValue &metadata = test[2].get_obj();
100        bool isPrivkey = metadata.find_value("isPrivkey").get_bool();
101        SelectParams(ChainTypeFromString(metadata.find_value("chain").get_str()).value());
102        if (isPrivkey) {
103            bool isCompressed = metadata.find_value("isCompressed").get_bool();
104            CKey key;
105            key.Set(exp_payload.begin(), exp_payload.end(), isCompressed);
106            assert(key.IsValid());
107            BOOST_CHECK_MESSAGE(EncodeSecret(key) == exp_base58string, "result mismatch: " + strTest);
108        } else {
109            CTxDestination dest;
110            CScript exp_script(exp_payload.begin(), exp_payload.end());
111            BOOST_CHECK(ExtractDestination(exp_script, dest));
112            std::string address = EncodeDestination(dest);
113
114            BOOST_CHECK_EQUAL(address, exp_base58string);
115        }
116    }
117
118    SelectParams(ChainType::MAIN);
119}
120
121
122// Goal: check that base58 parsing code is robust against a variety of corrupted data
123BOOST_AUTO_TEST_CASE(key_io_invalid)
124{
125    UniValue tests = read_json(json_tests::key_io_invalid); // Negative testcases
126    CKey privkey;
127    CTxDestination destination;
128
129    for (unsigned int idx = 0; idx < tests.size(); idx++) {
130        const UniValue& test = tests[idx];
131        std::string strTest = test.write();
132        if (test.size() < 1) // Allow for extra stuff (useful for comments)
133        {
134            BOOST_ERROR("Bad test: " << strTest);
135            continue;
136        }
137        std::string exp_base58string = test[0].get_str();
138
139        // must be invalid as public and as private key
140        for (const auto& chain : {ChainType::MAIN, ChainType::TESTNET, ChainType::SIGNET, ChainType::REGTEST}) {
141            SelectParams(chain);
142            destination = DecodeDestination(exp_base58string);
143            BOOST_CHECK_MESSAGE(!IsValidDestination(destination), "IsValid pubkey in mainnet:" + strTest);
144            privkey = DecodeSecret(exp_base58string);
145            BOOST_CHECK_MESSAGE(!privkey.IsValid(), "IsValid privkey in mainnet:" + strTest);
146        }
147    }
148}
149
150BOOST_AUTO_TEST_SUITE_END()
151

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.