Botan 3.14.1
Crypto and TLS for C&
Botan::Extensions Class Referencefinal

#include <pkix_types.h>

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

Public Member Functions

void add (std::unique_ptr< Certificate_Extension > extn, bool critical=false)
bool add_new (std::unique_ptr< Certificate_Extension > extn, bool critical=false)
std::vector< uint8_t > BER_encode () const
size_t count () const
bool critical_extension_set (const OID &oid) const
std::vector< OID > critical_extensions () const
void decode_from (BER_Decoder &from) override
void decode_from (BER_Decoder &from, std::optional< Extension_Context > context)
void encode_into (DER_Encoder &to) const override
bool extension_set (const OID &oid) const
 Extensions ()=default
 Extensions (const Extensions &)=default
 Extensions (Extensions &&)=default
std::vector< std::pair< std::unique_ptr< Certificate_Extension >, bool > > extensions () const
std::map< OID, std::pair< std::vector< uint8_t >, bool > > extensions_raw () const
std::unique_ptr< Certificate_Extension > get (const OID &oid) const
std::vector< uint8_t > get_extension_bits (const OID &oid) const
const Certificate_Extension * get_extension_object (const OID &oid) const
template<typename T>
const T * get_extension_object_as (const OID &oid=T::static_oid()) const
const std::vector< OID > & get_extension_oids () const
template<typename T>
std::unique_ptr< T > get_raw (const OID &oid) const
bool has_unknown_critical_extension () const
Extensions & operator= (const Extensions &)=default
Extensions & operator= (Extensions &&)=default
bool remove (const OID &oid)
void replace (std::unique_ptr< Certificate_Extension > extn, bool critical=false)
void validate (const X509_Certificate &subject, const std::optional< X509_Certificate > &issuer, const std::vector< X509_Certificate > &cert_path, std::vector< std::set< Certificate_Status_Code > > &cert_status, size_t pos) const
 ~Extensions () override=default

Detailed Description

X.509 Certificate Extension List

Definition at line 870 of file pkix_types.h.

Constructor & Destructor Documentation

◆ Extensions() [1/3]

Botan::Extensions::Extensions ( )
default

◆ Extensions() [2/3]

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

References Extensions().

◆ Extensions() [3/3]

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

References Extensions().

◆ ~Extensions()

Botan::Extensions::~Extensions ( )
overridedefault

References BOTAN_UNSTABLE_API.

Member Function Documentation

◆ add()

void Botan::Extensions::add ( std::unique_ptr< 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 180 of file x509_ext.cpp.

180 {
181 // sanity check: we don't want to have the same extension more than once
182 if(m_extension_info.contains(extn->oid_of())) {
183 const std::string name = extn->oid_name();
184 throw Invalid_Argument("Extension " + name + " already present in Extensions::add");
185 }
186
187 const OID oid = extn->oid_of();
188 Extensions_Info info(critical, std::move(extn));
189 m_extension_oids.push_back(oid);
190 m_extension_info.emplace(oid, info);
191}
const char * name
Definition ffi_tls.h:59

References name.

◆ add_new()

bool Botan::Extensions::add_new ( std::unique_ptr< 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 193 of file x509_ext.cpp.

193 {
194 if(m_extension_info.contains(extn->oid_of())) {
195 return false; // already exists
196 }
197
198 const OID oid = extn->oid_of();
199 Extensions_Info info(critical, std::move(extn));
200 m_extension_oids.push_back(oid);
201 m_extension_info.emplace(oid, info);
202 return true;
203}

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

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

21 {
22 std::vector<uint8_t> output;
23 DER_Encoder der(output);
24 this->encode_into(der);
25 return output;
26}
virtual void encode_into(DER_Encoder &to) const =0

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

◆ count()

size_t Botan::Extensions::count ( ) const
inline

Definition at line 1025 of file pkix_types.h.

1025{ return m_extension_oids.size(); }

◆ critical_extension_set()

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

Return true if an extension was set and marked critical

Definition at line 229 of file x509_ext.cpp.

229 {
230 const auto i = m_extension_info.find(oid);
231 if(i != m_extension_info.end()) {
232 return i->second.is_critical();
233 }
234 return false;
235}

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

◆ critical_extensions()

std::vector< OID > Botan::Extensions::critical_extensions ( ) const

Return the set of critical extensions in the order they appeared in the extension list (This may be an empty vector)

Definition at line 118 of file x509_ext.cpp.

118 {
119 std::vector<OID> crit;
120
121 for(const auto& oid : m_extension_oids) {
122 const auto ext_info = m_extension_info.find(oid);
123 BOTAN_ASSERT_NOMSG(ext_info != m_extension_info.end());
124 if(ext_info->second.is_critical()) {
125 crit.push_back(oid);
126 }
127 }
128
129 return crit;
130}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:82

References BOTAN_ASSERT_NOMSG.

Referenced by Botan::OCSP::SingleResponse::decode_from(), and Botan::OCSP::Response::Response().

◆ decode_from() [1/2]

void Botan::Extensions::decode_from ( 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 312 of file x509_ext.cpp.

312 {
313 decode_from(from_source, std::nullopt);
314}
void decode_from(BER_Decoder &from) override
Definition x509_ext.cpp:312

References decode_from().

Referenced by decode_from(), Botan::OCSP::SingleResponse::decode_from(), and Botan::OCSP::Response::Response().

◆ decode_from() [2/2]

void Botan::Extensions::decode_from ( BER_Decoder & from,
std::optional< Extension_Context > context )

Definition at line 316 of file x509_ext.cpp.

316 {
317 m_extension_oids.clear();
318 m_extension_info.clear();
319 m_has_unknown_critical_extension = false;
320
321 BER_Decoder sequence = from_source.start_sequence();
322
323 while(sequence.more_items()) {
324 OID oid;
325 bool critical = false;
326 std::vector<uint8_t> bits;
327
328 sequence.start_sequence()
329 .decode(oid)
330 .decode_optional(critical, ASN1_Type::Boolean, ASN1_Class::Universal, false)
331 .decode(bits, ASN1_Type::OctetString)
332 .end_cons();
333
334 auto obj = create_extn_obj(oid, critical, bits, context);
335 // Unknown_Extension is the only Certificate_Extension with an empty oid_name
336 if(critical && obj->oid_name().empty()) {
337 m_has_unknown_critical_extension = true;
338 }
339 Extensions_Info info(critical, std::move(bits), std::move(obj));
340
341 m_extension_oids.push_back(oid);
342
343 // RFC 5280 4.2: "A certificate MUST NOT include more than one
344 // instance of a particular extension."
345 if(!m_extension_info.emplace(std::move(oid), std::move(info)).second) {
346 throw Decoding_Error("Duplicate certificate extension encountered");
347 }
348 }
349 sequence.verify_end();
350}

References Botan::Boolean, Botan::BER_Decoder::decode(), Botan::BER_Decoder::decode_optional(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::more_items(), Botan::OctetString, Botan::BER_Decoder::start_sequence(), Botan::Universal, and Botan::BER_Decoder::verify_end().

◆ encode_into()

void Botan::Extensions::encode_into ( 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 292 of file x509_ext.cpp.

292 {
293 for(const auto& [oid, extn] : m_extension_info) {
294 const bool should_encode = extn.obj().should_encode();
295
296 if(should_encode) {
297 const auto is_critical = extn.is_critical() ? std::optional<bool>{true} : std::nullopt;
298 const std::vector<uint8_t>& ext_value = extn.bits();
299
300 to_object.start_sequence()
301 .encode(oid)
302 .encode_optional(is_critical)
303 .encode(ext_value, ASN1_Type::OctetString)
304 .end_cons();
305 }
306 }
307}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_optional(), Botan::DER_Encoder::end_cons(), Botan::OctetString, and Botan::DER_Encoder::start_sequence().

◆ extension_set()

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

Return true if an extension was set

Definition at line 225 of file x509_ext.cpp.

225 {
226 return m_extension_info.contains(oid);
227}

Referenced by botan_x509_cert_issuer_alternative_names(), botan_x509_cert_subject_alternative_names(), and Botan::Cert_Extension::NoRevocationAvailable::validate().

◆ 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 262 of file x509_ext.cpp.

262 {
263 std::vector<std::pair<std::unique_ptr<Certificate_Extension>, bool>> exts;
264 exts.reserve(m_extension_info.size());
265 for(auto&& ext : m_extension_info) {
266 exts.push_back(std::make_pair(ext.second.obj().copy(), ext.second.is_critical()));
267 }
268 return exts;
269}

◆ 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 281 of file x509_ext.cpp.

281 {
282 std::map<OID, std::pair<std::vector<uint8_t>, bool>> out;
283 for(auto&& ext : m_extension_info) {
284 out.emplace(ext.first, std::make_pair(ext.second.bits(), ext.second.is_critical()));
285 }
286 return out;
287}

◆ 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 255 of file x509_ext.cpp.

255 {
256 if(const Certificate_Extension* ext = this->get_extension_object(oid)) {
257 return ext->copy();
258 }
259 return nullptr;
260}
const Certificate_Extension * get_extension_object(const OID &oid) const
Definition x509_ext.cpp:246

References get_extension_object().

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

Definition at line 237 of file x509_ext.cpp.

237 {
238 const auto i = m_extension_info.find(oid);
239 if(i == m_extension_info.end()) {
240 throw Invalid_Argument("Extensions::get_extension_bits no such extension set");
241 }
242
243 return i->second.bits();
244}

◆ 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 246 of file x509_ext.cpp.

246 {
247 const auto extn = m_extension_info.find(oid);
248 if(extn == m_extension_info.end()) {
249 return nullptr;
250 }
251
252 return &extn->second.obj();
253}

Referenced by get(), and get_extension_object_as().

◆ 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 882 of file pkix_types.h.

882 {
883 if(const Certificate_Extension* extn = get_extension_object(oid)) {
884 // Unknown_Extension oid_name is empty
885 if(extn->oid_name().empty()) {
886 return nullptr;
887 } else if(const T* extn_as_T = dynamic_cast<const T*>(extn)) {
888 return extn_as_T;
889 } else {
890 throw Decoding_Error("Exception::get_extension_object_as dynamic_cast failed");
891 }
892 }
893
894 return nullptr;
895 }

References get_extension_object().

Referenced by Botan::distribution_point_match(), and Botan::Cert_Extension::NoRevocationAvailable::validate().

◆ 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 901 of file pkix_types.h.

901{ return m_extension_oids; }

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

◆ 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 987 of file pkix_types.h.

987 {
988 const auto extn_info = m_extension_info.find(oid);
989
990 if(extn_info != m_extension_info.end()) {
991 // Unknown_Extension oid_name is empty
992 if(extn_info->second.obj().oid_name().empty()) {
993 auto ext = std::make_unique<T>();
994 ext->decode_inner(extn_info->second.bits());
995 return ext;
996 }
997 }
998 return nullptr;
999 }

◆ has_unknown_critical_extension()

bool Botan::Extensions::has_unknown_critical_extension ( ) const
inline

Return true if an unrecognized critical extension was encountered during the most recent decode_from. Resets on each call to decode_from and is not affected by subsequent calls to add/replace/remove.

Definition at line 934 of file pkix_types.h.

934{ return m_has_unknown_critical_extension; }

◆ operator=() [1/2]

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

References Extensions().

◆ operator=() [2/2]

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

References Extensions().

◆ remove()

bool Botan::Extensions::remove ( const OID & oid)

Remove an extension from the list. Returns true if the extension had been set, false otherwise.

Definition at line 205 of file x509_ext.cpp.

205 {
206 const bool erased = m_extension_info.erase(oid) > 0;
207
208 if(erased) {
209 m_extension_oids.erase(std::find(m_extension_oids.begin(), m_extension_oids.end(), oid));
210 }
211
212 return erased;
213}

Referenced by replace().

◆ replace()

void Botan::Extensions::replace ( std::unique_ptr< 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 215 of file x509_ext.cpp.

215 {
216 // Remove it if it existed
217 remove(extn->oid_of());
218
219 const OID oid = extn->oid_of();
220 Extensions_Info info(critical, std::move(extn));
221 m_extension_oids.push_back(oid);
222 m_extension_info.emplace(oid, info);
223}
bool remove(const OID &oid)
Definition x509_ext.cpp:205

References remove().

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

◆ validate()

void Botan::Extensions::validate ( const X509_Certificate & subject,
const std::optional< X509_Certificate > & issuer,
const std::vector< X509_Certificate > & cert_path,
std::vector< std::set< Certificate_Status_Code > > & cert_status,
size_t pos ) const

Invoke the validation callback for each extension.

Definition at line 271 of file x509_ext.cpp.

275 {
276 for(const auto& ext : m_extension_info) {
277 ext.second.obj().validate(subject, issuer, cert_path, cert_status, pos);
278 }
279}

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


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