Botan::X509_DN Class Reference

#include <x509_dn.h>

Inheritance diagram for Botan::X509_DN:

Public Member Functions
void	add_attribute (const std::string &key, const std::string &val)
void	add_attribute (const OID &oid, const std::string &val)
void	add_attribute (const OID &oid, const ASN1_String &val)
std::vector< uint8_t >	BER_encode () const
std::multimap< std::string, std::string >	contents () const
void	decode_from (class BER_Decoder &) override
const std::vector< std::pair< OID, ASN1_String > > &	dn_info () const
bool	empty () const
void	encode_into (class DER_Encoder &) const override
std::vector< std::string >	get_attribute (const std::string &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 (const std::string &attr) const
bool	has_field (const OID &oid) const
bool	has_field (const std::string &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)

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

Detailed Description

Distinguished Name

Definition at line 24 of file x509_dn.h.

Constructor & Destructor Documentation

Botan::X509_DN::X509_DN ( )

default

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

inlineexplicit

Definition at line 29 of file x509_dn.h.

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

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

inlineexplicit

Definition at line 35 of file x509_dn.h.

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

Member Function Documentation

void Botan::X509_DN::add_attribute	(	const std::string &	key,
		const std::string &	val
	)

Definition at line 23 of file x509_dn.cpp.

References Botan::OID::from_string().

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

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

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

inline

Definition at line 67 of file x509_dn.h.

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

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

Definition at line 32 of file x509_dn.cpp.

References Botan::ASN1_String::empty().

   {
   if(str.empty())
      return;

   m_rdn.push_back(std::make_pair(oid, str));
   m_dn_bits.clear();
   }

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 16 of file asn1_obj.cpp.

References Botan::ASN1_Object::encode_into().

Referenced by Botan::PSSR::config_for_x509(), 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().

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

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

(

)

const

Definition at line 56 of file x509_dn.cpp.

References Botan::multimap_insert().

   {
   std::multimap<std::string, std::string> retval;

   for(auto& i : m_rdn)
      {
      multimap_insert(retval, i.first.to_formatted_string(), i.second.value());
      }
   return retval;
   }

void Botan::X509_DN::decode_from ( class 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 272 of file x509_dn.cpp.

References add_attribute(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::more_items(), Botan::BER_Decoder::raw_bytes(), Botan::SEQUENCE, Botan::SET, Botan::BER_Decoder::start_cons(), and Botan::BER_Decoder::verify_end().

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

   {
   std::vector<uint8_t> bits;

   source.start_cons(SEQUENCE)
      .raw_bytes(bits)
   .end_cons();

   BER_Decoder sequence(bits);

   while(sequence.more_items())
      {
      BER_Decoder rdn = sequence.start_cons(SET);

      while(rdn.more_items())
         {
         OID oid;
         ASN1_String str;

         rdn.start_cons(SEQUENCE)
            .decode(oid)
            .decode(str) // TODO support Any
            .end_cons().verify_end("Invalid X509_DN, data follows RDN");

         add_attribute(oid, str);
         }
      }

   m_dn_bits = bits;
   }

std::string Botan::X509_DN::deref_info_field ( const std::string &  key )

static

Definition at line 129 of file x509_dn.cpp.

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

   {
   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 info;
   }

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

inline

Definition at line 56 of file x509_dn.h.

Referenced by Botan::operator<<().

{ return m_rdn; }

bool Botan::X509_DN::empty ( ) const

inline

Definition at line 52 of file x509_dn.h.

Referenced by Botan::OCSP::Response::check_signature().

{ return m_rdn.empty(); }

void Botan::X509_DN::encode_into ( class 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 241 of file x509_dn.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::SET, and Botan::DER_Encoder::start_cons().

   {
   der.start_cons(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_cons(SET)
            .start_cons(SEQUENCE)
            .encode(dn.first)
            .encode(dn.second)
            .end_cons()
         .end_cons();
         }
      }

   der.end_cons();
   }

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

(

const std::string &

attr

)

const

Definition at line 109 of file x509_dn.cpp.

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

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

   {
   const OID oid = OID::from_string(deref_info_field(attr));

   std::vector<std::string> values;

   for(auto& i : m_rdn)
      {
      if(i.first == oid)
         {
         values.push_back(i.second.value());
         }
      }

   return values;
   }

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

(

)

const

Definition at line 44 of file x509_dn.cpp.

References Botan::multimap_insert().

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

   {
   std::multimap<OID, std::string> retval;

   for(auto& i : m_rdn)
      multimap_insert(retval, i.first, i.second.value());
   return retval;
   }

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

inline

Definition at line 50 of file x509_dn.h.

{ return m_dn_bits; }

ASN1_String Botan::X509_DN::get_first_attribute

(

const OID &

oid

)

const

Definition at line 93 of file x509_dn.cpp.

Referenced by get_first_attribute().

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

   return ASN1_String();
   }

std::string Botan::X509_DN::get_first_attribute

(

const std::string &

attr

)

const

Definition at line 87 of file x509_dn.cpp.

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

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

bool Botan::X509_DN::has_field

(

const OID &

oid

)

const

Definition at line 76 of file x509_dn.cpp.

Referenced by has_field().

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

   return false;
   }

bool Botan::X509_DN::has_field

(

const std::string &

attr

)

const

Definition at line 67 of file x509_dn.cpp.

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

   {
   const OID o = OIDS::str2oid_or_empty(deref_info_field(attr));
   if(o.has_value())
      return has_field(o);
   else
      return false;
   }

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 47 of file x509_dn_ub.cpp.

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

   {
   auto ub_entry = DN_UB.find(oid);
   if(ub_entry != DN_UB.end())
      {
      return ub_entry->second;
      }
   else
      {
      return 0;
      }
   }

std::string Botan::X509_DN::to_string

(

)

const

Definition at line 326 of file x509_dn.cpp.

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

---

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

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