Botan::BER_Decoder Class Reference

#include <ber_dec.h>

Public Member Functions
	BER_Decoder (BER_Object &&obj)
	BER_Decoder (const BER_Decoder &other)
	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)
BER_Decoder &	decode (BigInt &out)
BER_Decoder &	decode (BigInt &v, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
BER_Decoder &	decode (bool &out)
BER_Decoder &	decode (bool &v, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
BER_Decoder &	decode (class ASN1_Object &obj, ASN1_Tag type_tag=NO_OBJECT, ASN1_Tag class_tag=NO_OBJECT)
BER_Decoder &	decode (secure_vector< uint8_t > &v, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
BER_Decoder &	decode (size_t &out)
BER_Decoder &	decode (size_t &v, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
BER_Decoder &	decode (std::vector< uint8_t > &v, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
template<typename Alloc >
BER_Decoder &	decode (std::vector< uint8_t, Alloc > &out, ASN1_Tag real_type)
template<typename T >
BER_Decoder &	decode_and_check (const T &expected, const std::string &error_msg)
uint64_t	decode_constrained_integer (ASN1_Tag type_tag, ASN1_Tag 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_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
template<typename T >
BER_Decoder &	decode_list (std::vector< T > &out, ASN1_Tag type_tag=SEQUENCE, ASN1_Tag class_tag=UNIVERSAL)
BER_Decoder &	decode_null ()
BER_Decoder &	decode_octet_string_bigint (BigInt &b)
template<typename T >
BER_Decoder &	decode_optional (T &out, ASN1_Tag type_tag, ASN1_Tag class_tag, const T &default_value=T())
template<typename T >
BER_Decoder &	decode_optional_implicit (T &out, ASN1_Tag type_tag, ASN1_Tag class_tag, ASN1_Tag real_type, ASN1_Tag real_class, const T &default_value=T())
template<typename Alloc >
BER_Decoder &	decode_optional_string (std::vector< uint8_t, Alloc > &out, ASN1_Tag real_type, uint16_t type_no, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
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 >
BER_Decoder &	get_next_value (T &out, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
bool	more_items () const
BER_Decoder &	operator= (const BER_Decoder &)=delete
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_Tag type_tag, ASN1_Tag class_tag=UNIVERSAL)
BER_Decoder &	verify_end ()
BER_Decoder &	verify_end (const std::string &err_msg)

Detailed Description

BER Decoding Object

Definition at line 21 of file ber_dec.h.

Constructor & Destructor Documentation

BER_Decoder() [1/7]

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 327 of file ber_dec.cpp.

   {
   m_data_src.reset(new DataSource_Memory(data, length));
   m_source = m_data_src.get();
   }

Referenced by decode_optional(), and start_cons().

BER_Decoder() [2/7]

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

explicit

Set up to BER decode the data in vec

Definition at line 336 of file ber_dec.cpp.

   {
   m_data_src.reset(new DataSource_Memory(data));
   m_source = m_data_src.get();
   }

BER_Decoder() [3/7]

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

explicit

Set up to BER decode the data in vec

Definition at line 345 of file ber_dec.cpp.

   {
   m_data_src.reset(new DataSource_Memory(data.data(), data.size()));
   m_source = m_data_src.get();
   }

BER_Decoder() [4/7]

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

explicit

Set up to BER decode the data in src

Definition at line 319 of file ber_dec.cpp.

   {
   m_source = &src;
   }

BER_Decoder() [5/7]

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

inline

Set up to BER decode the data in obj

Definition at line 47 of file ber_dec.h.

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

BER_Decoder() [6/7]

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

inline

Set up to BER decode the data in obj

Definition at line 53 of file ber_dec.h.

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

BER_Decoder() [7/7]

Botan::BER_Decoder::BER_Decoder

(

const BER_Decoder &

other

)

Definition at line 354 of file ber_dec.cpp.

   {
   m_source = other.m_source;
 
   // take ownership
   std::swap(m_data_src, other.m_data_src);
   m_parent = other.m_parent;
   }

Member Function Documentation

decode() [1/10]

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

inline

Definition at line 186 of file ber_dec.h.

         {
         return decode(out, INTEGER, UNIVERSAL);
         }

References Botan::PEM_Code::decode(), Botan::INTEGER, and Botan::UNIVERSAL.

decode() [2/10]

BER_Decoder & Botan::BER_Decoder::decode	(	BigInt &	v,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 458 of file ber_dec.cpp.

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

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

decode() [3/10]

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

inline

Decode a BER encoded BOOLEAN

Definition at line 170 of file ber_dec.h.

         {
         return decode(out, BOOLEAN, UNIVERSAL);
         }

References Botan::BOOLEAN, Botan::PEM_Code::decode(), and Botan::UNIVERSAL.

Referenced by Botan::PK_Verifier::check_signature(), Botan::Curve25519_PrivateKey::Curve25519_PrivateKey(), decode(), decode_constrained_integer(), Botan::X509_DN::decode_from(), Botan::AlternativeName::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::Attribute::decode_from(), Botan::AlgorithmIdentifier::decode_from(), Botan::Extensions::decode_from(), Botan::CRL_Entry::decode_from(), Botan::OCSP::CertID::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::X509_Object::decode_from(), decode_list(), decode_octet_string_bigint(), decode_optional(), decode_optional_implicit(), decode_optional_string(), Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey(), Botan::Ed25519_PrivateKey::Ed25519_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::X509::load_key(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::McEliece_PublicKey::McEliece_PublicKey(), Botan::pbes2_decrypt(), Botan::OCSP::Response::Response(), Botan::RSA_PublicKey::RSA_PublicKey(), and Botan::TLS::Session::Session().

decode() [4/10]

BER_Decoder & Botan::BER_Decoder::decode	(	bool &	v,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 396 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");
 
   out = (obj.bits()[0]) ? true : false;
   return (*this);
   }

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

decode() [5/10]

BER_Decoder & Botan::BER_Decoder::decode	(	class ASN1_Object &	obj,
		ASN1_Tag	type_tag = NO_OBJECT,
		ASN1_Tag	class_tag = NO_OBJECT
	)

Definition at line 366 of file ber_dec.cpp.

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

References Botan::ASN1_Object::decode_from().

decode() [6/10]

BER_Decoder & Botan::BER_Decoder::decode	(	secure_vector< uint8_t > &	v,
		ASN1_Tag	real_type,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 527 of file ber_dec.cpp.

   {
   if(real_type != OCTET_STRING && real_type != BIT_STRING)
      throw BER_Bad_Tag("Bad tag for {BIT,OCTET} STRING", real_type);
 
   asn1_decode_binary_string(buffer, get_next_object(), real_type, type_tag, class_tag);
   return (*this);
   }

References Botan::BIT_STRING, get_next_object(), and Botan::OCTET_STRING.

decode() [7/10]

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

inline

Definition at line 178 of file ber_dec.h.

         {
         return decode(out, INTEGER, UNIVERSAL);
         }

References Botan::PEM_Code::decode(), Botan::INTEGER, and Botan::UNIVERSAL.

decode() [8/10]

BER_Decoder & Botan::BER_Decoder::decode	(	size_t &	v,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 412 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 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_Tag	real_type,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 538 of file ber_dec.cpp.

   {
   if(real_type != OCTET_STRING && real_type != BIT_STRING)
      throw BER_Bad_Tag("Bad tag for {BIT,OCTET} STRING", real_type);
 
   asn1_decode_binary_string(buffer, get_next_object(), real_type, type_tag, class_tag);
   return (*this);
   }

References Botan::BIT_STRING, get_next_object(), and Botan::OCTET_STRING.

decode() [10/10]

template<typename Alloc >

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

inline

Definition at line 202 of file ber_dec.h.

         {
         return decode(out, real_type, real_type, UNIVERSAL);
         }

References Botan::PEM_Code::decode(), and Botan::UNIVERSAL.

decode_and_check()

template<typename T >

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

inline

Definition at line 277 of file ber_dec.h.

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

References Botan::PEM_Code::decode(), and T.

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_Tag	type_tag,
		ASN1_Tag	class_tag,
		size_t	T_bytes
	)

Definition at line 435 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().

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, INTEGER, UNIVERSAL);
         }

References Botan::INTEGER, and Botan::UNIVERSAL.

Referenced by Botan::TLS::Session::Session().

decode_integer_type() [2/2]

template<typename T >

BER_Decoder & Botan::BER_Decoder::decode_integer_type ( T &  out, ASN1_Tag  type_tag, ASN1_Tag  class_tag = CONTEXT_SPECIFIC  )

inline

Definition at line 248 of file ber_dec.h.

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

References T.

decode_list()

template<typename T >

BER_Decoder & Botan::BER_Decoder::decode_list	(	std::vector< T > &	out,
		ASN1_Tag	type_tag = SEQUENCE,
		ASN1_Tag	class_tag = UNIVERSAL
	)

Definition at line 398 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 decode(), end_cons(), more_items(), push_back(), start_cons(), and T.

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

decode_null()

BER_Decoder & Botan::BER_Decoder::decode_null

(

)

Definition at line 376 of file ber_dec.cpp.

   {
   BER_Object obj = get_next_object();
   obj.assert_is_a(NULL_TAG, UNIVERSAL);
   if(obj.length() > 0)
      throw BER_Decoding_Error("NULL object had nonzero size");
   return (*this);
   }

References Botan::BER_Object::assert_is_a(), get_next_object(), Botan::BER_Object::length(), Botan::NULL_TAG, and Botan::UNIVERSAL.

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 385 of file ber_dec.cpp.

   {
   secure_vector<uint8_t> out_vec;
   decode(out_vec, OCTET_STRING);
   out = BigInt::decode(out_vec.data(), out_vec.size());
   return (*this);
   }

References decode(), Botan::BigInt::decode(), and Botan::OCTET_STRING.

decode_optional()

template<typename T >

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

Definition at line 337 of file ber_dec.h.

   {
   BER_Object obj = get_next_object();
 
   if(obj.is_a(type_tag, class_tag))
      {
      if((class_tag & CONSTRUCTED) && (class_tag & CONTEXT_SPECIFIC))
         {
         BER_Decoder(std::move(obj)).decode(out).verify_end();
         }
      else
         {
         push_back(std::move(obj));
         decode(out, type_tag, class_tag);
         }
      }
   else
      {
      out = default_value;
      push_back(std::move(obj));
      }
 
   return (*this);
   }

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

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

decode_optional_implicit()

template<typename T >

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

Definition at line 369 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 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_string()

template<typename Alloc >

BER_Decoder & Botan::BER_Decoder::decode_optional_string ( std::vector< uint8_t, Alloc > &  out, ASN1_Tag  real_type, uint16_t  type_no, ASN1_Tag  class_tag = CONTEXT_SPECIFIC  )

inline

Definition at line 293 of file ber_dec.h.

         {
         BER_Object obj = get_next_object();
 
         ASN1_Tag type_tag = static_cast<ASN1_Tag>(type_no);
 
         if(obj.is_a(type_tag, class_tag))
            {
            if((class_tag & CONSTRUCTED) && (class_tag & CONTEXT_SPECIFIC))
               {
               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 Botan::CONSTRUCTED, Botan::CONTEXT_SPECIFIC, decode(), Botan::PEM_Code::decode(), Botan::BER_Object::is_a(), and verify_end().

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

discard_remaining()

BER_Decoder & Botan::BER_Decoder::discard_remaining

(

)

Discard any data that remains unread Returns (*this)

Definition at line 226 of file ber_dec.cpp.

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

References Botan::DataSource::read_byte().

Referenced by Botan::Curve25519_PrivateKey::Curve25519_PrivateKey(), and Botan::Ed25519_PrivateKey::Ed25519_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 300 of file ber_dec.cpp.

   {
   if(!m_parent)
      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 Botan::DataSource::end_of_data().

Referenced by Botan::X509_DN::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::Attribute::decode_from(), Botan::AlgorithmIdentifier::decode_from(), Botan::Extensions::decode_from(), Botan::CRL_Entry::decode_from(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::decode_from(), Botan::OCSP::CertID::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::X509_Object::decode_from(), decode_list(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::X509::load_key(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::McEliece_PublicKey::McEliece_PublicKey(), Botan::pbes2_decrypt(), Botan::OCSP::Response::Response(), Botan::RSA_PublicKey::RSA_PublicKey(), and Botan::TLS::Session::Session().

get_next()

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

inline

Definition at line 66 of file ber_dec.h.

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

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 237 of file ber_dec.cpp.

   {
   BER_Object next;
 
   if(m_pushed.is_set())
      {
      std::swap(next, m_pushed);
      return next;
      }
 
   for(;;)
      {
      ASN1_Tag type_tag, class_tag;
      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;
      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() == EOC)
         continue;
      else
         break;
      }
 
   return next;
   }

References Botan::DataSource::check_available(), Botan::EOC, Botan::BER_Object::is_set(), Botan::DataSource::read(), and Botan::BER_Object::tagging().

Referenced by decode(), Botan::ASN1_Time::decode_from(), Botan::AlternativeName::decode_from(), Botan::GeneralName::decode_from(), Botan::OID::decode_from(), Botan::ASN1_String::decode_from(), decode_null(), decode_optional(), decode_optional_implicit(), and start_cons().

get_next_octet_string()

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

inline

Definition at line 191 of file ber_dec.h.

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

References Botan::PEM_Code::decode(), and Botan::OCTET_STRING.

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

get_next_value()

template<typename T >

BER_Decoder & Botan::BER_Decoder::get_next_value ( T &  out, ASN1_Tag  type_tag, ASN1_Tag  class_tag = CONTEXT_SPECIFIC  )

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_Tag enum to assert type on object read
class_tag	ASN1_Tag enum to assert class on object read (default: CONTEXT_SPECIFIC)

Returns

this reference

Definition at line 131 of file ber_dec.h.

         {
         static_assert(std::is_standard_layout<T>::value && std::is_trivial<T>::value, "Type must be POD");
 
         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)));
 
         copy_mem(reinterpret_cast<uint8_t*>(&out), obj.bits(), obj.length());
 
         return (*this);
         }

References Botan::BER_Object::assert_is_a(), Botan::BER_Object::bits(), Botan::copy_mem(), Botan::BER_Object::length(), T, and Botan::ASN1::to_string().

more_items()

bool Botan::BER_Decoder::more_items

(

)

const

Return true if there is at least one more item remaining

Definition at line 198 of file ber_dec.cpp.

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

References Botan::DataSource::end_of_data(), and Botan::BER_Object::is_set().

Referenced by Botan::PK_Verifier::check_signature(), Botan::X509_DN::decode_from(), Botan::AlternativeName::decode_from(), Botan::Extensions::decode_from(), Botan::CRL_Entry::decode_from(), decode_list(), and Botan::OCSP::Response::Response().

operator=()

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

delete

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 283 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);
   }

References Botan::BER_Object::is_set().

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 276 of file ber_dec.cpp.

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

References Botan::BER_Object::is_set().

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

raw_bytes()

template<typename Alloc >

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

inline

Definition at line 156 of file ber_dec.h.

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

References push_back().

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

start_cons()

BER_Decoder Botan::BER_Decoder::start_cons	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = UNIVERSAL
	)

Start decoding a constructed data (sequence or set)

Definition at line 290 of file ber_dec.cpp.

   {
   BER_Object obj = get_next_object();
   obj.assert_is_a(type_tag, ASN1_Tag(class_tag | 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 Botan::PK_Verifier::check_signature(), Botan::X509_DN::decode_from(), Botan::AlternativeName::decode_from(), Botan::GeneralSubtree::decode_from(), Botan::Attribute::decode_from(), Botan::AlgorithmIdentifier::decode_from(), Botan::Extensions::decode_from(), Botan::CRL_Entry::decode_from(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::decode_from(), Botan::OCSP::CertID::decode_from(), Botan::OCSP::SingleResponse::decode_from(), Botan::X509_Object::decode_from(), decode_list(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::X509::load_key(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::McEliece_PublicKey::McEliece_PublicKey(), Botan::pbes2_decrypt(), Botan::OCSP::Response::Response(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PublicKey::RSA_PublicKey(), and Botan::TLS::Session::Session().

verify_end() [1/2]

BER_Decoder & Botan::BER_Decoder::verify_end

(

)

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

Definition at line 208 of file ber_dec.cpp.

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

References verify_end().

Referenced by Botan::AlternativeName::decode_from(), Botan::Extensions::decode_from(), decode_optional_string(), Botan::pbes2_decrypt(), Botan::TLS::Session::Session(), and verify_end().

verify_end() [2/2]

BER_Decoder & Botan::BER_Decoder::verify_end

(

const std::string &

err_msg

)

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

Definition at line 216 of file ber_dec.cpp.

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

References Botan::DataSource::end_of_data(), and Botan::BER_Object::is_set().

---

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

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