Botan::OID Class Reference

#include <asn1_obj.h>

Inheritance diagram for Botan::OID:

Public Member Functions
std::vector< uint8_t >	BER_encode () const
void	decode_from (BER_Decoder &) override
bool	empty () const
void	encode_into (DER_Encoder &) const override
const std::vector< uint32_t > &	get_components () const
const std::vector< uint32_t > &	get_id () const
bool	has_value () const
size_t	hash_code () const
std::string	human_name_or_empty () const
	OID ()=default
	OID (std::initializer_list< uint32_t > init)
	OID (std::string_view str)
	OID (std::vector< uint32_t > &&init)
bool	operator== (const OID &other) const
bool	registered_oid () const
std::string	to_formatted_string () const
std::string	to_string () const

Static Public Member Functions
static std::optional< OID >	from_name (std::string_view name)
static OID	from_string (std::string_view str)
static void	register_oid (const OID &oid, std::string_view name)

Detailed Description

This class represents ASN.1 object identifiers.

Definition at line 216 of file asn1_obj.h.

Constructor & Destructor Documentation

OID() [1/4]

Botan::OID::OID ( )

explicitdefault

Create an uninitialied OID object

Referenced by from_string().

OID() [2/4]

Botan::OID::OID ( std::string_view str )

explicit

Construct an OID from a string.

Parameters

str	a string in the form "a.b.c" etc., where a,b,c are integers

Note: it is currently required that each integer fit into 32 bits

Definition at line 115 of file asn1_oid.cpp.

                               {
   if(!oid_str.empty()) {
      m_id = parse_oid_str(oid_str);
      oid_valid_check(m_id);
   }
}

OID() [3/4]

Botan::OID::OID ( std::initializer_list< uint32_t > init )

explicit

Initialize an OID from a sequence of integer values

Definition at line 104 of file asn1_oid.cpp.

                                           : m_id(init) {
   oid_valid_check(m_id);
}

OID() [4/4]

Botan::OID::OID ( std::vector< uint32_t > && init )

explicit

Initialize an OID from a vector of integer values

Definition at line 108 of file asn1_oid.cpp.

                                   : m_id(std::move(init)) {
   oid_valid_check(m_id);
}

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

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

References Botan::ASN1_Object::encode_into().

Referenced by 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().

decode_from()

void Botan::OID::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 216 of file asn1_oid.cpp.

                                          {
   BER_Object obj = decoder.get_next_object();
   if(obj.tagging() != (ASN1_Class::Universal | ASN1_Type::ObjectId)) {
      throw BER_Bad_Tag("Error decoding OID, unknown tag", obj.tagging());
   }
 
   if(obj.length() == 0) {
      throw BER_Decoding_Error("OID encoding is too short");
   }
 
   auto consume = [](BufferSlicer& data) -> uint32_t {
      BOTAN_ASSERT_NOMSG(!data.empty());
      uint32_t b = data.take_byte();
 
      if(b > 0x7F) {
         b &= 0x7F;
 
         // Even BER requires that the OID have minimal length, ie that
         // the first byte of a multibyte encoding cannot be zero
         // See X.690 section 8.19.2
         if(b == 0) {
            throw Decoding_Error("Leading zero byte in multibyte OID encoding");
         }
 
         while(true) {
            if(data.empty()) {
               throw Decoding_Error("Truncated OID value");
            }
 
            const uint8_t next = data.take_byte();
            const bool more = (next & 0x80);
            const uint8_t value = next & 0x7F;
 
            if((b >> (32 - 7)) != 0) {
               throw Decoding_Error("OID component overflow");
            }
 
            b = (b << 7) | value;
 
            if(!more) {
               break;
            }
         }
      }
 
      return b;
   };
 
   BufferSlicer data(obj.data());
   std::vector<uint32_t> parts;
   while(!data.empty()) {
      const uint32_t comp = consume(data);
 
      if(parts.empty()) {
         // divide into root and second arc
 
         const uint32_t root_arc = [](uint32_t b0) -> uint32_t {
            if(b0 < 40) {
               return 0;
            } else if(b0 < 80) {
               return 1;
            } else {
               return 2;
            }
         }(comp);
 
         parts.push_back(root_arc);
         BOTAN_ASSERT_NOMSG(comp >= 40 * root_arc);
         parts.push_back(comp - 40 * root_arc);
      } else {
         parts.push_back(comp);
      }
   }
 
   m_id = parts;
}

References Botan::b, BOTAN_ASSERT_NOMSG, Botan::BER_Object::data(), Botan::BufferSlicer::empty(), Botan::BER_Decoder::get_next_object(), Botan::BER_Object::length(), Botan::ObjectId, Botan::BER_Object::tagging(), and Botan::Universal.

empty()

bool Botan::OID::empty ( ) const

inline

Find out whether this OID is empty

Returns

true is no OID value is set

Definition at line 266 of file asn1_obj.h.

{ return m_id.empty(); }

References empty().

Referenced by Botan::EC_Group_Data::EC_Group_Data(), empty(), and Botan::EC_Group_Data::set_oid().

encode_into()

void Botan::OID::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 177 of file asn1_oid.cpp.

                                            {
   if(m_id.size() < 2) {
      throw Invalid_Argument("OID::encode_into: OID is invalid");
   }
 
   auto append = [](std::vector<uint8_t>& encoding, uint32_t z) {
      if(z <= 0x7F) {
         encoding.push_back(static_cast<uint8_t>(z));
      } else {
         size_t z7 = (high_bit(z) + 7 - 1) / 7;
 
         for(size_t j = 0; j != z7; ++j) {
            uint8_t zp = static_cast<uint8_t>(z >> (7 * (z7 - j - 1)) & 0x7F);
 
            if(j != z7 - 1) {
               zp |= 0x80;
            }
 
            encoding.push_back(zp);
         }
      }
   };
 
   std::vector<uint8_t> encoding;
 
   // We know 40 * root can't overflow because root is between 0 and 2
   auto first = BOTAN_ASSERT_IS_SOME(checked_add(40 * m_id[0], m_id[1]));
 
   append(encoding, first);
 
   for(size_t i = 2; i != m_id.size(); ++i) {
      append(encoding, m_id[i]);
   }
   der.add_object(ASN1_Type::ObjectId, ASN1_Class::Universal, encoding);
}

References Botan::DER_Encoder::add_object(), BOTAN_ASSERT_IS_SOME, Botan::checked_add(), Botan::high_bit(), Botan::ObjectId, and Botan::Universal.

from_name()

std::optional< OID > Botan::OID::from_name ( std::string_view name )

static

Construct an OID from a name

Parameters

name	any known OID name (for example "RSA" or "X509v3.SubjectKeyIdentifier")

Definition at line 72 of file asn1_oid.cpp.

                                                   {
   if(name.empty()) {
      throw Invalid_Argument("OID::from_name argument must be non-empty");
   }
 
   OID o = OID_Map::global_registry().str2oid(name);
   if(o.has_value()) {
      return std::optional(o);
   }
 
   return std::nullopt;
}

References Botan::OID_Map::global_registry(), has_value(), name, and Botan::OID_Map::str2oid().

Referenced by Botan::EC_Group::from_name().

from_string()

OID Botan::OID::from_string ( std::string_view str )

static

Construct an OID from a string.

Parameters

str	a string in the form "a.b.c" etc., where a,b,c are numbers or any known OID name (for example "RSA" or "X509v3.SubjectKeyIdentifier")

Definition at line 86 of file asn1_oid.cpp.

                                       {
   if(str.empty()) {
      throw Invalid_Argument("OID::from_string argument must be non-empty");
   }
 
   OID o = OID_Map::global_registry().str2oid(str);
   if(o.has_value()) {
      return o;
   }
 
   // Try to parse as a dotted decimal
   try {
      return OID(str);
   } catch(...) {}
 
   throw Lookup_Error(fmt("No OID associated with name '{}'", str));
}

References Botan::fmt(), Botan::OID_Map::global_registry(), has_value(), OID(), and Botan::OID_Map::str2oid().

Referenced by Botan::X509_DN::add_attribute(), Botan::X509_Cert_Options::add_ex_constraint(), Botan::TLS::Signature_Scheme::algorithm_identifier(), Botan::XMSS_Signature_Operation::algorithm_identifier(), Botan::X509_Certificate::allowed_extended_usage(), Botan::PKCS10_Request::constraints(), Botan::EC_Group::EC_Group(), Botan::PKCS10_Request::ex_constraints(), Botan::X509_DN::get_attribute(), Botan::X509_DN::get_first_attribute(), Botan::X509_Certificate::has_ex_constraint(), Botan::X509_DN::has_field(), Botan::PKCS10_Request::is_CA(), Botan::X509_Certificate::is_critical(), Botan::Asymmetric_Key::object_identifier(), Botan::Classic_McEliece_Parameters::object_identifier(), Botan::DilithiumMode::object_identifier(), Botan::FrodoKEMMode::object_identifier(), Botan::HSS_LMS_PublicKeyInternal::object_identifier(), Botan::KyberMode::object_identifier(), Botan::PKCS10_Request::path_limit(), and Botan::HSS_LMS_PrivateKey::pkcs8_algorithm_identifier().

get_components()

const std::vector< uint32_t > & Botan::OID::get_components ( ) const

inline

Get this OID as list (vector) of its components.

Returns

vector representing this OID

Definition at line 317 of file asn1_obj.h.

                                                        {
         return m_id;
      }

Referenced by Botan::operator<().

get_id()

const std::vector< uint32_t > & Botan::OID::get_id ( ) const

inline

Definition at line 322 of file asn1_obj.h.

                                                {
         return m_id;
      }

has_value()

bool Botan::OID::has_value ( ) const

inline

Find out whether this OID has a value

Returns

true is this OID has a value

Definition at line 272 of file asn1_obj.h.

{ return !empty(); }

Referenced by Botan::X509::create_self_signed_cert(), Botan::EC_Group::EC_Group(), Botan::EC_Group::EC_Group(), from_name(), from_string(), and Botan::X509_DN::has_field().

hash_code()

size_t Botan::OID::hash_code

(

)

const

Return a hash code for this OID

This value is only meant as a std::unsorted_map hash and can change value from release to release.

Definition at line 155 of file asn1_oid.cpp.

                            {
   constexpr uint64_t mod = 0xffffffffffffffc5;
   uint64_t hash = 0;
   for(auto id : m_id) {
      hash = (hash * 257 + id) % mod;
   }
   return static_cast<size_t>(hash);
}

human_name_or_empty()

std::string Botan::OID::human_name_or_empty

(

)

const

If there is a known name associated with this OID, return that. Otherwise return the empty string.

Definition at line 147 of file asn1_oid.cpp.

                                         {
   return OID_Map::global_registry().oid2str(*this);
}

References Botan::OID_Map::global_registry(), and Botan::OID_Map::oid2str().

Referenced by Botan::OIDS::oid2str_or_throw(), Botan::pbes2_decrypt(), registered_oid(), and to_formatted_string().

operator==()

bool Botan::OID::operator== ( const OID & other ) const

inline

Compare two OIDs.

Returns

true if they are equal, false otherwise

Definition at line 302 of file asn1_obj.h.

{ return m_id == other.m_id; }

register_oid()

void Botan::OID::register_oid ( const OID & oid, std::string_view name )

static

Register a new OID in the internal table

Definition at line 67 of file asn1_oid.cpp.

                                                          {
   OID_Map::global_registry().add_oid(oid, name);
}

References Botan::OID_Map::add_oid(), Botan::OID_Map::global_registry(), and name.

registered_oid()

bool Botan::OID::registered_oid

(

)

const

Return true if the OID in *this is registered in the internal set of constants as a known OID.

Definition at line 151 of file asn1_oid.cpp.

                               {
   return !human_name_or_empty().empty();
}

References human_name_or_empty().

Referenced by Botan::PKIX::check_chain().

to_formatted_string()

std::string Botan::OID::to_formatted_string

(

)

const

If there is a known name associated with this OID, return that. Otherwise return the result of to_string

Definition at line 139 of file asn1_oid.cpp.

                                         {
   std::string s = this->human_name_or_empty();
   if(!s.empty()) {
      return s;
   }
   return this->to_string();
}

References human_name_or_empty(), and to_string().

Referenced by Botan::Dilithium_PublicKey::algo_name(), Botan::Sphincs_Parameters::create(), Botan::Classic_McEliece_Parameter_Set::from_oid(), Botan::TPM2::get_tpm2_curve_id(), Botan::OCSP::CertID::is_id_for(), Botan::load_private_key(), Botan::load_public_key(), Botan::X942_PRF::name(), Botan::X509_Certificate::to_string(), and Botan::PK_Ops::Verification_with_Hash::Verification_with_Hash().

to_string()

std::string Botan::OID::to_string

(

)

const

Get this OID as a dotted-decimal string

Returns

string representing this OID

Definition at line 125 of file asn1_oid.cpp.

                               {
   std::ostringstream out;
 
   for(size_t i = 0; i != m_id.size(); ++i) {
      // avoid locale issues with integer formatting
      out << std::to_string(m_id[i]);
      if(i != m_id.size() - 1) {
         out << ".";
      }
   }
 
   return out.str();
}

Referenced by Botan::EC_Group::from_OID(), Botan::operator<<(), and to_formatted_string().

---

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

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