#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_othername (const OID &oid, std::string_view value, ASN1_Type type)

	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

void	decode_from (BER_Decoder &) override

X509_DN	dn () const

void	encode_into (DER_Encoder &) const override

std::vector< std::string >	get_attribute (std::string_view attr) const

const std::multimap< std::string, std::string, std::less<> > &	get_attributes () const

std::string	get_first_attribute (std::string_view attr) const

const std::multimap< OID, ASN1_String > &	get_othernames () const

bool	has_field (std::string_view attr) const

bool	has_items () const

Detailed Description

Alternative Name

Definition at line 114 of file pkix_types.h.

Constructor & Destructor Documentation

◆ AlternativeName()

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

Definition at line 24 of file asn1_alt_name.cpp.

                                                    {
   add_attribute("RFC822", email_addr);
   add_attribute("DNS", dns);
   add_attribute("URI", uri);
   add_attribute("IP", ip);
}

References add_attribute().

Member Function Documentation

◆ add_attribute()

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

Definition at line 37 of file asn1_alt_name.cpp.

                                                                             {
   if(type.empty() || value.empty()) {
      return;
   }
 
   auto range = m_alt_info.equal_range(type);
   for(auto j = range.first; j != range.second; ++j) {
      if(j->second == value) {
         return;
      }
   }
 
   m_alt_info.emplace(type, value);
}

Referenced by AlternativeName(), and decode_from().

◆ add_othername()

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

Definition at line 55 of file asn1_alt_name.cpp.

                                                                                        {
   if(value.empty()) {
      return;
   }
   multimap_insert(m_othernames, oid, ASN1_String(value, type));
}

References Botan::multimap_insert().

Referenced by 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 18 of file asn1_obj.cpp.

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

References Botan::ASN1_Object::encode_into().

Referenced by Botan::PSS_Params::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(), and Botan::Certificate_Store_In_SQL::revoke_cert().

◆ contents()

std::multimap< std::string, std::string > Botan::AlternativeName::contents ( ) const

Definition at line 65 of file asn1_alt_name.cpp.

                                                                  {
   std::multimap<std::string, std::string> names;
 
   for(const auto& name : m_alt_info) {
      names.emplace(name.first, name.second);
   }
 
   for(const auto& othername : m_othernames) {
      multimap_insert(names, othername.first.to_formatted_string(), othername.second.value());
   }
 
   return names;
}

References Botan::multimap_insert(), and name.

◆ 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 179 of file asn1_alt_name.cpp.

                                                     {
   BER_Decoder names = source.start_sequence();
 
   // FIXME this is largely a duplication of GeneralName::decode_from
 
   while(names.more_items()) {
      BER_Object obj = names.get_next_object();
 
      if(obj.is_a(0, ASN1_Class::ContextSpecific)) {
         BER_Decoder othername(obj);
 
         OID oid;
         othername.decode(oid);
         if(othername.more_items()) {
            BER_Object othername_value_outer = othername.get_next_object();
            othername.verify_end();
 
            if(othername_value_outer.is_a(0, ASN1_Class::ExplicitContextSpecific) == false) {
               throw Decoding_Error("Invalid tags on otherName value");
            }
 
            BER_Decoder othername_value_inner(othername_value_outer);
 
            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());
            }
         }
      }
      if(obj.is_a(1, ASN1_Class::ContextSpecific)) {
         add_attribute("RFC822", ASN1::to_string(obj));
      } else if(obj.is_a(2, ASN1_Class::ContextSpecific)) {
         add_attribute("DNS", ASN1::to_string(obj));
      } else if(obj.is_a(6, ASN1_Class::ContextSpecific)) {
         add_attribute("URI", ASN1::to_string(obj));
      } else if(obj.is_a(4, ASN1_Class::ContextSpecific | ASN1_Class::Constructed)) {
         BER_Decoder dec(obj);
         X509_DN dn;
         std::stringstream ss;
 
         dec.decode(dn);
         ss << dn;
 
         add_attribute("DN", ss.str());
      } else if(obj.is_a(7, ASN1_Class::ContextSpecific)) {
         if(obj.length() == 4) {
            const uint32_t ip = load_be<uint32_t>(obj.bits(), 0);
            add_attribute("IP", ipv4_to_string(ip));
         }
      }
   }
}

References add_attribute(), add_othername(), Botan::BER_Object::bits(), Botan::Constructed, Botan::ContextSpecific, Botan::BER_Decoder::decode(), dn(), Botan::ExplicitContextSpecific, Botan::BER_Object::get_class(), Botan::BER_Decoder::get_next_object(), Botan::ipv4_to_string(), Botan::BER_Object::is_a(), Botan::ASN1_String::is_string_type(), Botan::BER_Object::length(), Botan::load_be< uint32_t >(), 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().

◆ dn()

X509_DN Botan::AlternativeName::dn ( ) const

Definition at line 102 of file asn1_alt_name.cpp.

                                  {
   X509_DN dn;
   auto range = m_alt_info.equal_range("DN");
 
   for(auto i = range.first; i != range.second; ++i) {
      std::istringstream strm(i->second);
      strm >> dn;
   }
 
   return dn;
}

References dn().

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

◆ 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 155 of file asn1_alt_name.cpp.

                                                        {
   der.start_sequence();
 
   encode_entries(der, m_alt_info, "RFC822", ASN1_Type(1));
   encode_entries(der, m_alt_info, "DNS", ASN1_Type(2));
   encode_entries(der, m_alt_info, "DN", ASN1_Type(4));
   encode_entries(der, m_alt_info, "URI", ASN1_Type(6));
   encode_entries(der, m_alt_info, "IP", ASN1_Type(7));
 
   for(const auto& othername : m_othernames) {
      der.start_explicit(0)
         .encode(othername.first)
         .start_explicit(0)
         .encode(othername.second)
         .end_explicit()
         .end_explicit();
   }
 
   der.end_cons();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::end_explicit(), Botan::DER_Encoder::start_explicit(), and Botan::DER_Encoder::start_sequence().

◆ get_attribute()

std::vector< std::string > Botan::AlternativeName::get_attribute ( std::string_view attr ) const

Definition at line 93 of file asn1_alt_name.cpp.

                                                                             {
   std::vector<std::string> results;
   auto range = m_alt_info.equal_range(attr);
   for(auto i = range.first; i != range.second; ++i) {
      results.push_back(i->second);
   }
   return results;
}

Referenced by Botan::X509_Certificate::issuer_info(), Botan::GeneralName::matches(), and Botan::X509_Certificate::subject_info().

◆ get_attributes()

const std::multimap< std::string, std::string, std::less<> > & Botan::AlternativeName::get_attributes ( ) const

inline

Definition at line 129 of file pkix_types.h.

129{ return m_alt_info; }

◆ get_first_attribute()

std::string Botan::AlternativeName::get_first_attribute ( std::string_view attr ) const

Definition at line 84 of file asn1_alt_name.cpp.

                                                                        {
   auto i = m_alt_info.lower_bound(attr);
   if(i != m_alt_info.end() && i->first == attr) {
      return i->second;
   }
 
   return "";
}

◆ get_othernames()

const std::multimap< OID, ASN1_String > & Botan::AlternativeName::get_othernames ( ) const

inline

Definition at line 131 of file pkix_types.h.

131{ return m_othernames; }

◆ has_field()

bool Botan::AlternativeName::has_field ( std::string_view attr ) const

Definition at line 79 of file asn1_alt_name.cpp.

                                                         {
   auto range = m_alt_info.equal_range(attr);
   return (range.first != range.second);
}

◆ has_items()

bool Botan::AlternativeName::has_items ( ) const

Definition at line 117 of file asn1_alt_name.cpp.

                                      {
   return (!m_alt_info.empty() || !m_othernames.empty());
}

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

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

Public Member Functions