Botan::DER_Encoder Class Reference

#include <der_enc.h>

Public Types
typedef std::function< void(const uint8_t[], size_t)>	append_fn

Public Member Functions
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const secure_vector< uint8_t > &rep)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const std::string &str)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const std::vector< uint8_t > &rep)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const uint8_t rep[], size_t length)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, uint8_t val)
	DER_Encoder ()=default
	DER_Encoder (append_fn append)
	DER_Encoder (secure_vector< uint8_t > &vec)
	DER_Encoder (std::vector< uint8_t > &vec)
DER_Encoder &	encode (bool b)
DER_Encoder &	encode (bool b, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
DER_Encoder &	encode (const ASN1_Object &obj)
DER_Encoder &	encode (const BigInt &n)
DER_Encoder &	encode (const BigInt &n, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
template<typename Alloc >
DER_Encoder &	encode (const std::vector< uint8_t, Alloc > &bytes, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag)
template<typename Alloc >
DER_Encoder &	encode (const std::vector< uint8_t, Alloc > &vec, ASN1_Tag real_type)
DER_Encoder &	encode (const uint8_t v[], size_t len, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
DER_Encoder &	encode (const uint8_t val[], size_t len, ASN1_Tag real_type)
DER_Encoder &	encode (size_t s)
DER_Encoder &	encode (size_t s, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
DER_Encoder &	encode_if (bool pred, const ASN1_Object &obj)
DER_Encoder &	encode_if (bool pred, DER_Encoder &enc)
template<typename T >
DER_Encoder &	encode_list (const std::vector< T > &values)
DER_Encoder &	encode_null ()
template<typename T >
DER_Encoder &	encode_optional (const T &value, const T &default_value)
DER_Encoder &	end_cons ()
DER_Encoder &	end_explicit ()
secure_vector< uint8_t >	get_contents ()
std::vector< uint8_t >	get_contents_unlocked ()
template<typename Alloc >
DER_Encoder &	raw_bytes (const std::vector< uint8_t, Alloc > &val)
DER_Encoder &	raw_bytes (const uint8_t val[], size_t len)
DER_Encoder &	start_cons (ASN1_Tag type_tag, ASN1_Tag class_tag=UNIVERSAL)
DER_Encoder &	start_explicit (uint16_t type_tag)

Detailed Description

General DER Encoding Object

Definition at line 22 of file der_enc.h.

Member Typedef Documentation

append_fn

typedef std::function<void (const uint8_t[], size_t)> Botan::DER_Encoder::append_fn

Definition at line 25 of file der_enc.h.

Constructor & Destructor Documentation

DER_Encoder() [1/4]

Botan::DER_Encoder::DER_Encoder ( )

default

DER encode, writing to an internal buffer Use get_contents or get_contents_unlocked to read the results after all encoding is completed.

DER_Encoder() [2/4]

Botan::DER_Encoder::DER_Encoder

(

secure_vector< uint8_t > &

vec

)

DER encode, writing to

Parameters

vec	If this constructor is used, get_contents* may not be called.

Definition at line 69 of file der_enc.cpp.

   {
   m_append_output = [&vec](const uint8_t b[], size_t l)
      {
      vec.insert(vec.end(), b, b + l);
      };
   }

DER_Encoder() [3/4]

Botan::DER_Encoder::DER_Encoder

(

std::vector< uint8_t > &

vec

)

DER encode, writing to

Parameters

vec	If this constructor is used, get_contents* may not be called.

Definition at line 77 of file der_enc.cpp.

   {
   m_append_output = [&vec](const uint8_t b[], size_t l)
      {
      vec.insert(vec.end(), b, b + l);
      };
   }

DER_Encoder() [4/4]

Botan::DER_Encoder::DER_Encoder ( append_fn  append )

inline

DER encode, calling append to write output If this constructor is used, get_contents* may not be called.

Definition at line 50 of file der_enc.h.

: m_append_output(append) {}

Member Function Documentation

add_object() [1/5]

DER_Encoder & Botan::DER_Encoder::add_object ( ASN1_Tag  type_tag, ASN1_Tag  class_tag, const secure_vector< uint8_t > &  rep  )

inline

Definition at line 166 of file der_enc.h.

         {
         return add_object(type_tag, class_tag, rep.data(), rep.size());
         }

add_object() [2/5]

DER_Encoder & Botan::DER_Encoder::add_object	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag,
		const std::string &	str
	)

Definition at line 388 of file der_enc.cpp.

   {
   const uint8_t* rep = cast_char_ptr_to_uint8(rep_str.data());
   const size_t rep_len = rep_str.size();
   return add_object(type_tag, class_tag, rep, rep_len);
   }

References add_object(), and Botan::cast_char_ptr_to_uint8().

add_object() [3/5]

DER_Encoder & Botan::DER_Encoder::add_object ( ASN1_Tag  type_tag, ASN1_Tag  class_tag, const std::vector< uint8_t > &  rep  )

inline

Definition at line 160 of file der_enc.h.

         {
         return add_object(type_tag, class_tag, rep.data(), rep.size());
         }

add_object() [4/5]

DER_Encoder & Botan::DER_Encoder::add_object	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag,
		const uint8_t	rep[],
		size_t	length
	)

Definition at line 249 of file der_enc.cpp.

   {
   std::vector<uint8_t> hdr;
   encode_tag(hdr, type_tag, class_tag);
   encode_length(hdr, length);
 
   if(m_subsequences.size())
      {
      m_subsequences[m_subsequences.size()-1].add_bytes(hdr.data(), hdr.size(), rep, length);
      }
   else if(m_append_output)
      {
      m_append_output(hdr.data(), hdr.size());
      m_append_output(rep, length);
      }
   else
      {
      m_default_outbuf += hdr;
      m_default_outbuf += std::make_pair(rep, length);
      }
 
   return (*this);
   }

Referenced by add_object(), encode(), Botan::OID::encode_into(), Botan::ASN1_String::encode_into(), Botan::ASN1_Time::encode_into(), and encode_null().

add_object() [5/5]

DER_Encoder & Botan::DER_Encoder::add_object	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag,
		uint8_t	val
	)

Definition at line 399 of file der_enc.cpp.

   {
   return add_object(type_tag, class_tag, &rep, 1);
   }

References add_object().

encode() [1/11]

DER_Encoder & Botan::DER_Encoder::encode

(

bool

b

)

Definition at line 285 of file der_enc.cpp.

   {
   return encode(is_true, BOOLEAN, UNIVERSAL);
   }

References Botan::BOOLEAN, encode(), and Botan::UNIVERSAL.

Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::OCSP::Request::BER_encode(), Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PSSR::config_for_x509(), Botan::PKCS10_Request::create(), Botan::TLS::Session::DER_encode(), Botan::EC_Group::DER_encode(), Botan::DL_Group::DER_encode(), encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::Extensions::encode_into(), Botan::CRL_Entry::encode_into(), Botan::OCSP::CertID::encode_into(), Botan::X509_Object::encode_into(), Botan::X509_DN::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::X509_Object::make_signed(), Botan::Curve25519_PrivateKey::private_key_bits(), Botan::DL_Scheme_PrivateKey::private_key_bits(), Botan::EC_PrivateKey::private_key_bits(), Botan::Ed25519_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::private_key_bits(), Botan::XMSS_PrivateKey::private_key_bits(), Botan::Private_Key::private_key_info(), Botan::TPM_PrivateKey::public_key_bits(), Botan::DL_Scheme_PublicKey::public_key_bits(), Botan::GOST_3410_PublicKey::public_key_bits(), Botan::McEliece_PublicKey::public_key_bits(), Botan::RSA_PublicKey::public_key_bits(), Botan::XMSS_PublicKey::public_key_bits(), and Botan::Public_Key::subject_public_key().

encode() [2/11]

DER_Encoder & Botan::DER_Encoder::encode	(	bool	b,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 318 of file der_enc.cpp.

   {
   uint8_t val = is_true ? 0xFF : 0x00;
   return add_object(type_tag, class_tag, &val, 1);
   }

References add_object().

encode() [3/11]

DER_Encoder & Botan::DER_Encoder::encode

(

const ASN1_Object &

obj

)

Definition at line 379 of file der_enc.cpp.

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

References Botan::ASN1_Object::encode_into().

encode() [4/11]

DER_Encoder & Botan::DER_Encoder::encode

(

const BigInt &

n

)

Definition at line 301 of file der_enc.cpp.

   {
   return encode(n, INTEGER, UNIVERSAL);
   }

References encode(), Botan::INTEGER, and Botan::UNIVERSAL.

encode() [5/11]

DER_Encoder & Botan::DER_Encoder::encode	(	const BigInt &	n,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 337 of file der_enc.cpp.

   {
   if(n == 0)
      return add_object(type_tag, class_tag, 0);
 
   const size_t extra_zero = (n.bits() % 8 == 0) ? 1 : 0;
   secure_vector<uint8_t> contents(extra_zero + n.bytes());
   n.binary_encode(&contents[extra_zero]);
   if(n < 0)
      {
      for(size_t i = 0; i != contents.size(); ++i)
         contents[i] = ~contents[i];
      for(size_t i = contents.size(); i > 0; --i)
         if(++contents[i-1])
            break;
      }
 
   return add_object(type_tag, class_tag, contents);
   }

References add_object(), Botan::BigInt::binary_encode(), Botan::BigInt::bits(), and Botan::BigInt::bytes().

encode() [6/11]

template<typename Alloc >

DER_Encoder & Botan::DER_Encoder::encode ( const std::vector< uint8_t, Alloc > &  bytes, ASN1_Tag  real_type, ASN1_Tag  type_tag, ASN1_Tag  class_tag  )

inline

Definition at line 111 of file der_enc.h.

         {
         return encode(bytes.data(), bytes.size(),
                       real_type, type_tag, class_tag);
         }

References Botan::PEM_Code::encode().

encode() [7/11]

template<typename Alloc >

DER_Encoder & Botan::DER_Encoder::encode ( const std::vector< uint8_t, Alloc > &  vec, ASN1_Tag  real_type  )

inline

Definition at line 88 of file der_enc.h.

         {
         return encode(vec.data(), vec.size(), real_type);
         }

References Botan::PEM_Code::encode().

encode() [8/11]

DER_Encoder & Botan::DER_Encoder::encode	(	const uint8_t	v[],
		size_t	len,
		ASN1_Tag	real_type,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 361 of file der_enc.cpp.

   {
   if(real_type != OCTET_STRING && real_type != BIT_STRING)
      throw Invalid_Argument("DER_Encoder: Invalid tag for byte/bit string");
 
   if(real_type == BIT_STRING)
      {
      secure_vector<uint8_t> encoded;
      encoded.push_back(0);
      encoded += std::make_pair(bytes, length);
      return add_object(type_tag, class_tag, encoded);
      }
   else
      return add_object(type_tag, class_tag, bytes, length);
   }

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

encode() [9/11]

DER_Encoder & Botan::DER_Encoder::encode	(	const uint8_t	val[],
		size_t	len,
		ASN1_Tag	real_type
	)

Definition at line 309 of file der_enc.cpp.

   {
   return encode(bytes, length, real_type, real_type, UNIVERSAL);
   }

References encode(), and Botan::UNIVERSAL.

encode() [10/11]

DER_Encoder & Botan::DER_Encoder::encode

(

size_t

s

)

Definition at line 293 of file der_enc.cpp.

   {
   return encode(BigInt(n), INTEGER, UNIVERSAL);
   }

References encode(), Botan::INTEGER, and Botan::UNIVERSAL.

encode() [11/11]

DER_Encoder & Botan::DER_Encoder::encode	(	size_t	s,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC
	)

Definition at line 328 of file der_enc.cpp.

   {
   return encode(BigInt(n), type_tag, class_tag);
   }

References encode().

encode_if() [1/2]

DER_Encoder & Botan::DER_Encoder::encode_if ( bool  pred, const ASN1_Object &  obj  )

inline

Definition at line 150 of file der_enc.h.

         {
         if(pred)
            encode(obj);
         return (*this);
         }

References Botan::PEM_Code::encode().

encode_if() [2/2]

DER_Encoder & Botan::DER_Encoder::encode_if ( bool  pred, DER_Encoder &  enc  )

inline

Definition at line 143 of file der_enc.h.

         {
         if(pred)
            return raw_bytes(enc.get_contents());
         return (*this);
         }

References get_contents().

encode_list()

template<typename T >

DER_Encoder & Botan::DER_Encoder::encode_list ( const std::vector< T > &  values )

inline

Definition at line 128 of file der_enc.h.

         {
         for(size_t i = 0; i != values.size(); ++i)
            encode(values[i]);
         return (*this);
         }

References Botan::PEM_Code::encode().

encode_null()

DER_Encoder & Botan::DER_Encoder::encode_null

(

)

Definition at line 277 of file der_enc.cpp.

   {
   return add_object(NULL_TAG, UNIVERSAL, nullptr, 0);
   }

References add_object(), Botan::NULL_TAG, and Botan::UNIVERSAL.

Referenced by Botan::EC_Group::DER_encode().

encode_optional()

template<typename T >

DER_Encoder & Botan::DER_Encoder::encode_optional ( const T &  value, const T &  default_value  )

inline

Definition at line 120 of file der_enc.h.

         {
         if(value != default_value)
            encode(value);
         return (*this);
         }

References Botan::PEM_Code::encode().

Referenced by Botan::Extensions::encode_into().

end_cons()

DER_Encoder & Botan::DER_Encoder::end_cons

(

)

Definition at line 191 of file der_enc.cpp.

   {
   if(m_subsequences.empty())
      throw Invalid_State("DER_Encoder::end_cons: No such sequence");
 
   DER_Sequence last_seq = std::move(m_subsequences[m_subsequences.size()-1]);
   m_subsequences.pop_back();
   last_seq.push_contents(*this);
 
   return (*this);
   }

Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::OCSP::Request::BER_encode(), Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PSSR::config_for_x509(), Botan::PKCS10_Request::create(), Botan::TLS::Session::DER_encode(), Botan::EC_Group::DER_encode(), Botan::DL_Group::DER_encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::Extensions::encode_into(), Botan::CRL_Entry::encode_into(), Botan::OCSP::CertID::encode_into(), Botan::X509_Object::encode_into(), Botan::X509_DN::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), end_explicit(), Botan::X509_Object::make_signed(), Botan::EC_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::private_key_bits(), Botan::Private_Key::private_key_info(), Botan::TPM_PrivateKey::public_key_bits(), Botan::McEliece_PublicKey::public_key_bits(), Botan::RSA_PublicKey::public_key_bits(), Botan::ASN1::put_in_sequence(), and Botan::Public_Key::subject_public_key().

end_explicit()

DER_Encoder & Botan::DER_Encoder::end_explicit

(

)

Definition at line 220 of file der_enc.cpp.

   {
   return end_cons();
   }

References end_cons().

Referenced by Botan::OCSP::Request::BER_encode(), Botan::PKCS10_Request::create(), and Botan::AlternativeName::encode_into().

get_contents()

secure_vector< uint8_t > Botan::DER_Encoder::get_contents

(

)

Definition at line 152 of file der_enc.cpp.

   {
   if(m_subsequences.size() != 0)
      throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
 
   if(m_append_output)
      throw Invalid_State("DER_Encoder Cannot get contents when using output vector");
 
   secure_vector<uint8_t> output;
   std::swap(output, m_default_outbuf);
   return output;
   }

Referenced by Botan::PKCS10_Request::create(), Botan::TLS::Session::DER_encode(), encode_if(), Botan::Curve25519_PrivateKey::private_key_bits(), Botan::DL_Scheme_PrivateKey::private_key_bits(), Botan::EC_PrivateKey::private_key_bits(), Botan::Ed25519_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::private_key_bits(), Botan::XMSS_PrivateKey::private_key_bits(), and Botan::Private_Key::private_key_info().

get_contents_unlocked()

std::vector< uint8_t > Botan::DER_Encoder::get_contents_unlocked

(

)

Return the encoded contents as a std::vector

If using this function, instead pass a std::vector to the contructor of DER_Encoder where the output will be placed. This avoids several unecessary copies.

Definition at line 165 of file der_enc.cpp.

   {
   if(m_subsequences.size() != 0)
      throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
 
   if(m_append_output)
      throw Invalid_State("DER_Encoder Cannot get contents when using output vector");
 
   std::vector<uint8_t> output(m_default_outbuf.begin(), m_default_outbuf.end());
   m_default_outbuf.clear();
   return output;
   }

raw_bytes() [1/2]

template<typename Alloc >

DER_Encoder & Botan::DER_Encoder::raw_bytes ( const std::vector< uint8_t, Alloc > &  val )

inline

Definition at line 76 of file der_enc.h.

         {
         return raw_bytes(val.data(), val.size());
         }

raw_bytes() [2/2]

DER_Encoder & Botan::DER_Encoder::raw_bytes	(	const uint8_t	val[],
		size_t	len
	)

Insert raw bytes directly into the output stream

Definition at line 228 of file der_enc.cpp.

   {
   if(m_subsequences.size())
      {
      m_subsequences[m_subsequences.size()-1].add_bytes(bytes, length);
      }
   else if(m_append_output)
      {
      m_append_output(bytes, length);
      }
   else
      {
      m_default_outbuf += std::make_pair(bytes, length);
      }
 
   return (*this);
   }

Referenced by Botan::PKCS10_Request::create(), Botan::AlgorithmIdentifier::encode_into(), Botan::X509_Object::encode_into(), Botan::X509_DN::encode_into(), Botan::Attribute::encode_into(), Botan::X509_Object::make_signed(), and Botan::ASN1::put_in_sequence().

start_cons()

DER_Encoder & Botan::DER_Encoder::start_cons	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = UNIVERSAL
	)

Definition at line 181 of file der_enc.cpp.

   {
   m_subsequences.push_back(DER_Sequence(type_tag, class_tag));
   return (*this);
   }

Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::OCSP::Request::BER_encode(), Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PSSR::config_for_x509(), Botan::PKCS10_Request::create(), Botan::TLS::Session::DER_encode(), Botan::EC_Group::DER_encode(), Botan::DL_Group::DER_encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::Extensions::encode_into(), Botan::CRL_Entry::encode_into(), Botan::OCSP::CertID::encode_into(), Botan::X509_Object::encode_into(), Botan::X509_DN::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::X509_Object::make_signed(), Botan::EC_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::private_key_bits(), Botan::Private_Key::private_key_info(), Botan::TPM_PrivateKey::public_key_bits(), Botan::McEliece_PublicKey::public_key_bits(), Botan::RSA_PublicKey::public_key_bits(), Botan::ASN1::put_in_sequence(), start_explicit(), and Botan::Public_Key::subject_public_key().

start_explicit()

DER_Encoder & Botan::DER_Encoder::start_explicit

(

uint16_t

type_tag

)

Definition at line 206 of file der_enc.cpp.

   {
   ASN1_Tag type_tag = static_cast<ASN1_Tag>(type_no);
 
   // This would confuse DER_Sequence
   if(type_tag == SET)
      throw Internal_Error("DER_Encoder.start_explicit(SET) not supported");
 
   return start_cons(type_tag, CONTEXT_SPECIFIC);
   }

References Botan::CONTEXT_SPECIFIC, Botan::SET, and start_cons().

Referenced by Botan::OCSP::Request::BER_encode(), Botan::PKCS10_Request::create(), and Botan::AlternativeName::encode_into().

---

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

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