Botan::AlternativeName Class Reference

#include <pkix_types.h>

Inheritance diagram for Botan::AlternativeName:

Public Member Functions
void	add_attribute (std::string_view type, std::string_view value)
void	add_dn (const X509_DN &dn)
	Add a directory name to this AlternativeName.
void	add_dns (std::string_view dns)
	Add a DNS name to this AlternativeName.
void	add_email (std::string_view addr)
	Add a URI to this AlternativeName.
void	add_ipv4_address (IPv4Address ipv4)
	Add an IP address to this alternative name.
void	add_ipv4_address (uint32_t ipv4)
	Add an IP address to this alternative name.
void	add_ipv6_address (const IPv6Address &ipv6)
	Add an IPv6 address to this alternative name.
void	add_other_name (const OID &oid, const ASN1_String &value)
	Add an "OtherName" identified by object identifier to this AlternativeName.
void	add_othername (const OID &oid, std::string_view value, ASN1_Type type)
void	add_uri (std::string_view uri)
	Add a URI to this AlternativeName.
	AlternativeName ()=default
	Create an empty name.
BOTAN_FUTURE_EXPLICIT	AlternativeName (std::string_view email_addr, std::string_view uri="", std::string_view dns="", std::string_view ip_address="")
std::vector< uint8_t >	BER_encode () const
std::multimap< std::string, std::string >	contents () const
size_t	count () const
void	decode_from (BER_Decoder &from) override
const std::set< X509_DN > &	directory_names () const
	Return the set of directory names included in this alternative name.
X509_DN	dn () const
const std::set< std::string > &	dns () const
	Return the set of DNS names included in this alternative name.
const std::set< std::string > &	email () const
	Return the set of email addresses included in this alternative name.
void	encode_into (DER_Encoder &to) const override
std::vector< std::string >	get_attribute (std::string_view attr) const
std::multimap< std::string, std::string, std::less<> >	get_attributes () const
std::string	get_first_attribute (std::string_view attr) const
std::multimap< OID, ASN1_String >	get_othernames () const
bool	has_field (std::string_view attr) const
bool	has_items () const
	Return true if this has any names set.
const std::set< uint32_t > &	ipv4_address () const
	Return the set of IPv4 addresses included in this alternative name.
const std::set< IPv6Address > &	ipv6_address () const
	Return the set of IPv6 addresses included in this alternative name.
const std::set< std::pair< OID, ASN1_String > > &	other_names () const
	Return the set of "other names" included in this alternative name.
const std::set< std::string > &	uris () const
	Return the set of URIs included in this alternative name.

Detailed Description

Alternative Name

Definition at line 144 of file pkix_types.h.

Constructor & Destructor Documentation

AlternativeName() [1/2]

Botan::AlternativeName::AlternativeName ( )

default

Create an empty name.

References add_dn(), add_dns(), add_email(), add_ipv4_address(), add_other_name(), add_uri(), dn(), and dns().

Referenced by get_othernames().

AlternativeName() [2/2]

Botan::AlternativeName::AlternativeName	(	std::string_view	email_addr,
		std::string_view	uri = "",
		std::string_view	dns = "",
		std::string_view	ip_address = "" )

Definition at line 20 of file asn1_alt_name.cpp.

                                                    {
   if(!email_addr.empty()) {
      add_email(email_addr);
   }
   if(!dns.empty()) {
      add_dns(dns);
   }
   if(!uri.empty()) {
      add_uri(uri);
   }
   if(!ip.empty()) {
      if(auto ipv4 = string_to_ipv4(ip)) {
         add_ipv4_address(*ipv4);
      } else {
         throw Invalid_Argument(fmt("Invalid IPv4 address '{}'", ip));
      }
   }
}

References add_dns(), add_email(), add_ipv4_address(), add_uri(), dns(), Botan::fmt(), and Botan::string_to_ipv4().

Member Function Documentation

add_attribute()

void Botan::AlternativeName::add_attribute	(	std::string_view	type,
		std::string_view	value )

Definition at line 45 of file asn1_alt_name.cpp.

                                                                             {
   if(type.empty() || value.empty()) {
      return;
   }
 
   if(type == "DNS") {
      this->add_dns(value);
   } else if(type == "RFC822") {
      this->add_email(value);
   } else if(type == "URI") {
      this->add_uri(value);
   } else if(type == "DN") {
      X509_DN dn;
      std::istringstream ss{std::string(value)};
      ss >> dn;
      this->add_dn(dn);
   } else if(type == "IP") {
      if(auto ipv4 = string_to_ipv4(value)) {
         add_ipv4_address(*ipv4);
      } else {
         throw Invalid_Argument(fmt("Invalid IPv4 address '{}'", value));
      }
   } else {
      throw Not_Implemented(fmt("Unknown AlternativeName name type {}", type));
   }
}

References add_dn(), add_dns(), add_email(), add_ipv4_address(), add_uri(), dn(), Botan::fmt(), and Botan::string_to_ipv4().

add_dn()

void Botan::AlternativeName::add_dn

(

const X509_DN &

dn

)

Add a directory name to this AlternativeName.

Definition at line 39 of file alt_name.cpp.

                                              {
   m_dn_names.insert(dn);
}

References dn().

Referenced by add_attribute(), AlternativeName(), and decode_from().

add_dns()

void Botan::AlternativeName::add_dns

(

std::string_view

dns

)

Add a DNS name to this AlternativeName.

Definition at line 29 of file alt_name.cpp.

                                                {
   if(!dns.empty()) {
      m_dns.insert(tolower_string(dns));
   }
}

References dns(), and Botan::tolower_string().

Referenced by add_attribute(), AlternativeName(), and AlternativeName().

add_email()

void Botan::AlternativeName::add_email

(

std::string_view

addr

)

Add a URI to this AlternativeName.

Definition at line 23 of file alt_name.cpp.

                                                   {
   if(!addr.empty()) {
      m_email.insert(std::string(addr));
   }
}

Referenced by add_attribute(), AlternativeName(), AlternativeName(), and decode_from().

add_ipv4_address() [1/2]

void Botan::AlternativeName::add_ipv4_address ( IPv4Address ipv4 )

inline

Add an IP address to this alternative name.

Definition at line 171 of file pkix_types.h.

{ add_ipv4_address(ipv4.value()); }

References add_ipv4_address(), and Botan::IPv4Address::value().

Referenced by add_ipv4_address().

add_ipv4_address() [2/2]

void Botan::AlternativeName::add_ipv4_address

(

uint32_t

ipv4

)

Add an IP address to this alternative name.

Definition at line 43 of file alt_name.cpp.

                                                  {
   m_ipv4_addr.insert(ip);
}

Referenced by add_attribute(), AlternativeName(), AlternativeName(), and decode_from().

add_ipv6_address()

void Botan::AlternativeName::add_ipv6_address

(

const IPv6Address &

ipv6

)

Add an IPv6 address to this alternative name.

Definition at line 47 of file alt_name.cpp.

                                                            {
   m_ipv6_addr.insert(ip);
}

Referenced by decode_from().

add_other_name()

void Botan::AlternativeName::add_other_name	(	const OID &	oid,
		const ASN1_String &	value )

Add an "OtherName" identified by object identifier to this AlternativeName.

Definition at line 35 of file alt_name.cpp.

                                                                             {
   m_othernames.insert(std::make_pair(oid, value));
}

Referenced by add_othername(), and AlternativeName().

add_othername()

void Botan::AlternativeName::add_othername	(	const OID &	oid,
		std::string_view	value,
		ASN1_Type	type )

Definition at line 75 of file asn1_alt_name.cpp.

                                                                                        {
   if(value.empty()) {
      return;
   }
   this->add_other_name(oid, ASN1_String(value, type));
}

References add_other_name().

Referenced by decode_from().

add_uri()

void Botan::AlternativeName::add_uri

(

std::string_view

uri

)

Add a URI to this AlternativeName.

Definition at line 17 of file alt_name.cpp.

                                                {
   if(!uri.empty()) {
      m_uri.insert(std::string(uri));
   }
}

Referenced by add_attribute(), AlternativeName(), AlternativeName(), and decode_from().

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 20 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().

contents()

std::multimap< std::string, std::string > Botan::AlternativeName::contents

(

)

const

Definition at line 85 of file asn1_alt_name.cpp.

                                                                  {
   std::multimap<std::string, std::string> names;
 
   for(const auto& nm : this->dns()) {
      names.emplace("DNS", nm);
   }
 
   for(const auto& nm : this->email()) {
      names.emplace("RFC822", nm);
   }
 
   for(const auto& nm : this->uris()) {
      names.emplace("URI", nm);
   }
 
   for(const uint32_t ipv4 : this->ipv4_address()) {
      names.emplace("IP", ipv4_to_string(ipv4));
   }
 
   for(const auto& ipv6 : this->ipv6_address()) {
      names.emplace("IPv6", ipv6.to_string());
   }
 
   for(const auto& nm : this->directory_names()) {
      names.emplace("DN", nm.to_string());
   }
 
   for(const auto& othername : this->other_names()) {
      names.emplace(othername.first.to_formatted_string(), othername.second.value());
   }
 
   return names;
}

References directory_names(), dns(), email(), ipv4_address(), Botan::ipv4_to_string(), ipv6_address(), other_names(), and uris().

Referenced by get_attributes().

count()

size_t Botan::AlternativeName::count

(

)

const

Return the total number of names in this AlternativeName

This only counts names which were parsed, ignoring names which were of some unknown type

Definition at line 51 of file alt_name.cpp.

                                    {
   const auto sum = checked_add(m_dns.size(),
                                m_uri.size(),
                                m_email.size(),
                                m_ipv4_addr.size(),
                                m_ipv6_addr.size(),
                                m_dn_names.size(),
                                m_othernames.size());
 
   BOTAN_ASSERT_NOMSG(sum.has_value());
   return sum.value();
}

References BOTAN_ASSERT_NOMSG, and Botan::checked_add().

Referenced by has_items(), and Botan::GeneralName::matches().

decode_from()

void Botan::AlternativeName::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 126 of file alt_name.cpp.

                                                     {
   BER_Decoder names = source.start_sequence();
 
   while(names.more_items()) {
      const BER_Object obj = names.get_next_object();
 
      if(obj.is_a(0, ASN1_Class::ExplicitContextSpecific)) {
         BER_Decoder othername(obj, names.limits());
 
         OID oid;
         othername.decode(oid);
         if(othername.more_items()) {
            const BER_Object othername_value_outer = othername.get_next_object();
            othername.verify_end();
 
            if(!othername_value_outer.is_a(0, ASN1_Class::ExplicitContextSpecific)) {
               throw Decoding_Error("Invalid tags on otherName value");
            }
 
            BER_Decoder othername_value_inner(othername_value_outer, names.limits());
 
            const BER_Object value = othername_value_inner.get_next_object();
            othername_value_inner.verify_end();
 
            if(ASN1_String::is_string_type(value.type()) && value.get_class() == ASN1_Class::Universal) {
               add_othername(oid, ASN1::to_string(value), value.type());
            }
         }
      } else if(obj.is_a(1, ASN1_Class::ContextSpecific)) {
         add_email(ASN1::to_string(obj));
      } else if(obj.is_a(2, ASN1_Class::ContextSpecific)) {
         m_dns.insert(check_and_canonicalize_dns_name(ASN1::to_string(obj)));
      } else if(obj.is_a(4, ASN1_Class::ContextSpecific | ASN1_Class::Constructed)) {
         BER_Decoder dec(obj, names.limits());
         X509_DN dn;
         dec.decode(dn);
         this->add_dn(dn);
      } else if(obj.is_a(6, ASN1_Class::ContextSpecific)) {
         this->add_uri(ASN1::to_string(obj));
      } else if(obj.is_a(7, ASN1_Class::ContextSpecific)) {
         if(obj.length() == 4) {
            const uint32_t ip = load_be<uint32_t>(obj.bits(), 0);
            this->add_ipv4_address(ip);
         } else if(obj.length() == 16) {
            const IPv6Address ip(std::span<const uint8_t, 16>{obj.bits(), 16});
            this->add_ipv6_address(ip);
         } else {
            throw Decoding_Error("Invalid IP constraint neither IPv4 or IPv6");
         }
      }
   }
}

References add_dn(), add_email(), add_ipv4_address(), add_ipv6_address(), add_othername(), add_uri(), Botan::BER_Object::bits(), Botan::check_and_canonicalize_dns_name(), Botan::Constructed, Botan::ContextSpecific, Botan::BER_Decoder::decode(), dn(), Botan::ExplicitContextSpecific, Botan::BER_Object::get_class(), Botan::BER_Decoder::get_next_object(), Botan::BER_Object::is_a(), Botan::ASN1_String::is_string_type(), Botan::BER_Object::length(), Botan::BER_Decoder::limits(), Botan::load_be(), Botan::BER_Decoder::more_items(), Botan::BER_Decoder::start_sequence(), Botan::ASN1::to_string(), Botan::BER_Object::type(), Botan::Universal, and Botan::BER_Decoder::verify_end().

directory_names()

const std::set< X509_DN > & Botan::AlternativeName::directory_names ( ) const

inline

Return the set of directory names included in this alternative name.

Definition at line 198 of file pkix_types.h.

{ return m_dn_names; }

Referenced by contents(), dn(), get_attribute(), and Botan::GeneralName::matches().

dn()

X509_DN Botan::AlternativeName::dn

(

)

const

Definition at line 171 of file asn1_alt_name.cpp.

                                  {
   // This logic really does not make any sense, but it is
   // how this function was historically implemented.
 
   X509_DN combined_dn;
 
   for(const auto& dn : this->directory_names()) {
      std::ostringstream oss;
      oss << dn;
 
      std::istringstream iss(oss.str());
      iss >> combined_dn;
   }
 
   return combined_dn;
}

References directory_names(), and dn().

Referenced by add_attribute(), add_dn(), AlternativeName(), decode_from(), dn(), and get_othernames().

dns()

const std::set< std::string > & Botan::AlternativeName::dns ( ) const

inline

Return the set of DNS names included in this alternative name.

Definition at line 183 of file pkix_types.h.

{ return m_dns; }

Referenced by add_dns(), AlternativeName(), AlternativeName(), contents(), get_attribute(), get_othernames(), and Botan::GeneralName::matches().

email()

const std::set< std::string > & Botan::AlternativeName::email ( ) const

inline

Return the set of email addresses included in this alternative name.

Definition at line 180 of file pkix_types.h.

{ return m_email; }

Referenced by contents(), and get_attribute().

encode_into()

void Botan::AlternativeName::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 68 of file alt_name.cpp.

                                                        {
   der.start_sequence();
 
   /*
   GeneralName ::= CHOICE {
        otherName                       [0]     OtherName,
        rfc822Name                      [1]     IA5String,
        dNSName                         [2]     IA5String,
        x400Address                     [3]     ORAddress,
        directoryName                   [4]     Name,
        ediPartyName                    [5]     EDIPartyName,
        uniformResourceIdentifier       [6]     IA5String,
        iPAddress                       [7]     OCTET STRING,
        registeredID                    [8]     OBJECT IDENTIFIER }
   */
 
   for(const auto& othername : m_othernames) {
      der.start_explicit(0)
         .encode(othername.first)
         .start_explicit(0)
         .encode(othername.second)
         .end_explicit()
         .end_explicit();
   }
 
   for(const auto& name : m_email) {
      const ASN1_String str(name, ASN1_Type::Ia5String);
      der.add_object(ASN1_Type(1), ASN1_Class::ContextSpecific, str.value());
   }
 
   for(const auto& name : m_dns) {
      const ASN1_String str(name, ASN1_Type::Ia5String);
      der.add_object(ASN1_Type(2), ASN1_Class::ContextSpecific, str.value());
   }
 
   for(const auto& name : m_dn_names) {
      der.add_object(ASN1_Type(4), ASN1_Class::ExplicitContextSpecific, name.DER_encode());
   }
 
   for(const auto& name : m_uri) {
      const ASN1_String str(name, ASN1_Type::Ia5String);
      der.add_object(ASN1_Type(6), ASN1_Class::ContextSpecific, str.value());
   }
 
   for(const uint32_t ip : m_ipv4_addr) {
      auto ip_buf = store_be(ip);
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      der.add_object(ASN1_Type(7), ASN1_Class::ContextSpecific, ip_buf.data(), 4);
   }
 
   for(const auto& ip : m_ipv6_addr) {
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      der.add_object(ASN1_Type(7), ASN1_Class::ContextSpecific, ip.address().data(), ip.address().size());
   }
 
   der.end_cons();
}

References Botan::DER_Encoder::add_object(), Botan::ContextSpecific, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::end_explicit(), Botan::ExplicitContextSpecific, Botan::Ia5String, Botan::DER_Encoder::start_explicit(), Botan::DER_Encoder::start_sequence(), Botan::store_be(), and Botan::ASN1_String::value().

get_attribute()

std::vector< std::string > Botan::AlternativeName::get_attribute

(

std::string_view

attr

)

const

Definition at line 143 of file asn1_alt_name.cpp.

                                                                             {
   auto set_to_vector = [](const std::set<std::string>& s) -> std::vector<std::string> { return {s.begin(), s.end()}; };
 
   if(attr == "DNS") {
      return set_to_vector(this->dns());
   } else if(attr == "RFC822") {
      return set_to_vector(this->email());
   } else if(attr == "URI") {
      return set_to_vector(this->uris());
   } else if(attr == "DN") {
      std::vector<std::string> ret;
 
      for(const auto& nm : this->directory_names()) {
         ret.push_back(nm.to_string());
      }
 
      return ret;
   } else if(attr == "IP") {
      std::vector<std::string> ip_str;
      for(const uint32_t ipv4 : this->ipv4_address()) {
         ip_str.push_back(ipv4_to_string(ipv4));
      }
      return ip_str;
   } else {
      return {};
   }
}

References directory_names(), dns(), email(), ipv4_address(), Botan::ipv4_to_string(), and uris().

Referenced by get_first_attribute(), and has_field().

get_attributes()

std::multimap< std::string, std::string, std::less<> > Botan::AlternativeName::get_attributes

(

)

const

Definition at line 119 of file asn1_alt_name.cpp.

                                                                                   {
   std::multimap<std::string, std::string, std::less<>> r;
 
   for(const auto& c : this->contents()) {
      r.emplace(c.first, c.second);
   }
 
   return r;
}

References contents().

get_first_attribute()

std::string Botan::AlternativeName::get_first_attribute

(

std::string_view

attr

)

const

Definition at line 133 of file asn1_alt_name.cpp.

                                                                        {
   auto attr = this->get_attribute(type);
 
   if(!attr.empty()) {
      return attr[0];
   }
 
   return "";
}

References get_attribute().

get_othernames()

std::multimap< OID, ASN1_String > Botan::AlternativeName::get_othernames

(

)

const

References AlternativeName(), BOTAN_DEPRECATED, BOTAN_FUTURE_EXPLICIT, dn(), dns(), and get_othernames().

Referenced by get_othernames().

has_field()

bool Botan::AlternativeName::has_field

(

std::string_view

attr

)

const

Definition at line 129 of file asn1_alt_name.cpp.

                                                         {
   return !this->get_attribute(attr).empty();
}

References get_attribute().

has_items()

bool Botan::AlternativeName::has_items

(

)

const

Return true if this has any names set.

Definition at line 64 of file alt_name.cpp.

                                      {
   return this->count() > 0;
}

References count().

ipv4_address()

const std::set< uint32_t > & Botan::AlternativeName::ipv4_address ( ) const

inline

Return the set of IPv4 addresses included in this alternative name.

Definition at line 186 of file pkix_types.h.

{ return m_ipv4_addr; }

Referenced by contents(), get_attribute(), Botan::GeneralName::matches(), and Botan::X509_Certificate::matches_dns_name().

ipv6_address()

const std::set< IPv6Address > & Botan::AlternativeName::ipv6_address ( ) const

inline

Return the set of IPv6 addresses included in this alternative name.

Definition at line 189 of file pkix_types.h.

{ return m_ipv6_addr; }

Referenced by contents(), Botan::GeneralName::matches(), and Botan::X509_Certificate::matches_dns_name().

other_names()

const std::set< std::pair< OID, ASN1_String > > & Botan::AlternativeName::other_names ( ) const

inline

Return the set of "other names" included in this alternative name.

Definition at line 193 of file pkix_types.h.

                                                                   {
         return m_othernames;
      }

References other_names().

Referenced by contents(), and other_names().

uris()

const std::set< std::string > & Botan::AlternativeName::uris ( ) const

inline

Return the set of URIs included in this alternative name.

Definition at line 177 of file pkix_types.h.

{ return m_uri; }

Referenced by contents(), and get_attribute().

---

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

• src/lib/x509/pkix_types.h
• src/lib/x509/alt_name.cpp
• src/lib/x509/asn1_alt_name.cpp