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.

10,520 bytes · SHA-256 aff88316f6b760a2… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5"""Test torcontrol functionality with a mock Tor control server."""
6from contextlib import contextmanager
7import socket
8import threading
9from test_framework.test_framework import BitcoinTestFramework
10from test_framework.util import (
11    assert_equal,
12    ensure_for,
13    p2p_port,
14)
15
16
17class MockTorControlServer:
18    def __init__(self, port, manual_mode=False):
19        self.port = port
20        self.sock = None
21        self.conn = None
22        self.running = False
23        self.thread = None
24        self.received_commands = []
25        self.manual_mode = manual_mode
26        self.conn_ready = threading.Event()
27
28    def start(self):
29        self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
30        self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
31        self.sock.settimeout(1.0)
32        self.sock.bind(('127.0.0.1', self.port))
33        self.sock.listen(1)
34        self.running = True
35        self.thread = threading.Thread(target=self._serve)
36        self.thread.daemon = True
37        self.thread.start()
38
39    def stop(self):
40        self.running = False
41        if self.conn:
42            self.conn.close()
43        if self.sock:
44            self.sock.close()
45        if self.thread:
46            self.thread.join(timeout=5)
47
48    def _serve(self):
49        while self.running:
50            try:
51                self.conn, _ = self.sock.accept()
52                self.conn.settimeout(1.0)
53                self.conn_ready.set()
54                self._handle_connection(self.conn)
55            except socket.timeout:
56                continue
57            except OSError:
58                break
59
60    def _handle_connection(self, conn):
61        try:
62            buf = b""
63            while self.running:
64                try:
65                    data = conn.recv(1024)
66                    if not data:
67                        break
68                    buf += data
69                    while b"\r\n" in buf:
70                        line, buf = buf.split(b"\r\n", 1)
71                        command = line.decode('utf-8').strip()
72                        if command:
73                            self.received_commands.append(command)
74                            if not self.manual_mode:
75                                response = self._get_response(command)
76                                conn.sendall(response.encode('utf-8'))
77                except socket.timeout:
78                    continue
79        finally:
80            conn.close()
81
82    def send_raw(self, data):
83        if self.conn:
84            self.conn.sendall(data.encode('utf-8'))
85
86    def _get_response(self, command):
87        if command == "PROTOCOLINFO 1":
88            return (
89                "250-PROTOCOLINFO 1\r\n"
90                "250-AUTH METHODS=NULL\r\n"
91                "250-VERSION Tor=\"0.1.2.3\"\r\n"
92                "250 OK\r\n"
93            )
94        elif command == "AUTHENTICATE":
95            return "250 OK\r\n"
96        elif command.startswith("ADD_ONION"):
97            return (
98                "250-ServiceID=testserviceid1234567890123456789012345678901234567890123456\r\n"
99                "250 OK\r\n"
100            )
101        elif command.startswith("GETINFO"):
102            return "250-net/listeners/socks=\"127.0.0.1:9050\"\r\n250 OK\r\n"
103        else:
104            return "510 Unrecognized command\r\n"
105
106
107class TorControlTest(BitcoinTestFramework):
108    def set_test_params(self):
109        self.num_nodes = 1
110
111    def next_port(self):
112        self._port_counter = getattr(self, '_port_counter', 0) + 1
113        return p2p_port(self.num_nodes + self._port_counter)
114
115    def restart_with_mock(self, mock_tor):
116        mock_tor.start()
117        self.restart_node(0, extra_args=[
118            f"-torcontrol=127.0.0.1:{mock_tor.port}",
119            "-listenonion=1",
120            "-debug=tor",
121        ])
122
123        # Wait for connection and PROTOCOLINFO command
124        mock_tor.conn_ready.wait(timeout=10)
125        self.wait_until(lambda: len(mock_tor.received_commands) >= 1, timeout=10)
126        assert_equal(mock_tor.received_commands[0], "PROTOCOLINFO 1")
127
128    @contextmanager
129    def expect_disconnect(self, expect, mock_tor):
130        initial_len = len(mock_tor.received_commands)
131        yield
132
133        if expect:
134            # No reconnect before the initial reconnect timeout of 1s has passed
135            ensure_for(duration=0.5, f=lambda: len(mock_tor.received_commands) == initial_len)
136            # Expect to receive a PROTOCOLINFO 1 on reconnect, bumping the received
137            # commands length.
138            self.wait_until(lambda: len(mock_tor.received_commands) == initial_len + 1)
139            assert_equal(mock_tor.received_commands[initial_len], "PROTOCOLINFO 1")
140        else:
141            # No disconnect, so no reconnect message
142            ensure_for(duration=2, f=lambda: len(mock_tor.received_commands) == initial_len)
143
144    def test_basic(self):
145        self.log.info("Test Tor control basic functionality")
146
147        mock_tor = MockTorControlServer(self.next_port())
148        self.restart_with_mock(mock_tor)
149
150        # Waiting for Tor control commands
151        self.wait_until(lambda: len(mock_tor.received_commands) >= 4, timeout=10)
152
153        # Verify expected protocol sequence
154        assert_equal(mock_tor.received_commands[0], "PROTOCOLINFO 1")
155        assert_equal(mock_tor.received_commands[1], "AUTHENTICATE")
156        assert_equal(mock_tor.received_commands[2], "GETINFO net/listeners/socks")
157        assert mock_tor.received_commands[3].startswith("ADD_ONION ")
158        assert "PoWDefensesEnabled=1" in mock_tor.received_commands[3]
159
160        # Clean up
161        mock_tor.stop()
162
163    def test_partial_data(self):
164        self.log.info("Test that partial Tor control responses are buffered until complete")
165
166        mock_tor = MockTorControlServer(self.next_port(), manual_mode=True)
167        self.restart_with_mock(mock_tor)
168
169        # Send partial response (no \r\n on last line)
170        mock_tor.send_raw(
171            "250-PROTOCOLINFO 1\r\n"
172            "250-AUTH METHODS=NULL\r\n"
173            "250 OK"
174        )
175
176        # Verify AUTHENTICATE is not sent
177        ensure_for(duration=2, f=lambda: len(mock_tor.received_commands) == 1)
178
179        # Complete the response
180        mock_tor.send_raw("\r\n")
181
182        # Should now process the complete response and send AUTHENTICATE
183        self.wait_until(lambda: len(mock_tor.received_commands) >= 2, timeout=5)
184        assert_equal(mock_tor.received_commands[1], "AUTHENTICATE")
185
186        # Clean up
187        mock_tor.stop()
188
189    def test_pow_fallback(self):
190        self.log.info("Test that ADD_ONION retries without PoW on 512 error")
191
192        class NoPowServer(MockTorControlServer):
193            def _get_response(self, command):
194                if command.startswith("ADD_ONION"):
195                    if "PoWDefensesEnabled=1" in command:
196                        return "512 Unrecognized option\r\n"
197                    else:
198                        return (
199                            "250-ServiceID=testserviceid1234567890123456789012345678901234567890123456\r\n"
200                            "250 OK\r\n"
201                        )
202                return super()._get_response(command)
203
204        mock_tor = NoPowServer(self.next_port())
205        self.restart_with_mock(mock_tor)
206
207        # Expect: PROTOCOLINFO, AUTHENTICATE, GETINFO, ADD_ONION (with PoW), ADD_ONION (without PoW)
208        self.wait_until(lambda: len(mock_tor.received_commands) >= 5, timeout=10)
209
210        # First ADD_ONION should have PoW enabled
211        assert mock_tor.received_commands[3].startswith("ADD_ONION ")
212        assert "PoWDefensesEnabled=1" in mock_tor.received_commands[3]
213
214        # Retry should be ADD_ONION without PoW
215        assert mock_tor.received_commands[4].startswith("ADD_ONION ")
216        assert "PoWDefensesEnabled=1" not in mock_tor.received_commands[4]
217
218        # Clean up
219        mock_tor.stop()
220
221    def test_oversized_line(self):
222        mock_tor = MockTorControlServer(self.next_port(), manual_mode=True)
223        self.restart_with_mock(mock_tor)
224
225        MAX_LINE_LENGTH = 100000
226
227        self.log.info("Test that Tor control does not disconnect with a MAX_LINE_LENGTH line.")
228        with self.expect_disconnect(False, mock_tor):
229            msg = "250-" + ("A" * (MAX_LINE_LENGTH - 5)) + "\r"
230            assert_equal(len(msg), MAX_LINE_LENGTH)
231            # The \n is not counted in line length.
232            mock_tor.send_raw(msg + "\n")
233
234        self.log.info("Test that Tor control disconnects with a MAX_LINE_LENGTH + 1 line")
235        with self.expect_disconnect(True, mock_tor):
236            msg = "250-" + ("A" * (MAX_LINE_LENGTH - 4)) + "\r"
237            assert_equal(len(msg), MAX_LINE_LENGTH + 1)
238            mock_tor.send_raw(msg + "\n")
239
240        mock_tor.stop()
241
242    def test_overmany_lines(self):
243        mock_tor = MockTorControlServer(self.next_port(), manual_mode=True)
244        self.restart_with_mock(mock_tor)
245
246        MAX_LINE_COUNT = 1000
247
248        self.log.info("Test that Tor control does not disconnect on receiving MAX_LINE_COUNT lines.")
249        with self.expect_disconnect(False, mock_tor):
250            for _ in range(MAX_LINE_COUNT - 1):

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.