2017-08-11 08:41:58 +02:00
|
|
|
/*
|
2020-11-30 21:33:10 +01:00
|
|
|
* Copyright 2012-2020 Max Kellermann <max.kellermann@gmail.com>
|
2017-08-11 08:41:58 +02:00
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
*
|
|
|
|
* - Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
*
|
|
|
|
* - Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the
|
|
|
|
* distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
|
|
* FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
|
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef IPV4_ADDRESS_HXX
|
|
|
|
#define IPV4_ADDRESS_HXX
|
|
|
|
|
|
|
|
#include "SocketAddress.hxx"
|
2019-03-08 10:21:10 +01:00
|
|
|
#include "util/ByteOrder.hxx"
|
2017-08-11 08:41:58 +02:00
|
|
|
|
2020-03-13 01:08:53 +01:00
|
|
|
#include <cstdint>
|
2017-08-11 08:41:58 +02:00
|
|
|
|
|
|
|
#ifdef _WIN32
|
|
|
|
#include <winsock2.h>
|
|
|
|
#include <ws2tcpip.h>
|
|
|
|
#else
|
|
|
|
#include <netinet/in.h>
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* An OO wrapper for struct sockaddr_in.
|
|
|
|
*/
|
|
|
|
class IPv4Address {
|
|
|
|
struct sockaddr_in address;
|
|
|
|
|
2018-08-20 15:48:49 +02:00
|
|
|
#ifdef _WIN32
|
2017-08-11 08:41:58 +02:00
|
|
|
static constexpr struct in_addr ConstructInAddr(uint8_t a, uint8_t b,
|
2018-08-20 15:43:35 +02:00
|
|
|
uint8_t c, uint8_t d) noexcept {
|
2019-01-14 19:21:07 +01:00
|
|
|
struct in_addr result{};
|
|
|
|
result.s_net = a;
|
|
|
|
result.s_host = b;
|
|
|
|
result.s_lh = c;
|
|
|
|
result.s_impno = d;
|
|
|
|
return result;
|
2017-08-11 08:41:58 +02:00
|
|
|
}
|
|
|
|
#else
|
|
|
|
|
|
|
|
#ifdef __BIONIC__
|
|
|
|
typedef uint32_t in_addr_t;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
static constexpr in_addr_t ConstructInAddrT(uint8_t a, uint8_t b,
|
2018-08-20 15:43:35 +02:00
|
|
|
uint8_t c, uint8_t d) noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return ToBE32((a << 24) | (b << 16) | (c << 8) | d);
|
|
|
|
}
|
|
|
|
|
2018-11-02 17:47:43 +01:00
|
|
|
static constexpr struct in_addr ConstructInAddr(uint8_t a, uint8_t b,
|
|
|
|
uint8_t c, uint8_t d) noexcept {
|
2019-01-14 19:21:07 +01:00
|
|
|
return ConstructInAddrBE(ConstructInAddrT(a, b, c, d));
|
2018-11-02 17:47:43 +01:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2018-08-20 15:47:53 +02:00
|
|
|
/**
|
|
|
|
* @param x the 32 bit IP address in network byte order
|
|
|
|
*/
|
|
|
|
static constexpr struct in_addr ConstructInAddrBE(uint32_t x) noexcept {
|
2018-11-02 17:47:43 +01:00
|
|
|
struct in_addr ia{};
|
|
|
|
ia.s_addr = x;
|
|
|
|
return ia;
|
2018-08-20 15:47:53 +02:00
|
|
|
}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param x the 32 bit IP address in host byte order
|
|
|
|
*/
|
2018-08-20 15:43:35 +02:00
|
|
|
static constexpr struct in_addr ConstructInAddr(uint32_t x) noexcept {
|
2018-08-20 15:47:53 +02:00
|
|
|
return ConstructInAddrBE(ToBE32(x));
|
2017-08-11 08:41:58 +02:00
|
|
|
}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param port the port number in host byte order
|
|
|
|
*/
|
2017-08-11 08:41:58 +02:00
|
|
|
static constexpr struct sockaddr_in Construct(struct in_addr address,
|
2018-08-20 15:43:35 +02:00
|
|
|
uint16_t port) noexcept {
|
2018-11-02 17:47:43 +01:00
|
|
|
struct sockaddr_in sin{};
|
|
|
|
sin.sin_family = AF_INET;
|
|
|
|
sin.sin_port = ToBE16(port);
|
|
|
|
sin.sin_addr = address;
|
|
|
|
return sin;
|
2017-08-11 08:41:58 +02:00
|
|
|
}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param x the 32 bit IP address in host byte order
|
|
|
|
* @param port the port number in host byte order
|
|
|
|
*/
|
2017-08-11 08:41:58 +02:00
|
|
|
static constexpr struct sockaddr_in Construct(uint32_t address,
|
2018-08-20 15:43:35 +02:00
|
|
|
uint16_t port) noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return Construct(ConstructInAddr(address), port);
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
|
|
|
IPv4Address() = default;
|
|
|
|
|
2018-08-20 15:53:06 +02:00
|
|
|
constexpr IPv4Address(const struct sockaddr_in &_address) noexcept
|
|
|
|
:address(_address) {}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param port the port number in host byte order
|
|
|
|
*/
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr IPv4Address(struct in_addr _address, uint16_t port) noexcept
|
2018-08-20 15:53:06 +02:00
|
|
|
:IPv4Address(Construct(_address, port)) {}
|
2017-08-11 08:41:58 +02:00
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param port the port number in host byte order
|
|
|
|
*/
|
2017-08-11 08:41:58 +02:00
|
|
|
constexpr IPv4Address(uint8_t a, uint8_t b, uint8_t c,
|
2018-08-20 15:43:35 +02:00
|
|
|
uint8_t d, uint16_t port) noexcept
|
2017-08-11 08:41:58 +02:00
|
|
|
:IPv4Address(ConstructInAddr(a, b, c, d), port) {}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param port the port number in host byte order
|
|
|
|
*/
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr explicit IPv4Address(uint16_t port) noexcept
|
2017-08-11 08:41:58 +02:00
|
|
|
:IPv4Address(ConstructInAddr(INADDR_ANY), port) {}
|
|
|
|
|
|
|
|
/**
|
2018-08-20 15:50:25 +02:00
|
|
|
* Construct with data copied from a #SocketAddress. Its
|
|
|
|
* address family must be AF_INET.
|
2017-08-11 08:41:58 +02:00
|
|
|
*/
|
2018-08-20 15:43:35 +02:00
|
|
|
explicit IPv4Address(SocketAddress src) noexcept;
|
2017-08-11 08:41:58 +02:00
|
|
|
|
2018-08-20 15:43:35 +02:00
|
|
|
static constexpr struct in_addr Loopback() noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return ConstructInAddr(INADDR_LOOPBACK);
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:55:24 +02:00
|
|
|
/**
|
|
|
|
* Generate a (net-)mask with the specified prefix length.
|
|
|
|
*/
|
|
|
|
static constexpr IPv4Address MaskFromPrefix(unsigned prefix_length) noexcept {
|
|
|
|
return Construct(prefix_length == 0
|
|
|
|
? 0
|
|
|
|
: (~uint32_t(0)) << (32 - prefix_length),
|
|
|
|
~uint16_t(0));
|
|
|
|
}
|
|
|
|
|
2020-11-30 21:33:10 +01:00
|
|
|
/**
|
|
|
|
* Cast a #sockaddr_in6 reference to an IPv6Address reference.
|
|
|
|
*/
|
|
|
|
static constexpr const IPv4Address &Cast(const struct sockaddr_in &src) noexcept {
|
|
|
|
/* this reinterpret_cast works because this class is
|
|
|
|
just a wrapper for struct sockaddr_in6 */
|
|
|
|
return *(const IPv4Address *)(const void *)&src;
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:55:24 +02:00
|
|
|
/**
|
|
|
|
* Return a downcasted reference to the address. This call is
|
|
|
|
* only legal after verifying SocketAddress::GetFamily().
|
|
|
|
*/
|
2020-11-30 21:30:39 +01:00
|
|
|
static constexpr const IPv4Address &Cast(const SocketAddress src) noexcept {
|
2018-08-20 15:55:24 +02:00
|
|
|
/* this reinterpret_cast works because this class is
|
2019-01-20 20:59:43 +01:00
|
|
|
just a wrapper for struct sockaddr_in */
|
2018-08-20 15:55:24 +02:00
|
|
|
return *(const IPv4Address *)(const void *)src.GetAddress();
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr operator SocketAddress() const noexcept {
|
2019-04-03 16:59:53 +02:00
|
|
|
return SocketAddress((const struct sockaddr *)(const void *)&address,
|
2017-08-11 08:41:58 +02:00
|
|
|
sizeof(address));
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr SocketAddress::size_type GetSize() const noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return sizeof(address);
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr bool IsDefined() const noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return address.sin_family != AF_UNSPEC;
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @return the port number in host byte order
|
|
|
|
*/
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr uint16_t GetPort() const noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return FromBE16(address.sin_port);
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:50:25 +02:00
|
|
|
/**
|
|
|
|
* @param port the port number in host byte order
|
|
|
|
*/
|
2018-08-20 15:43:35 +02:00
|
|
|
void SetPort(uint16_t port) noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
address.sin_port = ToBE16(port);
|
|
|
|
}
|
|
|
|
|
2018-08-20 15:43:35 +02:00
|
|
|
constexpr const struct in_addr &GetAddress() const noexcept {
|
2017-08-11 08:41:58 +02:00
|
|
|
return address.sin_addr;
|
|
|
|
}
|
2018-08-20 15:55:24 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the 32 bit IP address in network byte order
|
|
|
|
*/
|
|
|
|
constexpr uint32_t GetNumericAddressBE() const noexcept {
|
|
|
|
return GetAddress().s_addr;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the 32 bit IP address in host byte order
|
|
|
|
*/
|
|
|
|
constexpr uint32_t GetNumericAddress() const noexcept {
|
|
|
|
return FromBE32(GetNumericAddressBE());
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Bit-wise AND of two addresses. This is useful for netmask
|
|
|
|
* calculations.
|
|
|
|
*/
|
|
|
|
constexpr IPv4Address operator&(const IPv4Address &other) const noexcept {
|
|
|
|
return IPv4Address(ConstructInAddrBE(GetNumericAddressBE() & other.GetNumericAddressBE()),
|
|
|
|
GetPort() & other.GetPort());
|
|
|
|
}
|
2017-08-11 08:41:58 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|