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.

29,397 bytes · SHA-256 e59224d706f6c792… · View upstream ↗

1// Copyright (c) 2012-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 <flatfile.h>
6#include <node/blockstorage.h>
7#include <streams.h>
8#include <test/util/common.h>
9#include <test/util/random.h>
10#include <test/util/setup_common.h>
11#include <util/fs.h>
12#include <util/obfuscation.h>
13#include <util/strencodings.h>
14
15#include <boost/test/unit_test.hpp>
16
17using namespace std::string_literals;
18using namespace util::hex_literals;
19
20BOOST_FIXTURE_TEST_SUITE(streams_tests, BasicTestingSetup)
21
22// Check optimized obfuscation with random offsets and sizes to ensure proper
23// handling of key wrapping. Also verify it roundtrips.
24BOOST_AUTO_TEST_CASE(xor_random_chunks)
25{
26    auto apply_random_xor_chunks{[&](std::span<std::byte> target, const Obfuscation& obfuscation) {
27        for (size_t offset{0}; offset < target.size();) {
28            const size_t chunk_size{1 + m_rng.randrange(target.size() - offset)};
29            obfuscation(target.subspan(offset, chunk_size), offset);
30            offset += chunk_size;
31        }
32    }};
33
34    for (size_t test{0}; test < 100; ++test) {
35        const size_t write_size{1 + m_rng.randrange(100U)};
36        const std::vector original{m_rng.randbytes<std::byte>(write_size)};
37        std::vector roundtrip{original};
38
39        const auto key_bytes{m_rng.randbool() ? m_rng.randbytes<Obfuscation::KEY_SIZE>() : std::array<std::byte, Obfuscation::KEY_SIZE>{}};
40        const Obfuscation obfuscation{key_bytes};
41        apply_random_xor_chunks(roundtrip, obfuscation);
42        BOOST_CHECK_EQUAL(roundtrip.size(), original.size());
43        for (size_t i{0}; i < original.size(); ++i) {
44            BOOST_CHECK_EQUAL(roundtrip[i], original[i] ^ key_bytes[i % Obfuscation::KEY_SIZE]);
45        }
46
47        apply_random_xor_chunks(roundtrip, obfuscation);
48        BOOST_CHECK_EQUAL_COLLECTIONS(roundtrip.begin(), roundtrip.end(), original.begin(), original.end());
49  }
50}
51
52BOOST_AUTO_TEST_CASE(obfuscation_hexkey)
53{
54    const auto key_bytes{m_rng.randbytes<Obfuscation::KEY_SIZE>()};
55
56    const Obfuscation obfuscation{key_bytes};
57    BOOST_CHECK_EQUAL(obfuscation.HexKey(), HexStr(key_bytes));
58}
59
60BOOST_AUTO_TEST_CASE(obfuscation_serialize)
61{
62    Obfuscation obfuscation{};
63    BOOST_CHECK(!obfuscation);
64
65    // Test loading a key.
66    std::vector key_in{m_rng.randbytes<std::byte>(Obfuscation::KEY_SIZE)};
67    DataStream ds_in;
68    ds_in << key_in;
69    BOOST_CHECK_EQUAL(ds_in.size(), 1 + Obfuscation::KEY_SIZE); // serialized as a vector
70    ds_in >> obfuscation;
71
72    // Test saving the key.
73    std::vector<std::byte> key_out;
74    DataStream ds_out;
75    ds_out << obfuscation;
76    ds_out >> key_out;
77
78    // Make sure saved key is the same.
79    BOOST_CHECK_EQUAL_COLLECTIONS(key_in.begin(), key_in.end(), key_out.begin(), key_out.end());
80}
81
82BOOST_AUTO_TEST_CASE(obfuscation_empty)
83{
84    const Obfuscation null_obf{};
85    BOOST_CHECK(!null_obf);
86
87    const Obfuscation non_null_obf{"ff00ff00ff00ff00"_hex};
88    BOOST_CHECK(non_null_obf);
89}
90
91BOOST_AUTO_TEST_CASE(streams_scoped_data_stream_usage)
92{
93    DataStream stream{};
94    {
95        ScopedDataStreamUsage usage{stream};
96        stream << uint8_t{42};
97        BOOST_CHECK_GT(stream.size(), 0U);
98    }
99    BOOST_CHECK(stream.empty());
100
101    {
102        ScopedDataStreamUsage usage{stream};
103        stream << uint16_t{42};
104        BOOST_CHECK_GT(stream.size(), 0U);
105    }
106    BOOST_CHECK(stream.empty());
107}
108
109BOOST_AUTO_TEST_CASE(xor_file)
110{
111    fs::path xor_path{m_args.GetDataDirBase() / "test_xor.bin"};
112    auto raw_file{[&](const auto& mode) { return fsbridge::fopen(xor_path, mode); }};
113    const std::vector<uint8_t> test1{1, 2, 3};
114    const std::vector<uint8_t> test2{4, 5};
115    const Obfuscation obfuscation{"ff00ff00ff00ff00"_hex};
116
117    {
118        // Check errors for missing file
119        AutoFile xor_file{raw_file("rb"), obfuscation};
120        BOOST_CHECK_EXCEPTION(xor_file << std::byte{}, std::ios_base::failure, HasReason{"AutoFile::write: file handle is nullptr"});
121        BOOST_CHECK_EXCEPTION(xor_file >> std::byte{}, std::ios_base::failure, HasReason{"AutoFile::read: file handle is nullptr"});
122        BOOST_CHECK_EXCEPTION(xor_file.ignore(1), std::ios_base::failure, HasReason{"AutoFile::ignore: file handle is nullptr"});
123        BOOST_CHECK_EXCEPTION(xor_file.size(), std::ios_base::failure, HasReason{"AutoFile::size: file handle is nullptr"});
124    }
125    {
126#ifdef __MINGW64__
127        // Temporary workaround for https://github.com/bitcoin/bitcoin/issues/30210
128        const char* mode = "wb";
129#else
130        const char* mode = "wbx";
131#endif
132        AutoFile xor_file{raw_file(mode), obfuscation};
133        xor_file << test1 << test2;
134        BOOST_CHECK_EQUAL(xor_file.size(), 7);
135        BOOST_REQUIRE_EQUAL(xor_file.fclose(), 0);
136    }
137    {
138        // Read raw from disk
139        AutoFile non_xor_file{raw_file("rb")};
140        std::vector<std::byte> raw(7);
141        non_xor_file >> std::span{raw};
142        BOOST_CHECK_EQUAL(HexStr(raw), "fc01fd03fd04fa");
143        // Check that no padding exists
144        BOOST_CHECK_EXCEPTION(non_xor_file.ignore(1), std::ios_base::failure, HasReason{"AutoFile::ignore: end of file"});
145        BOOST_CHECK_EQUAL(non_xor_file.size(), 7);
146    }
147    {
148        AutoFile xor_file{raw_file("rb"), obfuscation};
149        std::vector<std::byte> read1, read2;
150        xor_file >> read1 >> read2;
151        BOOST_CHECK_EQUAL(HexStr(read1), HexStr(test1));
152        BOOST_CHECK_EQUAL(HexStr(read2), HexStr(test2));
153        // Check that eof was reached
154        BOOST_CHECK_EXCEPTION(xor_file >> std::byte{}, std::ios_base::failure, HasReason{"AutoFile::read: end of file"});
155        BOOST_CHECK_EQUAL(xor_file.size(), 7);
156    }
157    {
158        AutoFile xor_file{raw_file("rb"), obfuscation};
159        std::vector<std::byte> read2;
160        // Check that ignore works
161        xor_file.ignore(4);
162        xor_file >> read2;
163        BOOST_CHECK_EQUAL(HexStr(read2), HexStr(test2));
164        // Check that ignore and read fail now
165        BOOST_CHECK_EXCEPTION(xor_file.ignore(1), std::ios_base::failure, HasReason{"AutoFile::ignore: end of file"});
166        BOOST_CHECK_EXCEPTION(xor_file >> std::byte{}, std::ios_base::failure, HasReason{"AutoFile::read: end of file"});
167        BOOST_CHECK_EQUAL(xor_file.size(), 7);
168    }
169}
170
171BOOST_AUTO_TEST_CASE(streams_vector_writer)
172{
173    unsigned char a(1);
174    unsigned char b(2);
175    unsigned char bytes[] = {3, 4, 5, 6};
176    std::vector<unsigned char> vch;
177
178    // Each test runs twice. Serializing a second time at the same starting
179    // point should yield the same results, even if the first test grew the
180    // vector.
181
182    VectorWriter{vch, 0, a, b};
183    BOOST_CHECK((vch == std::vector<unsigned char>{{1, 2}}));
184    VectorWriter{vch, 0, a, b};
185    BOOST_CHECK((vch == std::vector<unsigned char>{{1, 2}}));
186    vch.clear();
187
188    VectorWriter{vch, 2, a, b};
189    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 1, 2}}));
190    VectorWriter{vch, 2, a, b};
191    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 1, 2}}));
192    vch.clear();
193
194    vch.resize(5, 0);
195    VectorWriter{vch, 2, a, b};
196    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 1, 2, 0}}));
197    VectorWriter{vch, 2, a, b};
198    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 1, 2, 0}}));
199    vch.clear();
200
201    vch.resize(4, 0);
202    VectorWriter{vch, 3, a, b};
203    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 0, 1, 2}}));
204    VectorWriter{vch, 3, a, b};
205    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 0, 1, 2}}));
206    vch.clear();
207
208    vch.resize(4, 0);
209    VectorWriter{vch, 4, a, b};
210    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 0, 0, 1, 2}}));
211    VectorWriter{vch, 4, a, b};
212    BOOST_CHECK((vch == std::vector<unsigned char>{{0, 0, 0, 0, 1, 2}}));
213    vch.clear();
214
215    VectorWriter{vch, 0, bytes};
216    BOOST_CHECK((vch == std::vector<unsigned char>{{3, 4, 5, 6}}));
217    VectorWriter{vch, 0, bytes};
218    BOOST_CHECK((vch == std::vector<unsigned char>{{3, 4, 5, 6}}));
219    vch.clear();
220
221    vch.resize(4, 8);
222    VectorWriter{vch, 2, a, bytes, b};
223    BOOST_CHECK((vch == std::vector<unsigned char>{{8, 8, 1, 3, 4, 5, 6, 2}}));
224    VectorWriter{vch, 2, a, bytes, b};
225    BOOST_CHECK((vch == std::vector<unsigned char>{{8, 8, 1, 3, 4, 5, 6, 2}}));
226    vch.clear();
227}
228
229BOOST_AUTO_TEST_CASE(streams_span_writer)
230{
231    unsigned char a(1);
232    unsigned char b(2);
233    unsigned char bytes[] = {3, 4, 5, 6};
234    std::array<std::byte, 8> arr{};
235
236    // Test operator<<
237    SpanWriter writer{arr};
238    writer << a << b;
239    BOOST_CHECK_EQUAL(HexStr(arr), "0102000000000000");
240
241    // Use variadic constructor and write to subspan.
242    SpanWriter{std::span{arr}.subspan(2), a, bytes, b};
243    BOOST_CHECK_EQUAL(HexStr(arr), "0102010304050602");
244
245    // Writing past the end throws
246    std::array<std::byte, 1> small{};
247    BOOST_CHECK_THROW(SpanWriter(std::span{small}, a, b), std::ios_base::failure);
248    BOOST_CHECK_THROW(SpanWriter(std::span{small}) << a << b, std::ios_base::failure);
249}
250

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.