Botan::AlternativeName Class Reference

#include <pkix_types.h>

Inheritance diagram for Botan::AlternativeName:

Classes
class	OtherNameValue
	An "OtherName" GeneralName entry: type-id OID and the inner ANY value as raw BER. More...

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 (DNSName dns)
	Add a previously parsed DNS name to this AlternativeName.
void	add_dns (std::string_view dns)
	Add a DNS name to this AlternativeName, parsing and validating the input.
void	add_email (EmailAddress addr)
	Add a previously parsed email address to this AlternativeName.
void	add_email (std::string_view addr)
	Add an email address to this AlternativeName, parsing and validating the input.
void	add_ipv4_address (const 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_other_name_value (const OID &oid, std::span< const uint8_t > value)
void	add_othername (const OID &oid, std::string_view value, ASN1_Type type)
void	add_registered_id (const OID &oid)
	Add a registeredID (RFC 5280 [8]).
void	add_uri (std::string_view uri)
	Add a URI to this AlternativeName, parsing and validating the input.
void	add_uri (URI uri)
	Add a previously parsed 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
std::set< std::string >	dns () const
const std::set< DNSName > &	dns_names () const
	Return the set of DNS names included in this alternative name.
std::set< std::string >	email () const
const std::set< EmailAddress > &	email_addresses () 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.
std::set< uint32_t >	ipv4_address () const
	Return the set of IPv4 addresses included in this alternative name.
const std::set< IPv4Address > &	ipv4_addresses () 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< IPv6Address > &	ipv6_addresses () const
	Return the set of IPv6 addresses included in this alternative name.
bool	is_empty () const
	Return true if this alternative name is empty (zero names).
const std::set< OtherNameValue > &	other_name_values () const
	Return all "OtherName" entries with their inner ANY value as raw BER.
const std::set< std::pair< OID, ASN1_String > > &	other_names () const
	Return the set of "other names" whose value was a recognized ASN1_String type.
const std::set< OID > &	registered_ids () const
	Return the set of registeredID OIDs.
const std::set< SmtpUtf8Mailbox > &	smtp_utf8_mailboxes () const
const std::set< URI > &	uri_names () const
	Return the set of URIs included in this alternative name.
std::set< std::string >	uris () const

Detailed Description

Alternative Name

Definition at line 306 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_other_name(), add_other_name_value(), add_registered_id(), 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 21 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 = IPv4Address::from_string(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::IPv4Address::from_string().

Member Function Documentation

add_attribute()

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

Definition at line 46 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") {
      if(auto dn = X509_DN::parse(value)) {
         this->add_dn(*dn);
      } else {
         throw Invalid_Argument(fmt("Invalid X.509 DN '{}'", value));
      }
   } else if(type == "IP") {
      if(auto ipv4 = IPv4Address::from_string(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(), Botan::IPv4Address::from_string(), and Botan::X509_DN::parse().

add_dn()

void Botan::AlternativeName::add_dn

(

const X509_DN &

dn

)

Add a directory name to this AlternativeName.

Definition at line 101 of file alt_name.cpp.

                                              {
   m_dn_names.insert(dn);
}

References dn().

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

add_dns() [1/2]

void Botan::AlternativeName::add_dns

(

DNSName

dns

)

Add a previously parsed DNS name to this AlternativeName.

Definition at line 74 of file alt_name.cpp.

                                         {
   m_dns.insert(std::move(dns));
}

References dns().

add_dns() [2/2]

void Botan::AlternativeName::add_dns

(

std::string_view

dns

)

Add a DNS name to this AlternativeName, parsing and validating the input.

Definition at line 63 of file alt_name.cpp.

                                                {
   if(dns.empty()) {
      return;
   }
   if(auto parsed = DNSName::from_san_string(dns)) {
      add_dns(std::move(*parsed));
   } else {
      throw Decoding_Error("Invalid DNS name in SubjectAlternativeName");
   }
}

References add_dns(), dns(), and Botan::DNSName::from_san_string().

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

add_email() [1/2]

void Botan::AlternativeName::add_email

(

EmailAddress

addr

)

Add a previously parsed email address to this AlternativeName.

Definition at line 51 of file alt_name.cpp.

                                                 {
   m_email.insert(std::move(addr));
}

add_email() [2/2]

void Botan::AlternativeName::add_email

(

std::string_view

addr

)

Add an email address to this AlternativeName, parsing and validating the input.

Definition at line 40 of file alt_name.cpp.

                                                   {
   if(addr.empty()) {
      return;
   }
   if(auto parsed = EmailAddress::from_string(addr)) {
      add_email(std::move(*parsed));
   } else {
      throw Decoding_Error("Invalid email address in SubjectAlternativeName");
   }
}

References add_email(), and Botan::EmailAddress::from_string().

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

add_ipv4_address() [1/2]

void Botan::AlternativeName::add_ipv4_address

(

const IPv4Address &

ipv4

)

Add an IP address to this alternative name.

Definition at line 105 of file alt_name.cpp.

                                                            {
   m_ipv4_addrs.insert(ip);
}

add_ipv4_address() [2/2]

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

inline

Add an IP address to this alternative name.

Definition at line 374 of file pkix_types.h.

                                                                                              {
         this->add_ipv4_address(IPv4Address(ipv4));
      }

References add_ipv4_address().

Referenced by add_attribute(), add_ipv4_address(), 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 109 of file alt_name.cpp.

                                                            {
   m_ipv6_addrs.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 86 of file alt_name.cpp.

                                                                             {
   m_othernames.insert(std::make_pair(oid, value));
   std::vector<uint8_t> raw;
   DER_Encoder(raw).encode(value);
   m_other_name_values.insert(OtherNameValue(oid, std::move(raw)));
}

References Botan::DER_Encoder::encode().

Referenced by add_othername(), and AlternativeName().

add_other_name_value()

void Botan::AlternativeName::add_other_name_value	(	const OID &	oid,
		std::span< const uint8_t >	value )

Add an "OtherName" with arbitrary inner value, given as raw BER bytes

value must be a complete BER-encoded object (tag + length + content) representing the inner ANY value of the OtherName.

Definition at line 93 of file alt_name.cpp.

                                                                                       {
   m_other_name_values.insert(OtherNameValue(oid, value));
}

Referenced by AlternativeName().

add_othername()

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

Definition at line 77 of file asn1_alt_name.cpp.

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

References add_other_name().

add_registered_id()

void Botan::AlternativeName::add_registered_id

(

const OID &

oid

)

Add a registeredID (RFC 5280 [8]).

Definition at line 97 of file alt_name.cpp.

                                                      {
   m_registered_ids.insert(oid);
}

Referenced by AlternativeName(), and decode_from().

add_uri() [1/2]

void Botan::AlternativeName::add_uri

(

std::string_view

uri

)

Add a URI to this AlternativeName, parsing and validating the input.

Definition at line 17 of file alt_name.cpp.

                                                {
   if(uri.empty()) {
      return;
   }
   if(auto parsed = URI::from_string(uri)) {
      add_uri(std::move(*parsed));
   } else {
      throw Decoding_Error("Invalid URI in SubjectAlternativeName");
   }
}

References add_uri(), and Botan::URI::from_string().

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

add_uri() [2/2]

void Botan::AlternativeName::add_uri

(

URI

uri

)

Add a previously parsed URI to this AlternativeName.

Definition at line 28 of file alt_name.cpp.

                                     {
   m_uri.insert(std::move(uri));
}

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 21 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::PKCS12::export_to(), 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(), and Botan::PSS_Params::PSS_Params().

contents()

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

(

)

const

Definition at line 87 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 auto& ipv4 : this->ipv4_addresses()) {
      names.emplace("IP", ipv4.to_string());
   }
 
   for(const auto& ipv6 : this->ipv6_addresses()) {
      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_addresses(), ipv6_addresses(), 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 113 of file alt_name.cpp.

                                    {
   const auto sum = checked_add(m_dns.size(),
                                m_uri.size(),
                                m_email.size(),
                                m_ipv4_addrs.size(),
                                m_ipv6_addrs.size(),
                                m_dn_names.size(),
                                m_other_name_values.size(),
                                m_registered_ids.size());
 
   BOTAN_ASSERT_NOMSG(sum.has_value());
   return sum.value();
}

References BOTAN_ASSERT_NOMSG, and Botan::checked_add().

Referenced by has_items(), and is_empty().

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 198 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);
         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();
 
         // Capture the inner ANY value verbatim so applications can retrieve
         // it regardless of its ASN.1 form.
         std::vector<uint8_t> raw_value;
         DER_Encoder(raw_value).add_object(value.type_tag(), value.class_tag(), value.data());
         m_other_name_values.insert(OtherNameValue{oid, std::move(raw_value)});
 
         // Populate old string view for compatibility
         if(ASN1_String::is_string_type(value.type()) && value.get_class() == ASN1_Class::Universal) {
            try {
               m_othernames.insert(std::make_pair(oid, ASN1_String(ASN1::to_string(value), value.type())));
            } catch(const Invalid_Argument&) {  // NOLINT(*-empty-catch)
            }
         }
 
         if(oid == OID::from_string("PKIX.SmtpUTF8Mailbox")) {
            if(!value.is_a(ASN1_Type::Utf8String, ASN1_Class::Universal)) {
               throw Decoding_Error("SmtpUTF8Mailbox otherName must contain a UTF8String");
            }
            auto parsed_mailbox = SmtpUtf8Mailbox::from_string(ASN1::to_string(value));
            if(!parsed_mailbox.has_value()) {
               throw Decoding_Error("Invalid SmtpUTF8Mailbox encoding");
            }
            m_smtp_utf8_mailboxes.insert(std::move(*parsed_mailbox));
         }
      } else if(obj.is_a(1, ASN1_Class::ContextSpecific)) {
         add_email(ASN1::to_string(obj));
      } else if(obj.is_a(2, ASN1_Class::ContextSpecific)) {
         add_dns(ASN1::to_string(obj));
      } else if(obj.is_a(3, ASN1_Class::ContextSpecific | ASN1_Class::Constructed)) {
         // x400Address not supported but it is a SEQUENCE so we know it cannot be empty
         if(obj.length() == 0) {
            throw Decoding_Error("Invalid x400Address field");
         }
      } else if(obj.is_a(4, ASN1_Class::ContextSpecific | ASN1_Class::Constructed)) {
         BER_Decoder dec(obj, names.limits());
         X509_DN dn;
         dec.decode(dn).verify_end();
         this->add_dn(dn);
      } else if(obj.is_a(5, ASN1_Class::ContextSpecific | ASN1_Class::Constructed)) {
         // ediPartyName not supported but it is a SEQUENCE so we know it cannot be empty
         if(obj.length() == 0) {
            throw Decoding_Error("Invalid ediPartyName field");
         }
      } 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");
         }
      } else if(obj.is_a(8, ASN1_Class::ContextSpecific)) {
         // [8] registeredID is IMPLICIT OBJECT IDENTIFIER.
         OID oid;
         names.decode_implicit(obj, oid, ASN1_Type::ObjectId, ASN1_Class::Universal);
         this->add_registered_id(oid);
      } else {
         throw Decoding_Error(fmt("Unknown GeneralName tag {}/class {}",
                                  static_cast<uint32_t>(obj.type_tag()),
                                  static_cast<uint32_t>(obj.class_tag())));
      }
   }
}

References add_dn(), add_dns(), add_email(), add_ipv4_address(), add_ipv6_address(), Botan::DER_Encoder::add_object(), add_registered_id(), add_uri(), Botan::BER_Object::bits(), Botan::BER_Object::class_tag(), Botan::Constructed, Botan::ContextSpecific, Botan::BER_Object::data(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_implicit(), dn(), Botan::ExplicitContextSpecific, Botan::fmt(), Botan::OID::from_string(), Botan::SmtpUtf8Mailbox::from_string(), 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::ObjectId, Botan::BER_Decoder::start_sequence(), Botan::ASN1::to_string(), Botan::BER_Object::type(), Botan::BER_Object::type_tag(), Botan::Universal, Botan::Utf8String, 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 443 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

This returns all of the alternative name DNs combined into a single DN

This result is not a valid DN. The logic is retained for compatibility, but this function should not be used. It will be removed in Botan4.

Definition at line 173 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()) {
      for(const auto& rdn : dn.rdns()) {
         combined_dn.add_rdn(rdn);
      }
   }
 
   return combined_dn;
}

References Botan::X509_DN::add_rdn(), directory_names(), and dn().

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

dns()

std::set< std::string > Botan::AlternativeName::dns

(

)

const

Return the set of DNS names included in this alternative name

Deprecated: use dns_names() instead, which exposes the parsed DNSName values. This accessor constructs a copy.

Definition at line 78 of file alt_name.cpp.

                                             {
   std::set<std::string> out;
   for(const auto& name : m_dns) {
      out.insert(name.to_string());
   }
   return out;
}

Referenced by add_dns(), add_dns(), AlternativeName(), AlternativeName(), contents(), get_attribute(), and get_othernames().

dns_names()

const std::set< DNSName > & Botan::AlternativeName::dns_names ( ) const

inline

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

Definition at line 409 of file pkix_types.h.

{ return m_dns; }

References dns_names().

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

email()

std::set< std::string > Botan::AlternativeName::email

(

)

const

Return the set of email addresses included in this alternative name

Deprecated: use email_addresses() instead, which exposes the parsed EmailAddress values. This accessor constructs a copy.

Definition at line 55 of file alt_name.cpp.

                                               {
   std::set<std::string> out;
   for(const auto& addr : m_email) {
      out.insert(addr.to_string());
   }
   return out;
}

Referenced by contents(), and get_attribute().

email_addresses()

const std::set< EmailAddress > & Botan::AlternativeName::email_addresses ( ) const

inline

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

Definition at line 400 of file pkix_types.h.

{ return m_email; }

References email_addresses().

Referenced by email_addresses(), Botan::GeneralName::matches(), and Botan::X509_Certificate::subject_email_addresses().

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 135 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_other_name_values) {
      der.start_explicit(0)
         .encode(othername.oid())
         .start_explicit(0)
         .raw_bytes(othername.value())
         .end_explicit()
         .end_explicit();
   }
 
   for(const auto& addr : m_email) {
      const ASN1_String str(addr.to_string(), 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.to_string(), 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.original_input(), ASN1_Type::Ia5String);
      der.add_object(ASN1_Type(6), ASN1_Class::ContextSpecific, str.value());
   }
 
   for(const auto& ip : m_ipv4_addrs) {
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      der.add_object(ASN1_Type(7), ASN1_Class::ContextSpecific, ip.to_bytes());
   }
 
   for(const auto& ip : m_ipv6_addrs) {
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      der.add_object(ASN1_Type(7), ASN1_Class::ContextSpecific, ip.address().data(), ip.address().size());
   }
 
   for(const auto& reg_id : m_registered_ids) {
      // [8] registeredID is IMPLICIT OBJECT IDENTIFIER.
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      der.encode_implicit(reg_id, ASN1_Type(8), ASN1_Class::ContextSpecific);
   }
 
   der.end_cons();
}

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

get_attribute()

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

(

std::string_view

attr

)

const

Definition at line 145 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 auto& ipv4 : this->ipv4_addresses()) {
         ip_str.push_back(ipv4.to_string());
      }
      return ip_str;
   } else {
      return {};
   }
}

References directory_names(), dns(), email(), ipv4_addresses(), 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 121 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 135 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 131 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 127 of file alt_name.cpp.

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

References count().

ipv4_address()

std::set< uint32_t > Botan::AlternativeName::ipv4_address

(

)

const

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

Definition at line 188 of file asn1_alt_name.cpp.

                                                     {
   std::set<uint32_t> out;
   for(const auto& a : m_ipv4_addrs) {
      out.insert(a.address());
   }
   return out;
}

ipv4_addresses()

const std::set< IPv4Address > & Botan::AlternativeName::ipv4_addresses ( ) const

inline

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

Definition at line 420 of file pkix_types.h.

{ return m_ipv4_addrs; }

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

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 415 of file pkix_types.h.

                                                                                             {
         return ipv6_addresses();
      }

References BOTAN_DEPRECATED, ipv6_address(), and ipv6_addresses().

Referenced by ipv6_address().

ipv6_addresses()

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

inline

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

Definition at line 423 of file pkix_types.h.

{ return m_ipv6_addrs; }

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

is_empty()

bool Botan::AlternativeName::is_empty

(

)

const

Return true if this alternative name is empty (zero names).

Definition at line 131 of file alt_name.cpp.

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

References count().

Referenced by Botan::GeneralName::matches().

other_name_values()

const std::set< OtherNameValue > & Botan::AlternativeName::other_name_values ( ) const

inline

Return all "OtherName" entries with their inner ANY value as raw BER.

Definition at line 432 of file pkix_types.h.

{ return m_other_name_values; }

other_names()

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

inline

Return the set of "other names" whose value was a recognized ASN1_String type.

Definition at line 427 of file pkix_types.h.

                                                                   {
         return m_othernames;
      }

References other_names().

Referenced by contents(), and other_names().

registered_ids()

const std::set< OID > & Botan::AlternativeName::registered_ids ( ) const

inline

Return the set of registeredID OIDs.

Definition at line 440 of file pkix_types.h.

{ return m_registered_ids; }

smtp_utf8_mailboxes()

const std::set< SmtpUtf8Mailbox > & Botan::AlternativeName::smtp_utf8_mailboxes ( ) const

inline

Return the set of SmtpUTF8Mailbox SAN entries (RFC 9598).

Any such values are also included with their raw encoding in other_name_values

Definition at line 437 of file pkix_types.h.

{ return m_smtp_utf8_mailboxes; }

uri_names()

const std::set< URI > & Botan::AlternativeName::uri_names ( ) const

inline

Return the set of URIs included in this alternative name.

Definition at line 391 of file pkix_types.h.

{ return m_uri; }

References uri_names().

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

uris()

std::set< std::string > Botan::AlternativeName::uris

(

)

const

Return the set of URIs included in this alternative name

Deprecated: use uri_names() instead, which exposes the parsed URI values. This accessor constructs a copy.

Definition at line 32 of file alt_name.cpp.

                                              {
   std::set<std::string> out;
   for(const auto& uri : m_uri) {
      out.insert(uri.original_input());
   }
   return out;
}

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