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/Format.h>
28 #include <folly/Range.h>
29 #include <folly/IPAddressException.h>
30 #include <folly/IPAddressV4.h>
31 #include <folly/IPAddressV6.h>
32 #include <folly/detail/IPAddress.h>
39 * Pair of IPAddress, netmask
41 typedef std::pair<IPAddress, uint8_t> CIDRNetwork;
44 * Provides a unified interface for IP addresses.
46 * @note If you compare 2 IPAddress instances, v4-to-v6-mapped addresses are
47 * compared as V4 addresses.
49 * @note toLong/fromLong deal in network byte order, use toLongHBO/fromLongHBO
50 * if working in host byte order.
54 * IPAddress v4addr("192.0.2.129");
55 * IPAddress v6map("::ffff:192.0.2.129");
56 * CHECK(v4addr.inSubnet("192.0.2.0/24") ==
57 * v4addr.inSubnet(IPAddress("192.0.2.0"), 24));
58 * CHECK(v4addr.inSubnet("192.0.2.128/30"));
59 * CHECK(!v4addr.inSubnet("192.0.2.128/32"));
60 * CHECK(v4addr.asV4().toLong() == 2164392128);
61 * CHECK(v4addr.asV4().toLongHBO() == 3221226113);
62 * CHECK(v4addr.isV4());
63 * CHECK(v6addr.isV6());
64 * CHECK(v4addr == v6map);
65 * CHECK(v6map.isIPv4Mapped());
66 * CHECK(v4addr.asV4() == IPAddress::createIPv4(v6map));
67 * CHECK(IPAddress::createIPv6(v4addr) == v6map.asV6());
70 class IPAddress : boost::totally_ordered<IPAddress> {
72 // return the V4 representation of the address, converting it from V6 to V4 if
73 // needed. Note that this will throw an IPAddressFormatException if the V6
74 // address is not IPv4Mapped.
75 static IPAddressV4 createIPv4(const IPAddress& addr);
77 // return the V6 representation of the address, converting it from V4 to V6 if
79 static IPAddressV6 createIPv6(const IPAddress& addr);
82 * Create a network and mask from a CIDR formatted address string.
83 * @param [in] ipSlashCidr IP/CIDR formatted string to split
84 * @param [in] defaultCidr default value if no /N specified (if defaultCidr
85 * is -1, will use /32 for IPv4 and /128 for IPv6)
86 * @param [in] mask apply mask on the address or not,
87 * e.g. 192.168.13.46/24 => 192.168.13.0/24
88 * @throws IPAddressFormatException if invalid address
89 * @return pair with IPAddress network and uint8_t mask
91 static CIDRNetwork createNetwork(
92 StringPiece ipSlashCidr, int defaultCidr = -1, bool mask = true);
95 * Return a string representation of a CIDR block created with createNetwork.
96 * @param [in] network, pair of address and cidr
98 * @return string representing the netblock
100 static std::string networkToString(const CIDRNetwork& network) {
101 return network.first.str() + "/" + std::to_string(network.second);
105 * Create a new IPAddress instance from the provided binary data
106 * in network byte order.
107 * @throws IPAddressFormatException if len is not 4 or 16
109 static IPAddress fromBinary(ByteRange bytes);
112 * Create an IPAddress from a 32bit long (network byte order).
113 * @throws IPAddressFormatException
115 static IPAddress fromLong(uint32_t src);
116 // Same as above, but host byte order
117 static IPAddress fromLongHBO(uint32_t src);
119 // Given 2 IPAddress,mask pairs extract the longest common IPAddress,
121 static CIDRNetwork longestCommonPrefix(const CIDRNetwork& one,
122 const CIDRNetwork& two);
125 * Constructs an uninitialized IPAddress.
130 * Parse an IPAddress from a string representation.
132 * Formats accepted are exactly the same as the ones accepted by inet_pton(),
133 * using AF_INET6 if the string contains colons, and AF_INET otherwise;
134 * with the exception that the whole address can optionally be enclosed
135 * in square brackets.
137 * @throws IPAddressFormatException
139 explicit IPAddress(StringPiece ip);
142 * Create an IPAddress from a sockaddr.
143 * @throws IPAddressFormatException if nullptr or not AF_INET or AF_INET6
145 explicit IPAddress(const sockaddr* addr);
147 // Create an IPAddress from a V4 address
148 /* implicit */ IPAddress(const IPAddressV4 ipV4Addr);
149 /* implicit */ IPAddress(const in_addr addr);
151 // Create an IPAddress from a V6 address
152 /* implicit */ IPAddress(const IPAddressV6& ipV6Addr);
153 /* implicit */ IPAddress(const in6_addr& addr);
155 // Assign from V4 address
156 IPAddress& operator=(const IPAddressV4& ipV4Addr);
158 // Assign from V6 address
159 IPAddress& operator=(const IPAddressV6& ipV6Addr);
162 * Converts an IPAddress to an IPAddressV4 instance.
163 * @note This is not some handy convenience wrapper to convert an IPv4 address
164 * to a mapped IPv6 address. If you want that use
165 * IPAddress::createIPv6(addr)
166 * @throws IPAddressFormatException is not a V4 instance
168 const IPAddressV4& asV4() const {
170 auto familyName = detail::familyNameStr(family());
171 throw InvalidAddressFamilyException("Can't convert address with family ",
172 familyName, " to AF_INET address");
174 return addr_.ipV4Addr;
178 * Converts an IPAddress to an IPAddressV6 instance.
179 * @throws InvalidAddressFamilyException is not a V6 instance
181 const IPAddressV6& asV6() const {
183 auto familyName = detail::familyNameStr(family());
184 throw InvalidAddressFamilyException("Can't convert address with family ",
185 familyName, " to AF_INET6 address");
187 return addr_.ipV6Addr;
190 // Return sa_family_t of IPAddress
191 sa_family_t family() const { return family_; }
193 // Populate sockaddr_storage with an appropriate value
194 int toSockaddrStorage(sockaddr_storage *dest, uint16_t port = 0) const {
195 if (dest == nullptr) {
196 throw IPAddressFormatException("dest must not be null");
198 memset(dest, 0, sizeof(sockaddr_storage));
199 dest->ss_family = family();
201 sockaddr_in *sin = reinterpret_cast<sockaddr_in*>(dest);
202 sin->sin_addr = asV4().toAddr();
203 sin->sin_port = port;
206 sockaddr_in6 *sin = reinterpret_cast<sockaddr_in6*>(dest);
207 sin->sin6_addr = asV6().toAddr();
208 sin->sin6_port = port;
211 throw InvalidAddressFamilyException(family());
216 * Check if the address is found in the specified CIDR netblock.
218 * This will return false if the specified cidrNet is V4, but the address is
219 * V6. It will also return false if the specified cidrNet is V6 but the
220 * address is V4. This method will do the right thing in the case of a v6
223 * @note This is slower than the below counterparts. If perf is important use
224 * one of the two argument variations below.
225 * @param [in] ipSlashCidr address in "192.168.1.0/24" format
226 * @throws IPAddressFormatException if no /mask
227 * @return true if address is part of specified subnet with cidr
229 bool inSubnet(StringPiece ipSlashCidr) const;
232 * Check if an IPAddress belongs to a subnet.
233 * @param [in] subnet Subnet to check against (e.g. 192.168.1.0)
234 * @param [in] cidr CIDR for subnet (e.g. 24 for /24)
235 * @return true if address is part of specified subnet with cidr
237 bool inSubnet(const IPAddress& subnet, uint8_t cidr) const;
240 * Check if an IPAddress belongs to the subnet with the given mask.
241 * This is the same as inSubnet but the mask is provided instead of looked up
243 * @param [in] subnet Subnet to check against
244 * @param [in] mask The netmask for the subnet
245 * @return true if address is part of the specified subnet with mask
247 bool inSubnetWithMask(const IPAddress& subnet, ByteRange mask) const;
249 // @return true if address is a v4 mapped address
250 bool isIPv4Mapped() const {
251 return isV6() && asV6().isIPv4Mapped();
254 // @return true if address is uninitialized
255 bool empty() const { return (family_ == AF_UNSPEC); }
257 // @return true if address is initialized
258 explicit operator bool() { return !empty(); }
260 // @return true if this is an IPAddressV4 instance
261 bool isV4() const { return (family_ == AF_INET); }
263 // @return true if this is an IPAddressV6 instance
264 bool isV6() const { return (family_ == AF_INET6); }
266 // @return true if this address is all zeros
267 bool isZero() const {
268 return isV4() ? asV4().isZero()
272 // Number of bits in the address representation.
273 size_t bitCount() const {
274 return isV4() ? IPAddressV4::bitCount()
275 : IPAddressV6::bitCount();
277 // Number of bytes in the address representation.
278 size_t byteCount() const {
279 return bitCount() / 8;
281 //get nth most significant bit - 0 indexed
282 bool getNthMSBit(size_t bitIndex) const {
283 return detail::getNthMSBitImpl(*this, bitIndex, family());
285 //get nth most significant byte - 0 indexed
286 uint8_t getNthMSByte(size_t byteIndex) const;
287 //get nth bit - 0 indexed
288 bool getNthLSBit(size_t bitIndex) const {
289 return getNthMSBit(bitCount() - bitIndex - 1);
291 //get nth byte - 0 indexed
292 uint8_t getNthLSByte(size_t byteIndex) const {
293 return getNthMSByte(byteCount() - byteIndex - 1);
296 * Get human-readable string representation of the address.
298 * This prints a string representation of the address, for human consumption
299 * or logging. The string will take the form of a JSON object that looks like:
300 * {family:'AF_INET|AF_INET6', addr:'address', hash:long}.
302 std::string toJson() const {
303 return isV4() ? asV4().toJson()
308 std::size_t hash() const {
309 return isV4() ? asV4().hash()
313 // Return true if the address qualifies as localhost.
314 bool isLoopback() const {
315 return isV4() ? asV4().isLoopback()
316 : asV6().isLoopback();
319 // Return true if the address qualifies as broadcast.
320 bool isLinkLocalBroadcast() const {
321 return isV4() ? asV4().isLinkLocalBroadcast()
322 : asV6().isLinkLocalBroadcast();
326 * Return true if the address is a special purpose address, as per rfc6890
328 * For V6, true if the address is not in one of global scope blocks:
329 * 2000::/3, ffxe::/16.
331 bool isNonroutable() const {
332 return isV4() ? asV4().isNonroutable()
333 : asV6().isNonroutable();
337 * Return true if the address is private, as per rfc1918 and rfc4193
338 * (for example, 192.168.xxx.xxx or fc00::/7 addresses)
340 bool isPrivate() const {
341 return isV4() ? asV4().isPrivate()
342 : asV6().isPrivate();
345 // Return true if the address is a multicast address.
346 bool isMulticast() const {
347 return isV4() ? asV4().isMulticast()
348 : asV6().isMulticast();
352 * Creates IPAddress instance with all but most significant numBits set to 0.
353 * @param [in] numBits number of bits to mask
354 * @throws abort if numBits > bitCount()
355 * @return IPAddress instance with bits set to 0
357 IPAddress mask(uint8_t numBits) const {
358 return isV4() ? IPAddress(std::move(asV4().mask(numBits)))
359 : IPAddress(std::move(asV6().mask(numBits)));
363 * Provides a string representation of address.
364 * @note The string representation is calculated on demand.
365 * @throws IPAddressFormatException on inet_ntop error
367 std::string str() const {
368 return isV4() ? asV4().str()
373 * Return the fully qualified string representation of the address.
374 * For V4 addresses this is the same as calling str(). For V6 addresses
375 * this is the hex representation with : characters inserted every 4 digits.
377 std::string toFullyQualified() const {
378 return isV4() ? asV4().toFullyQualified()
379 : asV6().toFullyQualified();
382 // Address version (4 or 6)
383 uint8_t version() const {
384 return isV4() ? asV4().version()
389 * Access to address bytes, in network byte order.
391 const unsigned char* bytes() const {
392 return isV4() ? asV4().bytes() : asV6().bytes();
396 typedef union IPAddressV46 {
397 IPAddressV4 ipV4Addr;
398 IPAddressV6 ipV6Addr;
399 // default constructor
401 std::memset(this, 0, sizeof(IPAddressV46));
403 explicit IPAddressV46(const IPAddressV4& addr): ipV4Addr(addr) {}
404 explicit IPAddressV46(const IPAddressV6& addr): ipV6Addr(addr) {}
410 // boost::hash uses hash_value() so this allows boost::hash to work
411 // automatically for IPAddress
412 std::size_t hash_value(const IPAddress& addr);
413 std::ostream& operator<<(std::ostream& os, const IPAddress& addr);
414 // Define toAppend() to allow IPAddress to be used with folly::to<string>
415 void toAppend(IPAddress addr, std::string* result);
416 void toAppend(IPAddress addr, fbstring* result);
419 * Return true if two addresses are equal.
421 * @note This takes into consideration V4 mapped addresses as well. If one
422 * address is v4 mapped we compare the v4 addresses.
424 * @return true if the two addresses are equal.
426 bool operator==(const IPAddress& addr1, const IPAddress& addr2);
427 // Return true if addr1 < addr2
428 bool operator<(const IPAddress& addr1, const IPAddress& addr2);
434 struct hash<folly::IPAddress> {
435 size_t operator()(const folly::IPAddress& addr) const {