Botan 3.12.0
Crypto and TLS for C&
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_Encoder & add_object (ASN1_Type type_tag, ASN1_Class class_tag, const secure_vector< uint8_t > &rep)
DER_Encoder & add_object (ASN1_Type type_tag, ASN1_Class class_tag, const std::vector< uint8_t > &rep)
DER_Encoder & add_object (ASN1_Type type_tag, ASN1_Class class_tag, const uint8_t rep[], size_t length)
DER_Encoder & add_object (ASN1_Type type_tag, ASN1_Class class_tag, std::span< const uint8_t > rep)
DER_Encoder & add_object (ASN1_Type type_tag, ASN1_Class class_tag, std::string_view str)
DER_Encoder & add_object (ASN1_Type type_tag, ASN1_Class class_tag, uint8_t val)
 DER_Encoder ()=default
BOTAN_FUTURE_EXPLICIT DER_Encoder (append_fn append)
BOTAN_FUTURE_EXPLICIT DER_Encoder (secure_vector< uint8_t > &vec)
BOTAN_FUTURE_EXPLICIT DER_Encoder (std::vector< uint8_t > &vec)
DER_Encoder & encode (bool b)
DER_Encoder & encode (bool b, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
DER_Encoder & encode (const ASN1_Object &obj)
DER_Encoder & encode (const BigInt &n)
DER_Encoder & encode (const BigInt &n, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
template<typename Alloc>
DER_Encoder & encode (const std::vector< uint8_t, Alloc > &bytes, ASN1_Type real_type, ASN1_Type type_tag, ASN1_Class class_tag)
template<typename Alloc>
DER_Encoder & encode (const std::vector< uint8_t, Alloc > &vec, ASN1_Type real_type)
DER_Encoder & encode (const uint8_t v[], size_t len, ASN1_Type real_type, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
DER_Encoder & encode (const uint8_t val[], size_t len, ASN1_Type real_type)
DER_Encoder & encode (size_t s)
DER_Encoder & encode (size_t s, ASN1_Type type_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
DER_Encoder & encode_if (bool pred, bool num)
DER_Encoder & encode_if (bool pred, const ASN1_Object &obj)
DER_Encoder & encode_if (bool pred, DER_Encoder &enc)
DER_Encoder & encode_if (bool pred, size_t num)
template<typename T>
DER_Encoder & encode_list (const std::vector< T > &values)
DER_Encoder & encode_null ()
template<typename T>
DER_Encoder & encode_optional (const std::optional< T > &value)
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 ()
DER_Encoder & raw_bytes (const uint8_t val[], size_t len)
DER_Encoder & raw_bytes (std::span< const uint8_t > val)
DER_Encoder & start_cons (ASN1_Type type_tag, ASN1_Class class_tag)
DER_Encoder & start_context_specific (uint32_t tag)
DER_Encoder & start_explicit (uint16_t type_tag)
DER_Encoder & start_explicit_context_specific (uint32_t tag)
DER_Encoder & start_sequence ()
DER_Encoder & start_set ()

Detailed Description

General DER Encoding Object

Definition at line 25 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 27 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.

References BOTAN_FUTURE_EXPLICIT, and DER_Encoder().

Referenced by add_object(), add_object(), add_object(), add_object(), add_object(), add_object(), DER_Encoder(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode_if(), encode_if(), encode_if(), encode_if(), encode_list(), encode_null(), encode_optional(), encode_optional(), end_cons(), end_explicit(), raw_bytes(), raw_bytes(), start_cons(), start_context_specific(), start_explicit(), start_explicit_context_specific(), start_sequence(), and start_set().

◆ 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 68 of file der_enc.cpp.

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

◆ 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 72 of file der_enc.cpp.

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

◆ DER_Encoder() [4/4]

BOTAN_FUTURE_EXPLICIT 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 52 of file der_enc.h.

52: m_append_output(std::move(append)) {}

References BOTAN_FUTURE_EXPLICIT.

Member Function Documentation

◆ add_object() [1/6]

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

Definition at line 193 of file der_enc.h.

193 {
194 return add_object(type_tag, class_tag, std::span{rep});
195 }
Botan::DER_Encoder::add_object
DER_Encoder & add_object(ASN1_Type type_tag, ASN1_Class class_tag, const uint8_t rep[], size_t length)
Definition der_enc.cpp:217

References add_object(), and DER_Encoder().

◆ add_object() [2/6]

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

Definition at line 189 of file der_enc.h.

189 {
190 return add_object(type_tag, class_tag, std::span{rep});
191 }

References add_object(), and DER_Encoder().

◆ add_object() [3/6]

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

Definition at line 217 of file der_enc.cpp.

217 {
218 std::vector<uint8_t> hdr;
219 encode_tag(hdr, type_tag, class_tag);
220 encode_length(hdr, length);
221
222 if(!m_subsequences.empty()) {
223 m_subsequences[m_subsequences.size() - 1].add_bytes(hdr.data(), hdr.size(), rep, length);
224 } else if(m_append_output) {
225 m_append_output(hdr.data(), hdr.size());
226 m_append_output(rep, length);
227 } else {
228 m_default_outbuf += hdr;
229 m_default_outbuf += std::make_pair(rep, length);
230 }
231
232 return (*this);
233}

References DER_Encoder().

Referenced by add_object(), add_object(), add_object(), add_object(), add_object(), encode(), encode(), encode(), Botan::AlternativeName::encode_into(), Botan::ASN1_String::encode_into(), Botan::ASN1_Time::encode_into(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::encode_into(), Botan::OID::encode_into(), and encode_null().

◆ add_object() [4/6]

DER_Encoder & Botan::DER_Encoder::add_object ( ASN1_Type type_tag,
ASN1_Class class_tag,
std::span< const uint8_t > rep )
inline

Definition at line 185 of file der_enc.h.

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

References add_object(), and DER_Encoder().

◆ add_object() [5/6]

DER_Encoder & Botan::DER_Encoder::add_object ( ASN1_Type type_tag,
ASN1_Class class_tag,
std::string_view str )

Definition at line 346 of file der_enc.cpp.

346 {
347 return add_object(type_tag, class_tag, as_span_of_bytes(rep_str));
348}
Botan::as_span_of_bytes
std::span< const uint8_t > as_span_of_bytes(const char *s, size_t len)
Definition mem_utils.h:59

References add_object(), Botan::as_span_of_bytes(), and DER_Encoder().

◆ add_object() [6/6]

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

Definition at line 353 of file der_enc.cpp.

353 {
354 return add_object(type_tag, class_tag, std::span<const uint8_t>{&rep, 1});
355}

References add_object(), and DER_Encoder().

◆ encode() [1/11]

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

Definition at line 245 of file der_enc.cpp.

245 {
246 return encode(is_true, ASN1_Type::Boolean, ASN1_Class::Universal);
247}
Botan::DER_Encoder::encode
DER_Encoder & encode(bool b)
Definition der_enc.cpp:245

References Botan::Boolean, DER_Encoder(), 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::PKCS10_Request::create(), Botan::DL_Group::DER_encode(), Botan::DL_PrivateKey::DER_encode(), Botan::DL_PublicKey::DER_encode(), Botan::EC_Group::DER_encode(), Botan::TLS::Session::DER_encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode(), encode_if(), encode_if(), encode_if(), Botan::AlgorithmIdentifier::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::encode_into(), Botan::CRL_Entry::encode_into(), Botan::Extensions::encode_into(), Botan::OCSP::CertID::encode_into(), Botan::PSS_Params::encode_into(), Botan::X509_DN::encode_into(), Botan::X509_Object::encode_into(), encode_list(), encode_optional(), encode_optional(), Botan::X509_Object::make_signed(), Botan::EC_PrivateKey::private_key_bits(), Botan::Ed25519_PrivateKey::private_key_bits(), Botan::Ed448_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::private_key_bits(), Botan::X25519_PrivateKey::private_key_bits(), Botan::X448_PrivateKey::private_key_bits(), Botan::XMSS_PrivateKey::private_key_bits(), Botan::Private_Key::private_key_info(), Botan::GOST_3410_PublicKey::public_key_bits(), Botan::McEliece_PublicKey::public_key_bits(), Botan::RSA_PublicKey::public_key_bits(), Botan::TPM_PrivateKey::public_key_bits(), Botan::XMSS_PublicKey::public_key_bits(), Botan::PSS_Params::serialize(), Botan::TLS::Certificate_Request_12::serialize(), Botan::EC_Group_Data::set_oid(), and Botan::Public_Key::subject_public_key().

◆ encode() [2/11]

DER_Encoder & Botan::DER_Encoder::encode ( bool b,
ASN1_Type type_tag,
ASN1_Class class_tag = ASN1_Class::ContextSpecific )

Definition at line 273 of file der_enc.cpp.

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

References add_object(), and DER_Encoder().

◆ encode() [3/11]

DER_Encoder & Botan::DER_Encoder::encode ( const ASN1_Object & obj)

Definition at line 338 of file der_enc.cpp.

338 {
339 obj.encode_into(*this);
340 return (*this);
341}

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

◆ encode() [4/11]

DER_Encoder & Botan::DER_Encoder::encode ( const BigInt & n)

Definition at line 259 of file der_enc.cpp.

259 {
260 return encode(n, ASN1_Type::Integer, ASN1_Class::Universal);
261}

References DER_Encoder(), encode(), Botan::Integer, and Botan::Universal.

◆ encode() [5/11]

DER_Encoder & Botan::DER_Encoder::encode ( const BigInt & n,
ASN1_Type type_tag,
ASN1_Class class_tag = ASN1_Class::ContextSpecific )

Definition at line 288 of file der_enc.cpp.

288 {
289 if(n == 0) {
290 return add_object(type_tag, class_tag, 0);
291 }
292
293 // Serialize magnitude with one extra leading byte
294 auto contents = n.serialize(n.bytes() + 1);
295
296 if(n.signum() < 0) {
297 // Two's complement: bitwise NOT then increment
298 for(auto& byte : contents) {
299 byte = ~byte;
300 }
301 for(size_t i = contents.size(); i > 0; --i) {
302 if(++contents[i - 1] != 0) {
303 break;
304 }
305 }
306 }
307
308 /*
309 * DER requires the leading byte be emitted only if it required
310 */
311 BOTAN_ASSERT_NOMSG(contents.size() >= 2);
312 const bool leading_byte_redundant =
313 (contents[0] == 0x00 && (contents[1] & 0x80) == 0) || (contents[0] == 0xFF && (contents[1] & 0x80) != 0);
314 auto encoding = std::span{contents}.subspan(leading_byte_redundant ? 1 : 0);
315
316 return add_object(type_tag, class_tag, encoding);
317}
BOTAN_ASSERT_NOMSG
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:75

References add_object(), BOTAN_ASSERT_NOMSG, Botan::BigInt::bytes(), DER_Encoder(), Botan::BigInt::serialize(), and Botan::BigInt::signum().

◆ encode() [6/11]

template<typename Alloc>
DER_Encoder & Botan::DER_Encoder::encode ( const std::vector< uint8_t, Alloc > & bytes,
ASN1_Type real_type,
ASN1_Type type_tag,
ASN1_Class class_tag )
inline

Definition at line 115 of file der_enc.h.

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

References DER_Encoder(), and encode().

◆ encode() [7/11]

template<typename Alloc>
DER_Encoder & Botan::DER_Encoder::encode ( const std::vector< uint8_t, Alloc > & vec,
ASN1_Type real_type )
inline

Definition at line 98 of file der_enc.h.

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

References DER_Encoder(), and encode().

◆ encode() [8/11]

DER_Encoder & Botan::DER_Encoder::encode ( const uint8_t v[],
size_t len,
ASN1_Type real_type,
ASN1_Type type_tag,
ASN1_Class class_tag = ASN1_Class::ContextSpecific )

Definition at line 322 of file der_enc.cpp.

323 {
324 if(real_type != ASN1_Type::OctetString && real_type != ASN1_Type::BitString) {
325 throw Invalid_Argument("DER_Encoder: Invalid tag for byte/bit string");
326 }
327
328 if(real_type == ASN1_Type::BitString) {
329 secure_vector<uint8_t> encoded;
330 encoded.push_back(0);
331 encoded += std::make_pair(bytes, length);
332 return add_object(type_tag, class_tag, encoded);
333 } else {
334 return add_object(type_tag, class_tag, bytes, length);
335 }
336}
Botan::secure_vector
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:68

References add_object(), Botan::BitString, DER_Encoder(), and Botan::OctetString.

◆ encode() [9/11]

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

Definition at line 266 of file der_enc.cpp.

266 {
267 return encode(bytes, length, real_type, real_type, ASN1_Class::Universal);
268}

References DER_Encoder(), encode(), and Botan::Universal.

◆ encode() [10/11]

DER_Encoder & Botan::DER_Encoder::encode ( size_t s)

Definition at line 252 of file der_enc.cpp.

252 {
253 return encode(BigInt::from_u64(n), ASN1_Type::Integer, ASN1_Class::Universal);
254}
Botan::BigInt::from_u64
static BigInt from_u64(uint64_t n)
Definition bigint.cpp:30

References DER_Encoder(), encode(), Botan::BigInt::from_u64(), Botan::Integer, and Botan::Universal.

◆ encode() [11/11]

DER_Encoder & Botan::DER_Encoder::encode ( size_t s,
ASN1_Type type_tag,
ASN1_Class class_tag = ASN1_Class::ContextSpecific )

Definition at line 281 of file der_enc.cpp.

281 {
282 return encode(BigInt::from_u64(n), type_tag, class_tag);
283}

References DER_Encoder(), encode(), and Botan::BigInt::from_u64().

◆ encode_if() [1/4]

DER_Encoder & Botan::DER_Encoder::encode_if ( bool pred,
bool num )
inline

Definition at line 176 of file der_enc.h.

176 {
177 if(pred) {
178 encode(num);
179 }
180 return (*this);
181 }

References DER_Encoder(), and encode().

◆ encode_if() [2/4]

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

Definition at line 162 of file der_enc.h.

162 {
163 if(pred) {
164 encode(obj);
165 }
166 return (*this);
167 }

References DER_Encoder(), and encode().

◆ encode_if() [3/4]

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

Definition at line 155 of file der_enc.h.

155 {
156 if(pred) {
157 return raw_bytes(enc.get_contents());
158 }
159 return (*this);
160 }
Botan::DER_Encoder::raw_bytes
DER_Encoder & raw_bytes(const uint8_t val[], size_t len)
Definition der_enc.cpp:202

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

◆ encode_if() [4/4]

DER_Encoder & Botan::DER_Encoder::encode_if ( bool pred,
size_t num )
inline

Definition at line 169 of file der_enc.h.

169 {
170 if(pred) {
171 encode(num);
172 }
173 return (*this);
174 }

References DER_Encoder(), and encode().

◆ encode_list()

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

Definition at line 140 of file der_enc.h.

140 {
141 for(size_t i = 0; i != values.size(); ++i) {
142 encode(values[i]);
143 }
144 return (*this);
145 }

References DER_Encoder(), and encode().

Referenced by Botan::TLS::Session::DER_encode(), Botan::Cert_Extension::ASBlocks::ASIdentifierChoice::encode_into(), and Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::encode_into().

◆ encode_null()

DER_Encoder & Botan::DER_Encoder::encode_null ( )

Definition at line 238 of file der_enc.cpp.

238 {
239 return add_object(ASN1_Type::Null, ASN1_Class::Universal, nullptr, 0);
240}

References add_object(), DER_Encoder(), Botan::Null, and Botan::Universal.

Referenced by Botan::Cert_Extension::ASBlocks::ASIdentifierChoice::encode_into(), and Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::encode_into().

◆ encode_optional() [1/2]

template<typename T>
DER_Encoder & Botan::DER_Encoder::encode_optional ( const std::optional< T > & value)
inline

Definition at line 132 of file der_enc.h.

132 {
133 if(value) {
134 encode(*value);
135 }
136 return (*this);
137 }

References DER_Encoder(), and encode().

◆ encode_optional() [2/2]

template<typename T>
DER_Encoder & Botan::DER_Encoder::encode_optional ( const T & value,
const T & default_value )
inline

Definition at line 124 of file der_enc.h.

124 {
125 if(value != default_value) {
126 encode(value);
127 }
128 return (*this);
129 }

References DER_Encoder(), encode(), and encode_optional().

Referenced by Botan::Extensions::encode_into(), and encode_optional().

◆ end_cons()

DER_Encoder & Botan::DER_Encoder::end_cons ( )

Definition at line 173 of file der_enc.cpp.

173 {
174 if(m_subsequences.empty()) {
175 throw Invalid_State("DER_Encoder::end_cons: No such sequence");
176 }
177
178 DER_Sequence last_seq = std::move(m_subsequences[m_subsequences.size() - 1]);
179 m_subsequences.pop_back();
180 last_seq.push_contents(*this);
181
182 return (*this);
183}

References DER_Encoder().

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::PKCS10_Request::create(), Botan::DL_Group::DER_encode(), Botan::EC_Group::DER_encode(), Botan::TLS::Session::DER_encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdentifierChoice::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::encode_into(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::encode_into(), Botan::CRL_Entry::encode_into(), Botan::Extensions::encode_into(), Botan::OCSP::CertID::encode_into(), Botan::PSS_Params::encode_into(), Botan::X509_DN::encode_into(), Botan::X509_Object::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::McEliece_PublicKey::public_key_bits(), Botan::RSA_PublicKey::public_key_bits(), Botan::TPM_PrivateKey::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 195 of file der_enc.cpp.

195 {
196 return end_cons();
197}
Botan::DER_Encoder::end_cons
DER_Encoder & end_cons()
Definition der_enc.cpp:173

References DER_Encoder(), and end_cons().

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

◆ get_contents()

secure_vector< uint8_t > Botan::DER_Encoder::get_contents ( )

Definition at line 134 of file der_enc.cpp.

134 {
135 if(!m_subsequences.empty()) {
136 throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
137 }
138
139 if(m_append_output) {
140 throw Invalid_State("DER_Encoder Cannot get contents when using output vector");
141 }
142
143 secure_vector<uint8_t> output;
144 std::swap(output, m_default_outbuf);
145 return output;
146}

Referenced by Botan::DL_PrivateKey::DER_encode(), Botan::TLS::Session::DER_encode(), encode_if(), Botan::EC_PrivateKey::private_key_bits(), Botan::Ed25519_PrivateKey::private_key_bits(), Botan::Ed448_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::RSA_PrivateKey::private_key_bits(), Botan::X25519_PrivateKey::private_key_bits(), Botan::X448_PrivateKey::private_key_bits(), Botan::XMSS_PrivateKey::private_key_bits(), Botan::Private_Key::private_key_info(), and Botan::TLS::Certificate_Request_12::serialize().

◆ 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 constructor of DER_Encoder where the output will be placed. This avoids several unnecessary copies.

Definition at line 148 of file der_enc.cpp.

148 {
149 if(!m_subsequences.empty()) {
150 throw Invalid_State("DER_Encoder: Sequence hasn't been marked done");
151 }
152
153 if(m_append_output) {
154 throw Invalid_State("DER_Encoder Cannot get contents when using output vector");
155 }
156
157 std::vector<uint8_t> output(m_default_outbuf.begin(), m_default_outbuf.end());
158 m_default_outbuf.clear();
159 return output;
160}

Referenced by Botan::PKCS10_Request::create().

◆ raw_bytes() [1/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 202 of file der_enc.cpp.

202 {
203 if(!m_subsequences.empty()) {
204 m_subsequences[m_subsequences.size() - 1].add_bytes(bytes, length);
205 } else if(m_append_output) {
206 m_append_output(bytes, length);
207 } else {
208 m_default_outbuf += std::make_pair(bytes, length);
209 }
210
211 return (*this);
212}

References DER_Encoder().

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

◆ raw_bytes() [2/2]

DER_Encoder & Botan::DER_Encoder::raw_bytes ( std::span< const uint8_t > val)
inline

Definition at line 89 of file der_enc.h.

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

References DER_Encoder(), and raw_bytes().

Referenced by raw_bytes().

◆ start_cons()

DER_Encoder & Botan::DER_Encoder::start_cons ( ASN1_Type type_tag,
ASN1_Class class_tag )

Definition at line 165 of file der_enc.cpp.

165 {
166 m_subsequences.push_back(DER_Sequence(type_tag, class_tag));
167 return (*this);
168}

References DER_Encoder().

Referenced by Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::encode_into(), start_context_specific(), start_explicit(), start_explicit_context_specific(), start_sequence(), and start_set().

◆ start_context_specific()

DER_Encoder & Botan::DER_Encoder::start_context_specific ( uint32_t tag)
inline

Definition at line 71 of file der_enc.h.

71 {
72 return start_cons(ASN1_Type(tag), ASN1_Class::ContextSpecific);
73 }
Botan::DER_Encoder::start_cons
DER_Encoder & start_cons(ASN1_Type type_tag, ASN1_Class class_tag)
Definition der_enc.cpp:165
Botan::ASN1_Type
ASN1_Type
Definition asn1_obj.h:43

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

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

◆ start_explicit()

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

Definition at line 188 of file der_enc.cpp.

188 {
189 return start_cons(static_cast<ASN1_Type>(type_no), ASN1_Class::ContextSpecific);
190}

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

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

◆ start_explicit_context_specific()

DER_Encoder & Botan::DER_Encoder::start_explicit_context_specific ( uint32_t tag)
inline

Definition at line 75 of file der_enc.h.

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

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

Referenced by Botan::EC_PrivateKey::private_key_bits().

◆ start_sequence()

DER_Encoder & Botan::DER_Encoder::start_sequence ( )
inline

Definition at line 67 of file der_enc.h.

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

References DER_Encoder(), Botan::Sequence, start_cons(), start_sequence(), 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::PKCS10_Request::create(), Botan::DL_Group::DER_encode(), Botan::EC_Group::DER_encode(), Botan::TLS::Session::DER_encode(), Botan::AlgorithmIdentifier::encode_into(), Botan::AlternativeName::encode_into(), Botan::Attribute::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdentifierChoice::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdentifiers::encode_into(), Botan::Cert_Extension::ASBlocks::ASIdOrRange::encode_into(), Botan::Cert_Extension::CRL_Distribution_Points::Distribution_Point::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressChoice< V >::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressFamily::encode_into(), Botan::Cert_Extension::IPAddressBlocks::IPAddressOrRange< V >::encode_into(), Botan::CRL_Entry::encode_into(), Botan::Extensions::encode_into(), Botan::OCSP::CertID::encode_into(), Botan::PSS_Params::encode_into(), Botan::X509_DN::encode_into(), Botan::X509_Object::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::McEliece_PublicKey::public_key_bits(), Botan::RSA_PublicKey::public_key_bits(), Botan::TPM_PrivateKey::public_key_bits(), Botan::ASN1::put_in_sequence(), start_sequence(), and Botan::Public_Key::subject_public_key().

◆ start_set()

DER_Encoder & Botan::DER_Encoder::start_set ( )
inline

Definition at line 69 of file der_enc.h.

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

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

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

The documentation for this class was generated from the following files:
Generated by doxygen 1.16.1