Inside Bitcoin

1#!/usr/bin/env python3
2# Copyright (c) 2020-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"""
6Test that -discover does not add all interfaces' addresses if we listen on only some of them
7"""
8
9import os
10
11from test_framework.test_framework import BitcoinTestFramework, SkipTest
12from test_framework.test_node import (
13    FailedToStartError,
14)
15from test_framework.util import (
16    assert_equal,
17    assert_not_equal,
18    p2p_port,
19    tor_port,
20)
21
22# We need to bind to routable addresses for this test. Both addresses must be on an
23# interface that is UP and not a loopback interface (IFF_LOOPBACK). To set these
24# routable addresses on the machine, use:
25# Linux:
26# First find your interfaces: ip addr show
27# Then use your actual interface names (replace INTERFACE_NAME with yours):
28# ip addr add 1.1.1.5/32 dev INTERFACE_NAME && ip addr add 1111:1111::5/128 dev INTERFACE_NAME  # to set up
29# ip addr del 1.1.1.5/32 dev INTERFACE_NAME && ip addr del 1111:1111::5/128 dev INTERFACE_NAME  # to remove it
30#
31# FreeBSD and MacOS:
32# ifconfig INTERFACE_NAME 1.1.1.5/32 alias && ifconfig INTERFACE_NAME inet6 1111:1111::5/128 alias  # to set up
33# ifconfig INTERFACE_NAME 1.1.1.5 -alias && ifconfig INTERFACE_NAME inet6 1111:1111::5 -alias       # to remove it, after the test
34ADDR1 = os.getenv("BIND_TEST_ROUTABLE_IPV4", "1.1.1.5")
35ADDR2 = os.getenv("BIND_TEST_ROUTABLE_IPV6", "1111:1111::5")
36
37class BindPortDiscoverTest(BitcoinTestFramework):
38    def set_test_params(self):
39        # Avoid any -bind= on the command line. Force the framework to avoid adding -bind=127.0.0.1.
40        self.bind_to_localhost_only = False
41        # Get dynamic ports for each node from the test framework
42        self.bind_ports = [
43            p2p_port(0),
44            p2p_port(2), # node0 will use their port + 1 for onion listen, which is the same as p2p_port(1), so avoid collision
45            p2p_port(3),
46            p2p_port(4),
47        ]
48        self.extra_args = [
49            ['-discover', f'-port={self.bind_ports[0]}', '-listen=1'], # Without any -bind
50            ['-discover', f'-bind=0.0.0.0:{self.bind_ports[1]}'], # Explicit -bind=0.0.0.0
51            # Explicit -whitebind=0.0.0.0, add onion bind to avoid port conflict
52            ['-discover', f'-whitebind=0.0.0.0:{self.bind_ports[2]}', f'-bind=127.0.0.1:{tor_port(3)}=onion'],
53            ['-discover', f'-bind={ADDR1}:{self.bind_ports[3]}'], # Explicit -bind=routable_addr
54        ]
55        self.num_nodes = len(self.extra_args)
56
57    def setup_network(self):
58        """
59        Override to avoid connecting nodes together. This test intentionally does not connect nodes
60        because each node is bound to a different address or interface, and connections are not needed.
61        """
62        self.setup_nodes()
63
64    def setup_nodes(self):
65        """
66        Override to set has_explicit_bind=True for nodes with explicit bind arguments.
67        """
68        self.add_nodes(self.num_nodes, self.extra_args)
69        # TestNode.start() will add -bind= to extra_args if has_explicit_bind is
70        # False. We do not want any -bind= thus set has_explicit_bind to True.
71        for node in self.nodes:
72            node.has_explicit_bind = True
73
74        try:
75            self.start_nodes()
76        except FailedToStartError as e:
77            self.cleanup_partially_started_nodes()
78            if 'Unable to bind to ' in str(e):
79                raise SkipTest(
80                    "To run this test, set BIND_TEST_ROUTABLE_IPV4 and "
81                    "BIND_TEST_ROUTABLE_IPV6 to addresses assigned to non-loopback "
82                    f"interfaces on this machine (currently {ADDR1} and {ADDR2}).")
83            raise
84
85    def run_test(self):
86        self.log.info(
87                "Test that if -bind= is not passed or -bind=0.0.0.0 is used then all addresses are "
88                "added to localaddresses")
89        for i in [0, 1, 2]:
90            found_addr1 = False
91            found_addr2 = False
92            localaddresses = self.nodes[i].getnetworkinfo()['localaddresses']
93            for local in localaddresses:
94                if local['address'] == ADDR1:
95                    found_addr1 = True
96                    assert_equal(local['port'], self.bind_ports[i])
97                if local['address'] == ADDR2:
98                    found_addr2 = True
99                    assert_equal(local['port'], self.bind_ports[i])
100            if not found_addr1:
101                self.log.error(f"Address {ADDR1} not found in node{i}'s local addresses: {localaddresses}")
102                assert False
103            if not found_addr2:
104                self.log.error(f"Address {ADDR2} not found in node{i}'s local addresses: {localaddresses}")
105                assert False
106
107        self.log.info(
108                "Test that if -bind=routable_addr is passed then only that address is "
109                "added to localaddresses")
110        found_addr1 = False
111        i = 3
112        for local in self.nodes[i].getnetworkinfo()['localaddresses']:
113            if local['address'] == ADDR1:
114                found_addr1 = True
115                assert_equal(local['port'], self.bind_ports[i])
116            assert_not_equal(local['address'], ADDR2)
117        assert found_addr1
118
119if __name__ == '__main__':
120    BindPortDiscoverTest(__file__).main()
121