Botan::AlgorithmIdentifier Class Reference

#include <alg_id.h>

Inheritance diagram for Botan::AlgorithmIdentifier:

Public Types
enum	Encoding_Option { USE_NULL_PARAM, USE_EMPTY_PARAM }

Public Member Functions
	AlgorithmIdentifier ()=default
	AlgorithmIdentifier (const OID &oid, Encoding_Option enc)
	AlgorithmIdentifier (const std::string &oid_name, Encoding_Option enc)
	AlgorithmIdentifier (const OID &oid, const std::vector< uint8_t > &params)
	AlgorithmIdentifier (const std::string &oid_name, const std::vector< uint8_t > &params)
std::vector< uint8_t >	BER_encode () const
void	decode_from (class BER_Decoder &) override
void	encode_into (class DER_Encoder &) const override
const OID &	get_oid () const
const std::vector< uint8_t > &	get_parameters () const

Public Attributes
BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES	__pad0__: OID oid
std::vector< uint8_t >	parameters

Detailed Description

Algorithm Identifier

Definition at line 21 of file alg_id.h.

Member Enumeration Documentation

enum Botan::AlgorithmIdentifier::Encoding_Option

Enumerator
USE_NULL_PARAM
USE_EMPTY_PARAM

Definition at line 24 of file alg_id.h.

{ USE_NULL_PARAM, USE_EMPTY_PARAM };

Constructor & Destructor Documentation

Botan::AlgorithmIdentifier::AlgorithmIdentifier ( )

default

Botan::AlgorithmIdentifier::AlgorithmIdentifier	(	const OID &	oid,
		Encoding_Option	enc
	)

Definition at line 35 of file alg_id.cpp.

References parameters, and USE_NULL_PARAM.

                                                                 :
   oid(alg_id),
   parameters()
   {
   const uint8_t DER_NULL[] = { 0x05, 0x00 };

   if(option == USE_NULL_PARAM)
      parameters.assign(DER_NULL, DER_NULL + 2);
   }

Botan::AlgorithmIdentifier::AlgorithmIdentifier	(	const std::string &	oid_name,
		Encoding_Option	enc
	)

Definition at line 49 of file alg_id.cpp.

References parameters, and USE_NULL_PARAM.

                                                                 :
   oid(OID::from_string(alg_id)),
   parameters()
   {
   const uint8_t DER_NULL[] = { 0x05, 0x00 };

   if(option == USE_NULL_PARAM)
      parameters.assign(DER_NULL, DER_NULL + 2);
   }

Botan::AlgorithmIdentifier::AlgorithmIdentifier	(	const OID &	oid,
		const std::vector< uint8_t > &	params
	)

Definition at line 18 of file alg_id.cpp.

                                                                          :
   oid(alg_id),
   parameters(param)
   {}

Botan::AlgorithmIdentifier::AlgorithmIdentifier	(	const std::string &	oid_name,
		const std::vector< uint8_t > &	params
	)

Definition at line 27 of file alg_id.cpp.

                                                                          :
   AlgorithmIdentifier(OID::from_string(alg_id), param)
   {}

Member Function Documentation

std::vector< uint8_t > Botan::ASN1_Object::BER_encode ( ) const

inherited

Return the encoding of this object. This is a convenience method when just one object needs to be serialized. Use DER_Encoder for complicated encodings.

Definition at line 16 of file asn1_obj.cpp.

References Botan::ASN1_Object::encode_into().

Referenced by Botan::PSSR::config_for_x509(), Botan::Certificate_Store_In_SQL::find_all_certs(), Botan::Certificate_Store_In_SQL::find_cert(), Botan::X509_Certificate::fingerprint(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::X509_Object::PEM_encode(), and Botan::Certificate_Store_In_SQL::revoke_cert().

   {
   std::vector<uint8_t> output;
   DER_Encoder der(output);
   this->encode_into(der);
   return output;
   }

void Botan::AlgorithmIdentifier::decode_from ( class BER_Decoder &  from )

overridevirtual

Decode whatever this object is from from

Parameters

from	the BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 108 of file alg_id.cpp.

References Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), parameters, Botan::BER_Decoder::raw_bytes(), Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

   {
   codec.start_cons(SEQUENCE)
      .decode(oid)
      .raw_bytes(parameters)
   .end_cons();
   }

void Botan::AlgorithmIdentifier::encode_into ( class DER_Encoder &  to ) const

overridevirtual

Encode whatever this object is into to

Parameters

to	the DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 97 of file alg_id.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_oid(), get_parameters(), Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

   {
   codec.start_cons(SEQUENCE)
      .encode(get_oid())
      .raw_bytes(get_parameters())
   .end_cons();
   }

const OID& Botan::AlgorithmIdentifier::get_oid ( ) const

inline

Definition at line 37 of file alg_id.h.

Referenced by Botan::X509::create_self_signed_cert(), encode_into(), Botan::X509_Object::hash_used_for_signature(), Botan::OCSP::CertID::is_id_for(), Botan::load_private_key(), Botan::load_public_key(), Botan::operator==(), Botan::pbes2_decrypt(), Botan::X509_Certificate::to_string(), Botan::X509_Object::verify_signature(), Botan::OCSP::Response::verify_signature(), and Botan::X509_CA::X509_CA().

{ return oid; }

const std::vector<uint8_t>& Botan::AlgorithmIdentifier::get_parameters ( ) const

inline

Definition at line 38 of file alg_id.h.

Referenced by Botan::EMSA1::config_for_x509(), Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), encode_into(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::operator==(), and Botan::pbes2_decrypt().

{ return parameters; }

Member Data Documentation

BOTAN_DEPRECATED_PUBLIC_MEMBER_VARIABLES Botan::AlgorithmIdentifier::__pad0__

Definition at line 45 of file alg_id.h.

std::vector<uint8_t> Botan::AlgorithmIdentifier::parameters

Definition at line 46 of file alg_id.h.

Referenced by AlgorithmIdentifier(), and decode_from().

---

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

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