Botan 2.19.1
Crypto and TLS for C&
Classes | Public Types | Public Member Functions | List of all members
Botan::DER_Encoder Class Referencefinal

#include <der_enc.h>

Public Types

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

Public Member Functions

DER_Encoderadd_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const secure_vector< uint8_t > &rep)
 
DER_Encoderadd_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const std::string &str)
 
DER_Encoderadd_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const std::vector< uint8_t > &rep)
 
DER_Encoderadd_object (ASN1_Tag type_tag, ASN1_Tag class_tag, const uint8_t rep[], size_t length)
 
DER_Encoderadd_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_Encoderencode (bool b)
 
DER_Encoderencode (bool b, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
 
DER_Encoderencode (const ASN1_Object &obj)
 
DER_Encoderencode (const BigInt &n)
 
DER_Encoderencode (const BigInt &n, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
 
template<typename Alloc >
DER_Encoderencode (const std::vector< uint8_t, Alloc > &bytes, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag)
 
template<typename Alloc >
DER_Encoderencode (const std::vector< uint8_t, Alloc > &vec, ASN1_Tag real_type)
 
DER_Encoderencode (const uint8_t v[], size_t len, ASN1_Tag real_type, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
 
DER_Encoderencode (const uint8_t val[], size_t len, ASN1_Tag real_type)
 
DER_Encoderencode (size_t s)
 
DER_Encoderencode (size_t s, ASN1_Tag type_tag, ASN1_Tag class_tag=CONTEXT_SPECIFIC)
 
DER_Encoderencode_if (bool pred, const ASN1_Object &obj)
 
DER_Encoderencode_if (bool pred, DER_Encoder &enc)
 
template<typename T >
DER_Encoderencode_list (const std::vector< T > &values)
 
DER_Encoderencode_null ()
 
template<typename T >
DER_Encoderencode_optional (const T &value, const T &default_value)
 
DER_Encoderend_cons ()
 
DER_Encoderend_explicit ()
 
secure_vector< uint8_t > get_contents ()
 
std::vector< uint8_t > get_contents_unlocked ()
 
template<typename Alloc >
DER_Encoderraw_bytes (const std::vector< uint8_t, Alloc > &val)
 
DER_Encoderraw_bytes (const uint8_t val[], size_t len)
 
DER_Encoderstart_cons (ASN1_Tag type_tag, ASN1_Tag class_tag=UNIVERSAL)
 
DER_Encoderstart_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
vecIf this constructor is used, get_contents* may not be called.

Definition at line 69 of file der_enc.cpp.

70 {
71 m_append_output = [&vec](const uint8_t b[], size_t l)
72 {
73 vec.insert(vec.end(), b, b + l);
74 };
75 }

◆ DER_Encoder() [3/4]

Botan::DER_Encoder::DER_Encoder ( std::vector< uint8_t > &  vec)

DER encode, writing to

Parameters
vecIf this constructor is used, get_contents* may not be called.

Definition at line 77 of file der_enc.cpp.

78 {
79 m_append_output = [&vec](const uint8_t b[], size_t l)
80 {
81 vec.insert(vec.end(), b, b + l);
82 };
83 }

◆ 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.

50: 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.

168 {
169 return add_object(type_tag, class_tag, rep.data(), rep.size());
170 }
DER_Encoder & add_object(ASN1_Tag type_tag, ASN1_Tag class_tag, const uint8_t rep[], size_t length)
Definition: der_enc.cpp:249

◆ 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.

390 {
391 const uint8_t* rep = cast_char_ptr_to_uint8(rep_str.data());
392 const size_t rep_len = rep_str.size();
393 return add_object(type_tag, class_tag, rep, rep_len);
394 }
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition: mem_ops.h:190

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.

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

◆ 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.

251 {
252 std::vector<uint8_t> hdr;
253 encode_tag(hdr, type_tag, class_tag);
254 encode_length(hdr, length);
255
256 if(m_subsequences.size())
257 {
258 m_subsequences[m_subsequences.size()-1].add_bytes(hdr.data(), hdr.size(), rep, length);
259 }
260 else if(m_append_output)
261 {
262 m_append_output(hdr.data(), hdr.size());
263 m_append_output(rep, length);
264 }
265 else
266 {
267 m_default_outbuf += hdr;
268 m_default_outbuf += std::make_pair(rep, length);
269 }
270
271 return (*this);
272 }

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.

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

References add_object().

◆ encode() [1/11]

DER_Encoder & Botan::DER_Encoder::encode ( bool  b)

Definition at line 285 of file der_enc.cpp.

286 {
287 return encode(is_true, BOOLEAN, UNIVERSAL);
288 }
DER_Encoder & encode(bool b)
Definition: der_enc.cpp:285
@ BOOLEAN
Definition: asn1_obj.h:35
@ UNIVERSAL
Definition: asn1_obj.h:26

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.

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

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.

380 {
381 obj.encode_into(*this);
382 return (*this);
383 }

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.

302 {
303 return encode(n, INTEGER, UNIVERSAL);
304 }
@ INTEGER
Definition: asn1_obj.h:36

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.

339 {
340 if(n == 0)
341 return add_object(type_tag, class_tag, 0);
342
343 const size_t extra_zero = (n.bits() % 8 == 0) ? 1 : 0;
344 secure_vector<uint8_t> contents(extra_zero + n.bytes());
345 n.binary_encode(&contents[extra_zero]);
346 if(n < 0)
347 {
348 for(size_t i = 0; i != contents.size(); ++i)
349 contents[i] = ~contents[i];
350 for(size_t i = contents.size(); i > 0; --i)
351 if(++contents[i-1])
352 break;
353 }
354
355 return add_object(type_tag, class_tag, contents);
356 }

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.

114 {
115 return encode(bytes.data(), bytes.size(),
116 real_type, type_tag, class_tag);
117 }

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.

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

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.

364 {
365 if(real_type != OCTET_STRING && real_type != BIT_STRING)
366 throw Invalid_Argument("DER_Encoder: Invalid tag for byte/bit string");
367
368 if(real_type == BIT_STRING)
369 {
370 secure_vector<uint8_t> encoded;
371 encoded.push_back(0);
372 encoded += std::make_pair(bytes, length);
373 return add_object(type_tag, class_tag, encoded);
374 }
375 else
376 return add_object(type_tag, class_tag, bytes, length);
377 }
@ BIT_STRING
Definition: asn1_obj.h:37
@ OCTET_STRING
Definition: asn1_obj.h:38

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.

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

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.

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

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.

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

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.

151 {
152 if(pred)
153 encode(obj);
154 return (*this);
155 }

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.

144 {
145 if(pred)
146 return raw_bytes(enc.get_contents());
147 return (*this);
148 }
DER_Encoder & raw_bytes(const uint8_t val[], size_t len)
Definition: der_enc.cpp:228

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.

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

References Botan::PEM_Code::encode().

◆ encode_null()

DER_Encoder & Botan::DER_Encoder::encode_null ( )

Definition at line 277 of file der_enc.cpp.

278 {
279 return add_object(NULL_TAG, UNIVERSAL, nullptr, 0);
280 }
@ NULL_TAG
Definition: asn1_obj.h:39

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.

121 {
122 if(value != default_value)
123 encode(value);
124 return (*this);
125 }

References Botan::PEM_Code::encode().

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

◆ end_cons()

DER_Encoder & Botan::DER_Encoder::end_cons ( )

◆ end_explicit()

DER_Encoder & Botan::DER_Encoder::end_explicit ( )

Definition at line 220 of file der_enc.cpp.

221 {
222 return end_cons();
223 }
DER_Encoder & end_cons()
Definition: der_enc.cpp:191

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.

153 {
154 if(m_subsequences.size() != 0)
155 throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
156
157 if(m_append_output)
158 throw Invalid_State("DER_Encoder Cannot get contents when using output vector");
159
160 secure_vector<uint8_t> output;
161 std::swap(output, m_default_outbuf);
162 return output;
163 }

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.

166 {
167 if(m_subsequences.size() != 0)
168 throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
169
170 if(m_append_output)
171 throw Invalid_State("DER_Encoder Cannot get contents when using output vector");
172
173 std::vector<uint8_t> output(m_default_outbuf.begin(), m_default_outbuf.end());
174 m_default_outbuf.clear();
175 return output;
176 }

◆ 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.

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

◆ 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.

229 {
230 if(m_subsequences.size())
231 {
232 m_subsequences[m_subsequences.size()-1].add_bytes(bytes, length);
233 }
234 else if(m_append_output)
235 {
236 m_append_output(bytes, length);
237 }
238 else
239 {
240 m_default_outbuf += std::make_pair(bytes, length);
241 }
242
243 return (*this);
244 }

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 
)

◆ start_explicit()

DER_Encoder & Botan::DER_Encoder::start_explicit ( uint16_t  type_tag)

Definition at line 206 of file der_enc.cpp.

207 {
208 ASN1_Tag type_tag = static_cast<ASN1_Tag>(type_no);
209
210 // This would confuse DER_Sequence
211 if(type_tag == SET)
212 throw Internal_Error("DER_Encoder.start_explicit(SET) not supported");
213
214 return start_cons(type_tag, CONTEXT_SPECIFIC);
215 }
DER_Encoder & start_cons(ASN1_Tag type_tag, ASN1_Tag class_tag=UNIVERSAL)
Definition: der_enc.cpp:181
ASN1_Tag
Definition: asn1_obj.h:25
@ CONTEXT_SPECIFIC
Definition: asn1_obj.h:28
@ SET
Definition: asn1_obj.h:43

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: