Botan::BER_Object Class Reference

#include <asn1_obj.h>

Public Member Functions
void	assert_is_a (ASN1_Tag type_tag, ASN1_Tag class_tag, const std::string &descr="object") const
	BER_Object ()
	BER_Object (const BER_Object &other)=default
	BER_Object (BER_Object &&other)=default
const uint8_t *	bits () const
ASN1_Tag	get_class () const
bool	is_a (ASN1_Tag type_tag, ASN1_Tag class_tag) const
bool	is_a (int type_tag, ASN1_Tag class_tag) const
bool	is_set () const
size_t	length () const
BER_Object &	operator= (const BER_Object &other)=default
BER_Object &	operator= (BER_Object &&other)=default
ASN1_Tag	tagging () const
ASN1_Tag	type () const

Public Attributes
BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES	__pad0__: ASN1_Tag type_tag
BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES	class_tag
secure_vector< uint8_t >	value

Friends
class	BER_Decoder

Detailed Description

BER Encoded Object

Definition at line 96 of file asn1_obj.h.

Constructor & Destructor Documentation

BER_Object() [1/3]

Botan::BER_Object::BER_Object ( )

inline

Definition at line 99 of file asn1_obj.h.

: type_tag(NO_OBJECT), class_tag(UNIVERSAL) {}

BER_Object() [2/3]

Botan::BER_Object::BER_Object ( const BER_Object &  other )

default

BER_Object() [3/3]

Botan::BER_Object::BER_Object ( BER_Object &&  other )

default

Member Function Documentation

assert_is_a()

void Botan::BER_Object::assert_is_a	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag,
		const std::string &	descr = "object"
	)		const

Definition at line 27 of file asn1_obj.cpp.

References Botan::asn1_class_to_string(), Botan::asn1_tag_to_string(), class_tag, Botan::CONSTRUCTED, is_a(), Botan::NO_OBJECT, Botan::ASN1::to_string(), and Botan::UNIVERSAL.

Referenced by Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_null(), Botan::BER_Decoder::get_next_value(), and Botan::BER_Decoder::start_cons().

   {
   if(this->is_a(type_tag_, class_tag_) == false)
      {
      std::stringstream msg;

      msg << "Tag mismatch when decoding " << descr << " got ";

      if(class_tag == NO_OBJECT && type_tag == NO_OBJECT)
         {
         msg << "EOF";
         }
      else
         {
         if(class_tag == UNIVERSAL || class_tag == CONSTRUCTED)
            {
            msg << asn1_tag_to_string(type_tag);
            }
         else
            {
            msg << std::to_string(type_tag);
            }

         msg << "/" << asn1_class_to_string(class_tag);
         }

      msg << " expected ";

      if(class_tag_ == UNIVERSAL || class_tag_ == CONSTRUCTED)
         {
         msg << asn1_tag_to_string(type_tag_);
         }
      else
         {
         msg << std::to_string(type_tag_);
         }

      msg << "/" << asn1_class_to_string(class_tag_);

      throw BER_Decoding_Error(msg.str());
      }
   }

bits()

const uint8_t* Botan::BER_Object::bits ( ) const

inline

Definition at line 116 of file asn1_obj.h.

Referenced by Botan::BER_Decoder::decode(), Botan::ASN1_String::decode_from(), Botan::OID::decode_from(), Botan::AlternativeName::decode_from(), Botan::BER_Decoder::get_next_value(), and Botan::ASN1::to_string().

{ return value.data(); }

get_class()

ASN1_Tag Botan::BER_Object::get_class ( ) const

inline

Definition at line 114 of file asn1_obj.h.

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

{ return class_tag; }

is_a() [1/2]

bool Botan::BER_Object::is_a	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag
	)		const

Definition at line 71 of file asn1_obj.cpp.

References class_tag.

Referenced by assert_is_a(), Botan::AlternativeName::decode_from(), Botan::GeneralName::decode_from(), Botan::BER_Decoder::decode_optional(), Botan::BER_Decoder::decode_optional_implicit(), Botan::BER_Decoder::decode_optional_string(), and is_a().

   {
   return (type_tag == type_tag_ && class_tag == class_tag_);
   }

is_a() [2/2]

bool Botan::BER_Object::is_a	(	int	type_tag,
		ASN1_Tag	class_tag
	)		const

Definition at line 76 of file asn1_obj.cpp.

References is_a().

   {
   return is_a(ASN1_Tag(type_tag_), class_tag_);
   }

is_set()

bool Botan::BER_Object::is_set ( ) const

inline

Definition at line 109 of file asn1_obj.h.

References Botan::NO_OBJECT.

Referenced by Botan::BER_Decoder::get_next_object(), Botan::BER_Decoder::more_items(), Botan::BER_Decoder::push_back(), and Botan::BER_Decoder::verify_end().

{ return type_tag != NO_OBJECT; }

length()

size_t Botan::BER_Object::length ( ) const

inline

Definition at line 118 of file asn1_obj.h.

Referenced by Botan::BER_Decoder::decode(), Botan::ASN1_String::decode_from(), Botan::OID::decode_from(), Botan::AlternativeName::decode_from(), Botan::BER_Decoder::decode_null(), Botan::BER_Decoder::get_next_value(), and Botan::ASN1::to_string().

{ return value.size(); }

operator=() [1/2]

BER_Object& Botan::BER_Object::operator= ( const BER_Object &  other )

default

operator=() [2/2]

BER_Object& Botan::BER_Object::operator= ( BER_Object &&  other )

default

tagging()

ASN1_Tag Botan::BER_Object::tagging ( ) const

inline

Definition at line 111 of file asn1_obj.h.

References type.

Referenced by Botan::OID::decode_from(), and Botan::BER_Decoder::get_next_object().

{ return ASN1_Tag(type() | get_class()); }

type()

ASN1_Tag Botan::BER_Object::type ( ) const

inline

Definition at line 113 of file asn1_obj.h.

Referenced by Botan::ASN1_String::decode_from(), Botan::AlternativeName::decode_from(), and Botan::X509_Time::decode_from().

{ return type_tag; }

Friends And Related Function Documentation

BER_Decoder

friend class BER_Decoder

friend

Definition at line 138 of file asn1_obj.h.

Member Data Documentation

__pad0__

BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES Botan::BER_Object::__pad0__

Definition at line 133 of file asn1_obj.h.

class_tag

BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES Botan::BER_Object::class_tag

Definition at line 133 of file asn1_obj.h.

Referenced by assert_is_a(), and is_a().

value

secure_vector<uint8_t> Botan::BER_Object::value

Definition at line 134 of file asn1_obj.h.

---

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

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