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,595 bytes · SHA-256 05ea7244ffd37517… · 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 p2p permission message.
6
7Test that permissions are correctly calculated and applied
8"""
9
10from test_framework.messages import (
11    SEQUENCE_FINAL,
12)
13from test_framework.p2p import P2PDataStore
14from test_framework.test_node import ErrorMatch
15from test_framework.test_framework import BitcoinTestFramework
16from test_framework.util import (
17    append_config,
18    assert_equal,
19    p2p_port,
20    tor_port,
21)
22from test_framework.wallet import MiniWallet
23
24
25class P2PPermissionsTests(BitcoinTestFramework):
26    def set_test_params(self):
27        self.num_nodes = 2
28
29    def run_test(self):
30        self.wallet = MiniWallet(self.nodes[0])
31
32        self.check_tx_relay()
33
34        self.checkpermission(
35            # default permissions (no specific permissions)
36            ["-whitelist=127.0.0.1"],
37            # Make sure the default values in the command line documentation match the ones here
38            ["relay", "noban", "mempool", "download"])
39
40        self.checkpermission(
41            # no permission (even with forcerelay)
42            ["[email protected]", "-whitelistforcerelay=1"],
43            [])
44
45        self.checkpermission(
46            # relay permission removed (no specific permissions)
47            ["-whitelist=127.0.0.1", "-whitelistrelay=0"],
48            ["noban", "mempool", "download"])
49
50        self.checkpermission(
51            # forcerelay and relay permission added
52            # Legacy parameter interaction which set whitelistrelay to true
53            # if whitelistforcerelay is true
54            ["-whitelist=127.0.0.1", "-whitelistforcerelay"],
55            ["forcerelay", "relay", "noban", "mempool", "download"])
56
57        # Let's make sure permissions are merged correctly
58        # For this, we need to use whitebind instead of bind
59        # by modifying the configuration file.
60        ip_port = "127.0.0.1:{}".format(p2p_port(1))
61        self.nodes[1].replace_in_config([("bind=127.0.0.1", "whitebind=bloomfilter,forcerelay@" + ip_port)])
62        # Explicitly bind the tor port to prevent collisions with the default tor port
63        append_config(self.nodes[1].datadir_path, [f"bind=127.0.0.1:{tor_port(self.nodes[1].index)}=onion"])
64        self.checkpermission(
65            ["[email protected]"],
66            # Check parameter interaction forcerelay should activate relay
67            ["noban", "bloomfilter", "forcerelay", "relay", "download"])
68        self.nodes[1].replace_in_config([("whitebind=bloomfilter,forcerelay@" + ip_port, "bind=127.0.0.1")])
69        self.nodes[1].replace_in_config([(f"bind=127.0.0.1:{tor_port(self.nodes[1].index)}=onion", "")])
70
71        self.checkpermission(
72            # legacy whitelistrelay should be ignored
73            ["-whitelist=noban,[email protected]", "-whitelistrelay"],
74            ["noban", "mempool", "download"])
75
76        self.checkpermission(
77            # legacy whitelistforcerelay should be ignored
78            ["-whitelist=noban,[email protected]", "-whitelistforcerelay"],
79            ["noban", "mempool", "download"])
80
81        self.checkpermission(
82            # missing mempool permission to be considered legacy whitelisted
83            ["[email protected]"],
84            ["noban", "download"])
85
86        self.checkpermission(
87            # all permission added
88            ["[email protected]"],
89            ["forcerelay", "noban", "mempool", "bloomfilter", "relay", "download", "addr"])
90
91        for flag, permissions in [(["-whitelist=noban,[email protected]"], ["noban", "download"]), (["[email protected]"], [])]:
92            self.restart_node(0, flag)
93            self.connect_nodes(0, 1)
94            peerinfo = self.nodes[0].getpeerinfo()[0]
95            assert_equal(peerinfo['permissions'], permissions)
96
97        self.stop_node(1)
98        self.nodes[1].assert_start_raises_init_error(["-whitelist=in,[email protected]"], "Only direction was set, no permissions", match=ErrorMatch.PARTIAL_REGEX)
99        self.nodes[1].assert_start_raises_init_error(["[email protected]"], "Invalid P2P permission", match=ErrorMatch.PARTIAL_REGEX)
100        self.nodes[1].assert_start_raises_init_error(["[email protected]:230"], "Invalid netmask specified in", match=ErrorMatch.PARTIAL_REGEX)
101        self.nodes[1].assert_start_raises_init_error(["[email protected]/10"], "Cannot resolve -whitebind address", match=ErrorMatch.PARTIAL_REGEX)
102        self.nodes[1].assert_start_raises_init_error(["[email protected]", "-bind=127.0.0.1", "-listen=0"], "Cannot set -bind or -whitebind together with -listen=0", match=ErrorMatch.PARTIAL_REGEX)
103
104    def check_tx_relay(self):
105        self.log.debug("Create a connection from a forcerelay peer that rebroadcasts raw txs")
106        # A test framework p2p connection is needed to send the raw transaction directly. If a full node was used, it could only
107        # rebroadcast via the inv-getdata mechanism. However, even for forcerelay connections, a full node would
108        # currently not request a txid that is already in the mempool.
109        self.restart_node(1, extra_args=["[email protected]"])
110        p2p_rebroadcast_wallet = self.nodes[1].add_p2p_connection(P2PDataStore())
111
112        self.log.debug("Send a tx from the wallet initially")
113        tx = self.wallet.create_self_transfer(sequence=SEQUENCE_FINAL)['tx']
114        txid = tx.txid_hex
115
116        self.log.debug("Wait until tx is in node[1]'s mempool")
117        p2p_rebroadcast_wallet.send_txs_and_test([tx], self.nodes[1])
118
119        self.log.debug("Check that node[1] will send the tx to node[0] even though it is already in the mempool")
120        self.connect_nodes(1, 0)
121        with self.nodes[1].assert_debug_log(["Force relaying tx {} (wtxid={}) from peer=0".format(txid, tx.wtxid_hex)]):
122            p2p_rebroadcast_wallet.send_txs_and_test([tx], self.nodes[1])
123            self.wait_until(lambda: txid in self.nodes[0].getrawmempool())
124
125        self.log.debug("Check that node[1] will not send an invalid tx to node[0]")
126        tx.vout[0].nValue += 1
127        # add dust to cause policy rejection but no disconnection
128        tx.vout.append(tx.vout[0])
129        tx.vout[-1].nValue = 0
130        txid = tx.txid_hex
131        # Send the transaction twice. The first time, it'll be rejected by ATMP because it conflicts
132        # with a mempool transaction. The second time, it'll be in the m_lazy_recent_rejects filter.
133        p2p_rebroadcast_wallet.send_txs_and_test(
134            [tx],
135            self.nodes[1],
136            success=False,
137            reject_reason='{} (wtxid={}) from peer=0 was not accepted: dust'.format(txid, tx.wtxid_hex)
138        )
139
140        p2p_rebroadcast_wallet.send_txs_and_test(
141            [tx],
142            self.nodes[1],
143            success=False,
144            reject_reason='Not relaying non-mempool transaction {} (wtxid={}) from forcerelay peer=0'.format(txid, tx.wtxid_hex)
145        )
146
147    def checkpermission(self, args, expectedPermissions):
148        self.restart_node(1, args)
149        self.connect_nodes(0, 1)
150        peerinfo = self.nodes[1].getpeerinfo()[0]
151        assert_equal(len(expectedPermissions), len(peerinfo['permissions']))
152        for p in expectedPermissions:
153            if p not in peerinfo['permissions']:
154                raise AssertionError("Expected permissions %r is not granted." % p)
155
156
157if __name__ == '__main__':
158    P2PPermissionsTests(__file__).main()
159

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.