Botan::DER_Encoder Class Reference

#include <der_enc.h>

Public Member Functions
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, byte val)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const byte rep[], size_t length)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const MemoryRegion< byte > &rep)
DER_Encoder &	add_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const std::string &str)
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)
DER_Encoder &	encode (const byte v[], size_t len, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
DER_Encoder &	encode (const byte val[], size_t len, ASN1_Tag real_type)
DER_Encoder &	encode (const MemoryRegion< byte > &v, ASN1_Tag real_type)
DER_Encoder &	encode (const MemoryRegion< byte > &v, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
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, 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 ()
SecureVector< byte >	get_contents ()
DER_Encoder &	raw_bytes (const byte val[], size_t len)
DER_Encoder &	raw_bytes (const MemoryRegion< byte > &val)
DER_Encoder &	start_cons (ASN1_Tag type_tag, ASN1_Tag class_tag=UNIVERSAL)
DER_Encoder &	start_explicit (u16bit type_tag)

Detailed Description

General DER Encoding Object

Definition at line 22 of file der_enc.h.

Member Function Documentation

add_object() [1/4]

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

Definition at line 382 of file der_enc.cpp.

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

References add_object().

add_object() [2/4]

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

Definition at line 346 of file der_enc.cpp.

   {
   SecureVector<byte> buffer;
   buffer += encode_tag(type_tag, class_tag);
   buffer += encode_length(length);
   buffer += std::make_pair(rep, length);
 
   return raw_bytes(buffer);
   }

References add_object(), and raw_bytes().

Referenced by add_object(), add_object(), add_object(), add_object(), encode(), encode(), encode(), Botan::ASN1_EAC_String::encode_into(), Botan::ASN1_String::encode_into(), Botan::EAC_Time::encode_into(), Botan::OID::encode_into(), Botan::X509_Time::encode_into(), and encode_null().

add_object() [3/4]

DER_Encoder & Botan::DER_Encoder::add_object	(	ASN1_Tag	type_tag,
		ASN1_Tag	class_tag,
		const MemoryRegion< byte > &	rep )

Definition at line 360 of file der_enc.cpp.

   {
   const byte* rep = &rep_buf[0];
   const size_t rep_len = rep_buf.size();
   return add_object(type_tag, class_tag, rep, rep_len);
   }

References add_object(), and Botan::MemoryRegion< T >::size().

add_object() [4/4]

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

Definition at line 371 of file der_enc.cpp.

   {
   const byte* rep = reinterpret_cast<const byte*>(rep_str.data());
   const size_t rep_len = rep_str.size();
   return add_object(type_tag, class_tag, rep, rep_len);
   }

References add_object().

encode() [1/11]

DER_Encoder & Botan::DER_Encoder::encode

(

bool

b

)

Definition at line 209 of file der_enc.cpp.

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

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

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode(), Botan::X509::BER_encode(), Botan::X509_Object::BER_encode(), Botan::CVC_EAC::create_ado_req(), Botan::X509::create_cert_req(), Botan::CVC_EAC::create_cvc_req(), Botan::DL_Group::DER_encode(), Botan::EC_Group::DER_encode(), Botan::ECDSA_Signature::DER_encode(), Botan::CMS_Encoder::digest(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), Botan::EAC1_1_gen_CVC< Derived >::encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::CRL_Entry::encode_into(), Botan::Extensions::encode_into(), encode_list(), encode_optional(), Botan::CMS_Encoder::encrypt(), Botan::make_cvc_cert(), Botan::EAC1_1_ADO::make_signed(), Botan::EAC1_1_gen_CVC< Derived >::make_signed(), Botan::X509_Object::make_signed(), Botan::DL_Scheme_PrivateKey::pkcs8_private_key(), Botan::EC_PrivateKey::pkcs8_private_key(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::CMS_Encoder::sign(), Botan::DL_Scheme_PublicKey::x509_subject_public_key(), and Botan::IF_Scheme_PublicKey::x509_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 252 of file der_enc.cpp.

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

References add_object(), and encode().

encode() [3/11]

DER_Encoder & Botan::DER_Encoder::encode

(

const ASN1_Object &

obj

)

Definition at line 337 of file der_enc.cpp.

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

References encode(), and Botan::ASN1_Object::encode_into().

encode() [4/11]

DER_Encoder & Botan::DER_Encoder::encode

(

const BigInt &

n

)

Definition at line 225 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 271 of file der_enc.cpp.

   {
   if(n == 0)
      return add_object(type_tag, class_tag, 0);
 
   bool extra_zero = (n.bits() % 8 == 0);
   SecureVector<byte> contents(extra_zero + n.bytes());
   BigInt::encode(&contents[extra_zero], n);
   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::bits(), Botan::BigInt::bytes(), Botan::BigInt::encode(), and encode().

encode() [6/11]

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

Definition at line 306 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)
      {
      SecureVector<byte> 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, encode(), Botan::OCTET_STRING, and Botan::MemoryRegion< T >::push_back().

encode() [7/11]

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

Definition at line 243 of file der_enc.cpp.

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

References encode(), and Botan::UNIVERSAL.

encode() [8/11]

DER_Encoder & Botan::DER_Encoder::encode	(	const MemoryRegion< byte > &	v,
		ASN1_Tag	real_type )

Definition at line 233 of file der_enc.cpp.

   {
   return encode(&bytes[0], bytes.size(),
                 real_type, real_type, UNIVERSAL);
   }

References encode(), Botan::MemoryRegion< T >::size(), and Botan::UNIVERSAL.

encode() [9/11]

DER_Encoder & Botan::DER_Encoder::encode	(	const MemoryRegion< byte > &	v,
		ASN1_Tag	real_type,
		ASN1_Tag	type_tag,
		ASN1_Tag	class_tag = CONTEXT_SPECIFIC )

Definition at line 295 of file der_enc.cpp.

   {
   return encode(&bytes[0], bytes.size(),
                 real_type, type_tag, class_tag);
   }

References encode(), and Botan::MemoryRegion< T >::size().

encode() [10/11]

DER_Encoder & Botan::DER_Encoder::encode

(

size_t

s

)

Definition at line 217 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 262 of file der_enc.cpp.

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

References encode().

encode_if()

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

Definition at line 327 of file der_enc.cpp.

   {
   if(cond)
      return raw_bytes(codec.get_contents());
   return (*this);
   }

References encode_if(), get_contents(), and raw_bytes().

Referenced by encode_if().

encode_list()

template<typename T>

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

inline

Definition at line 75 of file der_enc.h.

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

References encode().

Referenced by Botan::PK_Signer::signature().

encode_null()

DER_Encoder & Botan::DER_Encoder::encode_null

(

)

Definition at line 201 of file der_enc.cpp.

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

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

Referenced by Botan::EC_Group::DER_encode(), and encode_null().

encode_optional()

template<typename T>

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

inline

Definition at line 67 of file der_enc.h.

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

References encode().

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

end_cons()

DER_Encoder & Botan::DER_Encoder::end_cons

(

)

Definition at line 145 of file der_enc.cpp.

   {
   if(subsequences.empty())
      throw Invalid_State("DER_Encoder::end_cons: No such sequence");
 
   SecureVector<byte> seq = subsequences[subsequences.size()-1].get_contents();
   subsequences.pop_back();
   raw_bytes(seq);
   return (*this);
   }

References end_cons(), and raw_bytes().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode(), Botan::X509::BER_encode(), Botan::X509_Object::BER_encode(), Botan::EAC1_1_gen_CVC< Derived >::build_cert_body(), Botan::X509::create_cert_req(), Botan::DL_Group::DER_encode(), Botan::EC_Group::DER_encode(), Botan::ECDSA_Signature::DER_encode(), Botan::CMS_Encoder::digest(), Botan::EAC1_1_gen_CVC< Derived >::encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::CRL_Entry::encode_into(), Botan::Extensions::encode_into(), Botan::X509_DN::encode_into(), Botan::CMS_Encoder::encrypt(), end_cons(), end_explicit(), Botan::make_cvc_cert(), Botan::EAC1_1_ADO::make_signed(), Botan::EAC1_1_gen_CVC< Derived >::make_signed(), Botan::X509_Object::make_signed(), Botan::EC_PrivateKey::pkcs8_private_key(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::ASN1::put_in_sequence(), Botan::CMS_Encoder::sign(), Botan::PK_Signer::signature(), and Botan::IF_Scheme_PublicKey::x509_subject_public_key().

end_explicit()

DER_Encoder & Botan::DER_Encoder::end_explicit

(

)

Definition at line 172 of file der_enc.cpp.

   {
   return end_cons();
   }

References end_cons(), and end_explicit().

Referenced by Botan::X509::create_cert_req(), Botan::AlternativeName::encode_into(), and end_explicit().

get_contents()

SecureVector< byte > Botan::DER_Encoder::get_contents

(

)

Definition at line 122 of file der_enc.cpp.

   {
   if(subsequences.size() != 0)
      throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
 
   SecureVector<byte> output;
   std::swap(output, contents);
   return output;
   }

References get_contents(), and std::swap().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode(), Botan::X509::BER_encode(), Botan::X509_Object::BER_encode(), Botan::EAC1_1_gen_CVC< Derived >::build_cert_body(), Botan::CVC_EAC::create_ado_req(), Botan::X509::create_cert_req(), Botan::CVC_EAC::create_cvc_req(), Botan::DL_Group::DER_encode(), Botan::EC_Group::DER_encode(), Botan::ECDSA_Signature::DER_encode(), Botan::EAC1_1_gen_CVC< Derived >::encode(), encode_if(), Botan::CMS_Encoder::get_contents(), get_contents(), Botan::make_cvc_cert(), Botan::EAC1_1_ADO::make_signed(), Botan::EAC1_1_gen_CVC< Derived >::make_signed(), Botan::X509_Object::make_signed(), Botan::DL_Scheme_PrivateKey::pkcs8_private_key(), Botan::EC_PrivateKey::pkcs8_private_key(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::ASN1::put_in_sequence(), Botan::PK_Signer::signature(), Botan::DL_Scheme_PublicKey::x509_subject_public_key(), and Botan::IF_Scheme_PublicKey::x509_subject_public_key().

raw_bytes() [1/2]

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

Definition at line 188 of file der_enc.cpp.

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

References raw_bytes().

Referenced by add_object(), Botan::X509_Object::BER_encode(), Botan::EAC1_1_gen_CVC< Derived >::build_cert_body(), Botan::X509::create_cert_req(), Botan::CVC_EAC::create_cvc_req(), Botan::CMS_Encoder::digest(), Botan::EAC1_1_gen_CVC< Derived >::encode(), encode_if(), Botan::AlgorithmIdentifier::encode_into(), Botan::Attribute::encode_into(), Botan::X509_DN::encode_into(), Botan::CMS_Encoder::encrypt(), end_cons(), Botan::make_cvc_cert(), Botan::EAC1_1_ADO::make_signed(), Botan::EAC1_1_gen_CVC< Derived >::make_signed(), Botan::X509_Object::make_signed(), Botan::ASN1::put_in_sequence(), raw_bytes(), raw_bytes(), and Botan::CMS_Encoder::sign().

raw_bytes() [2/2]

DER_Encoder & Botan::DER_Encoder::raw_bytes

(

const MemoryRegion< byte > &

val

)

Definition at line 180 of file der_enc.cpp.

   {
   return raw_bytes(&val[0], val.size());
   }

References raw_bytes(), and Botan::MemoryRegion< T >::size().

start_cons()

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

Definition at line 135 of file der_enc.cpp.

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

References start_cons().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode(), Botan::X509::BER_encode(), Botan::X509_Object::BER_encode(), Botan::EAC1_1_gen_CVC< Derived >::build_cert_body(), Botan::CMS_Encoder::compress(), Botan::X509::create_cert_req(), Botan::DL_Group::DER_encode(), Botan::EC_Group::DER_encode(), Botan::ECDSA_Signature::DER_encode(), Botan::CMS_Encoder::digest(), Botan::EAC1_1_gen_CVC< Derived >::encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::CRL_Entry::encode_into(), Botan::Extensions::encode_into(), Botan::X509_DN::encode_into(), Botan::CMS_Encoder::encrypt(), Botan::CMS_Encoder::get_contents(), Botan::make_cvc_cert(), Botan::EAC1_1_ADO::make_signed(), Botan::EAC1_1_gen_CVC< Derived >::make_signed(), Botan::X509_Object::make_signed(), Botan::EC_PrivateKey::pkcs8_private_key(), Botan::IF_Scheme_PrivateKey::pkcs8_private_key(), Botan::ASN1::put_in_sequence(), Botan::CMS_Encoder::sign(), Botan::PK_Signer::signature(), start_cons(), start_explicit(), and Botan::IF_Scheme_PublicKey::x509_subject_public_key().

start_explicit()

DER_Encoder & Botan::DER_Encoder::start_explicit

(

u16bit

type_tag

)

Definition at line 159 of file der_enc.cpp.

   {
   ASN1_Tag type_tag = static_cast<ASN1_Tag>(type_no);
 
   if(type_tag == SET)
      throw Internal_Error("DER_Encoder.start_explicit(SET); cannot perform");
 
   return start_cons(type_tag, CONTEXT_SPECIFIC);
   }

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

Referenced by Botan::X509::create_cert_req(), Botan::AlternativeName::encode_into(), Botan::CMS_Encoder::encrypt(), and start_explicit().

---

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

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