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 using std::ostream;
  29 using std::string;
  30
  31 namespace folly {
  32
  33 // public static const
  34 const uint32_t IPAddressV6::PREFIX_TEREDO = 0x20010000;
  35 const uint32_t IPAddressV6::PREFIX_6TO4 = 0x2002;
  36
  37 // free functions
  38 size_t hash_value(const IPAddressV6& addr) {
  39   return addr.hash();
  40 }
  41 ostream& operator<<(ostream& os, const IPAddressV6& addr) {
  42   os << addr.str();
  43   return os;
  44 }
  45 void toAppend(IPAddressV6 addr, string* result) {
  46   result->append(addr.str());
  47 }
  48 void toAppend(IPAddressV6 addr, fbstring* result) {
  49   result->append(addr.str());
  50 }
  51
  52 bool IPAddressV6::validate(StringPiece ip) {
  53   if (ip.size() > 0 && ip.front() == '[' && ip.back() == ']') {
  54     ip = ip.subpiece(1, ip.size() - 2);
  55   }
  56
  57   constexpr size_t kStrMaxLen = INET6_ADDRSTRLEN;
  58   std::array<char, kStrMaxLen + 1> ip_cstr;
  59   const size_t len = std::min(ip.size(), kStrMaxLen);
  60   std::memcpy(ip_cstr.data(), ip.data(), len);
  61   ip_cstr[len] = 0;
  62   struct in6_addr addr;
  63   return 1 == inet_pton(AF_INET6, ip_cstr.data(), &addr);
  64 }
  65
  66 // public default constructor
  67 IPAddressV6::IPAddressV6() {
  68 }
  69
  70 // public string constructor
  71 IPAddressV6::IPAddressV6(StringPiece addr) {
  72   auto ip = addr.str();
  73
  74   // Allow addresses surrounded in brackets
  75   if (ip.size() < 2) {
  76     throw IPAddressFormatException(
  77         to<std::string>("Invalid IPv6 address '", ip, "': address too short"));
  78   }
  79   if (ip.front() == '[' && ip.back() == ']') {
  80     ip = ip.substr(1, ip.size() - 2);
  81   }
  82
  83   struct addrinfo* result;
  84   struct addrinfo hints;
  85   memset(&hints, 0, sizeof(hints));
  86   hints.ai_family = AF_INET6;
  87   hints.ai_socktype = SOCK_STREAM;
  88   hints.ai_flags = AI_NUMERICHOST;
  89   if (!getaddrinfo(ip.c_str(), nullptr, &hints, &result)) {
  90     struct sockaddr_in6* ipAddr = (struct sockaddr_in6*)result->ai_addr;
  91     addr_.in6Addr_ = ipAddr->sin6_addr;
  92     scope_ = uint16_t(ipAddr->sin6_scope_id);
  93     freeaddrinfo(result);
  94   } else {
  95     throw IPAddressFormatException(
  96         to<std::string>("Invalid IPv6 address '", ip, "'"));
  97   }
  98 }
  99
 100 // in6_addr constructor
 101 IPAddressV6::IPAddressV6(const in6_addr& src)
 102   : addr_(src)
 103 {
 104 }
 105
 106 // sockaddr_in6 constructor
 107 IPAddressV6::IPAddressV6(const sockaddr_in6& src)
 108   : addr_(src.sin6_addr)
 109   , scope_(uint16_t(src.sin6_scope_id))
 110 {
 111 }
 112
 113 // ByteArray16 constructor
 114 IPAddressV6::IPAddressV6(const ByteArray16& src)
 115   : addr_(src)
 116 {
 117 }
 118
 119 // link-local constructor
 120 IPAddressV6::IPAddressV6(LinkLocalTag, MacAddress mac)
 121   : addr_(mac) {
 122 }
 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 (!(addr_.bytes_[0] == 0xfe && addr_.bytes_[1] == 0x80 &&
 142         addr_.bytes_[2] == 0x00 && addr_.bytes_[3] == 0x00 &&
 143         addr_.bytes_[4] == 0x00 && addr_.bytes_[5] == 0x00 &&
 144         addr_.bytes_[6] == 0x00 && addr_.bytes_[7] == 0x00 &&
 145         addr_.bytes_[11] == 0xff && addr_.bytes_[12] == 0xfe)) {
 146     return folly::none;
 147   }
 148   // The link-local address uses modified EUI-64 format,
 149   // See RFC 4291 sections 2.5.1, 2.5.6, and Appendix A
 150   std::array<uint8_t, MacAddress::SIZE> bytes;
 151   // Step 1: first 8 bytes are fe:80:00:00:00:00:00:00, and can be stripped
 152   // Step 2: invert the universal/local (U/L) flag (bit 7)
 153   bytes[0] = addr_.bytes_[8] ^ 0x02;
 154   // Step 3: copy thhese bytes are they are
 155   bytes[1] = addr_.bytes_[9];
 156   bytes[2] = addr_.bytes_[10];
 157   // Step 4: strip bytes (0xfffe), which are bytes_[11] and bytes_[12]
 158   // Step 5: copy the rest.
 159   bytes[3] = addr_.bytes_[13];
 160   bytes[4] = addr_.bytes_[14];
 161   bytes[5] = addr_.bytes_[15];
 162   return Optional<MacAddress>(MacAddress::fromBinary(range(bytes)));
 163 }
 164
 165 void IPAddressV6::setFromBinary(ByteRange bytes) {
 166   if (bytes.size() != 16) {
 167     throw IPAddressFormatException(to<std::string>(
 168         "Invalid IPv6 binary data: length must ",
 169         "be 16 bytes, got ",
 170         bytes.size()));
 171   }
 172   memcpy(&addr_.in6Addr_.s6_addr, bytes.data(), sizeof(in6_addr));
 173   scope_ = 0;
 174 }
 175
 176 // static
 177 IPAddressV6 IPAddressV6::fromInverseArpaName(const std::string& arpaname) {
 178   auto piece = StringPiece(arpaname);
 179   if (!piece.removeSuffix(".ip6.arpa")) {
 180     throw IPAddressFormatException(sformat(
 181         "Invalid input. Should end with 'ip6.arpa'. Got '{}'", arpaname));
 182   }
 183   std::vector<StringPiece> pieces;
 184   split(".", piece, pieces);
 185   if (pieces.size() != 32) {
 186     throw IPAddressFormatException(sformat("Invalid input. Got '{}'", piece));
 187   }
 188   std::array<char, IPAddressV6::kToFullyQualifiedSize> ip;
 189   size_t pos = 0;
 190   int count = 0;
 191   for (size_t i = 1; i <= pieces.size(); i++) {
 192     ip[pos] = pieces[pieces.size() - i][0];
 193     pos++;
 194     count++;
 195     // add ':' every 4 chars
 196     if (count == 4 && pos < ip.size()) {
 197       ip[pos++] = ':';
 198       count = 0;
 199     }
 200   }
 201   return IPAddressV6(folly::range(ip));
 202 }
 203
 204 // public
 205 IPAddressV4 IPAddressV6::createIPv4() const {
 206   if (!isIPv4Mapped()) {
 207     throw IPAddressFormatException("addr is not v4-to-v6-mapped");
 208   }
 209   const unsigned char* by = bytes();
 210   return IPAddressV4(detail::Bytes::mkAddress4(&by[12]));
 211 }
 212
 213 // convert two uint8_t bytes into a uint16_t as hibyte.lobyte
 214 static inline uint16_t unpack(uint8_t lobyte, uint8_t hibyte) {
 215   return uint16_t((uint16_t(hibyte) << 8) | lobyte);
 216 }
 217
 218 // given a src string, unpack count*2 bytes into dest
 219 // dest must have as much storage as count
 220 static inline void unpackInto(const unsigned char* src,
 221                               uint16_t* dest,
 222                               size_t count) {
 223   for (size_t i = 0, hi = 1, lo = 0; i < count; i++) {
 224     dest[i] = unpack(src[hi], src[lo]);
 225     hi += 2;
 226     lo += 2;
 227   }
 228 }
 229
 230 // public
 231 IPAddressV4 IPAddressV6::getIPv4For6To4() const {
 232   if (!is6To4()) {
 233     throw IPAddressV6::TypeError(format(
 234             "Invalid IP '{}': not a 6to4 address", str()).str());
 235   }
 236   // convert 16x8 bytes into first 4x16 bytes
 237   uint16_t ints[4] = {0,0,0,0};
 238   unpackInto(bytes(), ints, 4);
 239   // repack into 4x8
 240   union {
 241     unsigned char bytes[4];
 242     in_addr addr;
 243   } ipv4;
 244   ipv4.bytes[0] = (uint8_t)((ints[1] & 0xFF00) >> 8);
 245   ipv4.bytes[1] = (uint8_t)(ints[1] & 0x00FF);
 246   ipv4.bytes[2] = (uint8_t)((ints[2] & 0xFF00) >> 8);
 247   ipv4.bytes[3] = (uint8_t)(ints[2] & 0x00FF);
 248   return IPAddressV4(ipv4.addr);
 249 }
 250
 251 // public
 252 bool IPAddressV6::isIPv4Mapped() const {
 253   // v4 mapped addresses have their first 10 bytes set to 0, the next 2 bytes
 254   // set to 255 (0xff);
 255   const unsigned char* by = bytes();
 256
 257   // check if first 10 bytes are 0
 258   for (int i = 0; i < 10; i++) {
 259     if (by[i] != 0x00) {
 260       return false;
 261     }
 262   }
 263   // check if bytes 11 and 12 are 255
 264   if (by[10] == 0xff && by[11] == 0xff) {
 265     return true;
 266   }
 267   return false;
 268 }
 269
 270 // public
 271 IPAddressV6::Type IPAddressV6::type() const {
 272   // convert 16x8 bytes into first 2x16 bytes
 273   uint16_t ints[2] = {0,0};
 274   unpackInto(bytes(), ints, 2);
 275
 276   if ((((uint32_t)ints[0] << 16) | ints[1]) == IPAddressV6::PREFIX_TEREDO) {
 277     return Type::TEREDO;
 278   }
 279
 280   if ((uint32_t)ints[0] == IPAddressV6::PREFIX_6TO4) {
 281     return Type::T6TO4;
 282   }
 283
 284   return Type::NORMAL;
 285 }
 286
 287 // public
 288 string IPAddressV6::toJson() const {
 289   return format(
 290       "{{family:'AF_INET6', addr:'{}', hash:{}}}", str(), hash()).str();
 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(to<std::string>(
 314         "Address '", addr.toJson(), "' ", "is not a V6 address"));
 315   }
 316   return inSubnetWithMask(addr.asV6(), fetchMask(subnetInfo.second));
 317 }
 318
 319 // public
 320 bool IPAddressV6::inSubnetWithMask(const IPAddressV6& subnet,
 321                                    const ByteArray16& cidrMask) const {
 322   const ByteArray16 mask = detail::Bytes::mask(toByteArray(), cidrMask);
 323   const ByteArray16 subMask = detail::Bytes::mask(subnet.toByteArray(),
 324                                                   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] = { 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 386                         0x00, 0x00, 0x00, 0x01, 0xff, 0x00, 0x00, 0x00 };
 387   bytes[13] = addr_.bytes_[13];
 388   bytes[14] = addr_.bytes_[14];
 389   bytes[15] = addr_.bytes_[15];
 390   return IPAddressV6::fromBinary(ByteRange(bytes, 16));
 391 }
 392
 393 // public
 394 IPAddressV6 IPAddressV6::mask(size_t numBits) const {
 395   static const auto bits = bitCount();
 396   if (numBits > bits) {
 397     throw IPAddressFormatException(
 398         to<std::string>("numBits(", numBits, ") > bitCount(", bits, ")"));
 399   }
 400   ByteArray16 ba = detail::Bytes::mask(fetchMask(numBits), addr_.bytes_);
 401   return IPAddressV6(ba);
 402 }
 403
 404 // public
 405 string IPAddressV6::str() const {
 406   char buffer[INET6_ADDRSTRLEN] = {0};
 407   sockaddr_in6 sock = toSockAddr();
 408   int error = getnameinfo(
 409       (sockaddr*)&sock,
 410       sizeof(sock),
 411       buffer,
 412       INET6_ADDRSTRLEN,
 413       nullptr,
 414       0,
 415       NI_NUMERICHOST);
 416   if (!error) {
 417     string ip(buffer);
 418     return ip;
 419   } else {
 420     throw IPAddressFormatException(to<std::string>(
 421         "Invalid address with hex ",
 422         "'",
 423         detail::Bytes::toHex(bytes(), 16),
 424         "%",
 425         sock.sin6_scope_id,
 426         "'",
 427         " , with error ",
 428         gai_strerror(error)));
 429   }
 430 }
 431
 432 // public
 433 string IPAddressV6::toFullyQualified() const {
 434   return detail::fastIpv6ToString(addr_.in6Addr_);
 435 }
 436
 437 // public
 438 void IPAddressV6::toFullyQualifiedAppend(std::string& out) const {
 439   detail::fastIpv6AppendToString(addr_.in6Addr_, out);
 440 }
 441
 442 // public
 443 string IPAddressV6::toInverseArpaName() const {
 444   constexpr folly::StringPiece lut = "0123456789abcdef";
 445   std::array<char, 32> a;
 446   int j = 0;
 447   for (int i = 15; i >= 0; i--) {
 448     a[j] = (lut[bytes()[i] & 0xf]);
 449     a[j + 1] = (lut[bytes()[i] >> 4]);
 450     j += 2;
 451   }
 452   return sformat("{}.ip6.arpa", join(".", a));
 453 }
 454
 455 // public
 456 uint8_t IPAddressV6::getNthMSByte(size_t byteIndex) const {
 457   const auto highestIndex = byteCount() - 1;
 458   if (byteIndex > highestIndex) {
 459     throw std::invalid_argument(to<string>("Byte index must be <= ",
 460         to<string>(highestIndex), " for addresses of type :",
 461         detail::familyNameStr(AF_INET6)));
 462   }
 463   return bytes()[byteIndex];
 464 }
 465
 466 // protected
 467 const ByteArray16 IPAddressV6::fetchMask(size_t numBits) {
 468   static const size_t bits = bitCount();
 469   if (numBits > bits) {
 470     throw IPAddressFormatException("IPv6 addresses are 128 bits.");
 471   }
 472   if (numBits == 0) {
 473     return {{0}};
 474   }
 475   constexpr auto _0s = uint64_t(0);
 476   constexpr auto _1s = ~_0s;
 477   auto const fragment = Endian::big(_1s << ((128 - numBits) % 64));
 478   auto const hi = numBits <= 64 ? fragment : _1s;
 479   auto const lo = numBits <= 64 ? _0s : fragment;
 480   uint64_t const parts[] = {hi, lo};
 481   ByteArray16 arr;
 482   std::memcpy(arr.data(), parts, sizeof(parts));
 483   return arr;
 484 }
 485
 486 // public static
 487 CIDRNetworkV6 IPAddressV6::longestCommonPrefix(
 488     const CIDRNetworkV6& one,
 489     const CIDRNetworkV6& two) {
 490   auto prefix = detail::Bytes::longestCommonPrefix(
 491       one.first.addr_.bytes_, one.second, two.first.addr_.bytes_, two.second);
 492   return {IPAddressV6(prefix.first), prefix.second};
 493 }
 494
 495 // protected
 496 bool IPAddressV6::inBinarySubnet(const std::array<uint8_t, 2> addr,
 497                                  size_t numBits) const {
 498   auto masked = mask(numBits);
 499   return (std::memcmp(addr.data(), masked.bytes(), 2) == 0);
 500 }
 501 } // folly