Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily Class Reference

#include <x509_ext.h>

Inheritance diagram for Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily:

Public Types
typedef std::variant< IPAddressChoice< Version::IPv4 >, IPAddressChoice< Version::IPv6 > >	AddrChoice

Public Member Functions
const AddrChoice &	addr_choice () const
uint16_t	afi () const
std::vector< uint8_t >	BER_encode () const
void	decode_from (BER_Decoder &from) override
void	encode_into (DER_Encoder &to) const override
	IPAddressFamily ()=default
	IPAddressFamily (const AddrChoice &choice, std::optional< uint8_t > safi=std::nullopt)
std::optional< uint8_t >	safi () const

Detailed Description

Definition at line 686 of file x509_ext.h.

Member Typedef Documentation

AddrChoice

typedef std::variant<IPAddressChoice<Version::IPv4>, IPAddressChoice<Version::IPv6> > Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::AddrChoice

Definition at line 688 of file x509_ext.h.

Constructor & Destructor Documentation

IPAddressFamily() [1/2]

Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::IPAddressFamily ( )

default

IPAddressFamily() [2/2]

Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::IPAddressFamily ( const AddrChoice & choice, std::optional< uint8_t > safi = std::nullopt )

inlineexplicit

Definition at line 695 of file x509_ext.h.

                                                                                                       :
                  m_safi(safi), m_ip_addr_choice(choice) {
               if(std::holds_alternative<IPAddressChoice<Version::IPv4>>(choice)) {
                  m_afi = 1;
               } else {
                  m_afi = 2;
               }
            }

References safi().

Member Function Documentation

addr_choice()

const AddrChoice & Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::addr_choice ( ) const

inline

Definition at line 708 of file x509_ext.h.

{ return m_ip_addr_choice; }

Referenced by decode_from().

afi()

uint16_t Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::afi ( ) const

inline

Definition at line 704 of file x509_ext.h.

{ return m_afi; }

BER_encode()

std::vector< uint8_t > Botan::ASN1_Object::BER_encode ( ) const

inherited

Return the encoding of this object. This is a convenience method when just one object needs to be serialized. Use DER_Encoder for complicated encodings.

Definition at line 19 of file asn1_obj.cpp.

                                                 {
   std::vector<uint8_t> output;
   DER_Encoder der(output);
   this->encode_into(der);
   return output;
}

References encode_into().

Referenced by decode_from(), Botan::Certificate_Store_In_SQL::find_all_certs(), Botan::Certificate_Store_In_SQL::find_cert(), Botan::X509_Certificate::fingerprint(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::X509_Object::PEM_encode(), Botan::PSS_Params::PSS_Params(), and Botan::Certificate_Store_In_SQL::revoke_cert().

decode_from()

void Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::decode_from ( BER_Decoder & from )

overridevirtual

Decode whatever this object is from from

Parameters

from	the BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 907 of file x509_ext.cpp.

                                                                       {
   const ASN1_Type next_tag = from.peek_next_object().type_tag();
   if(next_tag != ASN1_Type::Sequence) {
      throw Decoding_Error(fmt("Unexpected type for IPAddressFamily {}", static_cast<uint32_t>(next_tag)));
   }
 
   BER_Decoder seq_dec = from.start_sequence();
 
   std::vector<uint8_t> addr_family;
   seq_dec.decode(addr_family, ASN1_Type::OctetString);
   const size_t addr_family_length = addr_family.size();
 
   if(addr_family_length != 2 && addr_family_length != 3) {
      throw Decoding_Error("(S)AFI can only contain 2 or 3 bytes");
   }
 
   m_afi = (addr_family[0] << 8) | addr_family[1];
 
   if(addr_family_length == 3) {
      m_safi = addr_family[2];
   }
 
   if(m_afi == 1) {
      IPAddressChoice<Version::IPv4> addr_choice;
      seq_dec.decode(addr_choice);
      m_ip_addr_choice = addr_choice;
   } else if(m_afi == 2) {
      IPAddressChoice<Version::IPv6> addr_choice;
      seq_dec.decode(addr_choice);
      m_ip_addr_choice = addr_choice;
   } else {
      throw Decoding_Error("Only AFI IPv4 and IPv6 are supported.");
   }
 
   seq_dec.end_cons();
}

References addr_choice(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::fmt(), Botan::OctetString, Botan::BER_Decoder::peek_next_object(), Botan::Sequence, Botan::BER_Decoder::start_sequence(), and Botan::BER_Object::type_tag().

encode_into()

void Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::encode_into ( DER_Encoder & to ) const

overridevirtual

Encode whatever this object is into to

Parameters

to	the DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 888 of file x509_ext.cpp.

                                                                             {
   into.start_sequence();
 
   std::vector<uint8_t> afam = {get_byte<0>(m_afi), get_byte<1>(m_afi)};
 
   if(m_safi.has_value()) {
      afam.push_back(m_safi.value());
   }
 
   into.add_object(ASN1_Type::OctetString, ASN1_Class::Universal, afam);
 
   if(std::holds_alternative<IPAddressChoice<Version::IPv4>>(m_ip_addr_choice)) {
      into.encode(std::get<IPAddressChoice<Version::IPv4>>(m_ip_addr_choice));
   } else {
      into.encode(std::get<IPAddressChoice<Version::IPv6>>(m_ip_addr_choice));
   }
   into.end_cons();
}

References Botan::DER_Encoder::add_object(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::get_byte(), Botan::OctetString, Botan::DER_Encoder::start_sequence(), and Botan::Universal.

safi()

std::optional< uint8_t > Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::safi ( ) const

inline

Definition at line 706 of file x509_ext.h.

{ return m_safi; }

Referenced by IPAddressFamily().

---

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

• src/lib/x509/x509_ext.h
• src/lib/x509/x509_ext.cpp