folly/IPAddressV6.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/IPAddressV6.h>
  18
  19 #include <ostream>
  20 #include <string>
  21
  22 #include <folly/Format.h>
  23 #include <folly/IPAddress.h>
  24 #include <folly/IPAddressV4.h>
  25 #include <folly/MacAddress.h>
  26 #include <folly/detail/IPAddressSource.h>
  27
  28 #if !_WIN32
  29 #include <net/if.h>
  30 #else
  31 // Because of the massive pain that is libnl, this can't go into the socket
  32 // portability header as you can't include <linux/if.h> and <net/if.h> in
  33 // the same translation unit without getting errors -_-...
  34 #include <iphlpapi.h> // @manual
  35 #include <ntddndis.h> // @manual
  36
  37 // Alias the max size of an interface name to what posix expects.
  38 #define IFNAMSIZ IF_NAMESIZE
  39 #endif
  40
  41 using std::ostream;
  42 using std::string;
  43
  44 namespace folly {
  45
  46 // public static const
  47 const uint32_t IPAddressV6::PREFIX_TEREDO = 0x20010000;
  48 const uint32_t IPAddressV6::PREFIX_6TO4 = 0x2002;
  49
  50 // free functions
  51 size_t hash_value(const IPAddressV6& addr) {
  52   return addr.hash();
  53 }
  54 ostream& operator<<(ostream& os, const IPAddressV6& addr) {
  55   os << addr.str();
  56   return os;
  57 }
  58 void toAppend(IPAddressV6 addr, string* result) {
  59   result->append(addr.str());
  60 }
  61 void toAppend(IPAddressV6 addr, fbstring* result) {
  62   result->append(addr.str());
  63 }
  64
  65 bool IPAddressV6::validate(StringPiece ip) {
  66   if (ip.size() > 0 && ip.front() == '[' && ip.back() == ']') {
  67     ip = ip.subpiece(1, ip.size() - 2);
  68   }
  69
  70   constexpr size_t kStrMaxLen = INET6_ADDRSTRLEN;
  71   std::array<char, kStrMaxLen + 1> ip_cstr;
  72   const size_t len = std::min(ip.size(), kStrMaxLen);
  73   std::memcpy(ip_cstr.data(), ip.data(), len);
  74   ip_cstr[len] = 0;
  75   struct in6_addr addr;
  76   return 1 == inet_pton(AF_INET6, ip_cstr.data(), &addr);
  77 }
  78
  79 // public default constructor
  80 IPAddressV6::IPAddressV6() {}
  81
  82 // public string constructor
  83 IPAddressV6::IPAddressV6(StringPiece addr) {
  84   auto ip = addr.str();
  85
  86   // Allow addresses surrounded in brackets
  87   if (ip.size() < 2) {
  88     throw IPAddressFormatException(
  89         sformat("Invalid IPv6 address '{}': address too short", ip));
  90   }
  91   if (ip.front() == '[' && ip.back() == ']') {
  92     ip = ip.substr(1, ip.size() - 2);
  93   }
  94
  95   struct addrinfo* result;
  96   struct addrinfo hints;
  97   memset(&hints, 0, sizeof(hints));
  98   hints.ai_family = AF_INET6;
  99   hints.ai_socktype = SOCK_STREAM;
 100   hints.ai_flags = AI_NUMERICHOST;
 101   if (!getaddrinfo(ip.c_str(), nullptr, &hints, &result)) {
 102     struct sockaddr_in6* ipAddr = (struct sockaddr_in6*)result->ai_addr;
 103     addr_.in6Addr_ = ipAddr->sin6_addr;
 104     scope_ = uint16_t(ipAddr->sin6_scope_id);
 105     freeaddrinfo(result);
 106   } else {
 107     throw IPAddressFormatException(sformat("Invalid IPv6 address '{}'", ip));
 108   }
 109 }
 110
 111 // in6_addr constructor
 112 IPAddressV6::IPAddressV6(const in6_addr& src) : addr_(src) {}
 113
 114 // sockaddr_in6 constructor
 115 IPAddressV6::IPAddressV6(const sockaddr_in6& src)
 116     : addr_(src.sin6_addr), scope_(uint16_t(src.sin6_scope_id)) {}
 117
 118 // ByteArray16 constructor
 119 IPAddressV6::IPAddressV6(const ByteArray16& src) : addr_(src) {}
 120
 121 // link-local constructor
 122 IPAddressV6::IPAddressV6(LinkLocalTag, MacAddress mac) : addr_(mac) {}
 123
 124 IPAddressV6::AddressStorage::AddressStorage(MacAddress mac) {
 125   // The link-local address uses modified EUI-64 format,
 126   // See RFC 4291 sections 2.5.1, 2.5.6, and Appendix A
 127   const auto* macBytes = mac.bytes();
 128   memcpy(&bytes_.front(), "\xfe\x80\x00\x00\x00\x00\x00\x00", 8);
 129   bytes_[8] = uint8_t(macBytes[0] ^ 0x02);
 130   bytes_[9] = macBytes[1];
 131   bytes_[10] = macBytes[2];
 132   bytes_[11] = 0xff;
 133   bytes_[12] = 0xfe;
 134   bytes_[13] = macBytes[3];
 135   bytes_[14] = macBytes[4];
 136   bytes_[15] = macBytes[5];
 137 }
 138
 139 Optional<MacAddress> IPAddressV6::getMacAddressFromLinkLocal() const {
 140   // Returned MacAddress must be constructed from a link-local IPv6 address.
 141   if (!isLinkLocal()) {
 142     return folly::none;
 143   }
 144   return getMacAddressFromEUI64();
 145 }
 146
 147 Optional<MacAddress> IPAddressV6::getMacAddressFromEUI64() const {
 148   if (!(addr_.bytes_[11] == 0xff && addr_.bytes_[12] == 0xfe)) {
 149     return folly::none;
 150   }
 151   // The auto configured address uses modified EUI-64 format,
 152   // See RFC 4291 sections 2.5.1, 2.5.6, and Appendix A
 153   std::array<uint8_t, MacAddress::SIZE> bytes;
 154   // Step 1: first 8 bytes are network prefix, and can be stripped
 155   // Step 2: invert the universal/local (U/L) flag (bit 7)
 156   bytes[0] = addr_.bytes_[8] ^ 0x02;
 157   // Step 3: copy these bytes as they are
 158   bytes[1] = addr_.bytes_[9];
 159   bytes[2] = addr_.bytes_[10];
 160   // Step 4: strip bytes (0xfffe), which are bytes_[11] and bytes_[12]
 161   // Step 5: copy the rest.
 162   bytes[3] = addr_.bytes_[13];
 163   bytes[4] = addr_.bytes_[14];
 164   bytes[5] = addr_.bytes_[15];
 165   return Optional<MacAddress>(MacAddress::fromBinary(range(bytes)));
 166 }
 167
 168 void IPAddressV6::setFromBinary(ByteRange bytes) {
 169   if (bytes.size() != 16) {
 170     throw IPAddressFormatException(sformat(
 171         "Invalid IPv6 binary data: length must be 16 bytes, got {}",
 172         bytes.size()));
 173   }
 174   memcpy(&addr_.in6Addr_.s6_addr, bytes.data(), sizeof(in6_addr));
 175   scope_ = 0;
 176 }
 177
 178 // static
 179 IPAddressV6 IPAddressV6::fromInverseArpaName(const std::string& arpaname) {
 180   auto piece = StringPiece(arpaname);
 181   if (!piece.removeSuffix(".ip6.arpa")) {
 182     throw IPAddressFormatException(sformat(
 183         "Invalid input. Should end with 'ip6.arpa'. Got '{}'", arpaname));
 184   }
 185   std::vector<StringPiece> pieces;
 186   split(".", piece, pieces);
 187   if (pieces.size() != 32) {
 188     throw IPAddressFormatException(sformat("Invalid input. Got '{}'", piece));
 189   }
 190   std::array<char, IPAddressV6::kToFullyQualifiedSize> ip;
 191   size_t pos = 0;
 192   int count = 0;
 193   for (size_t i = 1; i <= pieces.size(); i++) {
 194     ip[pos] = pieces[pieces.size() - i][0];
 195     pos++;
 196     count++;
 197     // add ':' every 4 chars
 198     if (count == 4 && pos < ip.size()) {
 199       ip[pos++] = ':';
 200       count = 0;
 201     }
 202   }
 203   return IPAddressV6(folly::range(ip));
 204 }
 205
 206 // public
 207 IPAddressV4 IPAddressV6::createIPv4() const {
 208   if (!isIPv4Mapped()) {
 209     throw IPAddressFormatException("addr is not v4-to-v6-mapped");
 210   }
 211   const unsigned char* by = bytes();
 212   return IPAddressV4(detail::Bytes::mkAddress4(&by[12]));
 213 }
 214
 215 // convert two uint8_t bytes into a uint16_t as hibyte.lobyte
 216 static inline uint16_t unpack(uint8_t lobyte, uint8_t hibyte) {
 217   return uint16_t((uint16_t(hibyte) << 8) | lobyte);
 218 }
 219
 220 // given a src string, unpack count*2 bytes into dest
 221 // dest must have as much storage as count
 222 static inline void
 223 unpackInto(const unsigned char* src, uint16_t* dest, size_t count) {
 224   for (size_t i = 0, hi = 1, lo = 0; i < count; i++) {
 225     dest[i] = unpack(src[hi], src[lo]);
 226     hi += 2;
 227     lo += 2;
 228   }
 229 }
 230
 231 // public
 232 IPAddressV4 IPAddressV6::getIPv4For6To4() const {
 233   if (!is6To4()) {
 234     throw IPAddressV6::TypeError(
 235         sformat("Invalid IP '{}': not a 6to4 address", str()));
 236   }
 237   // convert 16x8 bytes into first 4x16 bytes
 238   uint16_t ints[4] = {0, 0, 0, 0};
 239   unpackInto(bytes(), ints, 4);
 240   // repack into 4x8
 241   union {
 242     unsigned char bytes[4];
 243     in_addr addr;
 244   } ipv4;
 245   ipv4.bytes[0] = (uint8_t)((ints[1] & 0xFF00) >> 8);
 246   ipv4.bytes[1] = (uint8_t)(ints[1] & 0x00FF);
 247   ipv4.bytes[2] = (uint8_t)((ints[2] & 0xFF00) >> 8);
 248   ipv4.bytes[3] = (uint8_t)(ints[2] & 0x00FF);
 249   return IPAddressV4(ipv4.addr);
 250 }
 251
 252 // public
 253 bool IPAddressV6::isIPv4Mapped() const {
 254   // v4 mapped addresses have their first 10 bytes set to 0, the next 2 bytes
 255   // set to 255 (0xff);
 256   const unsigned char* by = bytes();
 257
 258   // check if first 10 bytes are 0
 259   for (int i = 0; i < 10; i++) {
 260     if (by[i] != 0x00) {
 261       return false;
 262     }
 263   }
 264   // check if bytes 11 and 12 are 255
 265   if (by[10] == 0xff && by[11] == 0xff) {
 266     return true;
 267   }
 268   return false;
 269 }
 270
 271 // public
 272 IPAddressV6::Type IPAddressV6::type() const {
 273   // convert 16x8 bytes into first 2x16 bytes
 274   uint16_t ints[2] = {0, 0};
 275   unpackInto(bytes(), ints, 2);
 276
 277   if ((((uint32_t)ints[0] << 16) | ints[1]) == IPAddressV6::PREFIX_TEREDO) {
 278     return Type::TEREDO;
 279   }
 280
 281   if ((uint32_t)ints[0] == IPAddressV6::PREFIX_6TO4) {
 282     return Type::T6TO4;
 283   }
 284
 285   return Type::NORMAL;
 286 }
 287
 288 // public
 289 string IPAddressV6::toJson() const {
 290   return sformat("{{family:'AF_INET6', addr:'{}', hash:{}}}", str(), hash());
 291 }
 292
 293 // public
 294 size_t IPAddressV6::hash() const {
 295   if (isIPv4Mapped()) {
 296     /* An IPAddress containing this object would be equal (i.e. operator==)
 297        to an IPAddress containing the corresponding IPv4.
 298        So we must make sure that the hash values are the same as well */
 299     return IPAddress::createIPv4(*this).hash();
 300   }
 301
 302   static const uint64_t seed = AF_INET6;
 303   uint64_t hash1 = 0, hash2 = 0;
 304   hash::SpookyHashV2::Hash128(&addr_, 16, &hash1, &hash2);
 305   return hash::hash_combine(seed, hash1, hash2);
 306 }
 307
 308 // public
 309 bool IPAddressV6::inSubnet(StringPiece cidrNetwork) const {
 310   auto subnetInfo = IPAddress::createNetwork(cidrNetwork);
 311   auto addr = subnetInfo.first;
 312   if (!addr.isV6()) {
 313     throw IPAddressFormatException(
 314         sformat("Address '{}' is not a V6 address", addr.toJson()));
 315   }
 316   return inSubnetWithMask(addr.asV6(), fetchMask(subnetInfo.second));
 317 }
 318
 319 // public
 320 bool IPAddressV6::inSubnetWithMask(
 321     const IPAddressV6& subnet,
 322     const ByteArray16& cidrMask) const {
 323   const auto mask = detail::Bytes::mask(toByteArray(), cidrMask);
 324   const auto subMask = detail::Bytes::mask(subnet.toByteArray(), cidrMask);
 325   return (mask == subMask);
 326 }
 327
 328 // public
 329 bool IPAddressV6::isLoopback() const {
 330   // Check if v4 mapped is loopback
 331   if (isIPv4Mapped() && createIPv4().isLoopback()) {
 332     return true;
 333   }
 334   auto socka = toSockAddr();
 335   return IN6_IS_ADDR_LOOPBACK(&socka.sin6_addr);
 336 }
 337
 338 bool IPAddressV6::isRoutable() const {
 339   return
 340       // 2000::/3 is the only assigned global unicast block
 341       inBinarySubnet({{0x20, 0x00}}, 3) ||
 342       // ffxe::/16 are global scope multicast addresses,
 343       // which are eligible to be routed over the internet
 344       (isMulticast() && getMulticastScope() == 0xe);
 345 }
 346
 347 bool IPAddressV6::isLinkLocalBroadcast() const {
 348   static const IPAddressV6 kLinkLocalBroadcast("ff02::1");
 349   return *this == kLinkLocalBroadcast;
 350 }
 351
 352 // public
 353 bool IPAddressV6::isPrivate() const {
 354   // Check if mapped is private
 355   if (isIPv4Mapped() && createIPv4().isPrivate()) {
 356     return true;
 357   }
 358   return isLoopback() || inBinarySubnet({{0xfc, 0x00}}, 7);
 359 }
 360
 361 // public
 362 bool IPAddressV6::isLinkLocal() const {
 363   return inBinarySubnet({{0xfe, 0x80}}, 10);
 364 }
 365
 366 bool IPAddressV6::isMulticast() const {
 367   return addr_.bytes_[0] == 0xff;
 368 }
 369
 370 uint8_t IPAddressV6::getMulticastFlags() const {
 371   DCHECK(isMulticast());
 372   return uint8_t((addr_.bytes_[1] >> 4) & 0xf);
 373 }
 374
 375 uint8_t IPAddressV6::getMulticastScope() const {
 376   DCHECK(isMulticast());
 377   return uint8_t(addr_.bytes_[1] & 0xf);
 378 }
 379
 380 IPAddressV6 IPAddressV6::getSolicitedNodeAddress() const {
 381   // Solicted node addresses must be constructed from unicast (or anycast)
 382   // addresses
 383   DCHECK(!isMulticast());
 384
 385   uint8_t bytes[16] = {
 386       0xff,
 387       0x02,
 388       0x00,
 389       0x00,
 390       0x00,
 391       0x00,
 392       0x00,
 393       0x00,
 394       0x00,
 395       0x00,
 396       0x00,
 397       0x01,
 398       0xff,
 399       addr_.bytes_[13],
 400       addr_.bytes_[14],
 401       addr_.bytes_[15],
 402   };
 403   return IPAddressV6::fromBinary(ByteRange(bytes, 16));
 404 }
 405
 406 // public
 407 IPAddressV6 IPAddressV6::mask(size_t numBits) const {
 408   static const auto bits = bitCount();
 409   if (numBits > bits) {
 410     throw IPAddressFormatException(
 411         sformat("numBits({}) > bitCount({})", numBits, bits));
 412   }
 413   ByteArray16 ba = detail::Bytes::mask(fetchMask(numBits), addr_.bytes_);
 414   return IPAddressV6(ba);
 415 }
 416
 417 // public
 418 string IPAddressV6::str() const {
 419   char buffer[INET6_ADDRSTRLEN + IFNAMSIZ + 1];
 420
 421   if (!inet_ntop(AF_INET6, toAddr().s6_addr, buffer, INET6_ADDRSTRLEN)) {
 422     throw IPAddressFormatException(sformat(
 423         "Invalid address with hex '{}' with error {}",
 424         detail::Bytes::toHex(bytes(), 16),
 425         strerror(errno)));
 426   }
 427
 428   auto scopeId = getScopeId();
 429   if (scopeId != 0) {
 430     auto len = strlen(buffer);
 431     buffer[len] = '%';
 432
 433     auto errsv = errno;
 434     if (!if_indextoname(scopeId, buffer + len + 1)) {
 435       // if we can't map the if because eg. it no longer exists,
 436       // append the if index instead
 437       snprintf(buffer + len + 1, IFNAMSIZ, "%u", scopeId);
 438     }
 439     errno = errsv;
 440   }
 441
 442   return string(buffer);
 443 }
 444
 445 // public
 446 string IPAddressV6::toFullyQualified() const {
 447   return detail::fastIpv6ToString(addr_.in6Addr_);
 448 }
 449
 450 // public
 451 void IPAddressV6::toFullyQualifiedAppend(std::string& out) const {
 452   detail::fastIpv6AppendToString(addr_.in6Addr_, out);
 453 }
 454
 455 // public
 456 string IPAddressV6::toInverseArpaName() const {
 457   constexpr folly::StringPiece lut = "0123456789abcdef";
 458   std::array<char, 32> a;
 459   int j = 0;
 460   for (int i = 15; i >= 0; i--) {
 461     a[j] = (lut[bytes()[i] & 0xf]);
 462     a[j + 1] = (lut[bytes()[i] >> 4]);
 463     j += 2;
 464   }
 465   return sformat("{}.ip6.arpa", join(".", a));
 466 }
 467
 468 // public
 469 uint8_t IPAddressV6::getNthMSByte(size_t byteIndex) const {
 470   const auto highestIndex = byteCount() - 1;
 471   if (byteIndex > highestIndex) {
 472     throw std::invalid_argument(sformat(
 473         "Byte index must be <= {} for addresses of type: {}",
 474         highestIndex,
 475         detail::familyNameStr(AF_INET6)));
 476   }
 477   return bytes()[byteIndex];
 478 }
 479
 480 // protected
 481 const ByteArray16 IPAddressV6::fetchMask(size_t numBits) {
 482   static const size_t bits = bitCount();
 483   if (numBits > bits) {
 484     throw IPAddressFormatException("IPv6 addresses are 128 bits.");
 485   }
 486   if (numBits == 0) {
 487     return {{0}};
 488   }
 489   constexpr auto _0s = uint64_t(0);
 490   constexpr auto _1s = ~_0s;
 491   auto const fragment = Endian::big(_1s << ((128 - numBits) % 64));
 492   auto const hi = numBits <= 64 ? fragment : _1s;
 493   auto const lo = numBits <= 64 ? _0s : fragment;
 494   uint64_t const parts[] = {hi, lo};
 495   ByteArray16 arr;
 496   std::memcpy(arr.data(), parts, sizeof(parts));
 497   return arr;
 498 }
 499
 500 // public static
 501 CIDRNetworkV6 IPAddressV6::longestCommonPrefix(
 502     const CIDRNetworkV6& one,
 503     const CIDRNetworkV6& two) {
 504   auto prefix = detail::Bytes::longestCommonPrefix(
 505       one.first.addr_.bytes_, one.second, two.first.addr_.bytes_, two.second);
 506   return {IPAddressV6(prefix.first), prefix.second};
 507 }
 508
 509 // protected
 510 bool IPAddressV6::inBinarySubnet(
 511     const std::array<uint8_t, 2> addr,
 512     size_t numBits) const {
 513   auto masked = mask(numBits);
 514   return (std::memcmp(addr.data(), masked.bytes(), 2) == 0);
 515 }
 516 } // namespace folly