Botan::ASN1_String Class Reference

#include <asn1_obj.h>

Inheritance diagram for Botan::ASN1_String:

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

Static Public Member Functions
static bool	is_string_type (ASN1_Type tag)

Friends
bool	operator< (const ASN1_String &a, const ASN1_String &b)

Detailed Description

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

Definition at line 577 of file asn1_obj.h.

Constructor & Destructor Documentation

ASN1_String() [1/2]

Botan::ASN1_String::ASN1_String ( std::string_view utf8 = "" )

explicit

Create a string, tagged as PrintableString if possible and otherwise as Utf8String

Parameters

utf8	the value of the string, encoded as UTF-8

Definition at line 145 of file asn1_str.cpp.

: ASN1_String(str, choose_encoding(str)) {}

References ASN1_String().

Referenced by ASN1_String(), operator<, and operator==().

ASN1_String() [2/2]

Botan::ASN1_String::ASN1_String	(	std::string_view	utf8,
		ASN1_Type	tag )

Create a string with a specific type tag

Parameters

utf8	the value of the string, encoded as UTF-8
tag	the string type tag to encode this value with

Throws Invalid_Argument if tag is not a string type that is a subset of UTF-8, or if utf8 is not a valid value for that type.

Definition at line 135 of file asn1_str.cpp.

                                                        : m_utf8_str(str), m_tag(t) {
   if(!is_utf8_subset_string_type(m_tag)) {
      throw Invalid_Argument("ASN1_String only supports encoding to UTF-8 or a UTF-8 subset");
   }
 
   if(!is_valid_asn1_string_content(m_utf8_str, m_tag)) {
      throw Invalid_Argument(fmt("ASN1_String: Invalid {} encoding", asn1_tag_to_string(m_tag)));
   }
}

References Botan::asn1_tag_to_string(), and Botan::fmt().

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 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().

decode_from()

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

                                                 {
   const BER_Object obj = source.get_next_object();
 
   if(obj.get_class() != ASN1_Class::Universal || !is_asn1_string_type(obj.type())) {
      auto typ = static_cast<uint32_t>(obj.type());
      auto cls = static_cast<uint32_t>(obj.get_class());
      throw Decoding_Error(fmt("ASN1_String: Unknown string type {}/{}", typ, cls));
   }
 
   m_tag = obj.type();
   m_data.assign(obj.bits(), obj.bits() + obj.length());
 
   if(m_tag == ASN1_Type::BmpString) {
      m_utf8_str = ucs2_to_utf8(m_data);
   } else if(m_tag == ASN1_Type::UniversalString) {
      m_utf8_str = ucs4_to_utf8(m_data);
   } else if(m_tag == ASN1_Type::TeletexString) {
      /*
      TeletexString is nominally ITU T.61 not ISO-8859-1 but it seems
      the majority of implementations actually used that charset here.
      */
      m_utf8_str = latin1_to_utf8(m_data);
   } else {
      // All other supported string types are UTF-8 or some subset thereof
      m_utf8_str = ASN1::to_string(obj);
 
      if(!is_valid_asn1_string_content(m_utf8_str, m_tag)) {
         throw Decoding_Error(fmt("ASN1_String: Invalid {} encoding", asn1_tag_to_string(m_tag)));
      }
   }
}

References Botan::asn1_tag_to_string(), Botan::BER_Object::bits(), Botan::BmpString, Botan::fmt(), Botan::BER_Object::get_class(), Botan::BER_Decoder::get_next_object(), Botan::latin1_to_utf8(), Botan::BER_Object::length(), Botan::TeletexString, Botan::ASN1::to_string(), Botan::BER_Object::type(), Botan::ucs2_to_utf8(), Botan::ucs4_to_utf8(), Botan::Universal, and Botan::UniversalString.

empty()

bool Botan::ASN1_String::empty ( ) const

inline

Return true if this string is empty

Definition at line 600 of file asn1_obj.h.

{ return m_utf8_str.empty(); }

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

encode_into()

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

                                                        {
   if(is_utf8_subset_string_type(tagging())) {
      encoder.add_object(tagging(), ASN1_Class::Universal, m_utf8_str);
   } else {
      // BMP/Universal/Teletex: m_utf8_str is the UTF-8 conversion, m_data is the wire form
      encoder.add_object(tagging(), ASN1_Class::Universal, m_data.data(), m_data.size());
   }
}

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

is_string_type()

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

static

Return true iff this is a tag for a known string type we can handle.

Definition at line 131 of file asn1_str.cpp.

                                              {
   return is_asn1_string_type(tag);
}

Referenced by Botan::AlternativeName::decode_from().

operator==()

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

inline

Compare two strings, ignoring the type tag they were encoded with

Definition at line 610 of file asn1_obj.h.

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

References ASN1_String(), and value().

size()

size_t Botan::ASN1_String::size ( ) const

inline

Return the length in bytes of the UTF-8 representation of this string

Definition at line 595 of file asn1_obj.h.

{ return value().size(); }

References value().

tagging()

ASN1_Type Botan::ASN1_String::tagging ( ) const

inline

Return the string type tag this value was encoded with

Definition at line 585 of file asn1_obj.h.

{ return m_tag; }

Referenced by encode_into().

value()

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

inline

Return the value of this string, converted to UTF-8

Definition at line 590 of file asn1_obj.h.

{ return m_utf8_str; }

Referenced by Botan::Cert_Extension::TNAuthList::Entry::decode_from(), Botan::AlternativeName::encode_into(), Botan::GeneralName::encode_into(), Botan::X509_DN::get_first_attribute(), operator<, operator==(), Botan::TLS::Session::Session(), and size().

Friends And Related Symbol Documentation

operator<

bool operator< ( const ASN1_String & a, const ASN1_String & b )

friend

Definition at line 612 of file asn1_obj.h.

{ return a.value() < b.value(); }

References ASN1_String(), and value().

---

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

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