2 * Copyright 2017 Facebook, Inc.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <folly/IPAddressV6.h>
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>
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 -_-...
37 // Alias the max size of an interface name to what posix expects.
38 #define IFNAMSIZ IF_NAMESIZE
46 // public static const
47 const uint32_t IPAddressV6::PREFIX_TEREDO = 0x20010000;
48 const uint32_t IPAddressV6::PREFIX_6TO4 = 0x2002;
51 size_t hash_value(const IPAddressV6& addr) {
54 ostream& operator<<(ostream& os, const IPAddressV6& addr) {
58 void toAppend(IPAddressV6 addr, string* result) {
59 result->append(addr.str());
61 void toAppend(IPAddressV6 addr, fbstring* result) {
62 result->append(addr.str());
65 bool IPAddressV6::validate(StringPiece ip) {
66 if (ip.size() > 0 && ip.front() == '[' && ip.back() == ']') {
67 ip = ip.subpiece(1, ip.size() - 2);
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);
76 return 1 == inet_pton(AF_INET6, ip_cstr.data(), &addr);
79 // public default constructor
80 IPAddressV6::IPAddressV6() {
83 // public string constructor
84 IPAddressV6::IPAddressV6(StringPiece addr) {
87 // Allow addresses surrounded in brackets
89 throw IPAddressFormatException(
90 sformat("Invalid IPv6 address '{}': address too short", ip));
92 if (ip.front() == '[' && ip.back() == ']') {
93 ip = ip.substr(1, ip.size() - 2);
96 struct addrinfo* result;
97 struct addrinfo hints;
98 memset(&hints, 0, sizeof(hints));
99 hints.ai_family = AF_INET6;
100 hints.ai_socktype = SOCK_STREAM;
101 hints.ai_flags = AI_NUMERICHOST;
102 if (!getaddrinfo(ip.c_str(), nullptr, &hints, &result)) {
103 struct sockaddr_in6* ipAddr = (struct sockaddr_in6*)result->ai_addr;
104 addr_.in6Addr_ = ipAddr->sin6_addr;
105 scope_ = uint16_t(ipAddr->sin6_scope_id);
106 freeaddrinfo(result);
108 throw IPAddressFormatException(sformat("Invalid IPv6 address '{}'", ip));
112 // in6_addr constructor
113 IPAddressV6::IPAddressV6(const in6_addr& src)
118 // sockaddr_in6 constructor
119 IPAddressV6::IPAddressV6(const sockaddr_in6& src)
120 : addr_(src.sin6_addr)
121 , scope_(uint16_t(src.sin6_scope_id))
125 // ByteArray16 constructor
126 IPAddressV6::IPAddressV6(const ByteArray16& src)
131 // link-local constructor
132 IPAddressV6::IPAddressV6(LinkLocalTag, MacAddress mac)
136 IPAddressV6::AddressStorage::AddressStorage(MacAddress mac) {
137 // The link-local address uses modified EUI-64 format,
138 // See RFC 4291 sections 2.5.1, 2.5.6, and Appendix A
139 const auto* macBytes = mac.bytes();
140 memcpy(&bytes_.front(), "\xfe\x80\x00\x00\x00\x00\x00\x00", 8);
141 bytes_[8] = uint8_t(macBytes[0] ^ 0x02);
142 bytes_[9] = macBytes[1];
143 bytes_[10] = macBytes[2];
146 bytes_[13] = macBytes[3];
147 bytes_[14] = macBytes[4];
148 bytes_[15] = macBytes[5];
151 Optional<MacAddress> IPAddressV6::getMacAddressFromLinkLocal() const {
152 // Returned MacAddress must be constructed from a link-local IPv6 address.
153 if (!(addr_.bytes_[0] == 0xfe && addr_.bytes_[1] == 0x80 &&
154 addr_.bytes_[2] == 0x00 && addr_.bytes_[3] == 0x00 &&
155 addr_.bytes_[4] == 0x00 && addr_.bytes_[5] == 0x00 &&
156 addr_.bytes_[6] == 0x00 && addr_.bytes_[7] == 0x00 &&
157 addr_.bytes_[11] == 0xff && addr_.bytes_[12] == 0xfe)) {
160 // The link-local address uses modified EUI-64 format,
161 // See RFC 4291 sections 2.5.1, 2.5.6, and Appendix A
162 std::array<uint8_t, MacAddress::SIZE> bytes;
163 // Step 1: first 8 bytes are fe:80:00:00:00:00:00:00, and can be stripped
164 // Step 2: invert the universal/local (U/L) flag (bit 7)
165 bytes[0] = addr_.bytes_[8] ^ 0x02;
166 // Step 3: copy thhese bytes are they are
167 bytes[1] = addr_.bytes_[9];
168 bytes[2] = addr_.bytes_[10];
169 // Step 4: strip bytes (0xfffe), which are bytes_[11] and bytes_[12]
170 // Step 5: copy the rest.
171 bytes[3] = addr_.bytes_[13];
172 bytes[4] = addr_.bytes_[14];
173 bytes[5] = addr_.bytes_[15];
174 return Optional<MacAddress>(MacAddress::fromBinary(range(bytes)));
177 void IPAddressV6::setFromBinary(ByteRange bytes) {
178 if (bytes.size() != 16) {
179 throw IPAddressFormatException(sformat(
180 "Invalid IPv6 binary data: length must be 16 bytes, got {}",
183 memcpy(&addr_.in6Addr_.s6_addr, bytes.data(), sizeof(in6_addr));
188 IPAddressV6 IPAddressV6::fromInverseArpaName(const std::string& arpaname) {
189 auto piece = StringPiece(arpaname);
190 if (!piece.removeSuffix(".ip6.arpa")) {
191 throw IPAddressFormatException(sformat(
192 "Invalid input. Should end with 'ip6.arpa'. Got '{}'", arpaname));
194 std::vector<StringPiece> pieces;
195 split(".", piece, pieces);
196 if (pieces.size() != 32) {
197 throw IPAddressFormatException(sformat("Invalid input. Got '{}'", piece));
199 std::array<char, IPAddressV6::kToFullyQualifiedSize> ip;
202 for (size_t i = 1; i <= pieces.size(); i++) {
203 ip[pos] = pieces[pieces.size() - i][0];
206 // add ':' every 4 chars
207 if (count == 4 && pos < ip.size()) {
212 return IPAddressV6(folly::range(ip));
216 IPAddressV4 IPAddressV6::createIPv4() const {
217 if (!isIPv4Mapped()) {
218 throw IPAddressFormatException("addr is not v4-to-v6-mapped");
220 const unsigned char* by = bytes();
221 return IPAddressV4(detail::Bytes::mkAddress4(&by[12]));
224 // convert two uint8_t bytes into a uint16_t as hibyte.lobyte
225 static inline uint16_t unpack(uint8_t lobyte, uint8_t hibyte) {
226 return uint16_t((uint16_t(hibyte) << 8) | lobyte);
229 // given a src string, unpack count*2 bytes into dest
230 // dest must have as much storage as count
231 static inline void unpackInto(const unsigned char* src,
234 for (size_t i = 0, hi = 1, lo = 0; i < count; i++) {
235 dest[i] = unpack(src[hi], src[lo]);
242 IPAddressV4 IPAddressV6::getIPv4For6To4() const {
244 throw IPAddressV6::TypeError(
245 sformat("Invalid IP '{}': not a 6to4 address", str()));
247 // convert 16x8 bytes into first 4x16 bytes
248 uint16_t ints[4] = {0,0,0,0};
249 unpackInto(bytes(), ints, 4);
252 unsigned char bytes[4];
255 ipv4.bytes[0] = (uint8_t)((ints[1] & 0xFF00) >> 8);
256 ipv4.bytes[1] = (uint8_t)(ints[1] & 0x00FF);
257 ipv4.bytes[2] = (uint8_t)((ints[2] & 0xFF00) >> 8);
258 ipv4.bytes[3] = (uint8_t)(ints[2] & 0x00FF);
259 return IPAddressV4(ipv4.addr);
263 bool IPAddressV6::isIPv4Mapped() const {
264 // v4 mapped addresses have their first 10 bytes set to 0, the next 2 bytes
265 // set to 255 (0xff);
266 const unsigned char* by = bytes();
268 // check if first 10 bytes are 0
269 for (int i = 0; i < 10; i++) {
274 // check if bytes 11 and 12 are 255
275 if (by[10] == 0xff && by[11] == 0xff) {
282 IPAddressV6::Type IPAddressV6::type() const {
283 // convert 16x8 bytes into first 2x16 bytes
284 uint16_t ints[2] = {0,0};
285 unpackInto(bytes(), ints, 2);
287 if ((((uint32_t)ints[0] << 16) | ints[1]) == IPAddressV6::PREFIX_TEREDO) {
291 if ((uint32_t)ints[0] == IPAddressV6::PREFIX_6TO4) {
299 string IPAddressV6::toJson() const {
300 return sformat("{{family:'AF_INET6', addr:'{}', hash:{}}}", str(), hash());
304 size_t IPAddressV6::hash() const {
305 if (isIPv4Mapped()) {
306 /* An IPAddress containing this object would be equal (i.e. operator==)
307 to an IPAddress containing the corresponding IPv4.
308 So we must make sure that the hash values are the same as well */
309 return IPAddress::createIPv4(*this).hash();
312 static const uint64_t seed = AF_INET6;
313 uint64_t hash1 = 0, hash2 = 0;
314 hash::SpookyHashV2::Hash128(&addr_, 16, &hash1, &hash2);
315 return hash::hash_combine(seed, hash1, hash2);
319 bool IPAddressV6::inSubnet(StringPiece cidrNetwork) const {
320 auto subnetInfo = IPAddress::createNetwork(cidrNetwork);
321 auto addr = subnetInfo.first;
323 throw IPAddressFormatException(
324 sformat("Address '{}' is not a V6 address", addr.toJson()));
326 return inSubnetWithMask(addr.asV6(), fetchMask(subnetInfo.second));
330 bool IPAddressV6::inSubnetWithMask(const IPAddressV6& subnet,
331 const ByteArray16& cidrMask) const {
332 const ByteArray16 mask = detail::Bytes::mask(toByteArray(), cidrMask);
333 const ByteArray16 subMask = detail::Bytes::mask(subnet.toByteArray(),
335 return (mask == subMask);
339 bool IPAddressV6::isLoopback() const {
340 // Check if v4 mapped is loopback
341 if (isIPv4Mapped() && createIPv4().isLoopback()) {
344 auto socka = toSockAddr();
345 return IN6_IS_ADDR_LOOPBACK(&socka.sin6_addr);
348 bool IPAddressV6::isRoutable() const {
350 // 2000::/3 is the only assigned global unicast block
351 inBinarySubnet({{0x20, 0x00}}, 3) ||
352 // ffxe::/16 are global scope multicast addresses,
353 // which are eligible to be routed over the internet
354 (isMulticast() && getMulticastScope() == 0xe);
357 bool IPAddressV6::isLinkLocalBroadcast() const {
358 static const IPAddressV6 kLinkLocalBroadcast("ff02::1");
359 return *this == kLinkLocalBroadcast;
363 bool IPAddressV6::isPrivate() const {
364 // Check if mapped is private
365 if (isIPv4Mapped() && createIPv4().isPrivate()) {
368 return isLoopback() || inBinarySubnet({{0xfc, 0x00}}, 7);
372 bool IPAddressV6::isLinkLocal() const {
373 return inBinarySubnet({{0xfe, 0x80}}, 10);
376 bool IPAddressV6::isMulticast() const {
377 return addr_.bytes_[0] == 0xff;
380 uint8_t IPAddressV6::getMulticastFlags() const {
381 DCHECK(isMulticast());
382 return uint8_t((addr_.bytes_[1] >> 4) & 0xf);
385 uint8_t IPAddressV6::getMulticastScope() const {
386 DCHECK(isMulticast());
387 return uint8_t(addr_.bytes_[1] & 0xf);
390 IPAddressV6 IPAddressV6::getSolicitedNodeAddress() const {
391 // Solicted node addresses must be constructed from unicast (or anycast)
393 DCHECK(!isMulticast());
395 uint8_t bytes[16] = { 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
396 0x00, 0x00, 0x00, 0x01, 0xff, 0x00, 0x00, 0x00 };
397 bytes[13] = addr_.bytes_[13];
398 bytes[14] = addr_.bytes_[14];
399 bytes[15] = addr_.bytes_[15];
400 return IPAddressV6::fromBinary(ByteRange(bytes, 16));
404 IPAddressV6 IPAddressV6::mask(size_t numBits) const {
405 static const auto bits = bitCount();
406 if (numBits > bits) {
407 throw IPAddressFormatException(
408 sformat("numBits({}) > bitCount({})", numBits, bits));
410 ByteArray16 ba = detail::Bytes::mask(fetchMask(numBits), addr_.bytes_);
411 return IPAddressV6(ba);
415 string IPAddressV6::str() const {
416 char buffer[INET6_ADDRSTRLEN + IFNAMSIZ + 1];
418 if (!inet_ntop(AF_INET6, toAddr().s6_addr, buffer, INET6_ADDRSTRLEN)) {
419 throw IPAddressFormatException(sformat(
420 "Invalid address with hex '{}' with error {}",
421 detail::Bytes::toHex(bytes(), 16),
425 auto scopeId = getScopeId();
427 auto len = strlen(buffer);
431 if (!if_indextoname(scopeId, buffer + len + 1)) {
432 // if we can't map the if because eg. it no longer exists,
433 // append the if index instead
434 snprintf(buffer + len + 1, IFNAMSIZ, "%u", scopeId);
439 return string(buffer);
443 string IPAddressV6::toFullyQualified() const {
444 return detail::fastIpv6ToString(addr_.in6Addr_);
448 void IPAddressV6::toFullyQualifiedAppend(std::string& out) const {
449 detail::fastIpv6AppendToString(addr_.in6Addr_, out);
453 string IPAddressV6::toInverseArpaName() const {
454 constexpr folly::StringPiece lut = "0123456789abcdef";
455 std::array<char, 32> a;
457 for (int i = 15; i >= 0; i--) {
458 a[j] = (lut[bytes()[i] & 0xf]);
459 a[j + 1] = (lut[bytes()[i] >> 4]);
462 return sformat("{}.ip6.arpa", join(".", a));
466 uint8_t IPAddressV6::getNthMSByte(size_t byteIndex) const {
467 const auto highestIndex = byteCount() - 1;
468 if (byteIndex > highestIndex) {
469 throw std::invalid_argument(sformat(
470 "Byte index must be <= {} for addresses of type: {}",
472 detail::familyNameStr(AF_INET6)));
474 return bytes()[byteIndex];
478 const ByteArray16 IPAddressV6::fetchMask(size_t numBits) {
479 static const size_t bits = bitCount();
480 if (numBits > bits) {
481 throw IPAddressFormatException("IPv6 addresses are 128 bits.");
486 constexpr auto _0s = uint64_t(0);
487 constexpr auto _1s = ~_0s;
488 auto const fragment = Endian::big(_1s << ((128 - numBits) % 64));
489 auto const hi = numBits <= 64 ? fragment : _1s;
490 auto const lo = numBits <= 64 ? _0s : fragment;
491 uint64_t const parts[] = {hi, lo};
493 std::memcpy(arr.data(), parts, sizeof(parts));
498 CIDRNetworkV6 IPAddressV6::longestCommonPrefix(
499 const CIDRNetworkV6& one,
500 const CIDRNetworkV6& two) {
501 auto prefix = detail::Bytes::longestCommonPrefix(
502 one.first.addr_.bytes_, one.second, two.first.addr_.bytes_, two.second);
503 return {IPAddressV6(prefix.first), prefix.second};
507 bool IPAddressV6::inBinarySubnet(const std::array<uint8_t, 2> addr,
508 size_t numBits) const {
509 auto masked = mask(numBits);
510 return (std::memcmp(addr.data(), masked.bytes(), 2) == 0);