|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# Copyright (c) 2024 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 | +""" |
| 6 | +Test P2P behaviour during the handshake phase (VERSION, VERACK messages). |
| 7 | +""" |
| 8 | +import itertools |
| 9 | +import time |
| 10 | + |
| 11 | +from test_framework.test_framework import BitcoinTestFramework |
| 12 | +from test_framework.messages import ( |
| 13 | + NODE_NETWORK, |
| 14 | + NODE_NETWORK_LIMITED, |
| 15 | + NODE_NONE, |
| 16 | + NODE_P2P_V2, |
| 17 | + NODE_WITNESS, |
| 18 | +) |
| 19 | +from test_framework.p2p import P2PInterface |
| 20 | + |
| 21 | + |
| 22 | +# Desirable service flags for outbound non-pruned and pruned peers. Note that |
| 23 | +# the desirable service flags for pruned peers are dynamic and only apply if |
| 24 | +# 1. the peer's service flag NODE_NETWORK_LIMITED is set *and* |
| 25 | +# 2. the local chain is close to the tip (<24h) |
| 26 | +DESIRABLE_SERVICE_FLAGS_FULL = NODE_NETWORK | NODE_WITNESS |
| 27 | +DESIRABLE_SERVICE_FLAGS_PRUNED = NODE_NETWORK_LIMITED | NODE_WITNESS |
| 28 | + |
| 29 | + |
| 30 | +class P2PHandshakeTest(BitcoinTestFramework): |
| 31 | + def set_test_params(self): |
| 32 | + self.num_nodes = 1 |
| 33 | + |
| 34 | + def add_outbound_connection(self, node, connection_type, services, wait_for_disconnect): |
| 35 | + peer = node.add_outbound_p2p_connection( |
| 36 | + P2PInterface(), p2p_idx=0, wait_for_disconnect=wait_for_disconnect, |
| 37 | + connection_type=connection_type, services=services, |
| 38 | + supports_v2_p2p=self.options.v2transport, advertise_v2_p2p=self.options.v2transport) |
| 39 | + if not wait_for_disconnect: |
| 40 | + # check that connection is alive past the version handshake and disconnect manually |
| 41 | + peer.sync_with_ping() |
| 42 | + peer.peer_disconnect() |
| 43 | + peer.wait_for_disconnect() |
| 44 | + |
| 45 | + def test_desirable_service_flags(self, node, service_flag_tests, desirable_service_flags, expect_disconnect): |
| 46 | + """Check that connecting to a peer either fails or succeeds depending on its offered |
| 47 | + service flags in the VERSION message. The test is exercised for all relevant |
| 48 | + outbound connection types where the desirable service flags check is done.""" |
| 49 | + CONNECTION_TYPES = ["outbound-full-relay", "block-relay-only", "addr-fetch"] |
| 50 | + for conn_type, services in itertools.product(CONNECTION_TYPES, service_flag_tests): |
| 51 | + if self.options.v2transport: |
| 52 | + services |= NODE_P2P_V2 |
| 53 | + expected_result = "disconnect" if expect_disconnect else "connect" |
| 54 | + self.log.info(f' - services 0x{services:08x}, type "{conn_type}" [{expected_result}]') |
| 55 | + if expect_disconnect: |
| 56 | + assert (services & desirable_service_flags) != desirable_service_flags |
| 57 | + expected_debug_log = f'does not offer the expected services ' \ |
| 58 | + f'({services:08x} offered, {desirable_service_flags:08x} expected)' |
| 59 | + with node.assert_debug_log([expected_debug_log]): |
| 60 | + self.add_outbound_connection(node, conn_type, services, wait_for_disconnect=True) |
| 61 | + else: |
| 62 | + assert (services & desirable_service_flags) == desirable_service_flags |
| 63 | + self.add_outbound_connection(node, conn_type, services, wait_for_disconnect=False) |
| 64 | + |
| 65 | + def run_test(self): |
| 66 | + node = self.nodes[0] |
| 67 | + self.log.info("Check that lacking desired service flags leads to disconnect (non-pruned peers)") |
| 68 | + self.test_desirable_service_flags(node, [NODE_NONE, NODE_NETWORK, NODE_WITNESS], |
| 69 | + DESIRABLE_SERVICE_FLAGS_FULL, expect_disconnect=True) |
| 70 | + self.test_desirable_service_flags(node, [NODE_NETWORK | NODE_WITNESS], |
| 71 | + DESIRABLE_SERVICE_FLAGS_FULL, expect_disconnect=False) |
| 72 | + |
| 73 | + self.log.info("Check that limited peers are only desired if the local chain is close to the tip (<24h)") |
| 74 | + node.setmocktime(int(time.time()) + 25 * 3600) # tip outside the 24h window, should fail |
| 75 | + self.test_desirable_service_flags(node, [NODE_NETWORK_LIMITED | NODE_WITNESS], |
| 76 | + DESIRABLE_SERVICE_FLAGS_FULL, expect_disconnect=True) |
| 77 | + node.setmocktime(int(time.time()) + 23 * 3600) # tip inside the 24h window, should succeed |
| 78 | + self.test_desirable_service_flags(node, [NODE_NETWORK_LIMITED | NODE_WITNESS], |
| 79 | + DESIRABLE_SERVICE_FLAGS_PRUNED, expect_disconnect=False) |
| 80 | + |
| 81 | + self.log.info("Check that feeler connections get disconnected immediately") |
| 82 | + with node.assert_debug_log([f"feeler connection completed"]): |
| 83 | + self.add_outbound_connection(node, "feeler", NODE_NONE, wait_for_disconnect=True) |
| 84 | + |
| 85 | + |
| 86 | +if __name__ == '__main__': |
| 87 | + P2PHandshakeTest().main() |
0 commit comments