Botan::BER_Object Class Reference

#include <asn1_obj.h>

Public Member Functions
void	assert_is_a (ASN1_Type type_tag, ASN1_Class class_tag, std::string_view descr="object") const
	BER_Object ()=default
	BER_Object (BER_Object &&other)=default
	BER_Object (const BER_Object &other)=default
const uint8_t *	bits () const
ASN1_Class	class_tag () const
std::span< const uint8_t >	data () const
ASN1_Class	get_class () const
bool	is_a (ASN1_Type type_tag, ASN1_Class class_tag) const
bool	is_a (int type_tag, ASN1_Class class_tag) const
bool	is_set () const
size_t	length () const
BER_Object &	operator= (BER_Object &&other)=default
BER_Object &	operator= (const BER_Object &other)=default
uint32_t	tagging () const
ASN1_Type	type () const
ASN1_Type	type_tag () const
	~BER_Object ()

Friends
class	BER_Decoder

Detailed Description

BER Encoded Object

Definition at line 234 of file asn1_obj.h.

Constructor & Destructor Documentation

BER_Object() [1/3]

Botan::BER_Object::BER_Object ( )

default

Create an unset BER_Object

Referenced by BER_Object(), BER_Object(), operator=(), and operator=().

BER_Object() [2/3]

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

default

Copy constructor

References BER_Object().

BER_Object() [3/3]

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

default

Move constructor

References BER_Object().

~BER_Object()

Botan::BER_Object::~BER_Object

(

)

Definition at line 58 of file asn1_obj.cpp.

                        {
   secure_scrub_memory(m_value);
}

References Botan::secure_scrub_memory().

Member Function Documentation

assert_is_a()

void Botan::BER_Object::assert_is_a	(	ASN1_Type	type_tag,
		ASN1_Class	class_tag,
		std::string_view	descr = "object" ) const

Throw BER_Decoding_Error unless this object has the expected tagging

Parameters

type_tag	the expected type tag
class_tag	the expected class tag
descr	a description of the object, used in the exception message

Definition at line 65 of file asn1_obj.cpp.

                                                                                                                   {
   if(!this->is_a(expected_type_tag, expected_class_tag)) {
      std::stringstream msg;
 
      msg << "Tag mismatch when decoding " << descr << " got ";
 
      if(m_class_tag == ASN1_Class::NoObject && m_type_tag == ASN1_Type::NoObject) {
         msg << "EOF";
      } else {
         if(m_class_tag == ASN1_Class::Universal || m_class_tag == ASN1_Class::Constructed) {
            msg << asn1_tag_to_string(m_type_tag);
         } else {
            msg << std::to_string(static_cast<uint32_t>(m_type_tag));
         }
 
         msg << "/" << asn1_class_to_string(m_class_tag);
      }
 
      msg << " expected ";
 
      if(expected_class_tag == ASN1_Class::Universal || expected_class_tag == ASN1_Class::Constructed) {
         msg << asn1_tag_to_string(expected_type_tag);
      } else {
         msg << std::to_string(static_cast<uint32_t>(expected_type_tag));
      }
 
      msg << "/" << asn1_class_to_string(expected_class_tag);
 
      throw BER_Decoding_Error(msg.str());
   }
}

References Botan::asn1_class_to_string(), Botan::asn1_tag_to_string(), Botan::Constructed, is_a(), Botan::NoObject, and Botan::Universal.

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

bits()

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

inline

Return a pointer to the contents of this object, excluding the tag and length header

Definition at line 298 of file asn1_obj.h.

{ return m_value.data(); }

Referenced by Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_bitstring(), Botan::AlternativeName::decode_from(), Botan::ASN1_String::decode_from(), Botan::GeneralName::decode_from(), Botan::BER_Decoder::get_next_value(), and Botan::BER_Decoder::start_cons().

class_tag()

ASN1_Class Botan::BER_Object::class_tag ( ) const

inline

Return the class tag of this object

Definition at line 282 of file asn1_obj.h.

{ return m_class_tag; }

Referenced by BER_Decoder, Botan::BER_Decoder::decode_bitstring(), Botan::AlternativeName::decode_from(), and tagging().

data()

std::span< const uint8_t > Botan::BER_Object::data ( ) const

inline

Return the contents of this object, excluding the tag and length header

Definition at line 308 of file asn1_obj.h.

{ return std::span{m_value}; }

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

get_class()

ASN1_Class Botan::BER_Object::get_class ( ) const

inline

Return the class tag of this object, an alias for class_tag()

Definition at line 292 of file asn1_obj.h.

{ return m_class_tag; }

Referenced by Botan::AlternativeName::decode_from(), Botan::ASN1_String::decode_from(), Botan::ASN1_Time::decode_from(), and Botan::Cert_Extension::TNAuthList::Entry::decode_from().

is_a() [1/2]

bool Botan::BER_Object::is_a	(	ASN1_Type	type_tag,
		ASN1_Class	class_tag ) const

Return true if this object has the given tagging

Parameters

type_tag	the expected type tag
class_tag	the expected class tag

Definition at line 97 of file asn1_obj.cpp.

                                                                                      {
   return (m_type_tag == expected_type_tag && m_class_tag == expected_class_tag);
}

Referenced by assert_is_a(), Botan::AlternativeName::decode_from(), Botan::Cert_Extension::DistributionPointName::decode_from(), Botan::GeneralName::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::BER_Decoder::decode_optional(), Botan::BER_Decoder::decode_optional_implicit(), Botan::BER_Decoder::decode_optional_octet_aligned_bitstring(), Botan::BER_Decoder::decode_optional_string(), is_a(), and Botan::OCSP::Response::Response().

is_a() [2/2]

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

Return true if this object has the given tagging

Parameters

type_tag	the expected type tag, typically a context specific tag number
class_tag	the expected class tag

Definition at line 101 of file asn1_obj.cpp.

                                                                                {
   return is_a(ASN1_Type(expected_type_tag), expected_class_tag);
}

References is_a().

is_set()

bool Botan::BER_Object::is_set ( ) const

inline

Return true if this object holds a value, ie if it was not read past the end of the input

Definition at line 267 of file asn1_obj.h.

{ return m_type_tag != ASN1_Type::NoObject; }

References Botan::NoObject.

Referenced by Botan::BER_Decoder::get_next_object().

length()

size_t Botan::BER_Object::length ( ) const

inline

Return the length in bytes of the contents of this object

Definition at line 303 of file asn1_obj.h.

{ return m_value.size(); }

Referenced by BER_Decoder, Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_bitstring(), Botan::AlternativeName::decode_from(), Botan::ASN1_String::decode_from(), Botan::GeneralName::decode_from(), Botan::OID::decode_from(), Botan::BER_Decoder::decode_null(), Botan::BER_Decoder::get_next_value(), and Botan::BER_Decoder::start_cons().

operator=() [1/2]

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

default

Move assignment

References BER_Object().

operator=() [2/2]

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

default

Copy assignment

References BER_Object().

tagging()

uint32_t Botan::BER_Object::tagging ( ) const

inline

Return the type and class tags combined into a single value

Definition at line 272 of file asn1_obj.h.

{ return type_tag() | class_tag(); }

References class_tag(), and type_tag().

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

type()

ASN1_Type Botan::BER_Object::type ( ) const

inline

Return the type tag of this object, an alias for type_tag()

Definition at line 287 of file asn1_obj.h.

{ return m_type_tag; }

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

type_tag()

ASN1_Type Botan::BER_Object::type_tag ( ) const

inline

Return the type tag of this object

Definition at line 277 of file asn1_obj.h.

{ return m_type_tag; }

Referenced by BER_Decoder, Botan::AlternativeName::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdentifierChoice::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::decode_from(), Botan::Cert_Extension::TNAuthList::Entry::decode_from(), and tagging().

Friends And Related Symbol Documentation

BER_Decoder

friend class BER_Decoder

friend

Definition at line 340 of file asn1_obj.h.

References BER_Decoder, class_tag(), length(), and type_tag().

Referenced by BER_Decoder.

---

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

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