Botan::OID Class Reference

#include <asn1_oid.h>

Inheritance diagram for Botan::OID:

List of all members.

Public Member Functions
std::string	as_string () const
void	clear ()
void	decode_from (class BER_Decoder &)
void	encode_into (class DER_Encoder &) const
std::vector< u32bit >	get_id () const
bool	is_empty () const
	OID (const std::string &str="")
OID &	operator+= (u32bit new_comp)
bool	operator== (const OID &) const

---

Detailed Description

This class represents ASN.1 object identifiers.

Definition at line 20 of file asn1_oid.h.

---

Constructor & Destructor Documentation

Botan::OID::OID

(

const std::string &

str = ""

)

Construct an OID from a string.

Parameters:

str

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

Definition at line 19 of file asn1_oid.cpp.

References Botan::parse_asn1_oid().

   {
   if(oid_str != "")
      {
      try
         {
         id = parse_asn1_oid(oid_str);
         }
      catch(...)
         {
         throw Invalid_OID(oid_str);
         }

      if(id.size() < 2 || id[0] > 2)
         throw Invalid_OID(oid_str);
      if((id[0] == 0 || id[0] == 1) && id[1] > 39)
         throw Invalid_OID(oid_str);
      }
   }

---

Member Function Documentation

std::string Botan::OID::as_string

(

)

const

Get this OID as a string

Returns:

string representing this OID

Definition at line 50 of file asn1_oid.cpp.

References Botan::to_string().

Referenced by Botan::OIDS::add_oid(), Botan::Extensions::decode_from(), Botan::EC_Domain_Params::EC_Domain_Params(), Botan::get_pbe(), Botan::PKCS8::load_key(), Botan::OIDS::lookup(), Botan::make_private_key(), Botan::make_public_key(), and Botan::X942_PRF::X942_PRF().

   {
   std::string oid_str;
   for(u32bit j = 0; j != id.size(); ++j)
      {
      oid_str += to_string(id[j]);
      if(j != id.size() - 1)
         oid_str += '.';
      }
   return oid_str;
   }

void Botan::OID::clear

(

)

Reset this instance to an empty OID.

Definition at line 42 of file asn1_oid.cpp.

Referenced by decode_from().

   {
   id.clear();
   }

void Botan::OID::decode_from

(

class BER_Decoder &

from

)

[virtual]

Decode whatever this object is from from

Parameters:

from

the BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 155 of file asn1_oid.cpp.

References Botan::BER_Object::class_tag, clear(), Botan::BER_Decoder::get_next_object(), Botan::OBJECT_ID, Botan::MemoryRegion< T >::size(), Botan::BER_Object::type_tag, Botan::UNIVERSAL, and Botan::BER_Object::value.

   {
   BER_Object obj = decoder.get_next_object();
   if(obj.type_tag != OBJECT_ID || obj.class_tag != UNIVERSAL)
      throw BER_Bad_Tag("Error decoding OID, unknown tag",
                        obj.type_tag, obj.class_tag);
   if(obj.value.size() < 2)
      throw BER_Decoding_Error("OID encoding is too short");


   clear();
   id.push_back(obj.value[0] / 40);
   id.push_back(obj.value[0] % 40);

   u32bit j = 0;
   while(j != obj.value.size() - 1)
      {
      u32bit component = 0;
      while(j != obj.value.size() - 1)
         {
         ++j;
         component = (component << 7) + (obj.value[j] & 0x7F);
         if(!(obj.value[j] & 0x80))
            break;
         }
      id.push_back(component);
      }
   }

void Botan::OID::encode_into

(

class DER_Encoder &

to

)

const [virtual]

Encode whatever this object is into to

Parameters:

to

the DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 127 of file asn1_oid.cpp.

References Botan::DER_Encoder::add_object(), Botan::MemoryRegion< T >::append(), Botan::high_bit(), Botan::OBJECT_ID, and Botan::UNIVERSAL.

   {
   if(id.size() < 2)
      throw Invalid_Argument("OID::encode_into: OID is invalid");

   MemoryVector<byte> encoding;
   encoding.append(40 * id[0] + id[1]);

   for(u32bit j = 2; j != id.size(); ++j)
      {
      if(id[j] == 0)
         encoding.append(0);
      else
         {
         u32bit blocks = high_bit(id[j]) + 6;
         blocks = (blocks - (blocks % 7)) / 7;

         for(u32bit k = 0; k != blocks - 1; ++k)
            encoding.append(0x80 | ((id[j] >> 7*(blocks-k-1)) & 0x7F));
         encoding.append(id[j] & 0x7F);
         }
      }
   der.add_object(OBJECT_ID, UNIVERSAL, encoding);
   }

std::vector<u32bit> Botan::OID::get_id

(

)

const [inline]

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

Returns:

vector representing this OID

Definition at line 36 of file asn1_oid.h.

Referenced by Botan::operator<().

{ return id; }

bool Botan::OID::is_empty

(

)

const [inline]

Find out whether this OID is empty

Returns:

true is no OID value is set

Definition at line 30 of file asn1_oid.h.

{ return id.size() == 0; }

OID & Botan::OID::operator+=

(

u32bit

new_comp

)

Add a component to this OID.

Parameters:

new_comp

the new component to add to the end of this OID

Returns:

reference to *this

Definition at line 78 of file asn1_oid.cpp.

   {
   id.push_back(component);
   return (*this);
   }

bool Botan::OID::operator==

(

const OID &

oid

)

const

Compare two OIDs.

Returns:

true if they are equal, false otherwise

Definition at line 65 of file asn1_oid.cpp.

References id.

   {
   if(id.size() != oid.id.size())
      return false;
   for(u32bit j = 0; j != id.size(); ++j)
      if(id[j] != oid.id[j])
         return false;
   return true;
   }

---

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

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