p2p_v2_transport.py
1 #!/usr/bin/env python3 2 # Copyright (c) 2021-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 """ 6 Test v2 transport 7 """ 8 import socket 9 10 from test_framework.messages import MAGIC_BYTES, NODE_P2P_V2 11 from test_framework.test_framework import BitcoinTestFramework 12 from test_framework.util import ( 13 assert_not_equal, 14 assert_equal, 15 p2p_port, 16 assert_raises_rpc_error 17 ) 18 19 20 class V2TransportTest(BitcoinTestFramework): 21 def set_test_params(self): 22 self.setup_clean_chain = True 23 self.num_nodes = 5 24 self.extra_args = [["-v2transport=1"], ["-v2transport=1"], ["-v2transport=0"], ["-v2transport=0"], ["-v2transport=0"]] 25 26 def run_test(self): 27 sending_handshake = "start sending v2 handshake to peer" 28 downgrading_to_v1 = "retrying with v1 transport protocol for peer" 29 self.disconnect_nodes(0, 1) 30 self.disconnect_nodes(1, 2) 31 self.disconnect_nodes(2, 3) 32 self.disconnect_nodes(3, 4) 33 34 # verify local services 35 network_info = self.nodes[2].getnetworkinfo() 36 assert_equal(int(network_info["localservices"], 16) & NODE_P2P_V2, 0) 37 assert "P2P_V2" not in network_info["localservicesnames"] 38 network_info = self.nodes[1].getnetworkinfo() 39 assert_equal(int(network_info["localservices"], 16) & NODE_P2P_V2, NODE_P2P_V2) 40 assert "P2P_V2" in network_info["localservicesnames"] 41 42 # V2 nodes can sync with V2 nodes 43 assert_equal(self.nodes[0].getblockcount(), 0) 44 assert_equal(self.nodes[1].getblockcount(), 0) 45 with self.nodes[0].assert_debug_log(expected_msgs=[sending_handshake], 46 unexpected_msgs=[downgrading_to_v1]): 47 self.connect_nodes(0, 1, peer_advertises_v2=True) 48 self.generate(self.nodes[0], 5, sync_fun=lambda: self.sync_all(self.nodes[0:2])) 49 assert_equal(self.nodes[1].getblockcount(), 5) 50 # verify there is a v2 connection between node 0 and 1 51 node_0_info = self.nodes[0].getpeerinfo() 52 node_1_info = self.nodes[1].getpeerinfo() 53 assert_equal(len(node_0_info), 1) 54 assert_equal(len(node_1_info), 1) 55 assert_equal(node_0_info[0]["transport_protocol_type"], "v2") 56 assert_equal(node_1_info[0]["transport_protocol_type"], "v2") 57 assert_equal(len(node_0_info[0]["session_id"]), 64) 58 assert_equal(len(node_1_info[0]["session_id"]), 64) 59 assert_equal(node_0_info[0]["session_id"], node_1_info[0]["session_id"]) 60 61 # V1 nodes can sync with each other 62 assert_equal(self.nodes[2].getblockcount(), 0) 63 assert_equal(self.nodes[3].getblockcount(), 0) 64 65 # addnode rpc error when v2transport requested but not enabled 66 ip_port = "127.0.0.1:{}".format(p2p_port(3)) 67 assert_raises_rpc_error(-8, "Error: v2transport requested but not enabled (see -v2transport)", self.nodes[2].addnode, node=ip_port, command='add', v2transport=True) 68 69 with self.nodes[2].assert_debug_log(expected_msgs=[], 70 unexpected_msgs=[sending_handshake, downgrading_to_v1]): 71 self.connect_nodes(2, 3, peer_advertises_v2=False) 72 self.generate(self.nodes[2], 8, sync_fun=lambda: self.sync_all(self.nodes[2:4])) 73 assert_equal(self.nodes[3].getblockcount(), 8) 74 assert_not_equal(self.nodes[0].getbestblockhash(), self.nodes[2].getbestblockhash()) 75 # verify there is a v1 connection between node 2 and 3 76 node_2_info = self.nodes[2].getpeerinfo() 77 node_3_info = self.nodes[3].getpeerinfo() 78 assert_equal(len(node_2_info), 1) 79 assert_equal(len(node_3_info), 1) 80 assert_equal(node_2_info[0]["transport_protocol_type"], "v1") 81 assert_equal(node_3_info[0]["transport_protocol_type"], "v1") 82 assert_equal(len(node_2_info[0]["session_id"]), 0) 83 assert_equal(len(node_3_info[0]["session_id"]), 0) 84 85 # V1 nodes can sync with V2 nodes 86 self.disconnect_nodes(0, 1) 87 self.disconnect_nodes(2, 3) 88 with self.nodes[2].assert_debug_log(expected_msgs=[], 89 unexpected_msgs=[sending_handshake, downgrading_to_v1]): 90 self.connect_nodes(2, 1, peer_advertises_v2=False) # cannot enable v2 on v1 node 91 self.sync_all(self.nodes[1:3]) 92 assert_equal(self.nodes[1].getblockcount(), 8) 93 assert_not_equal(self.nodes[0].getbestblockhash(), self.nodes[1].getbestblockhash()) 94 # verify there is a v1 connection between node 1 and 2 95 node_1_info = self.nodes[1].getpeerinfo() 96 node_2_info = self.nodes[2].getpeerinfo() 97 assert_equal(len(node_1_info), 1) 98 assert_equal(len(node_2_info), 1) 99 assert_equal(node_1_info[0]["transport_protocol_type"], "v1") 100 assert_equal(node_2_info[0]["transport_protocol_type"], "v1") 101 assert_equal(len(node_1_info[0]["session_id"]), 0) 102 assert_equal(len(node_2_info[0]["session_id"]), 0) 103 104 # V2 nodes can sync with V1 nodes 105 self.disconnect_nodes(1, 2) 106 with self.nodes[0].assert_debug_log(expected_msgs=[], 107 unexpected_msgs=[sending_handshake, downgrading_to_v1]): 108 self.connect_nodes(0, 3, peer_advertises_v2=False) 109 self.sync_all([self.nodes[0], self.nodes[3]]) 110 assert_equal(self.nodes[0].getblockcount(), 8) 111 # verify there is a v1 connection between node 0 and 3 112 node_0_info = self.nodes[0].getpeerinfo() 113 node_3_info = self.nodes[3].getpeerinfo() 114 assert_equal(len(node_0_info), 1) 115 assert_equal(len(node_3_info), 1) 116 assert_equal(node_0_info[0]["transport_protocol_type"], "v1") 117 assert_equal(node_3_info[0]["transport_protocol_type"], "v1") 118 assert_equal(len(node_0_info[0]["session_id"]), 0) 119 assert_equal(len(node_3_info[0]["session_id"]), 0) 120 121 # V2 node mines another block and everyone gets it 122 self.connect_nodes(0, 1, peer_advertises_v2=True) 123 self.connect_nodes(1, 2, peer_advertises_v2=False) 124 self.generate(self.nodes[1], 1, sync_fun=lambda: self.sync_all(self.nodes[0:4])) 125 assert_equal(self.nodes[0].getblockcount(), 9) # sync_all() verifies tip hashes match 126 127 # V1 node mines another block and everyone gets it 128 self.generate(self.nodes[3], 2, sync_fun=lambda: self.sync_all(self.nodes[0:4])) 129 assert_equal(self.nodes[2].getblockcount(), 11) # sync_all() verifies tip hashes match 130 131 assert_equal(self.nodes[4].getblockcount(), 0) 132 # Peer 4 is v1 p2p, but is falsely advertised as v2. 133 with self.nodes[1].assert_debug_log(expected_msgs=[sending_handshake, downgrading_to_v1]): 134 self.connect_nodes(1, 4, peer_advertises_v2=True) 135 self.sync_all() 136 assert_equal(self.nodes[4].getblockcount(), 11) 137 138 # Check v1 prefix detection 139 V1_PREFIX = MAGIC_BYTES["regtest"] + b"version\x00\x00\x00\x00\x00" 140 assert_equal(len(V1_PREFIX), 16) 141 with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: 142 with self.nodes[0].wait_for_new_peer(): 143 s.connect(("127.0.0.1", p2p_port(0))) 144 s.sendall(V1_PREFIX[:-1]) 145 assert_equal(self.nodes[0].getpeerinfo()[-1]["transport_protocol_type"], "detecting") 146 s.sendall(bytes([V1_PREFIX[-1]])) # send out last prefix byte 147 self.wait_until(lambda: self.nodes[0].getpeerinfo()[-1]["transport_protocol_type"] == "v1") 148 149 # Check wrong network prefix detection (hits if the next 12 bytes correspond to a v1 version message) 150 wrong_network_magic_prefix = MAGIC_BYTES["signet"] + V1_PREFIX[4:] 151 with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: 152 with self.nodes[0].wait_for_new_peer(): 153 s.connect(("127.0.0.1", p2p_port(0))) 154 with self.nodes[0].assert_debug_log(["V2 transport error: V1 peer with wrong MessageStart"], timeout=2): 155 s.sendall(wrong_network_magic_prefix + b"somepayload") 156 157 # Check detection of missing garbage terminator (hits after fixed amount of data if terminator never matches garbage) 158 MAX_KEY_GARB_AND_GARBTERM_LEN = 64 + 4095 + 16 159 with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: 160 with self.nodes[0].wait_for_new_peer(): 161 s.connect(("127.0.0.1", p2p_port(0))) 162 s.sendall(b'\x00' * (MAX_KEY_GARB_AND_GARBTERM_LEN - 1)) 163 self.wait_until(lambda: self.nodes[0].getpeerinfo()[-1]["bytesrecv"] == MAX_KEY_GARB_AND_GARBTERM_LEN - 1) 164 with self.nodes[0].assert_debug_log(["V2 transport error: missing garbage terminator"]): 165 peer_id = self.nodes[0].getpeerinfo()[-1]["id"] 166 s.sendall(b'\x00') # send out last byte 167 # should disconnect immediately 168 self.wait_until(lambda: peer_id not in [p["id"] for p in self.nodes[0].getpeerinfo()]) 169 170 171 if __name__ == '__main__': 172 V2TransportTest(__file__).main()