Branch data Line data Source code
# 1 : : // Copyright (c) 2009-2020 The Bitcoin Core developers
# 2 : : // Distributed under the MIT software license, see the accompanying
# 3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
# 4 : :
# 5 : : #ifndef BITCOIN_NETADDRESS_H
# 6 : : #define BITCOIN_NETADDRESS_H
# 7 : :
# 8 : : #if defined(HAVE_CONFIG_H)
# 9 : : #include <config/bitcoin-config.h>
# 10 : : #endif
# 11 : :
# 12 : : #include <compat.h>
# 13 : : #include <serialize.h>
# 14 : :
# 15 : : #include <cstdint>
# 16 : : #include <string>
# 17 : : #include <vector>
# 18 : :
# 19 : : /**
# 20 : : * A network type.
# 21 : : * @note An address may belong to more than one network, for example `10.0.0.1`
# 22 : : * belongs to both `NET_UNROUTABLE` and `NET_IPV4`.
# 23 : : * Keep these sequential starting from 0 and `NET_MAX` as the last entry.
# 24 : : * We have loops like `for (int i = 0; i < NET_MAX; i++)` that expect to iterate
# 25 : : * over all enum values and also `GetExtNetwork()` "extends" this enum by
# 26 : : * introducing standalone constants starting from `NET_MAX`.
# 27 : : */
# 28 : : enum Network
# 29 : : {
# 30 : : /// Addresses from these networks are not publicly routable on the global Internet.
# 31 : : NET_UNROUTABLE = 0,
# 32 : :
# 33 : : /// IPv4
# 34 : : NET_IPV4,
# 35 : :
# 36 : : /// IPv6
# 37 : : NET_IPV6,
# 38 : :
# 39 : : /// TORv2
# 40 : : NET_ONION,
# 41 : :
# 42 : : /// A set of dummy addresses that map a name to an IPv6 address. These
# 43 : : /// addresses belong to RFC4193's fc00::/7 subnet (unique-local addresses).
# 44 : : /// We use them to map a string or FQDN to an IPv6 address in CAddrMan to
# 45 : : /// keep track of which DNS seeds were used.
# 46 : : NET_INTERNAL,
# 47 : :
# 48 : : /// Dummy value to indicate the number of NET_* constants.
# 49 : : NET_MAX,
# 50 : : };
# 51 : :
# 52 : : /**
# 53 : : * Network address.
# 54 : : */
# 55 : : class CNetAddr
# 56 : : {
# 57 : : protected:
# 58 : : /**
# 59 : : * Network to which this address belongs.
# 60 : : */
# 61 : : Network m_net;
# 62 : :
# 63 : : unsigned char ip[16]; // in network byte order
# 64 : : uint32_t scopeId{0}; // for scoped/link-local ipv6 addresses
# 65 : :
# 66 : : public:
# 67 : : CNetAddr();
# 68 : : explicit CNetAddr(const struct in_addr& ipv4Addr);
# 69 : : void SetIP(const CNetAddr& ip);
# 70 : :
# 71 : : /**
# 72 : : * Set raw IPv4 or IPv6 address (in network byte order)
# 73 : : * @note Only NET_IPV4 and NET_IPV6 are allowed for network.
# 74 : : */
# 75 : : void SetRaw(Network network, const uint8_t *data);
# 76 : :
# 77 : : bool SetInternal(const std::string& name);
# 78 : :
# 79 : : bool SetSpecial(const std::string &strName); // for Tor addresses
# 80 : : bool IsBindAny() const; // INADDR_ANY equivalent
# 81 : : bool IsIPv4() const; // IPv4 mapped address (::FFFF:0:0/96, 0.0.0.0/0)
# 82 : : bool IsIPv6() const; // IPv6 address (not mapped IPv4, not Tor)
# 83 : : bool IsRFC1918() const; // IPv4 private networks (10.0.0.0/8, 192.168.0.0/16, 172.16.0.0/12)
# 84 : : bool IsRFC2544() const; // IPv4 inter-network communications (198.18.0.0/15)
# 85 : : bool IsRFC6598() const; // IPv4 ISP-level NAT (100.64.0.0/10)
# 86 : : bool IsRFC5737() const; // IPv4 documentation addresses (192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24)
# 87 : : bool IsRFC3849() const; // IPv6 documentation address (2001:0DB8::/32)
# 88 : : bool IsRFC3927() const; // IPv4 autoconfig (169.254.0.0/16)
# 89 : : bool IsRFC3964() const; // IPv6 6to4 tunnelling (2002::/16)
# 90 : : bool IsRFC4193() const; // IPv6 unique local (FC00::/7)
# 91 : : bool IsRFC4380() const; // IPv6 Teredo tunnelling (2001::/32)
# 92 : : bool IsRFC4843() const; // IPv6 ORCHID (deprecated) (2001:10::/28)
# 93 : : bool IsRFC7343() const; // IPv6 ORCHIDv2 (2001:20::/28)
# 94 : : bool IsRFC4862() const; // IPv6 autoconfig (FE80::/64)
# 95 : : bool IsRFC6052() const; // IPv6 well-known prefix for IPv4-embedded address (64:FF9B::/96)
# 96 : : bool IsRFC6145() const; // IPv6 IPv4-translated address (::FFFF:0:0:0/96) (actually defined in RFC2765)
# 97 : : bool IsHeNet() const; // IPv6 Hurricane Electric - https://he.net (2001:0470::/36)
# 98 : : bool IsTor() const;
# 99 : : bool IsLocal() const;
# 100 : : bool IsRoutable() const;
# 101 : : bool IsInternal() const;
# 102 : : bool IsValid() const;
# 103 : : enum Network GetNetwork() const;
# 104 : : std::string ToString() const;
# 105 : : std::string ToStringIP() const;
# 106 : : unsigned int GetByte(int n) const;
# 107 : : uint64_t GetHash() const;
# 108 : : bool GetInAddr(struct in_addr* pipv4Addr) const;
# 109 : : uint32_t GetNetClass() const;
# 110 : :
# 111 : : //! For IPv4, mapped IPv4, SIIT translated IPv4, Teredo, 6to4 tunneled addresses, return the relevant IPv4 address as a uint32.
# 112 : : uint32_t GetLinkedIPv4() const;
# 113 : : //! Whether this address has a linked IPv4 address (see GetLinkedIPv4()).
# 114 : : bool HasLinkedIPv4() const;
# 115 : :
# 116 : : // The AS on the BGP path to the node we use to diversify
# 117 : : // peers in AddrMan bucketing based on the AS infrastructure.
# 118 : : // The ip->AS mapping depends on how asmap is constructed.
# 119 : : uint32_t GetMappedAS(const std::vector<bool> &asmap) const;
# 120 : :
# 121 : : std::vector<unsigned char> GetGroup(const std::vector<bool> &asmap) const;
# 122 : 1256440 : std::vector<unsigned char> GetAddrBytes() const { return {std::begin(ip), std::end(ip)}; }
# 123 : : int GetReachabilityFrom(const CNetAddr *paddrPartner = nullptr) const;
# 124 : :
# 125 : : explicit CNetAddr(const struct in6_addr& pipv6Addr, const uint32_t scope = 0);
# 126 : : bool GetIn6Addr(struct in6_addr* pipv6Addr) const;
# 127 : :
# 128 : : friend bool operator==(const CNetAddr& a, const CNetAddr& b);
# 129 : 0 : friend bool operator!=(const CNetAddr& a, const CNetAddr& b) { return !(a == b); }
# 130 : : friend bool operator<(const CNetAddr& a, const CNetAddr& b);
# 131 : :
# 132 : : /**
# 133 : : * Serialize to a stream.
# 134 : : */
# 135 : : template <typename Stream>
# 136 : : void Serialize(Stream& s) const
# 137 : 1839 : {
# 138 : 1839 : s << ip;
# 139 : 1839 : }
# 140 : :
# 141 : : /**
# 142 : : * Unserialize from a stream.
# 143 : : */
# 144 : : template <typename Stream>
# 145 : : void Unserialize(Stream& s)
# 146 : 2694 : {
# 147 : 2694 : unsigned char ip_temp[sizeof(ip)];
# 148 : 2694 : s >> ip_temp;
# 149 : 2694 : // Use SetRaw() so that m_net is set correctly. For example
# 150 : 2694 : // ::FFFF:0102:0304 should be set as m_net=NET_IPV4 (1.2.3.4).
# 151 : 2694 : SetRaw(NET_IPV6, ip_temp);
# 152 : 2694 : }
# 153 : :
# 154 : : friend class CSubNet;
# 155 : : };
# 156 : :
# 157 : : class CSubNet
# 158 : : {
# 159 : : protected:
# 160 : : /// Network (base) address
# 161 : : CNetAddr network;
# 162 : : /// Netmask, in network byte order
# 163 : : uint8_t netmask[16];
# 164 : : /// Is this value valid? (only used to signal parse errors)
# 165 : : bool valid;
# 166 : :
# 167 : : public:
# 168 : : CSubNet();
# 169 : : CSubNet(const CNetAddr &addr, int32_t mask);
# 170 : : CSubNet(const CNetAddr &addr, const CNetAddr &mask);
# 171 : :
# 172 : : //constructor for single ip subnet (<ipv4>/32 or <ipv6>/128)
# 173 : : explicit CSubNet(const CNetAddr &addr);
# 174 : :
# 175 : : bool Match(const CNetAddr &addr) const;
# 176 : :
# 177 : : std::string ToString() const;
# 178 : : bool IsValid() const;
# 179 : :
# 180 : : friend bool operator==(const CSubNet& a, const CSubNet& b);
# 181 : 2 : friend bool operator!=(const CSubNet& a, const CSubNet& b) { return !(a == b); }
# 182 : : friend bool operator<(const CSubNet& a, const CSubNet& b);
# 183 : :
# 184 : 65 : SERIALIZE_METHODS(CSubNet, obj) { READWRITE(obj.network, obj.netmask, obj.valid); }
# 185 : : };
# 186 : :
# 187 : : /** A combination of a network address (CNetAddr) and a (TCP) port */
# 188 : : class CService : public CNetAddr
# 189 : : {
# 190 : : protected:
# 191 : : uint16_t port; // host order
# 192 : :
# 193 : : public:
# 194 : : CService();
# 195 : : CService(const CNetAddr& ip, uint16_t port);
# 196 : : CService(const struct in_addr& ipv4Addr, uint16_t port);
# 197 : : explicit CService(const struct sockaddr_in& addr);
# 198 : : uint16_t GetPort() const;
# 199 : : bool GetSockAddr(struct sockaddr* paddr, socklen_t *addrlen) const;
# 200 : : bool SetSockAddr(const struct sockaddr* paddr);
# 201 : : friend bool operator==(const CService& a, const CService& b);
# 202 : 875 : friend bool operator!=(const CService& a, const CService& b) { return !(a == b); }
# 203 : : friend bool operator<(const CService& a, const CService& b);
# 204 : : std::vector<unsigned char> GetKey() const;
# 205 : : std::string ToString() const;
# 206 : : std::string ToStringPort() const;
# 207 : : std::string ToStringIPPort() const;
# 208 : :
# 209 : : CService(const struct in6_addr& ipv6Addr, uint16_t port);
# 210 : : explicit CService(const struct sockaddr_in6& addr);
# 211 : :
# 212 : : SERIALIZE_METHODS(CService, obj)
# 213 : 4268 : {
# 214 : 4268 : READWRITEAS(CNetAddr, obj);
# 215 : 4268 : READWRITE(Using<BigEndianFormatter<2>>(obj.port));
# 216 : 4268 : }
# 217 : : };
# 218 : :
# 219 : : bool SanityCheckASMap(const std::vector<bool>& asmap);
# 220 : :
# 221 : : #endif // BITCOIN_NETADDRESS_H
|
