Botan::BER_Decoder Class Reference

#include <ber_dec.h>

Public Member Functions
	BER_Decoder (BER_Decoder &&other)=default
BOTAN_FUTURE_EXPLICIT	BER_Decoder (BER_Object &&obj)
	BER_Decoder (const BER_Decoder &other)
BOTAN_FUTURE_EXPLICIT	BER_Decoder (const BER_Object &obj)
	BER_Decoder (const secure_vector< uint8_t > &vec)
	BER_Decoder (const std::vector< uint8_t > &vec)
	BER_Decoder (const uint8_t buf[], size_t len)
	BER_Decoder (DataSource &src)
BOTAN_FUTURE_EXPLICIT	BER_Decoder (std::span< const uint8_t > buf)
BER_Decoder &	decode (ASN1_Object &obj, ASN1_Type type_tag=ASN1_Type::NoObject, ASN1_Class class_tag=ASN1_Class::NoObject)
BER_Decoder &	decode (BigInt &out)
BER_Decoder &	decode (BigInt &v, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
BER_Decoder &	decode (bool &out)
BER_Decoder &	decode (bool &v, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
BER_Decoder &	decode (secure_vector< uint8_t > &v, ASN1_Type real_type, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
BER_Decoder &	decode (size_t &out)
BER_Decoder &	decode (size_t &v, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
BER_Decoder &	decode (std::vector< uint8_t > &v, ASN1_Type real_type, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
template<typename Alloc>
BER_Decoder &	decode (std::vector< uint8_t, Alloc > &out, ASN1_Type real_type)
template<typename T>
BER_Decoder &	decode_and_check (const T &expected, std::string_view error_msg)
uint64_t	decode_constrained_integer (ASN1_Type type_tag, ASN1_Class class_tag, size_t T_bytes)
template<typename T>
BER_Decoder &	decode_integer_type (T &out)
template<typename T>
BER_Decoder &	decode_integer_type (T &out, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
template<typename T>
BER_Decoder &	decode_list (std::vector< T > &out, ASN1_Type type_tag=ASN1_Type::Sequence, ASN1_Class class_tag=ASN1_Class::Universal)
BER_Decoder &	decode_null ()
BER_Decoder &	decode_octet_string_bigint (BigInt &b)
template<typename T>
BER_Decoder &	decode_optional (std::optional< T > &out, ASN1_Type type_tag, ASN1_Class class_tag)
template<typename T>
BER_Decoder &	decode_optional (T &out, ASN1_Type type_tag, ASN1_Class class_tag, const T &default_value=T())
template<typename T>
BER_Decoder &	decode_optional_implicit (T &out, ASN1_Type type_tag, ASN1_Class class_tag, ASN1_Type real_type, ASN1_Class real_class, const T &default_value=T())
template<typename T>
bool	decode_optional_list (std::vector< T > &out, ASN1_Type type_tag=ASN1_Type::Sequence, ASN1_Class class_tag=ASN1_Class::Universal)
template<typename Alloc>
BER_Decoder &	decode_optional_string (std::vector< uint8_t, Alloc > &out, ASN1_Type real_type, ASN1_Type expected_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
template<typename Alloc>
BER_Decoder &	decode_optional_string (std::vector< uint8_t, Alloc > &out, ASN1_Type real_type, uint32_t expected_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
BER_Decoder &	discard_remaining ()
BER_Decoder &	end_cons ()
BER_Decoder &	get_next (BER_Object &ber)
BER_Object	get_next_object ()
std::vector< uint8_t >	get_next_octet_string ()
template<typename T> requires std::is_standard_layout_v<T> && std::is_trivial_v<T>
BER_Decoder &	get_next_value (T &out, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
bool	more_items () const
BER_Decoder &	operator= (BER_Decoder &&)=default
BER_Decoder &	operator= (const BER_Decoder &)=delete
const BER_Object &	peek_next_object ()
void	push_back (BER_Object &&obj)
void	push_back (const BER_Object &obj)
template<typename Alloc>
BER_Decoder &	raw_bytes (std::vector< uint8_t, Alloc > &out)
BER_Decoder	start_cons (ASN1_Type type_tag, ASN1_Class class_tag)
BER_Decoder	start_context_specific (uint32_t tag)
BER_Decoder	start_explicit_context_specific (uint32_t tag)
BER_Decoder	start_sequence ()
BER_Decoder	start_set ()
BER_Decoder &	verify_end ()
BER_Decoder &	verify_end (std::string_view err_msg)
	~BER_Decoder ()=default

Detailed Description

BER Decoding Object

Definition at line 22 of file ber_dec.h.

Constructor & Destructor Documentation

BER_Decoder() [1/9]

Botan::BER_Decoder::BER_Decoder	(	const uint8_t	buf[],
		size_t	len )

Set up to BER decode the data in buf of length len

Definition at line 335 of file ber_dec.cpp.

                                                            {
   m_data_src = std::make_unique<DataSource_Memory>(data, length);
   m_source = m_data_src.get();
}

Referenced by BER_Decoder(), BER_Decoder(), BER_Decoder(), BER_Decoder(), BER_Decoder(), decode(), decode(), decode(), decode(), decode(), decode(), decode(), decode(), decode(), decode(), decode_and_check(), decode_integer_type(), decode_integer_type(), decode_list(), decode_null(), decode_octet_string_bigint(), decode_optional(), decode_optional(), decode_optional_implicit(), decode_optional_string(), decode_optional_string(), discard_remaining(), end_cons(), get_next(), get_next_value(), operator=(), operator=(), raw_bytes(), start_cons(), start_context_specific(), start_explicit_context_specific(), start_sequence(), start_set(), verify_end(), verify_end(), and ~BER_Decoder().

BER_Decoder() [2/9]

BOTAN_FUTURE_EXPLICIT Botan::BER_Decoder::BER_Decoder ( std::span< const uint8_t > buf )

inline

Set up to BER decode the data in buf of length len

Definition at line 32 of file ber_dec.h.

: BER_Decoder(buf.data(), buf.size()) {}

References BER_Decoder(), and BOTAN_FUTURE_EXPLICIT.

BER_Decoder() [3/9]

Botan::BER_Decoder::BER_Decoder ( const secure_vector< uint8_t > & vec )

explicit

Set up to BER decode the data in vec

Definition at line 343 of file ber_dec.cpp.

                                                           {
   m_data_src = std::make_unique<DataSource_Memory>(data);
   m_source = m_data_src.get();
}

BER_Decoder() [4/9]

Botan::BER_Decoder::BER_Decoder ( const std::vector< uint8_t > & vec )

explicit

Set up to BER decode the data in vec

Definition at line 351 of file ber_dec.cpp.

                                                       {
   m_data_src = std::make_unique<DataSource_Memory>(data.data(), data.size());
   m_source = m_data_src.get();
}

BER_Decoder() [5/9]

Botan::BER_Decoder::BER_Decoder ( DataSource & src )

explicit

Set up to BER decode the data in src

Definition at line 330 of file ber_dec.cpp.

: m_source(&src) {}

BER_Decoder() [6/9]

BOTAN_FUTURE_EXPLICIT Botan::BER_Decoder::BER_Decoder ( const BER_Object & obj )

inline

Set up to BER decode the data in obj

Definition at line 52 of file ber_dec.h.

: BER_Decoder(obj.bits(), obj.length()) {}

References BER_Decoder(), and BOTAN_FUTURE_EXPLICIT.

BER_Decoder() [7/9]

BOTAN_FUTURE_EXPLICIT Botan::BER_Decoder::BER_Decoder ( BER_Object && obj )

inline

Set up to BER decode the data in obj

Definition at line 57 of file ber_dec.h.

: BER_Decoder(std::move(obj), nullptr) {}

References BER_Decoder(), and BOTAN_FUTURE_EXPLICIT.

BER_Decoder() [8/9]

Botan::BER_Decoder::BER_Decoder

(

const BER_Decoder &

other

)

Definition at line 359 of file ber_dec.cpp.

                                                 : m_parent(other.m_parent), m_source(other.m_source) {
   // take ownership of other's data source
   std::swap(m_data_src, other.m_data_src);
}

References BER_Decoder().

BER_Decoder() [9/9]

Botan::BER_Decoder::BER_Decoder ( BER_Decoder && other )

default

References BER_Decoder().

~BER_Decoder()

Botan::BER_Decoder::~BER_Decoder ( )

default

References BER_Decoder().

Member Function Documentation

decode() [1/10]

BER_Decoder & Botan::BER_Decoder::decode	(	ASN1_Object &	obj,
		ASN1_Type	type_tag = ASN1_Type::NoObject,
		ASN1_Class	class_tag = ASN1_Class::NoObject )

Definition at line 367 of file ber_dec.cpp.

                                                                            {
   obj.decode_from(*this);
   return (*this);
}

References BER_Decoder(), and Botan::ASN1_Object::decode_from().

decode() [2/10]

BER_Decoder & Botan::BER_Decoder::decode ( BigInt & out )

inline

Definition at line 198 of file ber_dec.h.

{ return decode(out, ASN1_Type::Integer, ASN1_Class::Universal); }

References BER_Decoder(), decode(), Botan::Integer, and Botan::Universal.

Referenced by decode().

decode() [3/10]

BER_Decoder & Botan::BER_Decoder::decode	(	BigInt &	v,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag = ASN1_Class::ContextSpecific )

Definition at line 459 of file ber_dec.cpp.

                                                                                      {
   BER_Object obj = get_next_object();
   obj.assert_is_a(type_tag, class_tag);
 
   if(obj.length() == 0) {
      out.clear();
   } else {
      const uint8_t first = obj.bits()[0];
      const bool negative = (first & 0x80) == 0x80;
 
      if(negative) {
         secure_vector<uint8_t> vec(obj.bits(), obj.bits() + obj.length());
         for(size_t i = obj.length(); i > 0; --i) {
            const bool gt0 = (vec[i - 1] > 0);
            vec[i - 1] -= 1;
            if(gt0) {
               break;
            }
         }
         for(size_t i = 0; i != obj.length(); ++i) {
            vec[i] = ~vec[i];
         }
         out._assign_from_bytes(vec);
         out.flip_sign();
      } else {
         out._assign_from_bytes(obj.data());
      }
   }
 
   return (*this);
}

References Botan::BigInt::_assign_from_bytes(), Botan::BER_Object::assert_is_a(), BER_Decoder(), Botan::BER_Object::bits(), Botan::BigInt::clear(), Botan::BER_Object::data(), Botan::BigInt::flip_sign(), get_next_object(), and Botan::BER_Object::length().

decode() [4/10]

BER_Decoder & Botan::BER_Decoder::decode ( bool & out )

inline

Decode a BER encoded BOOLEAN

Definition at line 188 of file ber_dec.h.

{ return decode(out, ASN1_Type::Boolean, ASN1_Class::Universal); }

References BER_Decoder(), Botan::Boolean, decode(), and Botan::Universal.

Referenced by Botan::TLS::Certificate_Authorities::Certificate_Authorities(), decode(), decode(), decode(), decode_and_check(), decode_constrained_integer(), Botan::AlgorithmIdentifier::decode_from(), Botan::AlternativeName::decode_from(), Botan::Attribute::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::decode_from(), Botan::Cert_Extension::TNAuthList::Entry::decode_from(), Botan::CRL_Entry::decode_from(), Botan::Extensions::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::OCSP::CertID::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::X509_DN::decode_from(), Botan::X509_Object::decode_from(), decode_list(), decode_octet_string_bigint(), decode_optional(), decode_optional_implicit(), decode_optional_string(), Botan::Ed25519_PrivateKey::Ed25519_PrivateKey(), Botan::Ed448_PrivateKey::Ed448_PrivateKey(), get_next_octet_string(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::X509::load_key(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::pbes2_decrypt(), Botan::OCSP::Response::Response(), Botan::RSA_PublicKey::RSA_PublicKey(), Botan::TLS::Session::Session(), and Botan::X25519_PrivateKey::X25519_PrivateKey().

decode() [5/10]

BER_Decoder & Botan::BER_Decoder::decode	(	bool &	v,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag = ASN1_Class::ContextSpecific )

Definition at line 394 of file ber_dec.cpp.

                                                                                    {
   BER_Object obj = get_next_object();
   obj.assert_is_a(type_tag, class_tag);
 
   if(obj.length() != 1) {
      throw BER_Decoding_Error("BER boolean value had invalid size");
   }
 
   const uint8_t val = obj.bits()[0];
 
   // TODO if decoding DER we should reject non-canonical booleans
   out = (val != 0) ? true : false;
 
   return (*this);
}

References Botan::BER_Object::assert_is_a(), BER_Decoder(), Botan::BER_Object::bits(), get_next_object(), and Botan::BER_Object::length().

decode() [6/10]

BER_Decoder & Botan::BER_Decoder::decode	(	secure_vector< uint8_t > &	v,
		ASN1_Type	real_type,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag = ASN1_Class::ContextSpecific )

Definition at line 524 of file ber_dec.cpp.

                                                       {
   if(real_type != ASN1_Type::OctetString && real_type != ASN1_Type::BitString) {
      throw BER_Bad_Tag("Bad tag for {BIT,OCTET} STRING", static_cast<uint32_t>(real_type));
   }
 
   asn1_decode_binary_string(buffer, get_next_object(), real_type, type_tag, class_tag);
   return (*this);
}

References BER_Decoder(), Botan::BitString, get_next_object(), and Botan::OctetString.

decode() [7/10]

BER_Decoder & Botan::BER_Decoder::decode ( size_t & out )

inline

Definition at line 193 of file ber_dec.h.

{ return decode(out, ASN1_Type::Integer, ASN1_Class::Universal); }

References BER_Decoder(), decode(), Botan::Integer, and Botan::Universal.

Referenced by decode().

decode() [8/10]

BER_Decoder & Botan::BER_Decoder::decode	(	size_t &	v,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag = ASN1_Class::ContextSpecific )

Definition at line 413 of file ber_dec.cpp.

                                                                                      {
   BigInt integer;
   decode(integer, type_tag, class_tag);
 
   if(integer.is_negative()) {
      throw BER_Decoding_Error("Decoded small integer value was negative");
   }
 
   if(integer.bits() > 32) {
      throw BER_Decoding_Error("Decoded integer value larger than expected");
   }
 
   out = 0;
   for(size_t i = 0; i != 4; ++i) {
      out = (out << 8) | integer.byte_at(3 - i);
   }
 
   return (*this);
}

References BER_Decoder(), Botan::BigInt::bits(), Botan::BigInt::byte_at(), decode(), and Botan::BigInt::is_negative().

decode() [9/10]

BER_Decoder & Botan::BER_Decoder::decode	(	std::vector< uint8_t > &	v,
		ASN1_Type	real_type,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag = ASN1_Class::ContextSpecific )

Definition at line 536 of file ber_dec.cpp.

                                                       {
   if(real_type != ASN1_Type::OctetString && real_type != ASN1_Type::BitString) {
      throw BER_Bad_Tag("Bad tag for {BIT,OCTET} STRING", static_cast<uint32_t>(real_type));
   }
 
   asn1_decode_binary_string(buffer, get_next_object(), real_type, type_tag, class_tag);
   return (*this);
}

References BER_Decoder(), Botan::BitString, get_next_object(), and Botan::OctetString.

decode() [10/10]

template<typename Alloc>

BER_Decoder & Botan::BER_Decoder::decode ( std::vector< uint8_t, Alloc > & out, ASN1_Type real_type )

inline

Definition at line 210 of file ber_dec.h.

                                                                               {
         return decode(out, real_type, real_type, ASN1_Class::Universal);
      }

References BER_Decoder(), decode(), and Botan::Universal.

decode_and_check()

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_and_check ( const T & expected, std::string_view error_msg )

inline

Definition at line 282 of file ber_dec.h.

                                                                                 {
         T actual;
         decode(actual);
 
         if(actual != expected) {
            throw Decoding_Error(error_msg);
         }
 
         return (*this);
      }

References BER_Decoder(), and decode().

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::OCSP::Response::Response(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::TLS::Session::Session().

decode_constrained_integer()

uint64_t Botan::BER_Decoder::decode_constrained_integer	(	ASN1_Type	type_tag,
		ASN1_Class	class_tag,
		size_t	T_bytes )

Definition at line 436 of file ber_dec.cpp.

                                                                                                         {
   if(T_bytes > 8) {
      throw BER_Decoding_Error("Can't decode small integer over 8 bytes");
   }
 
   BigInt integer;
   decode(integer, type_tag, class_tag);
 
   if(integer.bits() > 8 * T_bytes) {
      throw BER_Decoding_Error("Decoded integer value larger than expected");
   }
 
   uint64_t out = 0;
   for(size_t i = 0; i != 8; ++i) {
      out = (out << 8) | integer.byte_at(7 - i);
   }
 
   return out;
}

References Botan::BigInt::bits(), Botan::BigInt::byte_at(), and decode().

Referenced by decode_integer_type().

decode_integer_type() [1/2]

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_integer_type ( T & out )

inline

Definition at line 242 of file ber_dec.h.

                                               {
         return decode_integer_type<T>(out, ASN1_Type::Integer, ASN1_Class::Universal);
      }

References BER_Decoder(), decode_integer_type(), Botan::Integer, and Botan::Universal.

Referenced by decode_integer_type(), and Botan::TLS::Session::Session().

decode_integer_type() [2/2]

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_integer_type ( T & out, ASN1_Type type_tag, ASN1_Class class_tag = ASN1_Class::ContextSpecific )

inline

Definition at line 247 of file ber_dec.h.

                                                                                                                     {
         out = static_cast<T>(decode_constrained_integer(type_tag, class_tag, sizeof(out)));
         return (*this);
      }

References BER_Decoder(), Botan::ContextSpecific, and decode_constrained_integer().

decode_list()

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_list	(	std::vector< T > &	out,
		ASN1_Type	type_tag = ASN1_Type::Sequence,
		ASN1_Class	class_tag = ASN1_Class::Universal )

Definition at line 393 of file ber_dec.h.

                                                                                                 {
   BER_Decoder list = start_cons(type_tag, class_tag);
 
   while(list.more_items()) {
      T value;
      list.decode(value);
      vec.push_back(std::move(value));
   }
 
   list.end_cons();
 
   return (*this);
}

References BER_Decoder(), decode(), end_cons(), more_items(), push_back(), and start_cons().

Referenced by Botan::Cert_Extension::ASBlocks::ASIdentifierChoice::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::decode_from(), decode_optional_list(), Botan::OCSP::Response::Response(), and Botan::TLS::Session::Session().

decode_null()

BER_Decoder & Botan::BER_Decoder::decode_null

(

)

Definition at line 375 of file ber_dec.cpp.

                                      {
   BER_Object obj = get_next_object();
   obj.assert_is_a(ASN1_Type::Null, ASN1_Class::Universal);
   if(obj.length() > 0) {
      throw BER_Decoding_Error("NULL object had nonzero size");
   }
   return (*this);
}

References Botan::BER_Object::assert_is_a(), BER_Decoder(), get_next_object(), Botan::BER_Object::length(), Botan::Null, and Botan::Universal.

Referenced by Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::decode_from().

decode_octet_string_bigint()

BER_Decoder & Botan::BER_Decoder::decode_octet_string_bigint

(

BigInt &

b

)

Decode an integer value which is typed as an octet string

Definition at line 384 of file ber_dec.cpp.

                                                                {
   secure_vector<uint8_t> out_vec;
   decode(out_vec, ASN1_Type::OctetString);
   out = BigInt::from_bytes(out_vec);
   return (*this);
}

References BER_Decoder(), decode(), Botan::BigInt::from_bytes(), and Botan::OctetString.

decode_optional() [1/2]

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_optional	(	std::optional< T > &	out,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag )

Definition at line 344 of file ber_dec.h.

                                                                                                          {
   BER_Object obj = get_next_object();
 
   if(obj.is_a(type_tag, class_tag)) {
      T out{};
      if(class_tag == ASN1_Class::ExplicitContextSpecific) {
         BER_Decoder(std::move(obj)).decode(out).verify_end();
      } else {
         this->push_back(std::move(obj));
         this->decode(out, type_tag, class_tag);
      }
      optval = std::move(out);
   } else {
      this->push_back(std::move(obj));
      optval = std::nullopt;
   }
 
   return (*this);
}

References BER_Decoder(), decode(), Botan::ExplicitContextSpecific, get_next_object(), Botan::BER_Object::is_a(), and push_back().

decode_optional() [2/2]

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_optional ( T & out, ASN1_Type type_tag, ASN1_Class class_tag, const T & default_value = T() )

inline

Definition at line 253 of file ber_dec.h.

                                                                                                                   {
         std::optional<T> optval;
         this->decode_optional(optval, type_tag, class_tag);
         out = optval ? *optval : default_value;
         return (*this);
      }

References BER_Decoder(), and decode_optional().

Referenced by Botan::Extensions::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::OCSP::SingleResponse::decode_from(), decode_optional(), and Botan::OCSP::Response::Response().

decode_optional_implicit()

template<typename T>

BER_Decoder & Botan::BER_Decoder::decode_optional_implicit	(	T &	out,
		ASN1_Type	type_tag,
		ASN1_Class	class_tag,
		ASN1_Type	real_type,
		ASN1_Class	real_class,
		const T &	default_value = T() )

Definition at line 368 of file ber_dec.h.

                                                                           {
   BER_Object obj = get_next_object();
 
   if(obj.is_a(type_tag, class_tag)) {
      obj.set_tagging(real_type, real_class);
      push_back(std::move(obj));
      decode(out, real_type, real_class);
   } else {
      // Not what we wanted, push it back on the stream
      out = default_value;
      push_back(std::move(obj));
   }
 
   return (*this);
}

References BER_Decoder(), decode(), get_next_object(), Botan::BER_Object::is_a(), and push_back().

Referenced by Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::decode_from().

decode_optional_list()

template<typename T>

bool Botan::BER_Decoder::decode_optional_list	(	std::vector< T > &	out,
		ASN1_Type	type_tag = ASN1_Type::Sequence,
		ASN1_Class	class_tag = ASN1_Class::Universal )

Definition at line 411 of file ber_dec.h.

                                                                                                  {
   if(peek_next_object().is_a(type_tag, class_tag)) {
      decode_list(vec, type_tag, class_tag);
      return true;
   }
 
   return false;
}

References decode_list(), and peek_next_object().

decode_optional_string() [1/2]

template<typename Alloc>

BER_Decoder & Botan::BER_Decoder::decode_optional_string ( std::vector< uint8_t, Alloc > & out, ASN1_Type real_type, ASN1_Type expected_tag, ASN1_Class class_tag = ASN1_Class::ContextSpecific )

inline

Definition at line 321 of file ber_dec.h.

                                                                                            {
         return decode_optional_string(out, real_type, static_cast<uint32_t>(expected_tag), class_tag);
      }

References BER_Decoder(), Botan::ContextSpecific, and decode_optional_string().

decode_optional_string() [2/2]

template<typename Alloc>

BER_Decoder & Botan::BER_Decoder::decode_optional_string ( std::vector< uint8_t, Alloc > & out, ASN1_Type real_type, uint32_t expected_tag, ASN1_Class class_tag = ASN1_Class::ContextSpecific )

inline

Definition at line 297 of file ber_dec.h.

                                                                                            {
         BER_Object obj = get_next_object();
 
         ASN1_Type type_tag = static_cast<ASN1_Type>(expected_tag);
 
         if(obj.is_a(type_tag, class_tag)) {
            if(class_tag == ASN1_Class::ExplicitContextSpecific) {
               BER_Decoder(std::move(obj)).decode(out, real_type).verify_end();
            } else {
               push_back(std::move(obj));
               decode(out, real_type, type_tag, class_tag);
            }
         } else {
            out.clear();
            push_back(std::move(obj));
         }
 
         return (*this);
      }

References BER_Decoder(), Botan::ContextSpecific, decode(), Botan::ExplicitContextSpecific, get_next_object(), Botan::BER_Object::is_a(), and push_back().

Referenced by decode_optional_string(), and Botan::OCSP::Response::Response().

discard_remaining()

BER_Decoder & Botan::BER_Decoder::discard_remaining

(

)

Discard any data that remains unread Returns (*this)

Definition at line 231 of file ber_dec.cpp.

                                            {
   uint8_t buf = 0;
   while(m_source->read_byte(buf) != 0) {}
   return (*this);
}

References BER_Decoder().

Referenced by Botan::Ed25519_PrivateKey::Ed25519_PrivateKey(), and Botan::X25519_PrivateKey::X25519_PrivateKey().

end_cons()

BER_Decoder & Botan::BER_Decoder::end_cons

(

)

Finish decoding a constructed data, throws if any data remains. Returns the parent of *this (ie the object on which start_cons was called).

Definition at line 312 of file ber_dec.cpp.

                                   {
   if(m_parent == nullptr) {
      throw Invalid_State("BER_Decoder::end_cons called with null parent");
   }
   if(!m_source->end_of_data()) {
      throw Decoding_Error("BER_Decoder::end_cons called with data left");
   }
   return (*m_parent);
}

References BER_Decoder().

Referenced by Botan::AlgorithmIdentifier::decode_from(), Botan::Attribute::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::decode_from(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::decode_from(), Botan::Cert_Extension::TNAuthList::Entry::decode_from(), Botan::CRL_Entry::decode_from(), Botan::Extensions::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::OCSP::CertID::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::X509_DN::decode_from(), Botan::X509_Object::decode_from(), decode_list(), Botan::X509::load_key(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::pbes2_decrypt(), Botan::OCSP::Response::Response(), and Botan::RSA_PublicKey::RSA_PublicKey().

get_next()

BER_Decoder & Botan::BER_Decoder::get_next ( BER_Object & ber )

inline

Definition at line 71 of file ber_dec.h.

                                             {
         ber = get_next_object();
         return (*this);
      }

References BER_Decoder(), and get_next_object().

Referenced by Botan::OCSP::SingleResponse::decode_from().

get_next_object()

BER_Object Botan::BER_Decoder::get_next_object

(

)

Get the next object in the data stream. If EOF, returns an object with type NO_OBJECT.

Definition at line 248 of file ber_dec.cpp.

                                        {
   BER_Object next;
 
   if(m_pushed.is_set()) {
      std::swap(next, m_pushed);
      return next;
   }
 
   for(;;) {
      ASN1_Type type_tag = ASN1_Type::NoObject;
      ASN1_Class class_tag = ASN1_Class::NoObject;
      decode_tag(m_source, type_tag, class_tag);
      next.set_tagging(type_tag, class_tag);
      if(next.is_set() == false) {  // no more objects
         return next;
      }
 
      size_t field_size = 0;
      const size_t length = decode_length(m_source, field_size, ALLOWED_EOC_NESTINGS);
      if(!m_source->check_available(length)) {
         throw BER_Decoding_Error("Value truncated");
      }
 
      uint8_t* out = next.mutable_bits(length);
      if(m_source->read(out, length) != length) {
         throw BER_Decoding_Error("Value truncated");
      }
 
      if(next.tagging() == static_cast<uint32_t>(ASN1_Type::Eoc)) {
         continue;
      } else {
         break;
      }
   }
 
   return next;
}

References Botan::Eoc, Botan::BER_Object::is_set(), Botan::NoObject, and Botan::BER_Object::tagging().

Referenced by decode(), decode(), decode(), decode(), Botan::AlternativeName::decode_from(), Botan::ASN1_String::decode_from(), Botan::ASN1_Time::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::decode_from(), Botan::Cert_Extension::TNAuthList::Entry::decode_from(), Botan::CRL_Entry::decode_from(), Botan::GeneralName::decode_from(), Botan::OID::decode_from(), decode_null(), decode_optional(), decode_optional_implicit(), decode_optional_string(), get_next(), get_next_value(), operator=(), peek_next_object(), and start_cons().

get_next_octet_string()

std::vector< uint8_t > Botan::BER_Decoder::get_next_octet_string ( )

inline

Definition at line 200 of file ber_dec.h.

                                                 {
         std::vector<uint8_t> out_vec;
         decode(out_vec, ASN1_Type::OctetString);
         return out_vec;
      }

References decode(), and Botan::OctetString.

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

get_next_value()

template<typename T>
requires std::is_standard_layout_v<T> && std::is_trivial_v<T>

BER_Decoder & Botan::BER_Decoder::get_next_value ( T & out, ASN1_Type type_tag, ASN1_Class class_tag = ASN1_Class::ContextSpecific )

inline

Get next object and copy value to POD type Asserts value length is equal to POD type sizeof. Asserts Type tag and optional Class tag according to parameters. Copy value to POD type (struct, union, C-style array, std::array, etc.).

Parameters

out	POD type reference where to copy object value
type_tag	ASN1_Type enum to assert type on object read
class_tag	ASN1_Type enum to assert class on object read (default: CONTEXT_SPECIFIC)

Returns

this reference

Definition at line 154 of file ber_dec.h.

      {
         BER_Object obj = get_next_object();
         obj.assert_is_a(type_tag, class_tag);
 
         if(obj.length() != sizeof(T)) {
            throw BER_Decoding_Error("Size mismatch. Object value size is " + std::to_string(obj.length()) +
                                     "; Output type size is " + std::to_string(sizeof(T)));
         }
 
         std::memcpy(reinterpret_cast<uint8_t*>(&out), obj.bits(), obj.length());
 
         return (*this);
      }

References Botan::BER_Object::assert_is_a(), BER_Decoder(), Botan::BER_Object::bits(), Botan::ContextSpecific, get_next_object(), and Botan::BER_Object::length().

more_items()

bool Botan::BER_Decoder::more_items

(

)

const

Return true if there is at least one more item remaining

Definition at line 204 of file ber_dec.cpp.

                                   {
   if(m_source->end_of_data() && !m_pushed.is_set()) {
      return false;
   }
   return true;
}

Referenced by Botan::AlternativeName::decode_from(), Botan::Cert_Extension::TNAuthList::Entry::decode_from(), Botan::CRL_Entry::decode_from(), Botan::Extensions::decode_from(), Botan::X509_DN::decode_from(), decode_list(), and Botan::OCSP::Response::Response().

operator=() [1/2]

BER_Decoder & Botan::BER_Decoder::operator= ( BER_Decoder && )

default

References BER_Decoder(), and get_next_object().

operator=() [2/2]

BER_Decoder & Botan::BER_Decoder::operator= ( const BER_Decoder & )

delete

References BER_Decoder().

peek_next_object()

const BER_Object & Botan::BER_Decoder::peek_next_object

(

)

Peek at the next object without removing it from the stream

If an object has been pushed, then it returns that object. Otherwise it reads the next object and pushes it. Thus, a you call peek_next_object followed by push_back without a subsequent read, it will fail.

Definition at line 237 of file ber_dec.cpp.

                                                {
   if(!m_pushed.is_set()) {
      m_pushed = get_next_object();
   }
 
   return m_pushed;
}

References get_next_object().

Referenced by 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(), and decode_optional_list().

push_back() [1/2]

void Botan::BER_Decoder::push_back

(

BER_Object &&

obj

)

Push an object back onto the stream. Throws if another object was previously pushed and has not been subsequently read out.

Definition at line 296 of file ber_dec.cpp.

                                            {
   if(m_pushed.is_set()) {
      throw Invalid_State("BER_Decoder: Only one push back is allowed");
   }
   m_pushed = std::move(obj);
}

push_back() [2/2]

void Botan::BER_Decoder::push_back

(

const BER_Object &

obj

)

Push an object back onto the stream. Throws if another object was previously pushed and has not been subsequently read out.

Definition at line 289 of file ber_dec.cpp.

                                                 {
   if(m_pushed.is_set()) {
      throw Invalid_State("BER_Decoder: Only one push back is allowed");
   }
   m_pushed = obj;
}

Referenced by decode_list(), decode_optional(), decode_optional_implicit(), decode_optional_string(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and Botan::McEliece_PrivateKey::McEliece_PrivateKey().

raw_bytes()

template<typename Alloc>

BER_Decoder & Botan::BER_Decoder::raw_bytes ( std::vector< uint8_t, Alloc > & out )

inline

Definition at line 174 of file ber_dec.h.

                                                             {
         out.clear();
         uint8_t buf = 0;
         while(m_source->read_byte(buf)) {
            out.push_back(buf);
         }
         return (*this);
      }

References BER_Decoder().

Referenced by Botan::AlgorithmIdentifier::decode_from(), Botan::Attribute::decode_from(), Botan::X509_DN::decode_from(), Botan::X509_Object::decode_from(), and Botan::OCSP::Response::Response().

start_cons()

BER_Decoder Botan::BER_Decoder::start_cons	(	ASN1_Type	type_tag,
		ASN1_Class	class_tag )

Definition at line 303 of file ber_dec.cpp.

                                                                            {
   BER_Object obj = get_next_object();
   obj.assert_is_a(type_tag, class_tag | ASN1_Class::Constructed);
   return BER_Decoder(std::move(obj), this);
}

References Botan::BER_Object::assert_is_a(), BER_Decoder(), Botan::Constructed, and get_next_object().

Referenced by decode_list(), start_context_specific(), start_explicit_context_specific(), start_sequence(), and start_set().

start_context_specific()

BER_Decoder Botan::BER_Decoder::start_context_specific ( uint32_t tag )

inline

Definition at line 129 of file ber_dec.h.

                                                       {
         return start_cons(ASN1_Type(tag), ASN1_Class::ContextSpecific);
      }

References BER_Decoder(), Botan::ContextSpecific, and start_cons().

Referenced by Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::decode_from(), and Botan::OCSP::Response::Response().

start_explicit_context_specific()

BER_Decoder Botan::BER_Decoder::start_explicit_context_specific ( uint32_t tag )

inline

Definition at line 133 of file ber_dec.h.

                                                                {
         return start_cons(ASN1_Type(tag), ASN1_Class::ExplicitContextSpecific);
      }

References BER_Decoder(), Botan::ExplicitContextSpecific, and start_cons().

start_sequence()

BER_Decoder Botan::BER_Decoder::start_sequence ( )

inline

Definition at line 125 of file ber_dec.h.

{ return start_cons(ASN1_Type::Sequence, ASN1_Class::Universal); }

References BER_Decoder(), Botan::Sequence, start_cons(), and Botan::Universal.

Referenced by Botan::AlgorithmIdentifier::decode_from(), Botan::AlternativeName::decode_from(), Botan::Attribute::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::decode_from(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::decode_from(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::decode_from(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::decode_from(), Botan::Cert_Extension::TNAuthList::Entry::decode_from(), Botan::CRL_Entry::decode_from(), Botan::Extensions::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::OCSP::CertID::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::X509_DN::decode_from(), Botan::X509_Object::decode_from(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::X509::load_key(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::pbes2_decrypt(), Botan::OCSP::Response::Response(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PublicKey::RSA_PublicKey(), and Botan::TLS::Session::Session().

start_set()

BER_Decoder Botan::BER_Decoder::start_set ( )

inline

Definition at line 127 of file ber_dec.h.

{ return start_cons(ASN1_Type::Set, ASN1_Class::Universal); }

References BER_Decoder(), Botan::Set, start_cons(), and Botan::Universal.

Referenced by Botan::Attribute::decode_from(), and Botan::X509_DN::decode_from().

verify_end() [1/2]

BER_Decoder & Botan::BER_Decoder::verify_end

(

)

Verify the stream is concluded, throws otherwise. Returns (*this)

Definition at line 214 of file ber_dec.cpp.

                                     {
   return verify_end("BER_Decoder::verify_end called, but data remains");
}

References BER_Decoder(), and verify_end().

Referenced by Botan::AlternativeName::decode_from(), Botan::Extensions::decode_from(), Botan::Ed448_PrivateKey::Ed448_PrivateKey(), Botan::pbes2_decrypt(), and verify_end().

verify_end() [2/2]

BER_Decoder & Botan::BER_Decoder::verify_end

(

std::string_view

err_msg

)

Verify the stream is concluded, throws otherwise. Returns (*this)

Definition at line 221 of file ber_dec.cpp.

                                                       {
   if(!m_source->end_of_data() || m_pushed.is_set()) {
      throw Decoding_Error(err);
   }
   return (*this);
}

References BER_Decoder().

---

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

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