src/netaddress.h

   1 // Copyright (c) 2009-2016 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 <stdint.h>
  16 #include <string>
  17 #include <vector>
  18
  19 enum Network
  20 {
  21     NET_UNROUTABLE = 0,
  22     NET_IPV4,
  23     NET_IPV6,
  24     NET_TOR,
  25
  26     NET_MAX,
  27 };
  28
  29 /** IP address (IPv6, or IPv4 using mapped IPv6 range (::FFFF:0:0/96)) */
  30 class CNetAddr
  31 {
  32     protected:
  33         unsigned char ip[16]; // in network byte order
  34         uint32_t scopeId; // for scoped/link-local ipv6 addresses
  35
  36     public:
  37         CNetAddr();
  38         CNetAddr(const struct in_addr& ipv4Addr);
  39         void Init();
  40         void SetIP(const CNetAddr& ip);
  41
  42         /**
  43          * Set raw IPv4 or IPv6 address (in network byte order)
  44          * @note Only NET_IPV4 and NET_IPV6 are allowed for network.
  45          */
  46         void SetRaw(Network network, const uint8_t *data);
  47
  48         bool SetSpecial(const std::string &strName); // for Tor addresses
  49         bool IsIPv4() const;    // IPv4 mapped address (::FFFF:0:0/96, 0.0.0.0/0)
  50         bool IsIPv6() const;    // IPv6 address (not mapped IPv4, not Tor)
  51         bool IsRFC1918() const; // IPv4 private networks (10.0.0.0/8, 192.168.0.0/16, 172.16.0.0/12)
  52         bool IsRFC2544() const; // IPv4 inter-network communications (192.18.0.0/15)
  53         bool IsRFC6598() const; // IPv4 ISP-level NAT (100.64.0.0/10)
  54         bool IsRFC5737() const; // IPv4 documentation addresses (192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24)
  55         bool IsRFC3849() const; // IPv6 documentation address (2001:0DB8::/32)
  56         bool IsRFC3927() const; // IPv4 autoconfig (169.254.0.0/16)
  57         bool IsRFC3964() const; // IPv6 6to4 tunnelling (2002::/16)
  58         bool IsRFC4193() const; // IPv6 unique local (FC00::/7)
  59         bool IsRFC4380() const; // IPv6 Teredo tunnelling (2001::/32)
  60         bool IsRFC4843() const; // IPv6 ORCHID (2001:10::/28)
  61         bool IsRFC4862() const; // IPv6 autoconfig (FE80::/64)
  62         bool IsRFC6052() const; // IPv6 well-known prefix (64:FF9B::/96)
  63         bool IsRFC6145() const; // IPv6 IPv4-translated address (::FFFF:0:0:0/96)
  64         bool IsTor() const;
  65         bool IsLocal() const;
  66         bool IsRoutable() const;
  67         bool IsValid() const;
  68         bool IsMulticast() const;
  69         enum Network GetNetwork() const;
  70         std::string ToString() const;
  71         std::string ToStringIP() const;
  72         unsigned int GetByte(int n) const;
  73         uint64_t GetHash() const;
  74         bool GetInAddr(struct in_addr* pipv4Addr) const;
  75         std::vector<unsigned char> GetGroup() const;
  76         int GetReachabilityFrom(const CNetAddr *paddrPartner = NULL) const;
  77
  78         CNetAddr(const struct in6_addr& pipv6Addr, const uint32_t scope = 0);
  79         bool GetIn6Addr(struct in6_addr* pipv6Addr) const;
  80
  81         friend bool operator==(const CNetAddr& a, const CNetAddr& b);
  82         friend bool operator!=(const CNetAddr& a, const CNetAddr& b);
  83         friend bool operator<(const CNetAddr& a, const CNetAddr& b);
  84
  85         ADD_SERIALIZE_METHODS;
  86
  87         template <typename Stream, typename Operation>
  88         inline void SerializationOp(Stream& s, Operation ser_action) {
  89             READWRITE(FLATDATA(ip));
  90         }
  91
  92         friend class CSubNet;
  93 };
  94
  95 class CSubNet
  96 {
  97     protected:
  98         /// Network (base) address
  99         CNetAddr network;
 100         /// Netmask, in network byte order
 101         uint8_t netmask[16];
 102         /// Is this value valid? (only used to signal parse errors)
 103         bool valid;
 104
 105     public:
 106         CSubNet();
 107         CSubNet(const CNetAddr &addr, int32_t mask);
 108         CSubNet(const CNetAddr &addr, const CNetAddr &mask);
 109
 110         //constructor for single ip subnet (<ipv4>/32 or <ipv6>/128)
 111         explicit CSubNet(const CNetAddr &addr);
 112
 113         bool Match(const CNetAddr &addr) const;
 114
 115         std::string ToString() const;
 116         bool IsValid() const;
 117
 118         friend bool operator==(const CSubNet& a, const CSubNet& b);
 119         friend bool operator!=(const CSubNet& a, const CSubNet& b);
 120         friend bool operator<(const CSubNet& a, const CSubNet& b);
 121
 122         ADD_SERIALIZE_METHODS;
 123
 124         template <typename Stream, typename Operation>
 125         inline void SerializationOp(Stream& s, Operation ser_action) {
 126             READWRITE(network);
 127             READWRITE(FLATDATA(netmask));
 128             READWRITE(FLATDATA(valid));
 129         }
 130 };
 131
 132 /** A combination of a network address (CNetAddr) and a (TCP) port */
 133 class CService : public CNetAddr
 134 {
 135     protected:
 136         unsigned short port; // host order
 137
 138     public:
 139         CService();
 140         CService(const CNetAddr& ip, unsigned short port);
 141         CService(const struct in_addr& ipv4Addr, unsigned short port);
 142         CService(const struct sockaddr_in& addr);
 143         void Init();
 144         void SetPort(unsigned short portIn);
 145         unsigned short GetPort() const;
 146         bool GetSockAddr(struct sockaddr* paddr, socklen_t *addrlen) const;
 147         bool SetSockAddr(const struct sockaddr* paddr);
 148         friend bool operator==(const CService& a, const CService& b);
 149         friend bool operator!=(const CService& a, const CService& b);
 150         friend bool operator<(const CService& a, const CService& b);
 151         std::vector<unsigned char> GetKey() const;
 152         std::string ToString() const;
 153         std::string ToStringPort() const;
 154         std::string ToStringIPPort() const;
 155
 156         CService(const struct in6_addr& ipv6Addr, unsigned short port);
 157         CService(const struct sockaddr_in6& addr);
 158
 159         ADD_SERIALIZE_METHODS;
 160
 161         template <typename Stream, typename Operation>
 162         inline void SerializationOp(Stream& s, Operation ser_action) {
 163             READWRITE(FLATDATA(ip));
 164             unsigned short portN = htons(port);
 165             READWRITE(FLATDATA(portN));
 166             if (ser_action.ForRead())
 167                  port = ntohs(portN);
 168         }
 169 };
 170
 171 #endif // BITCOIN_NETADDRESS_H