folly/IPAddressV4.cpp

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <folly/IPAddressV4.h>
  18
  19 #include <ostream>
  20 #include <string>
  21
  22 #include <folly/Format.h>
  23 #include <folly/IPAddress.h>
  24 #include <folly/IPAddressV6.h>
  25 #include <folly/detail/IPAddressSource.h>
  26
  27 using std::ostream;
  28 using std::string;
  29
  30 namespace folly {
  31
  32
  33 // free functions
  34 size_t hash_value(const IPAddressV4& addr) {
  35   return addr.hash();
  36 }
  37 ostream& operator<<(ostream& os, const IPAddressV4& addr) {
  38   os << addr.str();
  39   return os;
  40 }
  41 void toAppend(IPAddressV4 addr, string* result) {
  42   result->append(addr.str());
  43 }
  44 void toAppend(IPAddressV4 addr, fbstring* result) {
  45   result->append(addr.str());
  46 }
  47
  48 bool IPAddressV4::validate(StringPiece ip) {
  49   constexpr size_t kStrMaxLen = INET_ADDRSTRLEN;
  50   std::array<char, kStrMaxLen + 1> ip_cstr;
  51   const size_t len = std::min(ip.size(), kStrMaxLen);
  52   std::memcpy(ip_cstr.data(), ip.data(), len);
  53   ip_cstr[len] = 0;
  54   struct in_addr addr;
  55   return 1 == inet_pton(AF_INET, ip_cstr.data(), &addr);
  56 }
  57
  58 // public static
  59 IPAddressV4 IPAddressV4::fromLong(uint32_t src) {
  60   in_addr addr;
  61   addr.s_addr = src;
  62   return IPAddressV4(addr);
  63 }
  64
  65 IPAddressV4 IPAddressV4::fromLongHBO(uint32_t src) {
  66   in_addr addr;
  67   addr.s_addr = htonl(src);
  68   return IPAddressV4(addr);
  69 }
  70
  71 // static public
  72 uint32_t IPAddressV4::toLong(StringPiece ip) {
  73   auto str = ip.str();
  74   in_addr addr;
  75   if (inet_pton(AF_INET, str.c_str(), &addr) != 1) {
  76     throw IPAddressFormatException(
  77         sformat("Can't convert invalid IP '{}' to long", ip));
  78   }
  79   return addr.s_addr;
  80 }
  81
  82 // static public
  83 uint32_t IPAddressV4::toLongHBO(StringPiece ip) {
  84   return ntohl(IPAddressV4::toLong(ip));
  85 }
  86
  87 // public default constructor
  88 IPAddressV4::IPAddressV4() {
  89 }
  90
  91 // ByteArray4 constructor
  92 IPAddressV4::IPAddressV4(const ByteArray4& src)
  93   : addr_(src)
  94 {
  95 }
  96
  97 // public string constructor
  98 IPAddressV4::IPAddressV4(StringPiece addr)
  99   : addr_()
 100 {
 101   auto ip = addr.str();
 102   if (inet_pton(AF_INET, ip.c_str(), &addr_.inAddr_) != 1) {
 103     throw IPAddressFormatException(sformat("Invalid IPv4 address '{}'", addr));
 104   }
 105 }
 106
 107 // in_addr constructor
 108 IPAddressV4::IPAddressV4(const in_addr src)
 109   : addr_(src)
 110 {
 111 }
 112
 113 // public
 114 void IPAddressV4::setFromBinary(ByteRange bytes) {
 115   if (bytes.size() != 4) {
 116     throw IPAddressFormatException(sformat(
 117         "Invalid IPv4 binary data: length must be 4 bytes, got {}",
 118         bytes.size()));
 119   }
 120   memcpy(&addr_.inAddr_.s_addr, bytes.data(), sizeof(in_addr));
 121 }
 122
 123 // static
 124 IPAddressV4 IPAddressV4::fromInverseArpaName(const std::string& arpaname) {
 125   auto piece = StringPiece(arpaname);
 126   // input must be something like 1.0.168.192.in-addr.arpa
 127   if (!piece.removeSuffix(".in-addr.arpa")) {
 128     throw IPAddressFormatException(
 129         sformat("input does not end with '.in-addr.arpa': '{}'", arpaname));
 130   }
 131   std::vector<StringPiece> pieces;
 132   split(".", piece, pieces);
 133   if (pieces.size() != 4) {
 134     throw IPAddressFormatException(sformat("Invalid input. Got {}", piece));
 135   }
 136   // reverse 1.0.168.192 -> 192.168.0.1
 137   return IPAddressV4(join(".", pieces.rbegin(), pieces.rend()));
 138 }
 139
 140 // public
 141 IPAddressV6 IPAddressV4::createIPv6() const {
 142   ByteArray16 ba{};
 143   ba[10] = 0xff;
 144   ba[11] = 0xff;
 145   std::memcpy(&ba[12], bytes(), 4);
 146   return IPAddressV6(ba);
 147 }
 148
 149 // public
 150 IPAddressV6 IPAddressV4::getIPv6For6To4() const {
 151   ByteArray16 ba{};
 152   ba[0] = (uint8_t)((IPAddressV6::PREFIX_6TO4 & 0xFF00) >> 8);
 153   ba[1] = (uint8_t)(IPAddressV6::PREFIX_6TO4 & 0x00FF);
 154   std::memcpy(&ba[2], bytes(), 4);
 155   return IPAddressV6(ba);
 156 }
 157
 158 // public
 159 string IPAddressV4::toJson() const {
 160   return sformat("{{family:'AF_INET', addr:'{}', hash:{}}}", str(), hash());
 161 }
 162
 163 // public
 164 bool IPAddressV4::inSubnet(StringPiece cidrNetwork) const {
 165   auto subnetInfo = IPAddress::createNetwork(cidrNetwork);
 166   auto addr = subnetInfo.first;
 167   if (!addr.isV4()) {
 168     throw IPAddressFormatException(
 169         sformat("Address '{}' is not a V4 address", addr.toJson()));
 170   }
 171   return inSubnetWithMask(addr.asV4(), fetchMask(subnetInfo.second));
 172 }
 173
 174 // public
 175 bool IPAddressV4::inSubnetWithMask(const IPAddressV4& subnet,
 176                                    const ByteArray4 cidrMask) const {
 177   const ByteArray4 mask = detail::Bytes::mask(toByteArray(), cidrMask);
 178   const ByteArray4 subMask = detail::Bytes::mask(subnet.toByteArray(),
 179                                                  cidrMask);
 180   return (mask == subMask);
 181 }
 182
 183 // public
 184 bool IPAddressV4::isLoopback() const {
 185   static IPAddressV4 loopback_addr("127.0.0.0");
 186   return inSubnetWithMask(loopback_addr, fetchMask(8));
 187 }
 188
 189 // public
 190 bool IPAddressV4::isLinkLocal() const {
 191   static IPAddressV4 linklocal_addr("169.254.0.0");
 192   return inSubnetWithMask(linklocal_addr, fetchMask(16));
 193 }
 194
 195 // public
 196 bool IPAddressV4::isNonroutable() const {
 197   auto ip = toLongHBO();
 198   return isPrivate() ||
 199       (ip <= 0x00FFFFFF)                     || // 0.0.0.0-0.255.255.255
 200       (ip >= 0xC0000000 && ip <= 0xC00000FF) || // 192.0.0.0-192.0.0.255
 201       (ip >= 0xC0000200 && ip <= 0xC00002FF) || // 192.0.2.0-192.0.2.255
 202       (ip >= 0xC6120000 && ip <= 0xC613FFFF) || // 198.18.0.0-198.19.255.255
 203       (ip >= 0xC6336400 && ip <= 0xC63364FF) || // 198.51.100.0-198.51.100.255
 204       (ip >= 0xCB007100 && ip <= 0xCB0071FF) || // 203.0.113.0-203.0.113.255
 205       (ip >= 0xE0000000 && ip <= 0xFFFFFFFF);   // 224.0.0.0-255.255.255.255
 206 }
 207
 208 // public
 209 bool IPAddressV4::isPrivate() const {
 210   auto ip = toLongHBO();
 211   return
 212       (ip >= 0x0A000000 && ip <= 0x0AFFFFFF) || // 10.0.0.0-10.255.255.255
 213       (ip >= 0x7F000000 && ip <= 0x7FFFFFFF) || // 127.0.0.0-127.255.255.255
 214       (ip >= 0xA9FE0000 && ip <= 0xA9FEFFFF) || // 169.254.0.0-169.254.255.255
 215       (ip >= 0xAC100000 && ip <= 0xAC1FFFFF) || // 172.16.0.0-172.31.255.255
 216       (ip >= 0xC0A80000 && ip <= 0xC0A8FFFF);   // 192.168.0.0-192.168.255.255
 217 }
 218
 219 // public
 220 bool IPAddressV4::isMulticast() const {
 221   return (toLongHBO() & 0xf0000000) == 0xe0000000;
 222 }
 223
 224 // public
 225 IPAddressV4 IPAddressV4::mask(size_t numBits) const {
 226   static const auto bits = bitCount();
 227   if (numBits > bits) {
 228     throw IPAddressFormatException(
 229         sformat("numBits({}) > bitsCount({})", numBits, bits));
 230   }
 231
 232   ByteArray4 ba = detail::Bytes::mask(fetchMask(numBits), addr_.bytes_);
 233   return IPAddressV4(ba);
 234 }
 235
 236 // public
 237 string IPAddressV4::str() const {
 238   return detail::fastIpv4ToString(addr_.inAddr_);
 239 }
 240
 241 // public
 242 void IPAddressV4::toFullyQualifiedAppend(std::string& out) const {
 243   detail::fastIpv4AppendToString(addr_.inAddr_, out);
 244 }
 245
 246 // public
 247 string IPAddressV4::toInverseArpaName() const {
 248   return sformat(
 249       "{}.{}.{}.{}.in-addr.arpa",
 250       addr_.bytes_[3],
 251       addr_.bytes_[2],
 252       addr_.bytes_[1],
 253       addr_.bytes_[0]);
 254 }
 255
 256 // public
 257 uint8_t IPAddressV4::getNthMSByte(size_t byteIndex) const {
 258   const auto highestIndex = byteCount() - 1;
 259   if (byteIndex > highestIndex) {
 260     throw std::invalid_argument(sformat(
 261         "Byte index must be <= {} for addresses of type: {}",
 262         highestIndex,
 263         detail::familyNameStr(AF_INET)));
 264   }
 265   return bytes()[byteIndex];
 266 }
 267 // protected
 268 const ByteArray4 IPAddressV4::fetchMask(size_t numBits) {
 269   static const size_t bits = bitCount();
 270   if (numBits > bits) {
 271     throw IPAddressFormatException("IPv4 addresses are 32 bits");
 272   }
 273   auto const val = Endian::big(uint32_t(~uint64_t(0) << (32 - numBits)));
 274   ByteArray4 arr;
 275   std::memcpy(arr.data(), &val, sizeof(val));
 276   return arr;
 277 }
 278 // public static
 279 CIDRNetworkV4 IPAddressV4::longestCommonPrefix(
 280     const CIDRNetworkV4& one,
 281     const CIDRNetworkV4& two) {
 282   auto prefix = detail::Bytes::longestCommonPrefix(
 283       one.first.addr_.bytes_, one.second, two.first.addr_.bytes_, two.second);
 284   return {IPAddressV4(prefix.first), prefix.second};
 285 }
 286
 287 } // namespace folly