Botan  2.7.0
Crypto and TLS for C++11
Classes | Public Member Functions | List of all members
Botan::Extensions Class Referencefinal

#include <x509_ext.h>

Inheritance diagram for Botan::Extensions:
Botan::ASN1_Object

Public Member Functions

void add (Certificate_Extension *extn, bool critical=false)
 
bool add_new (Certificate_Extension *extn, bool critical=false)
 
std::vector< uint8_t > BER_encode () const
 
void contents_to (Data_Store &, Data_Store &) const
 
bool critical_extension_set (const OID &oid) const
 
void decode_from (class BER_Decoder &) override
 
void encode_into (class DER_Encoder &) const override
 
bool extension_set (const OID &oid) const
 
std::vector< std::pair< std::unique_ptr< Certificate_Extension >, bool > > extensions () const
 
 Extensions ()
 
 Extensions (const Extensions &)=default
 
 Extensions (Extensions &&)=default
 
std::map< OID, std::pair< std::vector< uint8_t >, bool > > extensions_raw () const
 
std::unique_ptr< Certificate_Extensionget (const OID &oid) const
 
std::vector< uint8_t > get_extension_bits (const OID &oid) const
 
const Certificate_Extensionget_extension_object (const OID &oid) const
 
template<typename T >
const Tget_extension_object_as (const OID &oid=T::static_oid()) const
 
const std::vector< OID > & get_extension_oids () const
 
template<typename T >
std::unique_ptr< Tget_raw (const OID &oid) const
 
Extensionsoperator= (const Extensions &)=default
 
Extensionsoperator= (Extensions &&)=default
 
void replace (Certificate_Extension *extn, bool critical=false)
 

Detailed Description

X.509 Certificate Extension List

Definition at line 90 of file x509_ext.h.

Constructor & Destructor Documentation

◆ Extensions() [1/3]

Botan::Extensions::Extensions ( )
inline

Definition at line 226 of file x509_ext.h.

226 {}

◆ Extensions() [2/3]

Botan::Extensions::Extensions ( const Extensions )
default

◆ Extensions() [3/3]

Botan::Extensions::Extensions ( Extensions &&  )
default

Member Function Documentation

◆ add()

void Botan::Extensions::add ( Certificate_Extension extn,
bool  critical = false 
)

Adds a new extension to the list.

Parameters
extnpointer to the certificate extension (Extensions takes ownership)
criticalwhether this extension should be marked as critical
Exceptions
Invalid_Argumentif the extension is already present in the list

Definition at line 122 of file x509_ext.cpp.

References Botan::Certificate_Extension::oid_name(), and Botan::Certificate_Extension::oid_of().

123  {
124  // sanity check: we don't want to have the same extension more than once
125  if(m_extension_info.count(extn->oid_of()) > 0)
126  throw Invalid_Argument(extn->oid_name() + " extension already present in Extensions::add");
127 
128  const OID oid = extn->oid_of();
129  Extensions_Info info(critical, extn);
130  m_extension_oids.push_back(oid);
131  m_extension_info.emplace(oid, info);
132  }

◆ add_new()

bool Botan::Extensions::add_new ( Certificate_Extension extn,
bool  critical = false 
)

Adds a new extension to the list unless it already exists. If the extension already exists within the Extensions object, the extn pointer will be deleted.

Parameters
extnpointer to the certificate extension (Extensions takes ownership)
criticalwhether this extension should be marked as critical
Returns
true if the object was added false if the extension was already used

Definition at line 134 of file x509_ext.cpp.

References Botan::Certificate_Extension::oid_of().

Referenced by Botan::X509::create_cert_req(), and Botan::X509::create_self_signed_cert().

135  {
136  if(m_extension_info.count(extn->oid_of()) > 0)
137  {
138  delete extn;
139  return false; // already exists
140  }
141 
142  const OID oid = extn->oid_of();
143  Extensions_Info info(critical, extn);
144  m_extension_oids.push_back(oid);
145  m_extension_info.emplace(oid, info);
146  return true;
147  }

◆ 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 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().

17  {
18  std::vector<uint8_t> output;
19  DER_Encoder der(output);
20  this->encode_into(der);
21  return output;
22  }
virtual void encode_into(DER_Encoder &to) const =0

◆ contents_to()

void Botan::Extensions::contents_to ( Data_Store subject_info,
Data_Store issuer_info 
) const

Definition at line 275 of file x509_ext.cpp.

References Botan::Data_Store::add().

277  {
278  for(auto&& m_extn_info : m_extension_info)
279  {
280  m_extn_info.second.obj().contents_to(subject_info, issuer_info);
281  subject_info.add(m_extn_info.second.obj().oid_name() + ".is_critical",
282  m_extn_info.second.is_critical());
283  }
284  }

◆ critical_extension_set()

bool Botan::Extensions::critical_extension_set ( const OID oid) const

Return true if an extesion was set and marked critical

Definition at line 165 of file x509_ext.cpp.

Referenced by Botan::X509_Certificate::is_critical().

166  {
167  auto i = m_extension_info.find(oid);
168  if(i != m_extension_info.end())
169  return i->second.is_critical();
170  return false;
171  }

◆ decode_from()

void Botan::Extensions::decode_from ( class BER_Decoder from)
overridevirtual

Decode whatever this object is from from

Parameters
fromthe BER_Decoder that will be read from

Implements Botan::ASN1_Object.

Definition at line 244 of file x509_ext.cpp.

References Botan::BOOLEAN, Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_optional(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::more_items(), Botan::OCTET_STRING, Botan::SEQUENCE, Botan::BER_Decoder::start_cons(), Botan::UNIVERSAL, and Botan::BER_Decoder::verify_end().

245  {
246  m_extension_oids.clear();
247  m_extension_info.clear();
248 
249  BER_Decoder sequence = from_source.start_cons(SEQUENCE);
250 
251  while(sequence.more_items())
252  {
253  OID oid;
254  bool critical;
255  std::vector<uint8_t> bits;
256 
257  sequence.start_cons(SEQUENCE)
258  .decode(oid)
259  .decode_optional(critical, BOOLEAN, UNIVERSAL, false)
260  .decode(bits, OCTET_STRING)
261  .end_cons();
262 
263  std::unique_ptr<Certificate_Extension> obj = create_extn_obj(oid, critical, bits);
264  Extensions_Info info(critical, bits, obj.release());
265 
266  m_extension_oids.push_back(oid);
267  m_extension_info.emplace(oid, info);
268  }
269  sequence.verify_end();
270  }

◆ encode_into()

void Botan::Extensions::encode_into ( class DER_Encoder to) const
overridevirtual

Encode whatever this object is into to

Parameters
tothe DER_Encoder that will be written to

Implements Botan::ASN1_Object.

Definition at line 220 of file x509_ext.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_optional(), Botan::DER_Encoder::end_cons(), Botan::OCTET_STRING, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

221  {
222  for(auto ext_info : m_extension_info)
223  {
224  const OID& oid = ext_info.first;
225  const bool should_encode = ext_info.second.obj().should_encode();
226 
227  if(should_encode)
228  {
229  const bool is_critical = ext_info.second.is_critical();
230  const std::vector<uint8_t>& ext_value = ext_info.second.bits();
231 
232  to_object.start_cons(SEQUENCE)
233  .encode(oid)
234  .encode_optional(is_critical, false)
235  .encode(ext_value, OCTET_STRING)
236  .end_cons();
237  }
238  }
239  }

◆ extension_set()

bool Botan::Extensions::extension_set ( const OID oid) const

Return true if an extension was set

Definition at line 160 of file x509_ext.cpp.

161  {
162  return (m_extension_info.find(oid) != m_extension_info.end());
163  }

◆ extensions()

std::vector< std::pair< std::unique_ptr< Certificate_Extension >, bool > > Botan::Extensions::extensions ( ) const

Returns a copy of the list of extensions together with the corresponding criticality flag. All extensions are encoded as some object, falling back to Unknown_Extension class which simply allows reading the bytes as well as the criticality flag.

Definition at line 191 of file x509_ext.cpp.

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

192  {
193  std::vector<std::pair<std::unique_ptr<Certificate_Extension>, bool>> exts;
194  for(auto&& ext : m_extension_info)
195  {
196  exts.push_back(
197  std::make_pair(
198  std::unique_ptr<Certificate_Extension>(ext.second.obj().copy()),
199  ext.second.is_critical())
200  );
201  }
202  return exts;
203  }

◆ extensions_raw()

std::map< OID, std::pair< std::vector< uint8_t >, bool > > Botan::Extensions::extensions_raw ( ) const

Returns the list of extensions as raw, encoded bytes together with the corresponding criticality flag. Contains all extensions, including any extensions encoded as Unknown_Extension

Definition at line 205 of file x509_ext.cpp.

206  {
207  std::map<OID, std::pair<std::vector<uint8_t>, bool>> out;
208  for(auto&& ext : m_extension_info)
209  {
210  out.emplace(ext.first,
211  std::make_pair(ext.second.bits(),
212  ext.second.is_critical()));
213  }
214  return out;
215  }

◆ get()

std::unique_ptr< Certificate_Extension > Botan::Extensions::get ( const OID oid) const

Searches for an extension by OID and returns the result. Only the known extensions types declared in this header are searched for by this function.

Returns
Copy of extension with oid, nullptr if not found. Can avoid creating a copy by using get_extension_object function

Definition at line 182 of file x509_ext.cpp.

References get_extension_object().

183  {
184  if(const Certificate_Extension* ext = this->get_extension_object(oid))
185  {
186  return std::unique_ptr<Certificate_Extension>(ext->copy());
187  }
188  return nullptr;
189  }
const Certificate_Extension * get_extension_object(const OID &oid) const
Definition: x509_ext.cpp:173

◆ get_extension_bits()

std::vector<uint8_t> Botan::Extensions::get_extension_bits ( const OID oid) const

Return the raw bytes of the extension Will throw if OID was not set as an extension.

◆ get_extension_object()

const Certificate_Extension * Botan::Extensions::get_extension_object ( const OID oid) const

Look up an object in the extensions, based on OID Returns nullptr if not set, if the extension was either absent or not handled. The pointer returned is owned by the Extensions object. This would be better with an optional<T> return value

Definition at line 173 of file x509_ext.cpp.

Referenced by get().

174  {
175  auto extn = m_extension_info.find(oid);
176  if(extn == m_extension_info.end())
177  return nullptr;
178 
179  return &extn->second.obj();
180  }

◆ get_extension_object_as()

template<typename T >
const T* Botan::Extensions::get_extension_object_as ( const OID oid = T::static_oid()) const
inline

Definition at line 103 of file x509_ext.h.

References T.

104  {
105  if(const Certificate_Extension* extn = get_extension_object(oid))
106  {
107  if(const T* extn_as_T = dynamic_cast<const T*>(extn))
108  {
109  return extn_as_T;
110  }
111  else
112  {
113  throw Exception("Exception::get_extension_object_as dynamic_cast failed");
114  }
115  }
116 
117  return nullptr;
118  }
fe T
Definition: ge.cpp:37
const Certificate_Extension * get_extension_object(const OID &oid) const
Definition: x509_ext.cpp:173

◆ get_extension_oids()

const std::vector<OID>& Botan::Extensions::get_extension_oids ( ) const
inline

Return the set of extensions in the order they appeared in the certificate (or as they were added, if constructed)

Definition at line 124 of file x509_ext.h.

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

125  {
126  return m_extension_oids;
127  }

◆ get_raw()

template<typename T >
std::unique_ptr<T> Botan::Extensions::get_raw ( const OID oid) const
inline

Searches for an extension by OID and returns the result decoding it to some arbitrary extension type chosen by the application.

Only the unknown extensions, that is, extensions types that are not declared in this header, are searched for by this function.

Returns
Pointer to new extension with oid, nullptr if not found.

Definition at line 194 of file x509_ext.h.

References T.

195  {
196  auto extn_info = m_extension_info.find(oid);
197 
198  if(extn_info != m_extension_info.end())
199  {
200  // Unknown_Extension oid_name is empty
201  if(extn_info->second.obj().oid_name() == "")
202  {
203  std::unique_ptr<T> ext(new T);
204  ext->decode_inner(extn_info->second.bits());
205  return std::move(ext);
206  }
207  }
208  return nullptr;
209  }
fe T
Definition: ge.cpp:37

◆ operator=() [1/2]

Extensions& Botan::Extensions::operator= ( const Extensions )
default

◆ operator=() [2/2]

Extensions& Botan::Extensions::operator= ( Extensions &&  )
default

◆ replace()

void Botan::Extensions::replace ( Certificate_Extension extn,
bool  critical = false 
)

Adds an extension to the list or replaces it.

Parameters
extnthe certificate extension
criticalwhether this extension should be marked as critical

Definition at line 149 of file x509_ext.cpp.

References Botan::Certificate_Extension::oid_of().

150  {
151  // Remove it if it existed
152  m_extension_info.erase(extn->oid_of());
153 
154  const OID oid = extn->oid_of();
155  Extensions_Info info(critical, extn);
156  m_extension_oids.push_back(oid);
157  m_extension_info.emplace(oid, info);
158  }

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