Botan::AlgorithmIdentifier Class Reference

#include <asn1_obj.h>

Inheritance diagram for Botan::AlgorithmIdentifier:

Public Types
enum	Encoding_Option : uint8_t { USE_NULL_PARAM , USE_EMPTY_PARAM }

Public Member Functions
	AlgorithmIdentifier ()=default
	AlgorithmIdentifier (const OID &oid, const std::vector< uint8_t > &params)
	AlgorithmIdentifier (const OID &oid, Encoding_Option enc)
	AlgorithmIdentifier (std::string_view oid_name, const std::vector< uint8_t > &params)
	AlgorithmIdentifier (std::string_view oid_name, Encoding_Option enc)
std::vector< uint8_t >	BER_encode () const
void	decode_from (BER_Decoder &from) override
bool	empty () const
void	encode_into (DER_Encoder &to) const override
const OID &	get_oid () const
const std::vector< uint8_t > &	get_parameters () const
const OID &	oid () const
const std::vector< uint8_t > &	parameters () const
bool	parameters_are_empty () const
bool	parameters_are_null () const
bool	parameters_are_null_or_empty () const

Detailed Description

Algorithm Identifier

Definition at line 642 of file asn1_obj.h.

Member Enumeration Documentation

Encoding_Option

enum Botan::AlgorithmIdentifier::Encoding_Option : uint8_t

Selects how an absent parameters field is encoded

Enumerator
USE_NULL_PARAM
USE_EMPTY_PARAM

Definition at line 647 of file asn1_obj.h.

: uint8_t { USE_NULL_PARAM, USE_EMPTY_PARAM }; /* NOLINT(*-use-enum-class) */

Constructor & Destructor Documentation

AlgorithmIdentifier() [1/5]

Botan::AlgorithmIdentifier::AlgorithmIdentifier ( )

default

Create an empty AlgorithmIdentifier

References AlgorithmIdentifier(), and oid().

Referenced by AlgorithmIdentifier(), and AlgorithmIdentifier().

AlgorithmIdentifier() [2/5]

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

Create an AlgorithmIdentifier with no parameters

Parameters

oid	the algorithm OID
enc	whether the empty parameters are encoded as NULL or omitted

Definition at line 31 of file alg_id.cpp.

                                                                               : m_oid(oid) {
   constexpr uint8_t DER_NULL[] = {0x05, 0x00};
 
   if(option == USE_NULL_PARAM) {
      m_parameters.assign(DER_NULL, DER_NULL + 2);
   }
}

References oid(), and USE_NULL_PARAM.

AlgorithmIdentifier() [3/5]

Botan::AlgorithmIdentifier::AlgorithmIdentifier	(	std::string_view	oid_name,
		Encoding_Option	enc )

Create an AlgorithmIdentifier with no parameters

Parameters

oid_name	a name or dotted decimal string identifying the algorithm
enc	whether the empty parameters are encoded as NULL or omitted

Definition at line 42 of file alg_id.cpp.

                                                                                   : m_oid(OID::from_string(oid)) {
   constexpr uint8_t DER_NULL[2] = {0x05, 0x00};
 
   if(option == USE_NULL_PARAM) {
      m_parameters.assign(DER_NULL, DER_NULL + 2);
   }
}

References oid(), and USE_NULL_PARAM.

AlgorithmIdentifier() [4/5]

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

Create an AlgorithmIdentifier

Parameters

oid	the algorithm OID
params	the DER encoded parameters

Definition at line 19 of file alg_id.cpp.

                                                                                        :
      m_oid(oid), m_parameters(param) {}

References oid().

AlgorithmIdentifier() [5/5]

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

Create an AlgorithmIdentifier

Parameters

oid_name	a name or dotted decimal string identifying the algorithm
params	the DER encoded parameters

Definition at line 25 of file alg_id.cpp.

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

References AlgorithmIdentifier(), and oid().

Member Function Documentation

BER_encode()

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 21 of file asn1_obj.cpp.

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

References encode_into().

Referenced by decode_from(), Botan::PKCS12::export_to(), 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::PSS_Params::PSS_Params().

decode_from()

void Botan::AlgorithmIdentifier::decode_from ( 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 72 of file alg_id.cpp.

                                                        {
   codec.start_sequence().decode(m_oid).raw_bytes(m_parameters).end_cons();
 
   /*
   * The parameters field is OPTIONAL ANY but in practice it is one of
   * - empty
   * - NULL
   * - SEQUENCE
   * - OBJECT IDENTIFIER (namedCurve)
   * - OCTET STRING (CBC IV in PBES2)
   *
   * So require it be exactly one of these values. In particular this ensures that
   * there is not any additional trailing data (eg after the SEQUENCE encoding)
   * that might be otherwise skipped over by a reader.
   */
 
   const bool acceptable_parameters = [&]() {
      if(this->parameters_are_null_or_empty()) {
         return true;
      }
      if(ASN1::is_der_sequence_header(m_parameters)) {
         return true;
      }
      if(ASN1::is_single_der_object(m_parameters, ASN1_Type::ObjectId, ASN1_Class::Universal)) {
         return true;
      }
      if(ASN1::is_single_der_object(m_parameters, ASN1_Type::OctetString, ASN1_Class::Universal)) {
         return true;
      }
      return false;
   }();
 
   if(!acceptable_parameters) {
      throw Decoding_Error("AlgorithmIdentifier parameters were not NULL, a SEQUENCE, an OID, or an OCTET STRING");
   }
}

References Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::ASN1::is_der_sequence_header(), Botan::ASN1::is_single_der_object(), Botan::ObjectId, Botan::OctetString, parameters_are_null_or_empty(), Botan::BER_Decoder::raw_bytes(), Botan::BER_Decoder::start_sequence(), and Botan::Universal.

empty()

bool Botan::AlgorithmIdentifier::empty ( ) const

inline

Return true if neither the OID nor the parameters have been set

Definition at line 725 of file asn1_obj.h.

{ return m_oid.empty() && m_parameters.empty(); }

encode_into()

void Botan::AlgorithmIdentifier::encode_into ( 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 65 of file alg_id.cpp.

                                                              {
   codec.start_sequence().encode(oid()).raw_bytes(parameters()).end_cons();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), oid(), parameters(), Botan::DER_Encoder::raw_bytes(), and Botan::DER_Encoder::start_sequence().

get_oid()

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

inline

Return the algorithm OID

Definition at line 698 of file asn1_obj.h.

{ return m_oid; }

References get_oid().

Referenced by get_oid().

get_parameters()

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

inline

Return the DER encoded parameters, which may be empty

Definition at line 703 of file asn1_obj.h.

                                                                                                             {
         return m_parameters;
      }

References get_parameters().

Referenced by get_parameters().

oid()

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

inline

Return the algorithm OID

Definition at line 688 of file asn1_obj.h.

{ return m_oid; }

Referenced by AlgorithmIdentifier(), AlgorithmIdentifier(), AlgorithmIdentifier(), AlgorithmIdentifier(), AlgorithmIdentifier(), Botan::EC_PublicKey::assert_algorithm_identifier(), Botan::PKIX::check_chain(), Botan::X509::create_self_signed_cert(), Botan::SphincsPlus_PublicKey::create_x509_verification_op(), encode_into(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::load_private_key(), Botan::load_public_key(), Botan::operator==(), Botan::pbes2_decrypt(), Botan::PKCS12::PKCS12(), Botan::pkcs12_pbe_decrypt(), Botan::RSA_PrivateKey::RSA_PrivateKey(), Botan::RSA_PublicKey::RSA_PublicKey(), Botan::X509_Certificate::to_string(), and Botan::PK_Ops::Verification_with_Hash::Verification_with_Hash().

parameters()

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

inline

Return the DER encoded parameters, which may be empty

Definition at line 693 of file asn1_obj.h.

{ return m_parameters; }

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), encode_into(), Botan::operator==(), Botan::pbes2_decrypt(), and Botan::pkcs12_pbe_decrypt().

parameters_are_empty()

bool Botan::AlgorithmIdentifier::parameters_are_empty ( ) const

inline

Return true if the parameters field is absent

Definition at line 715 of file asn1_obj.h.

{ return m_parameters.empty(); }

Referenced by Botan::Classic_McEliece_PrivateKey::Classic_McEliece_PrivateKey(), Botan::Classic_McEliece_PublicKey::Classic_McEliece_PublicKey(), Botan::SphincsPlus_PublicKey::create_x509_verification_op(), Botan::Dilithium_PrivateKey::Dilithium_PrivateKey(), Botan::Dilithium_PublicKey::Dilithium_PublicKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::Ed25519_PrivateKey::Ed25519_PrivateKey(), Botan::Ed25519_PublicKey::Ed25519_PublicKey(), Botan::Ed448_PrivateKey::Ed448_PrivateKey(), Botan::Ed448_PublicKey::Ed448_PublicKey(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey(), Botan::HSS_LMS_PrivateKey::HSS_LMS_PrivateKey(), Botan::HSS_LMS_PublicKey::HSS_LMS_PublicKey(), Botan::Kyber_PrivateKey::Kyber_PrivateKey(), Botan::Kyber_PublicKey::Kyber_PublicKey(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), Botan::McEliece_PublicKey::McEliece_PublicKey(), parameters_are_null_or_empty(), Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey(), Botan::SphincsPlus_PublicKey::SphincsPlus_PublicKey(), Botan::PK_Ops::Verification_with_Hash::Verification_with_Hash(), Botan::X25519_PrivateKey::X25519_PrivateKey(), Botan::X25519_PublicKey::X25519_PublicKey(), Botan::X448_PrivateKey::X448_PrivateKey(), Botan::X448_PublicKey::X448_PublicKey(), and Botan::XMSS_PublicKey::XMSS_PublicKey().

parameters_are_null()

bool Botan::AlgorithmIdentifier::parameters_are_null

(

)

const

Return true if the parameters consist of a single DER encoded NULL

Definition at line 50 of file alg_id.cpp.

                                                    {
   return (m_parameters.size() == 2 && (m_parameters[0] == 0x05) && (m_parameters[1] == 0x00));
}

Referenced by parameters_are_null_or_empty(), and Botan::PK_Ops::Verification_with_Hash::Verification_with_Hash().

parameters_are_null_or_empty()

bool Botan::AlgorithmIdentifier::parameters_are_null_or_empty ( ) const

inline

Return true if the parameters field is absent or a single DER encoded NULL

Definition at line 720 of file asn1_obj.h.

{ return parameters_are_empty() || parameters_are_null(); }

References parameters_are_empty(), and parameters_are_null().

Referenced by decode_from(), Botan::RSA_PrivateKey::RSA_PrivateKey(), and Botan::RSA_PublicKey::RSA_PublicKey().

---

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

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