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.

7,066 bytes · SHA-256 b37015d0eeff667d… · View upstream ↗

1// Copyright (c) 2017 The Zcash 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
6#include <boost/test/unit_test.hpp>
7
8#include <map>
9#include <string>
10#include <utility>
11
12
13std::pair<std::string, std::string> SplitTorReplyLine(const std::string& s);
14std::map<std::string, std::string> ParseTorReplyMapping(const std::string& s);
15
16
17BOOST_AUTO_TEST_SUITE(torcontrol_tests)
18
19static void CheckSplitTorReplyLine(std::string input, std::string command, std::string args)
20{
21    auto ret = SplitTorReplyLine(input);
22    BOOST_CHECK_EQUAL(ret.first, command);
23    BOOST_CHECK_EQUAL(ret.second, args);
24}
25
26BOOST_AUTO_TEST_CASE(util_SplitTorReplyLine)
27{
28    // Data we should receive during normal usage
29    CheckSplitTorReplyLine(
30        "PROTOCOLINFO PIVERSION",
31        "PROTOCOLINFO", "PIVERSION");
32    CheckSplitTorReplyLine(
33        "AUTH METHODS=COOKIE,SAFECOOKIE COOKIEFILE=\"/home/x/.tor/control_auth_cookie\"",
34        "AUTH", "METHODS=COOKIE,SAFECOOKIE COOKIEFILE=\"/home/x/.tor/control_auth_cookie\"");
35    CheckSplitTorReplyLine(
36        "AUTH METHODS=NULL",
37        "AUTH", "METHODS=NULL");
38    CheckSplitTorReplyLine(
39        "AUTH METHODS=HASHEDPASSWORD",
40        "AUTH", "METHODS=HASHEDPASSWORD");
41    CheckSplitTorReplyLine(
42        "VERSION Tor=\"0.2.9.8 (git-a0df013ea241b026)\"",
43        "VERSION", "Tor=\"0.2.9.8 (git-a0df013ea241b026)\"");
44    CheckSplitTorReplyLine(
45        "AUTHCHALLENGE SERVERHASH=aaaa SERVERNONCE=bbbb",
46        "AUTHCHALLENGE", "SERVERHASH=aaaa SERVERNONCE=bbbb");
47
48    // Other valid inputs
49    CheckSplitTorReplyLine("COMMAND", "COMMAND", "");
50    CheckSplitTorReplyLine("COMMAND SOME  ARGS", "COMMAND", "SOME  ARGS");
51
52    // These inputs are valid because PROTOCOLINFO accepts an OtherLine that is
53    // just an OptArguments, which enables multiple spaces to be present
54    // between the command and arguments.
55    CheckSplitTorReplyLine("COMMAND  ARGS", "COMMAND", " ARGS");
56    CheckSplitTorReplyLine("COMMAND   EVEN+more  ARGS", "COMMAND", "  EVEN+more  ARGS");
57}
58
59static void CheckParseTorReplyMapping(std::string input, std::map<std::string,std::string> expected)
60{
61    auto ret = ParseTorReplyMapping(input);
62    BOOST_CHECK_EQUAL(ret.size(), expected.size());
63    auto r_it = ret.begin();
64    auto e_it = expected.begin();
65    while (r_it != ret.end() && e_it != expected.end()) {
66        BOOST_CHECK_EQUAL(r_it->first, e_it->first);
67        BOOST_CHECK_EQUAL(r_it->second, e_it->second);
68        r_it++;
69        e_it++;
70    }
71}
72
73BOOST_AUTO_TEST_CASE(util_ParseTorReplyMapping)
74{
75    // Data we should receive during normal usage
76    CheckParseTorReplyMapping(
77        "METHODS=COOKIE,SAFECOOKIE COOKIEFILE=\"/home/x/.tor/control_auth_cookie\"", {
78            {"METHODS", "COOKIE,SAFECOOKIE"},
79            {"COOKIEFILE", "/home/x/.tor/control_auth_cookie"},
80        });
81    CheckParseTorReplyMapping(
82        "METHODS=NULL", {
83            {"METHODS", "NULL"},
84        });
85    CheckParseTorReplyMapping(
86        "METHODS=HASHEDPASSWORD", {
87            {"METHODS", "HASHEDPASSWORD"},
88        });
89    CheckParseTorReplyMapping(
90        "Tor=\"0.2.9.8 (git-a0df013ea241b026)\"", {
91            {"Tor", "0.2.9.8 (git-a0df013ea241b026)"},
92        });
93    CheckParseTorReplyMapping(
94        "SERVERHASH=aaaa SERVERNONCE=bbbb", {
95            {"SERVERHASH", "aaaa"},
96            {"SERVERNONCE", "bbbb"},
97        });
98    CheckParseTorReplyMapping(
99        "ServiceID=exampleonion1234", {
100            {"ServiceID", "exampleonion1234"},
101        });
102    CheckParseTorReplyMapping(
103        "PrivateKey=RSA1024:BLOB", {
104            {"PrivateKey", "RSA1024:BLOB"},
105        });
106    CheckParseTorReplyMapping(
107        "ClientAuth=bob:BLOB", {
108            {"ClientAuth", "bob:BLOB"},
109        });
110
111    // Other valid inputs
112    CheckParseTorReplyMapping(
113        "Foo=Bar=Baz Spam=Eggs", {
114            {"Foo", "Bar=Baz"},
115            {"Spam", "Eggs"},
116        });
117    CheckParseTorReplyMapping(
118        "Foo=\"Bar=Baz\"", {
119            {"Foo", "Bar=Baz"},
120        });
121    CheckParseTorReplyMapping(
122        "Foo=\"Bar Baz\"", {
123            {"Foo", "Bar Baz"},
124        });
125
126    // Escapes
127    CheckParseTorReplyMapping(
128        "Foo=\"Bar\\ Baz\"", {
129            {"Foo", "Bar Baz"},
130        });
131    CheckParseTorReplyMapping(
132        "Foo=\"Bar\\Baz\"", {
133            {"Foo", "BarBaz"},
134        });
135    CheckParseTorReplyMapping(
136        "Foo=\"Bar\\@Baz\"", {
137            {"Foo", "Bar@Baz"},
138        });
139    CheckParseTorReplyMapping(
140        "Foo=\"Bar\\\"Baz\" Spam=\"\\\"Eggs\\\"\"", {
141            {"Foo", "Bar\"Baz"},
142            {"Spam", "\"Eggs\""},
143        });
144    CheckParseTorReplyMapping(
145        "Foo=\"Bar\\\\Baz\"", {
146            {"Foo", "Bar\\Baz"},
147        });
148
149    // C escapes
150    CheckParseTorReplyMapping(
151        "Foo=\"Bar\\nBaz\\t\" Spam=\"\\rEggs\" Octals=\"\\1a\\11\\17\\18\\81\\377\\378\\400\\2222\" Final=Check", {
152            {"Foo", "Bar\nBaz\t"},
153            {"Spam", "\rEggs"},
154            {"Octals", "\1a\11\17\1" "881\377\37" "8\40" "0\222" "2"},
155            {"Final", "Check"},
156        });
157    CheckParseTorReplyMapping(
158        "Valid=Mapping Escaped=\"Escape\\\\\"", {
159            {"Valid", "Mapping"},
160            {"Escaped", "Escape\\"},
161        });
162    CheckParseTorReplyMapping(
163        "Valid=Mapping Bare=\"Escape\\\"", {});
164    CheckParseTorReplyMapping(
165        "OneOctal=\"OneEnd\\1\" TwoOctal=\"TwoEnd\\11\"", {
166            {"OneOctal", "OneEnd\1"},
167            {"TwoOctal", "TwoEnd\11"},
168        });
169
170    // Special handling for null case
171    // (needed because string comparison reads the null as end-of-string)
172    auto ret = ParseTorReplyMapping("Null=\"\\0\"");
173    BOOST_CHECK_EQUAL(ret.size(), 1U);
174    auto r_it = ret.begin();
175    BOOST_CHECK_EQUAL(r_it->first, "Null");
176    BOOST_CHECK_EQUAL(r_it->second.size(), 1U);
177    BOOST_CHECK_EQUAL(r_it->second[0], '\0');
178
179    // A more complex valid grammar. PROTOCOLINFO accepts a VersionLine that
180    // takes a key=value pair followed by an OptArguments, making this valid.
181    // Because an OptArguments contains no semantic data, there is no point in
182    // parsing it.
183    CheckParseTorReplyMapping(
184        "SOME=args,here MORE optional=arguments  here", {
185            {"SOME", "args,here"},
186        });
187
188    // Inputs that are effectively invalid under the target grammar.
189    // PROTOCOLINFO accepts an OtherLine that is just an OptArguments, which
190    // would make these inputs valid. However,
191    // - This parser is never used in that situation, because the
192    //   SplitTorReplyLine parser enables OtherLine to be skipped.
193    // - Even if these were valid, an OptArguments contains no semantic data,
194    //   so there is no point in parsing it.
195    CheckParseTorReplyMapping("ARGS", {});
196    CheckParseTorReplyMapping("MORE ARGS", {});
197    CheckParseTorReplyMapping("MORE  ARGS", {});
198    CheckParseTorReplyMapping("EVEN more=ARGS", {});
199    CheckParseTorReplyMapping("EVEN+more ARGS", {});
200}
201
202BOOST_AUTO_TEST_SUITE_END()
203

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.