2 * Copyright 2014 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.
23 #include <utility> // std::pair
25 #include <boost/operators.hpp>
27 #include <folly/Conv.h>
28 #include <folly/Format.h>
29 #include <folly/Range.h>
30 #include <folly/IPAddressException.h>
31 #include <folly/IPAddressV4.h>
32 #include <folly/IPAddressV6.h>
33 #include <folly/detail/IPAddress.h>
40 * Pair of IPAddress, netmask
42 typedef std::pair<IPAddress, uint8_t> CIDRNetwork;
45 * Provides a unified interface for IP addresses.
47 * @note If you compare 2 IPAddress instances, v4-to-v6-mapped addresses are
48 * compared as V4 addresses.
50 * @note toLong/fromLong deal in network byte order, use toLongHBO/fromLongHBO
51 * if working in host byte order.
55 * IPAddress v4addr("192.0.2.129");
56 * IPAddress v6map("::ffff:192.0.2.129");
57 * CHECK(v4addr.inSubnet("192.0.2.0/24") ==
58 * v4addr.inSubnet(IPAddress("192.0.2.0"), 24));
59 * CHECK(v4addr.inSubnet("192.0.2.128/30"));
60 * CHECK(!v4addr.inSubnet("192.0.2.128/32"));
61 * CHECK(v4addr.asV4().toLong() == 2164392128);
62 * CHECK(v4addr.asV4().toLongHBO() == 3221226113);
63 * CHECK(v4addr.isV4());
64 * CHECK(v6addr.isV6());
65 * CHECK(v4addr == v6map);
66 * CHECK(v6map.isIPv4Mapped());
67 * CHECK(v4addr.asV4() == IPAddress::createIPv4(v6map));
68 * CHECK(IPAddress::createIPv6(v4addr) == v6map.asV6());
71 class IPAddress : boost::totally_ordered<IPAddress> {
73 // return the V4 representation of the address, converting it from V6 to V4 if
74 // needed. Note that this will throw an IPAddressFormatException if the V6
75 // address is not IPv4Mapped.
76 static IPAddressV4 createIPv4(const IPAddress& addr);
78 // return the V6 representation of the address, converting it from V4 to V6 if
80 static IPAddressV6 createIPv6(const IPAddress& addr);
83 * Create a network and mask from a CIDR formatted address string.
84 * @param [in] ipSlashCidr IP/CIDR formatted string to split
85 * @param [in] defaultCidr default value if no /N specified (if defaultCidr
86 * is -1, will use /32 for IPv4 and /128 for IPv6)
87 * @param [in] mask apply mask on the address or not,
88 * e.g. 192.168.13.46/24 => 192.168.13.0/24
89 * @throws IPAddressFormatException if invalid address
90 * @return pair with IPAddress network and uint8_t mask
92 static CIDRNetwork createNetwork(
93 StringPiece ipSlashCidr, int defaultCidr = -1, bool mask = true);
96 * Return a string representation of a CIDR block created with createNetwork.
97 * @param [in] network, pair of address and cidr
99 * @return string representing the netblock
101 static std::string networkToString(const CIDRNetwork& network) {
102 return network.first.str() + "/" + folly::to<std::string>(network.second);
106 * Create a new IPAddress instance from the provided binary data
107 * in network byte order.
108 * @throws IPAddressFormatException if len is not 4 or 16
110 static IPAddress fromBinary(ByteRange bytes);
113 * Create an IPAddress from a 32bit long (network byte order).
114 * @throws IPAddressFormatException
116 static IPAddress fromLong(uint32_t src);
117 // Same as above, but host byte order
118 static IPAddress fromLongHBO(uint32_t src);
120 // Given 2 IPAddress,mask pairs extract the longest common IPAddress,
122 static CIDRNetwork longestCommonPrefix(const CIDRNetwork& one,
123 const CIDRNetwork& two);
126 * Constructs an uninitialized IPAddress.
131 * Parse an IPAddress from a string representation.
133 * Formats accepted are exactly the same as the ones accepted by inet_pton(),
134 * using AF_INET6 if the string contains colons, and AF_INET otherwise;
135 * with the exception that the whole address can optionally be enclosed
136 * in square brackets.
138 * @throws IPAddressFormatException
140 explicit IPAddress(StringPiece ip);
143 * Create an IPAddress from a sockaddr.
144 * @throws IPAddressFormatException if nullptr or not AF_INET or AF_INET6
146 explicit IPAddress(const sockaddr* addr);
148 // Create an IPAddress from a V4 address
149 /* implicit */ IPAddress(const IPAddressV4 ipV4Addr);
150 /* implicit */ IPAddress(const in_addr addr);
152 // Create an IPAddress from a V6 address
153 /* implicit */ IPAddress(const IPAddressV6& ipV6Addr);
154 /* implicit */ IPAddress(const in6_addr& addr);
156 // Assign from V4 address
157 IPAddress& operator=(const IPAddressV4& ipV4Addr);
159 // Assign from V6 address
160 IPAddress& operator=(const IPAddressV6& ipV6Addr);
163 * Converts an IPAddress to an IPAddressV4 instance.
164 * @note This is not some handy convenience wrapper to convert an IPv4 address
165 * to a mapped IPv6 address. If you want that use
166 * IPAddress::createIPv6(addr)
167 * @throws IPAddressFormatException is not a V4 instance
169 const IPAddressV4& asV4() const {
171 auto familyName = detail::familyNameStr(family());
172 throw InvalidAddressFamilyException("Can't convert address with family ",
173 familyName, " to AF_INET address");
175 return addr_.ipV4Addr;
179 * Converts an IPAddress to an IPAddressV6 instance.
180 * @throws InvalidAddressFamilyException is not a V6 instance
182 const IPAddressV6& asV6() const {
184 auto familyName = detail::familyNameStr(family());
185 throw InvalidAddressFamilyException("Can't convert address with family ",
186 familyName, " to AF_INET6 address");
188 return addr_.ipV6Addr;
191 // Return sa_family_t of IPAddress
192 sa_family_t family() const { return family_; }
194 // Populate sockaddr_storage with an appropriate value
195 int toSockaddrStorage(sockaddr_storage *dest, uint16_t port = 0) const {
196 if (dest == nullptr) {
197 throw IPAddressFormatException("dest must not be null");
199 memset(dest, 0, sizeof(sockaddr_storage));
200 dest->ss_family = family();
202 sockaddr_in *sin = reinterpret_cast<sockaddr_in*>(dest);
203 sin->sin_addr = asV4().toAddr();
204 sin->sin_port = port;
207 sockaddr_in6 *sin = reinterpret_cast<sockaddr_in6*>(dest);
208 sin->sin6_addr = asV6().toAddr();
209 sin->sin6_port = port;
210 sin->sin6_scope_id = asV6().getScopeId();
213 throw InvalidAddressFamilyException(family());
218 * Check if the address is found in the specified CIDR netblock.
220 * This will return false if the specified cidrNet is V4, but the address is
221 * V6. It will also return false if the specified cidrNet is V6 but the
222 * address is V4. This method will do the right thing in the case of a v6
225 * @note This is slower than the below counterparts. If perf is important use
226 * one of the two argument variations below.
227 * @param [in] ipSlashCidr address in "192.168.1.0/24" format
228 * @throws IPAddressFormatException if no /mask
229 * @return true if address is part of specified subnet with cidr
231 bool inSubnet(StringPiece ipSlashCidr) const;
234 * Check if an IPAddress belongs to a subnet.
235 * @param [in] subnet Subnet to check against (e.g. 192.168.1.0)
236 * @param [in] cidr CIDR for subnet (e.g. 24 for /24)
237 * @return true if address is part of specified subnet with cidr
239 bool inSubnet(const IPAddress& subnet, uint8_t cidr) const;
242 * Check if an IPAddress belongs to the subnet with the given mask.
243 * This is the same as inSubnet but the mask is provided instead of looked up
245 * @param [in] subnet Subnet to check against
246 * @param [in] mask The netmask for the subnet
247 * @return true if address is part of the specified subnet with mask
249 bool inSubnetWithMask(const IPAddress& subnet, ByteRange mask) const;
251 // @return true if address is a v4 mapped address
252 bool isIPv4Mapped() const {
253 return isV6() && asV6().isIPv4Mapped();
256 // @return true if address is uninitialized
257 bool empty() const { return (family_ == AF_UNSPEC); }
259 // @return true if address is initialized
260 explicit operator bool() const { return !empty(); }
262 // @return true if this is an IPAddressV4 instance
263 bool isV4() const { return (family_ == AF_INET); }
265 // @return true if this is an IPAddressV6 instance
266 bool isV6() const { return (family_ == AF_INET6); }
268 // @return true if this address is all zeros
269 bool isZero() const {
270 return isV4() ? asV4().isZero()
274 // Number of bits in the address representation.
275 size_t bitCount() const {
276 return isV4() ? IPAddressV4::bitCount()
277 : IPAddressV6::bitCount();
279 // Number of bytes in the address representation.
280 size_t byteCount() const {
281 return bitCount() / 8;
283 //get nth most significant bit - 0 indexed
284 bool getNthMSBit(size_t bitIndex) const {
285 return detail::getNthMSBitImpl(*this, bitIndex, family());
287 //get nth most significant byte - 0 indexed
288 uint8_t getNthMSByte(size_t byteIndex) const;
289 //get nth bit - 0 indexed
290 bool getNthLSBit(size_t bitIndex) const {
291 return getNthMSBit(bitCount() - bitIndex - 1);
293 //get nth byte - 0 indexed
294 uint8_t getNthLSByte(size_t byteIndex) const {
295 return getNthMSByte(byteCount() - byteIndex - 1);
298 * Get human-readable string representation of the address.
300 * This prints a string representation of the address, for human consumption
301 * or logging. The string will take the form of a JSON object that looks like:
302 * {family:'AF_INET|AF_INET6', addr:'address', hash:long}.
304 std::string toJson() const {
305 return isV4() ? asV4().toJson()
310 std::size_t hash() const {
311 return isV4() ? asV4().hash()
315 // Return true if the address qualifies as localhost.
316 bool isLoopback() const {
317 return isV4() ? asV4().isLoopback()
318 : asV6().isLoopback();
321 // Return true if the address qualifies as broadcast.
322 bool isLinkLocalBroadcast() const {
323 return isV4() ? asV4().isLinkLocalBroadcast()
324 : asV6().isLinkLocalBroadcast();
328 * Return true if the address is a special purpose address, as per rfc6890
330 * For V6, true if the address is not in one of global scope blocks:
331 * 2000::/3, ffxe::/16.
333 bool isNonroutable() const {
334 return isV4() ? asV4().isNonroutable()
335 : asV6().isNonroutable();
339 * Return true if the address is private, as per rfc1918 and rfc4193
340 * (for example, 192.168.xxx.xxx or fc00::/7 addresses)
342 bool isPrivate() const {
343 return isV4() ? asV4().isPrivate()
344 : asV6().isPrivate();
347 // Return true if the address is a multicast address.
348 bool isMulticast() const {
349 return isV4() ? asV4().isMulticast()
350 : asV6().isMulticast();
354 * Creates IPAddress instance with all but most significant numBits set to 0.
355 * @param [in] numBits number of bits to mask
356 * @throws abort if numBits > bitCount()
357 * @return IPAddress instance with bits set to 0
359 IPAddress mask(uint8_t numBits) const {
360 return isV4() ? IPAddress(std::move(asV4().mask(numBits)))
361 : IPAddress(std::move(asV6().mask(numBits)));
365 * Provides a string representation of address.
366 * @note The string representation is calculated on demand.
367 * @throws IPAddressFormatException on inet_ntop error
369 std::string str() const {
370 return isV4() ? asV4().str()
375 * Return the fully qualified string representation of the address.
376 * For V4 addresses this is the same as calling str(). For V6 addresses
377 * this is the hex representation with : characters inserted every 4 digits.
379 std::string toFullyQualified() const {
380 return isV4() ? asV4().toFullyQualified()
381 : asV6().toFullyQualified();
384 // Address version (4 or 6)
385 uint8_t version() const {
386 return isV4() ? asV4().version()
391 * Access to address bytes, in network byte order.
393 const unsigned char* bytes() const {
394 return isV4() ? asV4().bytes() : asV6().bytes();
398 typedef union IPAddressV46 {
399 IPAddressV4 ipV4Addr;
400 IPAddressV6 ipV6Addr;
401 // default constructor
403 std::memset(this, 0, sizeof(IPAddressV46));
405 explicit IPAddressV46(const IPAddressV4& addr): ipV4Addr(addr) {}
406 explicit IPAddressV46(const IPAddressV6& addr): ipV6Addr(addr) {}
412 // boost::hash uses hash_value() so this allows boost::hash to work
413 // automatically for IPAddress
414 std::size_t hash_value(const IPAddress& addr);
415 std::ostream& operator<<(std::ostream& os, const IPAddress& addr);
416 // Define toAppend() to allow IPAddress to be used with folly::to<string>
417 void toAppend(IPAddress addr, std::string* result);
418 void toAppend(IPAddress addr, fbstring* result);
421 * Return true if two addresses are equal.
423 * @note This takes into consideration V4 mapped addresses as well. If one
424 * address is v4 mapped we compare the v4 addresses.
426 * @return true if the two addresses are equal.
428 bool operator==(const IPAddress& addr1, const IPAddress& addr2);
429 // Return true if addr1 < addr2
430 bool operator<(const IPAddress& addr1, const IPAddress& addr2);
436 struct hash<folly::IPAddress> {
437 size_t operator()(const folly::IPAddress& addr) const {