Botan::ASN1_String Class Reference

#include <asn1_str.h>

Inheritance diagram for Botan::ASN1_String:

Public Member Functions
	ASN1_String (const std::string &utf8="")
	ASN1_String (const std::string &utf8, ASN1_Tag tag)
std::vector< uint8_t >	BER_encode () const
void	decode_from (class BER_Decoder &) override
bool	empty () const
void	encode_into (class DER_Encoder &) const override
std::string	iso_8859 () const
bool	operator== (const ASN1_String &other) const
size_t	size () const
ASN1_Tag	tagging () const
const std::string &	value () const

Static Public Member Functions
static bool	is_string_type (ASN1_Tag tag)

Detailed Description

ASN.1 string type This class normalizes all inputs to a UTF-8 std::string

Definition at line 19 of file asn1_str.h.

Constructor & Destructor Documentation

ASN1_String() [1/2]

Botan::ASN1_String::ASN1_String ( const std::string &  utf8 = "" )

explicit

Definition at line 97 of file asn1_str.cpp.

                                             :
   m_utf8_str(str),
   m_tag(choose_encoding(m_utf8_str))
   {}

ASN1_String() [2/2]

Botan::ASN1_String::ASN1_String	(	const std::string &	utf8,
		ASN1_Tag	tag
	)

Definition at line 84 of file asn1_str.cpp.

References Botan::DIRECTORY_STRING.

                                                         : m_utf8_str(str), m_tag(t)
   {
   if(m_tag == DIRECTORY_STRING)
      {
      m_tag = choose_encoding(m_utf8_str);
      }

   assert_is_string_type(m_tag);
   }

Member Function Documentation

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

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

decode_from()

void Botan::ASN1_String::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 129 of file asn1_str.cpp.

References Botan::BER_Object::bits(), Botan::BMP_STRING, Botan::BER_Decoder::get_next_object(), Botan::BER_Object::length(), Botan::ASN1::to_string(), Botan::BER_Object::type(), Botan::ucs2_to_utf8(), Botan::ucs4_to_utf8(), and Botan::UNIVERSAL_STRING.

   {
   BER_Object obj = source.get_next_object();

   assert_is_string_type(obj.type());

   m_tag = obj.type();
   m_data.assign(obj.bits(), obj.bits() + obj.length());

   if(m_tag == BMP_STRING)
      {
      m_utf8_str = ucs2_to_utf8(m_data.data(), m_data.size());
      }
   else if(m_tag == UNIVERSAL_STRING)
      {
      m_utf8_str = ucs4_to_utf8(m_data.data(), m_data.size());
      }
   else
      {
      // All other supported string types are UTF-8 or some subset thereof
      m_utf8_str = ASN1::to_string(obj);
      }
   }

empty()

bool Botan::ASN1_String::empty ( ) const

inline

Definition at line 31 of file asn1_str.h.

Referenced by Botan::X509_DN::add_attribute().

{ return m_utf8_str.empty(); }

encode_into()

void Botan::ASN1_String::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 113 of file asn1_str.cpp.

References Botan::DER_Encoder::add_object(), tagging(), and Botan::UNIVERSAL.

   {
   if(m_data.empty())
      {
      encoder.add_object(tagging(), UNIVERSAL, m_utf8_str);
      }
   else
      {
      // If this string was decoded, reserialize using original encoding
      encoder.add_object(tagging(), UNIVERSAL, m_data.data(), m_data.size());
      }
   }

is_string_type()

bool Botan::ASN1_String::is_string_type ( ASN1_Tag  tag )

static

Return true iff this is a tag for a known string type we can handle. This ignores string types that are not supported, eg teletexString

Definition at line 68 of file asn1_str.cpp.

References Botan::BMP_STRING, Botan::IA5_STRING, Botan::NUMERIC_STRING, Botan::PRINTABLE_STRING, Botan::T61_STRING, Botan::UNIVERSAL_STRING, Botan::UTF8_STRING, and Botan::VISIBLE_STRING.

Referenced by Botan::AlternativeName::decode_from(), and Botan::ASN1_Formatter::print_to_stream().

   {
   return (tag == NUMERIC_STRING ||
           tag == PRINTABLE_STRING ||
           tag == VISIBLE_STRING ||
           tag == T61_STRING ||
           tag == IA5_STRING ||
           tag == UTF8_STRING ||
           tag == BMP_STRING ||
           tag == UNIVERSAL_STRING);
   }

iso_8859()

std::string Botan::ASN1_String::iso_8859

(

)

const

Definition at line 105 of file asn1_str.cpp.

References Botan::utf8_to_latin1().

   {
   return utf8_to_latin1(m_utf8_str);
   }

operator==()

bool Botan::ASN1_String::operator== ( const ASN1_String &  other ) const

inline

Definition at line 42 of file asn1_str.h.

References value().

         { return value() == other.value(); }

size()

size_t Botan::ASN1_String::size ( ) const

inline

Definition at line 29 of file asn1_str.h.

{ return value().size(); }

tagging()

ASN1_Tag Botan::ASN1_String::tagging ( ) const

inline

Definition at line 25 of file asn1_str.h.

Referenced by encode_into().

{ return m_tag; }

value()

const std::string& Botan::ASN1_String::value ( ) const

inline

Definition at line 27 of file asn1_str.h.

Referenced by Botan::PKCS10_Request::create(), Botan::X509_DN::get_first_attribute(), Botan::AlternativeName::has_items(), operator==(), Botan::ASN1_Formatter::print_to_stream(), Botan::TLS::Session::Session(), and Botan::Cert_Extension::Certificate_Policies::validate().

{ return m_utf8_str; }

---

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

• src/lib/asn1/asn1_str.h
• src/lib/asn1/asn1_str.cpp