test/functional/p2p-leaktests.py

   1 #!/usr/bin/env python3
   2 # Copyright (c) 2017 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 message sending before handshake completion.
   6
   7 A node should never send anything other than VERSION/VERACK/REJECT until it's
   8 received a VERACK.
   9
  10 This test connects to a node and sends it a few messages, trying to intice it
  11 into sending us something it shouldn't.
  12
  13 Also test that nodes that send unsupported service bits to bitcoind are disconnected
  14 and don't receive a VERACK. Unsupported service bits are currently 1 << 5 and
  15 1 << 7 (until August 1st 2018)."""
  16
  17 from test_framework.mininode import *
  18 from test_framework.test_framework import BitcoinTestFramework
  19 from test_framework.util import *
  20
  21 banscore = 10
  22
  23 class CLazyNode(NodeConnCB):
  24     def __init__(self):
  25         super().__init__()
  26         self.unexpected_msg = False
  27         self.ever_connected = False
  28
  29     def bad_message(self, message):
  30         self.unexpected_msg = True
  31         self.log.info("should not have received message: %s" % message.command)
  32
  33     def on_open(self, conn):
  34         self.connected = True
  35         self.ever_connected = True
  36
  37     def on_version(self, conn, message): self.bad_message(message)
  38     def on_verack(self, conn, message): self.bad_message(message)
  39     def on_reject(self, conn, message): self.bad_message(message)
  40     def on_inv(self, conn, message): self.bad_message(message)
  41     def on_addr(self, conn, message): self.bad_message(message)
  42     def on_alert(self, conn, message): self.bad_message(message)
  43     def on_getdata(self, conn, message): self.bad_message(message)
  44     def on_getblocks(self, conn, message): self.bad_message(message)
  45     def on_tx(self, conn, message): self.bad_message(message)
  46     def on_block(self, conn, message): self.bad_message(message)
  47     def on_getaddr(self, conn, message): self.bad_message(message)
  48     def on_headers(self, conn, message): self.bad_message(message)
  49     def on_getheaders(self, conn, message): self.bad_message(message)
  50     def on_ping(self, conn, message): self.bad_message(message)
  51     def on_mempool(self, conn): self.bad_message(message)
  52     def on_pong(self, conn, message): self.bad_message(message)
  53     def on_feefilter(self, conn, message): self.bad_message(message)
  54     def on_sendheaders(self, conn, message): self.bad_message(message)
  55     def on_sendcmpct(self, conn, message): self.bad_message(message)
  56     def on_cmpctblock(self, conn, message): self.bad_message(message)
  57     def on_getblocktxn(self, conn, message): self.bad_message(message)
  58     def on_blocktxn(self, conn, message): self.bad_message(message)
  59
  60 # Node that never sends a version. We'll use this to send a bunch of messages
  61 # anyway, and eventually get disconnected.
  62 class CNodeNoVersionBan(CLazyNode):
  63     # send a bunch of veracks without sending a message. This should get us disconnected.
  64     # NOTE: implementation-specific check here. Remove if bitcoind ban behavior changes
  65     def on_open(self, conn):
  66         super().on_open(conn)
  67         for i in range(banscore):
  68             self.send_message(msg_verack())
  69
  70     def on_reject(self, conn, message): pass
  71
  72 # Node that never sends a version. This one just sits idle and hopes to receive
  73 # any message (it shouldn't!)
  74 class CNodeNoVersionIdle(CLazyNode):
  75     def __init__(self):
  76         super().__init__()
  77
  78 # Node that sends a version but not a verack.
  79 class CNodeNoVerackIdle(CLazyNode):
  80     def __init__(self):
  81         self.version_received = False
  82         super().__init__()
  83
  84     def on_reject(self, conn, message): pass
  85     def on_verack(self, conn, message): pass
  86     # When version is received, don't reply with a verack. Instead, see if the
  87     # node will give us a message that it shouldn't. This is not an exhaustive
  88     # list!
  89     def on_version(self, conn, message):
  90         self.version_received = True
  91         conn.send_message(msg_ping())
  92         conn.send_message(msg_getaddr())
  93
  94 class P2PLeakTest(BitcoinTestFramework):
  95     def set_test_params(self):
  96         self.num_nodes = 1
  97         self.extra_args = [['-banscore='+str(banscore)]]
  98
  99     def run_test(self):
 100         self.nodes[0].setmocktime(1501545600)  # August 1st 2017
 101
 102         no_version_bannode = self.nodes[0].add_p2p_connection(CNodeNoVersionBan(), send_version=False)
 103         no_version_idlenode = self.nodes[0].add_p2p_connection(CNodeNoVersionIdle(), send_version=False)
 104         no_verack_idlenode = self.nodes[0].add_p2p_connection(CNodeNoVerackIdle())
 105         unsupported_service_bit5_node = self.nodes[0].add_p2p_connection(CLazyNode(), services=NODE_NETWORK|NODE_UNSUPPORTED_SERVICE_BIT_5)
 106         unsupported_service_bit7_node = self.nodes[0].add_p2p_connection(CLazyNode(), services=NODE_NETWORK|NODE_UNSUPPORTED_SERVICE_BIT_7)
 107
 108         NetworkThread().start()  # Start up network handling in another thread
 109
 110         wait_until(lambda: no_version_bannode.ever_connected, timeout=10, lock=mininode_lock)
 111         wait_until(lambda: no_version_idlenode.ever_connected, timeout=10, lock=mininode_lock)
 112         wait_until(lambda: no_verack_idlenode.version_received, timeout=10, lock=mininode_lock)
 113         wait_until(lambda: unsupported_service_bit5_node.ever_connected, timeout=10, lock=mininode_lock)
 114         wait_until(lambda: unsupported_service_bit7_node.ever_connected, timeout=10, lock=mininode_lock)
 115
 116         # Mine a block and make sure that it's not sent to the connected nodes
 117         self.nodes[0].generate(1)
 118
 119         #Give the node enough time to possibly leak out a message
 120         time.sleep(5)
 121
 122         #This node should have been banned
 123         assert not no_version_bannode.connected
 124
 125         # These nodes should have been disconnected
 126         assert not unsupported_service_bit5_node.connected
 127         assert not unsupported_service_bit7_node.connected
 128
 129         self.nodes[0].disconnect_p2ps()
 130
 131         # Wait until all connections are closed
 132         wait_until(lambda: len(self.nodes[0].getpeerinfo()) == 0)
 133
 134         # Make sure no unexpected messages came in
 135         assert(no_version_bannode.unexpected_msg == False)
 136         assert(no_version_idlenode.unexpected_msg == False)
 137         assert(no_verack_idlenode.unexpected_msg == False)
 138         assert not unsupported_service_bit5_node.unexpected_msg
 139         assert not unsupported_service_bit7_node.unexpected_msg
 140
 141         self.log.info("Service bits 5 and 7 are allowed after August 1st 2018")
 142         self.nodes[0].setmocktime(1533168000)  # August 2nd 2018
 143
 144         allowed_service_bit5_node = self.nodes[0].add_p2p_connection(NodeConnCB(), services=NODE_NETWORK|NODE_UNSUPPORTED_SERVICE_BIT_5)
 145         allowed_service_bit7_node = self.nodes[0].add_p2p_connection(NodeConnCB(), services=NODE_NETWORK|NODE_UNSUPPORTED_SERVICE_BIT_7)
 146
 147         NetworkThread().start()  # Network thread stopped when all previous NodeConnCBs disconnected. Restart it
 148
 149         wait_until(lambda: allowed_service_bit5_node.message_count["verack"], lock=mininode_lock)
 150         wait_until(lambda: allowed_service_bit7_node.message_count["verack"], lock=mininode_lock)
 151
 152 if __name__ == '__main__':
 153     P2PLeakTest().main()