Botan::IPv6Address Class Reference

#include <ipv6_address.h>

Public Member Functions
std::span< const uint8_t, 16 >	address () const
std::optional< IPv4Address >	as_ipv4 () const
	IPv6Address (std::array< uint8_t, 16 > ip)
	IPv6Address (std::span< const uint8_t, 16 > ip)
IPv6Address	operator& (const IPv6Address &other) const
auto	operator<=> (const IPv6Address &) const =default
std::optional< size_t >	prefix_length () const
std::string	to_string () const

Static Public Member Functions
static std::optional< IPv6Address >	from_string (std::string_view str)
static IPv6Address	host_mask ()
static IPv6Address	netmask (size_t bits)

Detailed Description

IPv6 Address

Definition at line 25 of file ipv6_address.h.

Constructor & Destructor Documentation

IPv6Address() [1/2]

Botan::IPv6Address::IPv6Address ( std::span< const uint8_t, 16 > ip )

explicit

Definition at line 17 of file ipv6_address.cpp.

                                                      : m_ip{} {
   for(size_t i = 0; i != 16; ++i) {
      m_ip[i] = ip[i];
   }
}

Referenced by from_string(), host_mask(), netmask(), operator&(), and operator<=>().

IPv6Address() [2/2]

Botan::IPv6Address::IPv6Address ( std::array< uint8_t, 16 > ip )

inlineexplicit

Definition at line 29 of file ipv6_address.h.

: m_ip(ip) {}

Member Function Documentation

address()

std::span< const uint8_t, 16 > Botan::IPv6Address::address ( ) const

inline

Definition at line 45 of file ipv6_address.h.

{ return m_ip; }

Referenced by Botan::IPv6Subnet::serialize().

as_ipv4()

std::optional< IPv4Address > Botan::IPv6Address::as_ipv4

(

)

const

If this IPv6 address is an IPv4-compatible IPv6 address (RFC 4291 2.5.5.1) or an IPv4-mapped IPv6 address (RFC 4291 2.5.5.2), return the embedded IPv4 address.

Definition at line 81 of file ipv6_address.cpp.

                                                    {
   const uint32_t ip0 = load_be<uint32_t>(m_ip.data(), 0);
   const uint32_t ip1 = load_be<uint32_t>(m_ip.data(), 1);
   const uint32_t ip2 = load_be<uint32_t>(m_ip.data(), 2);
   const uint32_t ip3 = load_be<uint32_t>(m_ip.data(), 3);
 
   if(ip0 == 0x00000000 && ip1 == 0x00000000 && (ip2 == 0x00000000 || ip2 == 0x0000FFFF)) {
      return IPv4Address(ip3);
   } else {
      return {};
   }
}

References Botan::load_be().

from_string()

std::optional< IPv6Address > Botan::IPv6Address::from_string ( std::string_view str )

static

Definition at line 24 of file ipv6_address.cpp.

                                                                    {
   if(auto ipv6 = string_to_ipv6(str)) {
      return IPv6Address(*ipv6);
   } else {
      return {};
   }
}

References IPv6Address(), and Botan::string_to_ipv6().

Referenced by Botan::IPv6Subnet::from_string(), and Botan::X509_Certificate::matches_dns_name().

host_mask()

IPv6Address Botan::IPv6Address::host_mask ( )

inlinestatic

Definition at line 39 of file ipv6_address.h.

{ return netmask(128); }

References IPv6Address(), and netmask().

netmask()

IPv6Address Botan::IPv6Address::netmask ( size_t bits )

static

Return an address with the leading bits set to one and the remainder zero. Throws Invalid_Argument if bits > 128.

Definition at line 33 of file ipv6_address.cpp.

                                            {
   BOTAN_ARG_CHECK(bits <= 128, "IPv6 netmask prefix length must be at most 128");
 
   const size_t full_bytes = bits / 8;
   const size_t leftover = bits % 8;
 
   std::array<uint8_t, 16> m{};
   for(size_t i = 0; i != full_bytes; ++i) {
      m[i] = 0xFF;
   }
 
   if(leftover > 0) {
      m[full_bytes] = static_cast<uint8_t>(0xFF << (8 - leftover));
   }
 
   return IPv6Address(m);
}

References BOTAN_ARG_CHECK, and IPv6Address().

Referenced by Botan::IPv6Subnet::contains(), host_mask(), prefix_length(), and Botan::IPv6Subnet::serialize().

operator&()

IPv6Address Botan::IPv6Address::operator&

(

const IPv6Address &

other

)

const

Definition at line 55 of file ipv6_address.cpp.

                                                                 {
   std::array<uint8_t, 16> masked{};
   for(size_t i = 0; i != 16; ++i) {
      masked[i] = m_ip[i] & other.m_ip[i];
   }
   return IPv6Address(masked);
}

References IPv6Address().

operator<=>()

auto Botan::IPv6Address::operator<=> ( const IPv6Address & ) const

default

References IPv6Address().

prefix_length()

std::optional< size_t > Botan::IPv6Address::prefix_length

(

)

const

If this value is a netmask consisting of a run of one bits followed by a run of zero bits, return the number of one bits.

Otherwise return nullopt.

Definition at line 63 of file ipv6_address.cpp.

                                                     {
   // Count leading one bits, stopping at the first byte that isn't fully set.
   size_t leading = 0;
   for(size_t i = 0; i != 16; ++i) {
      const size_t hw = (m_ip[i] == 0xFF) ? 8 : std::countl_one(m_ip[i]);
      leading += hw;
      if(hw != 8) {
         break;
      }
   }
 
   // Verify this is exactly equal to a netmask of that size
   if(*this != netmask(leading)) {
      return std::nullopt;
   }
   return leading;
}

References netmask().

to_string()

std::string Botan::IPv6Address::to_string

(

)

const

Definition at line 51 of file ipv6_address.cpp.

                                       {
   return ipv6_to_string(m_ip);
}

References Botan::ipv6_to_string().

---

The documentation for this class was generated from the following files:

• src/lib/utils/ip_address/ipv6_address.h
• src/lib/utils/ip_address/ipv6_address.cpp