Botan::X509_DN Class Reference

#include <pkix_types.h>

Inheritance diagram for Botan::X509_DN:

Public Member Functions
void	add_attribute (const OID &oid, const ASN1_String &val)
void	add_attribute (const OID &oid, std::string_view val)
void	add_attribute (std::string_view key, std::string_view val)
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
std::vector< uint8_t >	DER_encode () const
const std::vector< std::pair< OID, ASN1_String > > &	dn_info () const
bool	empty () const
void	encode_into (DER_Encoder &to) const override
std::vector< std::string >	get_attribute (std::string_view attr) const
std::multimap< OID, std::string >	get_attributes () const
const std::vector< uint8_t > &	get_bits () const
ASN1_String	get_first_attribute (const OID &oid) const
std::string	get_first_attribute (std::string_view attr) const
bool	has_field (const OID &oid) const
bool	has_field (std::string_view attr) const
std::string	to_string () const
	X509_DN ()=default
	X509_DN (const std::multimap< OID, std::string > &args)
	X509_DN (const std::multimap< std::string, std::string > &args)
	X509_DN (std::initializer_list< std::pair< std::string_view, std::string_view > > args)

Static Public Member Functions
static std::string	deref_info_field (std::string_view key)
static size_t	lookup_ub (const OID &oid)

Detailed Description

Distinguished Name

Definition at line 43 of file pkix_types.h.

Constructor & Destructor Documentation

X509_DN() [1/4]

Botan::X509_DN::X509_DN ( )

default

Referenced by X509_DN(), and X509_DN().

X509_DN() [2/4]

Botan::X509_DN::X509_DN ( std::initializer_list< std::pair< std::string_view, std::string_view > > args )

inline

Definition at line 47 of file pkix_types.h.

                                                                                 {
         for(const auto& i : args) {
            add_attribute(i.first, i.second);
         }
      }

References add_attribute().

X509_DN() [3/4]

Botan::X509_DN::X509_DN ( const std::multimap< OID, std::string > & args )

inlineexplicit

Since DN matching for Name Constraints requires preserving order and multimaps have sorted keys, this constructor is deprecated.

Definition at line 58 of file pkix_types.h.

                                                                {
         for(const auto& i : args) {
            add_attribute(i.first, i.second);
         }
      }

References add_attribute(), and X509_DN().

X509_DN() [4/4]

Botan::X509_DN::X509_DN ( const std::multimap< std::string, std::string > & args )

inlineexplicit

Since DN matching for Name Constraints requires preserving order and multimaps have sorted keys, this constructor is deprecated.

Definition at line 69 of file pkix_types.h.

                                                                      {
         for(const auto& i : args) {
            add_attribute(i.first, i.second);
         }
      }

References add_attribute(), and X509_DN().

Member Function Documentation

add_attribute() [1/3]

void Botan::X509_DN::add_attribute	(	const OID &	oid,
		const ASN1_String &	val )

Definition at line 109 of file x509_dn.cpp.

                                                                  {
   if(str.empty()) {
      return;
   }
 
   m_rdn.push_back(std::make_pair(oid, str));
   m_dn_bits.clear();
}

References Botan::ASN1_String::empty().

add_attribute() [2/3]

void Botan::X509_DN::add_attribute ( const OID & oid, std::string_view val )

inline

Definition at line 109 of file pkix_types.h.

{ add_attribute(oid, ASN1_String(val)); }

References add_attribute().

Referenced by add_attribute().

add_attribute() [3/3]

void Botan::X509_DN::add_attribute	(	std::string_view	key,
		std::string_view	val )

Definition at line 102 of file x509_dn.cpp.

                                                                   {
   add_attribute(OID::from_string(type), str);
}

References add_attribute(), and Botan::OID::from_string().

Referenced by add_attribute(), decode_from(), Botan::operator>>(), X509_DN(), X509_DN(), and X509_DN().

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::X509_DN::contents

(

)

const

Definition at line 133 of file x509_dn.cpp.

                                                          {
   std::multimap<std::string, std::string> retval;
 
   for(const auto& i : m_rdn) {
      retval.emplace(i.first.to_formatted_string(), i.second.value());
   }
   return retval;
}

count()

size_t Botan::X509_DN::count ( ) const

inline

Definition at line 90 of file pkix_types.h.

{ return m_rdn.size(); }

Referenced by Botan::NameConstraints::is_excluded(), and Botan::NameConstraints::is_permitted().

decode_from()

void Botan::X509_DN::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 338 of file x509_dn.cpp.

                                             {
   std::vector<uint8_t> bits;
 
   source.start_sequence().raw_bytes(bits).end_cons();
 
   BER_Decoder sequence(bits, source.limits());
 
   m_rdn.clear();
 
   while(sequence.more_items()) {
      BER_Decoder rdn = sequence.start_set();
 
      while(rdn.more_items()) {
         OID oid;
         ASN1_String str;
 
         rdn.start_sequence()
            .decode(oid)
            .decode(str)  // TODO support Any
            .end_cons();
 
         add_attribute(oid, str);
      }
   }
 
   // Have to assign last as add_attribute zaps m_dn_bits
   m_dn_bits = bits;
}

References add_attribute(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::limits(), Botan::BER_Decoder::more_items(), Botan::BER_Decoder::raw_bytes(), Botan::BER_Decoder::start_sequence(), and Botan::BER_Decoder::start_set().

Referenced by Botan::Certificate_Store_In_SQL::all_subjects(), and Botan::GeneralName::decode_from().

DER_encode()

std::vector< uint8_t > Botan::X509_DN::DER_encode

(

)

const

Definition at line 307 of file x509_dn.cpp.

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

References encode_into().

deref_info_field()

std::string Botan::X509_DN::deref_info_field ( std::string_view key )

static

Definition at line 198 of file x509_dn.cpp.

                                                       {
   if(info == "Name" || info == "CommonName" || info == "CN") {
      return "X520.CommonName";
   }
   if(info == "SerialNumber" || info == "SN") {
      return "X520.SerialNumber";
   }
   if(info == "Country" || info == "C") {
      return "X520.Country";
   }
   if(info == "Organization" || info == "O") {
      return "X520.Organization";
   }
   if(info == "Organizational Unit" || info == "OrgUnit" || info == "OU") {
      return "X520.OrganizationalUnit";
   }
   if(info == "Locality" || info == "L") {
      return "X520.Locality";
   }
   if(info == "State" || info == "Province" || info == "ST") {
      return "X520.State";
   }
   if(info == "Email") {
      return "RFC822";
   }
   return std::string(info);
}

Referenced by get_attribute(), get_first_attribute(), has_field(), and Botan::operator>>().

dn_info()

const std::vector< std::pair< OID, ASN1_String > > & Botan::X509_DN::dn_info ( ) const

inline

Return the DN components as a vector. Note that the order of the components is preserved only when using the initializer list constructor.

Definition at line 98 of file pkix_types.h.

{ return m_rdn; }

Referenced by Botan::PKIX::check_chain(), and Botan::operator<<().

empty()

bool Botan::X509_DN::empty ( ) const

inline

Definition at line 88 of file pkix_types.h.

{ return m_rdn.empty(); }

Referenced by Botan::NameConstraints::is_permitted().

encode_into()

void Botan::X509_DN::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 317 of file x509_dn.cpp.

                                                {
   der.start_sequence();
 
   if(!m_dn_bits.empty()) {
      /*
      If we decoded this from somewhere, encode it back exactly as
      we received it
      */
      der.raw_bytes(m_dn_bits);
   } else {
      for(const auto& dn : m_rdn) {
         der.start_set().start_sequence().encode(dn.first).encode(dn.second).end_cons().end_cons();
      }
   }
 
   der.end_cons();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::raw_bytes(), Botan::DER_Encoder::start_sequence(), and Botan::DER_Encoder::start_set().

Referenced by DER_encode().

get_attribute()

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

(

std::string_view

attr

)

const

Definition at line 181 of file x509_dn.cpp.

                                                                     {
   const OID oid = OID::from_string(deref_info_field(attr));
 
   std::vector<std::string> values;
 
   for(const auto& i : m_rdn) {
      if(i.first == oid) {
         values.push_back(i.second.value());
      }
   }
 
   return values;
}

References deref_info_field(), and Botan::OID::from_string().

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

get_attributes()

std::multimap< OID, std::string > Botan::X509_DN::get_attributes

(

)

const

Definition at line 121 of file x509_dn.cpp.

                                                          {
   std::multimap<OID, std::string> retval;
 
   for(const auto& i : m_rdn) {
      retval.emplace(i.first, i.second.value());
   }
   return retval;
}

Referenced by Botan::operator<(), and Botan::operator==().

get_bits()

const std::vector< uint8_t > & Botan::X509_DN::get_bits ( ) const

inline

Definition at line 84 of file pkix_types.h.

{ return m_dn_bits; }

Referenced by botan_x509_crl_view_binary_values().

get_first_attribute() [1/2]

ASN1_String Botan::X509_DN::get_first_attribute

(

const OID &

oid

)

const

Definition at line 168 of file x509_dn.cpp.

                                                             {
   for(const auto& i : m_rdn) {
      if(i.first == oid) {
         return i.second;
      }
   }
 
   return ASN1_String();
}

Referenced by get_first_attribute().

get_first_attribute() [2/2]

std::string Botan::X509_DN::get_first_attribute

(

std::string_view

attr

)

const

Definition at line 163 of file x509_dn.cpp.

                                                                {
   const OID oid = OID::from_string(deref_info_field(attr));
   return get_first_attribute(oid).value();
}

References deref_info_field(), Botan::OID::from_string(), get_first_attribute(), and Botan::ASN1_String::value().

has_field() [1/2]

bool Botan::X509_DN::has_field

(

const OID &

oid

)

const

Definition at line 153 of file x509_dn.cpp.

                                            {
   for(const auto& i : m_rdn) {
      if(i.first == oid) {
         return true;
      }
   }
 
   return false;
}

Referenced by has_field().

has_field() [2/2]

bool Botan::X509_DN::has_field

(

std::string_view

attr

)

const

Definition at line 142 of file x509_dn.cpp.

                                                 {
   try {
      const OID o = OID::from_string(deref_info_field(attr));
      if(o.has_value()) {
         return has_field(o);
      }
   } catch(Lookup_Error&) {}
 
   return false;
}

References deref_info_field(), Botan::OID::from_string(), has_field(), and Botan::OID::has_value().

lookup_ub()

size_t Botan::X509_DN::lookup_ub ( const OID & oid )

static

Lookup upper bounds in characters for the length of distinguished name fields as given in RFC 5280, Appendix A.

Parameters

oid	the oid of the DN to lookup

Returns

the upper bound, or zero if no ub is known to Botan

Definition at line 16 of file x509_dn_ub.cpp.

                                        {
   /*
   * See RFC 5280 Appendix A.1 starting with comment "-- Upper Bounds"
   */
 
   // NOLINTBEGIN(*-branch-clone)
   if(auto iso_dn = is_sub_element_of(oid, {2, 5, 4})) {
      switch(*iso_dn) {
         case 3:
            // X520.CommonName
            return 64;
         case 4:
            // X520.Surname
            return 40;
         case 5:
            // X520.SerialNumber
            return 64;
         case 6:
            // X520.Country
            return 3;
         case 7:
            // X520.Locality
            return 128;
         case 8:
            // X520.State
            return 128;
         case 9:
            // X520.StreetAddress
            return 128;
         case 10:
            // X520.Organization
            return 64;
         case 11:
            // X520.OrganizationalUnit
            return 64;
         case 12:
            // X520.Title
            return 64;
         case 42:
            // X520.GivenName
            return 16;
         case 43:
            // X520.Initials
            return 5;
         case 44:
            // X520.GenerationalQualifier
            return 3;
         case 46:
            // X520.DNQualifier
            return 64;
         case 65:
            // X520.Pseudonym
            return 128;
         default:
            return 0;
      }
   }
 
   // NOLINTEND(*-branch-clone)
 
   return 0;
}

References Botan::is_sub_element_of().

Referenced by Botan::PKIX::check_chain().

to_string()

std::string Botan::X509_DN::to_string

(

)

const

Definition at line 393 of file x509_dn.cpp.

                                   {
   std::ostringstream out;
   out << *this;
   return out.str();
}

Referenced by Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store().

---

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

• src/lib/x509/pkix_types.h
• src/lib/x509/x509_dn.cpp
• src/lib/x509/x509_dn_ub.cpp