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.

9,166 bytes · SHA-256 b07a8cfaceb12bdb… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2015-present 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 multiple RPC users."""
6
7from test_framework.test_framework import BitcoinTestFramework
8from test_framework.util import (
9    assert_equal,
10    str_to_b64str,
11)
12
13import http.client
14import os
15import platform
16import urllib.parse
17import subprocess
18from random import SystemRandom
19import string
20import sys
21from typing import Optional
22
23
24def call_with_auth(node, user, password, method="getbestblockhash"):
25    url = urllib.parse.urlparse(node.url)
26    headers = {"Authorization": "Basic " + str_to_b64str('{}:{}'.format(user, password))}
27
28    conn = http.client.HTTPConnection(url.hostname, url.port)
29    conn.connect()
30    conn.request('POST', '/', f'{{"method": "{method}"}}', headers)
31    resp = conn.getresponse()
32    conn.close()
33    return resp
34
35
36class HTTPBasicsTest(BitcoinTestFramework):
37    def set_test_params(self):
38        self.num_nodes = 2
39
40    def conf_setup(self):
41        #Append rpcauth to bitcoin.conf before initialization
42        self.rtpassword = "cA773lm788buwYe4g4WT+05pKyNruVKjQ25x3n0DQcM="
43        rpcauth = "rpcauth=rt:93648e835a54c573682c2eb19f882535$7681e9c5b74bdd85e78166031d2058e1069b3ed7ed967c93fc63abba06f31144"
44
45        self.rpcuser = "rpcuser💻"
46        self.rpcpassword = "rpcpassword🔑"
47
48        gen_rpcauth = self.config["environment"]["RPCAUTH"]
49
50        # Generate RPCAUTH with specified password
51        self.rt2password = "8/F3uMDw4KSEbw96U3CA1C4X05dkHDN2BPFjTgZW4KI="
52        p = subprocess.Popen([sys.executable, gen_rpcauth, 'rt2', self.rt2password], stdout=subprocess.PIPE, text=True)
53        lines = p.stdout.read().splitlines()
54        rpcauth2 = lines[1]
55
56        # Generate RPCAUTH without specifying password
57        self.user = ''.join(SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(10))
58        p = subprocess.Popen([sys.executable, gen_rpcauth, self.user], stdout=subprocess.PIPE, text=True)
59        lines = p.stdout.read().splitlines()
60        rpcauth3 = lines[1]
61        self.password = lines[3]
62
63        self.stop_nodes()
64        with open(self.nodes[0].datadir_path / "bitcoin.conf", "a") as f:
65            f.write(rpcauth + "\n")
66            f.write(rpcauth2 + "\n")
67            f.write(rpcauth3 + "\n")
68        with open(self.nodes[1].datadir_path / "bitcoin.conf", "a") as f:
69            f.write("rpcuser={}\n".format(self.rpcuser))
70            f.write("rpcpassword={}\n".format(self.rpcpassword))
71        self.start_nodes()
72
73    def test_auth(self, node, user, password):
74        self.log.info('Correct...')
75        assert_equal(200, call_with_auth(node, user, password).status)
76
77        self.log.info('Wrong...')
78        assert_equal(401, call_with_auth(node, user, password + 'wrong').status)
79
80        self.log.info('Wrong...')
81        assert_equal(401, call_with_auth(node, user + 'wrong', password).status)
82
83        self.log.info('Wrong...')
84        assert_equal(401, call_with_auth(node, user + 'wrong', password + 'wrong').status)
85
86    def test_rpccookieperms(self):
87        p = {"owner": 0o600, "group": 0o640, "all": 0o644}
88
89        if platform.system() == 'Windows':
90            self.log.info(f"Skip cookie file permissions checks as OS detected as: {platform.system()=}")
91            return
92
93        self.log.info('Check cookie file permissions can be set using -rpccookieperms')
94
95        cookie_file_path = self.nodes[1].chain_path / '.cookie'
96        PERM_BITS_UMASK = 0o777
97
98        def test_perm(perm: Optional[str]):
99            if not perm:
100                perm = 'owner'
101                self.restart_node(1)
102            else:
103                self.restart_node(1, extra_args=[f"-rpccookieperms={perm}"])
104
105            file_stat = os.stat(cookie_file_path)
106            actual_perms = file_stat.st_mode & PERM_BITS_UMASK
107            expected_perms = p[perm]
108            assert_equal(expected_perms, actual_perms)
109
110        # Remove any leftover rpc{user|password} config options from previous tests
111        self.stop_node(1)
112        self.nodes[1].replace_in_config([("rpcuser", "#rpcuser"), ("rpcpassword", "#rpcpassword")])
113
114        self.log.info('Check default cookie permission')
115        test_perm(None)
116
117        self.log.info('Check custom cookie permissions')
118        for perm in ["owner", "group", "all"]:
119            test_perm(perm)
120
121    def test_norpccookiefile(self, node0_cookie_path):
122        assert self.nodes[0].is_node_stopped(), "We expect previous test to stopped the node"
123        assert not node0_cookie_path.exists()
124
125        self.log.info('Starting with -norpccookiefile')
126        # Start, but don't wait for RPC connection as TestNode.wait_for_rpc_connection() requires the cookie.
127        with self.nodes[0].busy_wait_for_debug_log([b'init message: Done loading']):
128            self.nodes[0].start(extra_args=["-norpccookiefile"])
129        assert not node0_cookie_path.exists()
130
131        self.log.info('Testing user/password authentication still works without cookie file')
132        assert_equal(200, call_with_auth(self.nodes[0], "rt", self.rtpassword).status)
133        # After confirming that we could log in, check that cookie file does not exist.
134        assert not node0_cookie_path.exists()
135
136        # Need to shut down in slightly unorthodox way since cookie auth can't be used
137        assert_equal(200, call_with_auth(self.nodes[0], "rt", self.rtpassword, method="stop").status)
138        self.nodes[0].wait_until_stopped()
139
140    def run_test(self):
141        self.conf_setup()
142        self.log.info('Check correctness of the rpcauth config option')
143        url = urllib.parse.urlparse(self.nodes[0].url)
144
145        self.test_auth(self.nodes[0], url.username, url.password)
146        self.test_auth(self.nodes[0], 'rt', self.rtpassword)
147        self.test_auth(self.nodes[0], 'rt2', self.rt2password)
148        self.test_auth(self.nodes[0], self.user, self.password)
149
150        self.log.info('Check correctness of the rpcuser/rpcpassword config options')
151        url = urllib.parse.urlparse(self.nodes[1].url)
152
153        self.test_auth(self.nodes[1], self.rpcuser, self.rpcpassword)
154
155        init_error = 'Error: Unable to start HTTP server. See debug log for details.'
156
157        self.log.info('Check -rpcauth are validated')
158        self.log.info('Empty -rpcauth are treated as error')
159        self.stop_node(0)
160        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth'])
161        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth='])
162        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=""'])
163        self.log.info('Check malformed -rpcauth')
164        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=foo'])
165        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=foo:bar'])
166        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=foo:bar:baz'])
167        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=foo$bar:baz'])
168        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=foo$bar$baz'])
169
170        self.log.info('Check interactions between blank and non-blank rpcauth')
171        # pw = bitcoin
172        rpcauth_user1 = '-rpcauth=user1:6dd184e5e69271fdd69103464630014f$eb3d7ce67c4d1ff3564270519b03b636c0291012692a5fa3dd1d2075daedd07b'
173        rpcauth_user2 = '-rpcauth=user2:57b2f77c919eece63cfa46c2f06e46ae$266b63902f99f97eeaab882d4a87f8667ab84435c3799f2ce042ef5a994d620b'
174        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=[rpcauth_user1, rpcauth_user2, '-rpcauth='])
175        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=[rpcauth_user1, '-rpcauth=', rpcauth_user2])
176        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error, extra_args=['-rpcauth=', rpcauth_user1, rpcauth_user2])
177
178        self.log.info('Check -norpcauth disables previous -rpcauth params')
179        self.restart_node(0, extra_args=[rpcauth_user1, rpcauth_user2, '-norpcauth'])
180        assert_equal(401, call_with_auth(self.nodes[0], 'user1', 'bitcoin').status)
181        assert_equal(401, call_with_auth(self.nodes[0], 'rt', self.rtpassword).status)
182        self.stop_node(0)
183
184        self.log.info('Check that failure to write cookie file will abort the node gracefully')
185        cookie_path =     self.nodes[0].chain_path / ".cookie"
186        cookie_path_tmp = self.nodes[0].chain_path / ".cookie.tmp"
187        cookie_path_tmp.mkdir()
188        self.nodes[0].assert_start_raises_init_error(expected_msg=init_error)
189        cookie_path_tmp.rmdir()
190        assert not cookie_path.exists()
191        self.restart_node(0)
192        assert cookie_path.exists()
193        self.stop_node(0)
194
195        self.test_rpccookieperms()
196
197        self.test_norpccookiefile(cookie_path)
198
199if __name__ == '__main__':
200    HTTPBasicsTest(__file__).main()
201

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.