Botan 3.7.1
Crypto and TLS for C&
Botan::X509_Certificate Class Reference

#include <x509cert.h>

Inheritance diagram for Botan::X509_Certificate:
Botan::X509_Object Botan::ASN1_Object

Public Member Functions

bool allowed_extended_usage (const OID &usage) const
 
bool allowed_extended_usage (std::string_view usage) const
 
bool allowed_usage (Key_Constraints usage) const
 
bool allowed_usage (Usage_Type usage) const
 
const std::vector< uint8_t > & authority_key_id () const
 
std::vector< uint8_t > BER_encode () const
 
std::vector< std::string > ca_issuers () const
 
const std::vector< OID > & certificate_policy_oids () const
 
bool check_signature (const Public_Key &key) const
 
Key_Constraints constraints () const
 
std::string crl_distribution_point () const
 
std::vector< std::string > crl_distribution_points () const
 
void decode_from (BER_Decoder &from) override
 
void encode_into (DER_Encoder &to) const override
 
const std::vector< OID > & extended_key_usage () const
 
std::string fingerprint (std::string_view hash_name="SHA-1") const
 
bool has_constraints (Key_Constraints constraints) const
 
bool has_ex_constraint (const OID &ex_constraint) const
 
bool has_ex_constraint (std::string_view ex_constraint) const
 
bool is_CA_cert () const
 
bool is_critical (std::string_view ex_name) const
 
bool is_self_signed () const
 
bool is_serial_negative () const
 
const AlternativeNameissuer_alt_name () const
 
const X509_DNissuer_dn () const
 
std::vector< std::string > issuer_info (std::string_view name) const
 
std::unique_ptr< Public_Keyload_subject_public_key () const
 
bool matches_dns_name (std::string_view name) const
 
const NameConstraintsname_constraints () const
 
const X509_Timenot_after () const
 
const X509_Timenot_before () const
 
std::string ocsp_responder () const
 
bool operator< (const X509_Certificate &other) const
 
X509_Certificateoperator= (const X509_Certificate &other)=default
 
bool operator== (const X509_Certificate &other) const
 
uint32_t path_limit () const
 
std::string PEM_encode () const
 
const std::vector< uint8_t > & raw_issuer_dn () const
 
std::vector< uint8_t > raw_issuer_dn_sha256 () const
 
const std::vector< uint8_t > & raw_subject_dn () const
 
std::vector< uint8_t > raw_subject_dn_sha256 () const
 
const std::vector< uint8_t > & serial_number () const
 
const std::vector< uint8_t > & signature () const
 
const AlgorithmIdentifiersignature_algorithm () const
 
const std::vector< uint8_t > & signed_body () const
 
const AlternativeNamesubject_alt_name () const
 
const X509_DNsubject_dn () const
 
std::vector< std::string > subject_info (std::string_view name) const
 
const std::vector< uint8_t > & subject_key_id () const
 
std::unique_ptr< Public_Keysubject_public_key () const
 
const AlgorithmIdentifiersubject_public_key_algo () const
 
const std::vector< uint8_t > & subject_public_key_bits () const
 
const std::vector< uint8_t > & subject_public_key_bitstring () const
 
const std::vector< uint8_t > & subject_public_key_bitstring_sha1 () const
 
const std::vector< uint8_t > & subject_public_key_info () const
 
std::vector< uint8_t > tbs_data () const
 
std::string to_string () const
 
const std::vector< uint8_t > & v2_issuer_key_id () const
 
const std::vector< uint8_t > & v2_subject_key_id () const
 
const Extensionsv3_extensions () const
 
std::pair< Certificate_Status_Code, std::string > verify_signature (const Public_Key &key) const
 
 X509_Certificate ()=default
 
 X509_Certificate (const std::vector< uint8_t > &in)
 
 X509_Certificate (const uint8_t data[], size_t length)
 
 X509_Certificate (const X509_Certificate &other)=default
 
 X509_Certificate (DataSource &source)
 
uint32_t x509_version () const
 

Static Public Member Functions

static std::unique_ptr< PK_Signerchoose_sig_format (const Private_Key &key, RandomNumberGenerator &rng, std::string_view hash_fn, std::string_view padding_algo)
 
static std::vector< uint8_t > make_signed (PK_Signer &signer, RandomNumberGenerator &rng, const AlgorithmIdentifier &alg_id, const secure_vector< uint8_t > &tbs)
 

Protected Member Functions

void load_data (DataSource &src)
 

Detailed Description

This class represents an X.509 Certificate

Definition at line 36 of file x509cert.h.

Constructor & Destructor Documentation

◆ X509_Certificate() [1/5]

Botan::X509_Certificate::X509_Certificate ( DataSource & source)
explicit

Create a certificate from a data source providing the DER or PEM encoded certificate.

Parameters
sourcethe data source

Definition at line 79 of file x509cert.cpp.

79 {
80 load_data(src);
81}
void load_data(DataSource &src)
Definition x509_obj.cpp:23

References Botan::X509_Object::load_data().

◆ X509_Certificate() [2/5]

Botan::X509_Certificate::X509_Certificate ( const std::vector< uint8_t > & in)
explicit

Create a certificate from a buffer

Parameters
inthe buffer containing the DER-encoded certificate

Definition at line 83 of file x509cert.cpp.

83 {
84 DataSource_Memory src(vec.data(), vec.size());
85 load_data(src);
86}

References Botan::X509_Object::load_data().

◆ X509_Certificate() [3/5]

Botan::X509_Certificate::X509_Certificate ( const uint8_t data[],
size_t length )

Create a certificate from a buffer

Parameters
datathe buffer containing the DER-encoded certificate
lengthlength of data in bytes

Definition at line 88 of file x509cert.cpp.

88 {
89 DataSource_Memory src(data, len);
90 load_data(src);
91}

References Botan::X509_Object::load_data().

◆ X509_Certificate() [4/5]

Botan::X509_Certificate::X509_Certificate ( )
default

Create an uninitialized certificate object. Any attempts to access this object will throw an exception.

◆ X509_Certificate() [5/5]

Botan::X509_Certificate::X509_Certificate ( const X509_Certificate & other)
default

Member Function Documentation

◆ allowed_extended_usage() [1/2]

bool Botan::X509_Certificate::allowed_extended_usage ( const OID & usage) const

Returns true if the specified usage is set in the extended key usage extension, or if no extended key usage constraints are set at all. To check if a certain extended key constraint is set in the certificate use

See also
X509_Certificate::has_ex_constraint.

Definition at line 473 of file x509cert.cpp.

473 {
474 const std::vector<OID>& ex = extended_key_usage();
475 if(ex.empty()) {
476 return true;
477 }
478
479 if(std::find(ex.begin(), ex.end(), usage) != ex.end()) {
480 return true;
481 }
482
483 return false;
484}
const std::vector< OID > & extended_key_usage() const
Definition x509cert.cpp:441

References extended_key_usage().

◆ allowed_extended_usage() [2/2]

bool Botan::X509_Certificate::allowed_extended_usage ( std::string_view usage) const

Returns true if the specified

Parameters
usageis set in the extended key usage extension or if no extended key usage constraints are set at all. To check if a certain extended key constraint is set in the certificate use
See also
X509_Certificate::has_ex_constraint.

Definition at line 469 of file x509cert.cpp.

469 {
471}
static OID from_string(std::string_view str)
Definition asn1_oid.cpp:86
bool allowed_extended_usage(std::string_view usage) const
Definition x509cert.cpp:469

References allowed_extended_usage(), and Botan::OID::from_string().

Referenced by allowed_extended_usage(), and allowed_usage().

◆ allowed_usage() [1/2]

bool Botan::X509_Certificate::allowed_usage ( Key_Constraints usage) const

Returns true if the specified

Parameters
usageis set in the key usage extension or if no key usage constraints are set at all. To check if a certain key constraint is set in the certificate use
See also
X509_Certificate::has_constraints.

Definition at line 462 of file x509cert.cpp.

462 {
463 if(constraints().empty()) {
464 return true;
465 }
466 return constraints().includes(usage);
467}
bool includes(Key_Constraints::Bits other) const
Definition pkix_enums.h:160
Key_Constraints constraints() const
Definition x509cert.cpp:437

References constraints(), and Botan::Key_Constraints::includes().

Referenced by allowed_usage(), and Botan::PKIX::check_crl().

◆ allowed_usage() [2/2]

bool Botan::X509_Certificate::allowed_usage ( Usage_Type usage) const

Returns true if the required key and extended key constraints are set in the certificate for the specified

Parameters
usageor if no key constraints are set in both the key usage and extended key usage extension.

Definition at line 486 of file x509cert.cpp.

486 {
487 // These follow suggestions in RFC 5280 4.2.1.12
488
489 switch(usage) {
491 return true;
492
496 allowed_extended_usage("PKIX.ServerAuth");
497
500 allowed_extended_usage("PKIX.ClientAuth");
501
504 has_ex_constraint("PKIX.OCSPSigning");
505
507 return is_CA_cert();
508
511 }
512
513 return false;
514}
bool is_CA_cert() const
Definition x509cert.cpp:421
bool has_ex_constraint(std::string_view ex_constraint) const
Definition x509cert.cpp:516
bool allowed_usage(Key_Constraints usage) const
Definition x509cert.cpp:462

References allowed_extended_usage(), allowed_usage(), Botan::CERTIFICATE_AUTHORITY, Botan::Key_Constraints::DataEncipherment, Botan::Key_Constraints::DigitalSignature, Botan::ENCRYPTION, has_ex_constraint(), is_CA_cert(), Botan::Key_Constraints::KeyAgreement, Botan::Key_Constraints::KeyEncipherment, Botan::Key_Constraints::NonRepudiation, Botan::OCSP_RESPONDER, Botan::TLS_CLIENT_AUTH, Botan::TLS_SERVER_AUTH, and Botan::UNSPECIFIED.

◆ authority_key_id()

const std::vector< uint8_t > & Botan::X509_Certificate::authority_key_id ( ) const

Get the DER encoded AuthorityKeyIdentifier of this certificate.

Returns
DER encoded AuthorityKeyIdentifier

Definition at line 389 of file x509cert.cpp.

389 {
390 return data().m_authority_key_id;
391}

Referenced by Botan::PKIX::build_certificate_path(), Botan::Certificate_Store_In_Memory::find_crl_for(), Botan::X509_CRL::is_revoked(), and to_string().

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

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

References Botan::ASN1_Object::encode_into().

Referenced by Botan::Certificate_Store_In_SQL::find_all_certs(), Botan::Certificate_Store_In_SQL::find_cert(), fingerprint(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::X509_Object::PEM_encode(), and Botan::Certificate_Store_In_SQL::revoke_cert().

◆ ca_issuers()

std::vector< std::string > Botan::X509_Certificate::ca_issuers ( ) const

Return the listed addresses of ca issuers, or empty if not set

Definition at line 536 of file x509cert.cpp.

536 {
537 return data().m_ca_issuers;
538}

Referenced by to_string().

◆ certificate_policy_oids()

const std::vector< OID > & Botan::X509_Certificate::certificate_policy_oids ( ) const

Get the policies as defined in the CertificatePolicies extension of this certificate.

Returns
certificate policies

Definition at line 445 of file x509cert.cpp.

445 {
446 return data().m_cert_policies;
447}

Referenced by to_string().

◆ check_signature()

bool Botan::X509_Object::check_signature ( const Public_Key & key) const
inherited

Check the signature on this data

Parameters
keythe public key purportedly used to sign this data
Returns
true if the signature is valid, otherwise false

Definition at line 96 of file x509_obj.cpp.

96 {
97 const auto result = this->verify_signature(pub_key);
98 return (result.first == Certificate_Status_Code::VERIFIED);
99}
std::pair< Certificate_Status_Code, std::string > verify_signature(const Public_Key &key) const
Definition x509_obj.cpp:101

References Botan::VERIFIED, and Botan::X509_Object::verify_signature().

◆ choose_sig_format()

std::unique_ptr< PK_Signer > Botan::X509_Object::choose_sig_format ( const Private_Key & key,
RandomNumberGenerator & rng,
std::string_view hash_fn,
std::string_view padding_algo )
staticinherited

Choose and return a signature scheme appropriate for X.509 signing using the provided parameters.

Parameters
keywill be the key to choose a padding scheme for
rngthe random generator to use
hash_fnis the desired hash function
padding_algospecifies the padding method
Returns
a PK_Signer object for generating signatures

Definition at line 208 of file x509_obj.cpp.

211 {
212 const Signature_Format format = key._default_x509_signature_format();
213
214 if(!user_specified_padding.empty()) {
215 try {
216 auto pk_signer = std::make_unique<PK_Signer>(key, rng, user_specified_padding, format);
217 if(!hash_fn.empty() && pk_signer->hash_function() != hash_fn) {
218 throw Invalid_Argument(format_padding_error_message(
219 key.algo_name(), pk_signer->hash_function(), hash_fn, "", user_specified_padding));
220 }
221 return pk_signer;
222 } catch(Lookup_Error&) {}
223 }
224
225 const std::string padding = x509_signature_padding_for(key.algo_name(), hash_fn, user_specified_padding);
226
227 try {
228 auto pk_signer = std::make_unique<PK_Signer>(key, rng, padding, format);
229 if(!hash_fn.empty() && pk_signer->hash_function() != hash_fn) {
230 throw Invalid_Argument(format_padding_error_message(
231 key.algo_name(), pk_signer->hash_function(), hash_fn, padding, user_specified_padding));
232 }
233 return pk_signer;
234 } catch(Not_Implemented&) {
235 throw Invalid_Argument("Signatures using " + key.algo_name() + "/" + padding + " are not supported");
236 }
237}
Signature_Format
Definition pk_keys.h:31

References Botan::Asymmetric_Key::_default_x509_signature_format(), and Botan::Asymmetric_Key::algo_name().

Referenced by Botan::PKCS10_Request::create(), Botan::X509::create_self_signed_cert(), and Botan::X509_CA::X509_CA().

◆ constraints()

Key_Constraints Botan::X509_Certificate::constraints ( ) const

Get the key constraints as defined in the KeyUsage extension of this certificate.

Returns
key constraints

Definition at line 437 of file x509cert.cpp.

437 {
438 return data().m_key_constraints;
439}

Referenced by allowed_usage(), has_constraints(), and to_string().

◆ crl_distribution_point()

std::string Botan::X509_Certificate::crl_distribution_point ( ) const

Return the CRL distribution point, or empty if not set

Definition at line 544 of file x509cert.cpp.

544 {
545 // just returns the first (arbitrarily)
546 if(!data().m_crl_distribution_points.empty()) {
547 return data().m_crl_distribution_points[0];
548 }
549 return "";
550}

◆ crl_distribution_points()

std::vector< std::string > Botan::X509_Certificate::crl_distribution_points ( ) const

Return the CRL distribution points, or empty if not set

Definition at line 540 of file x509cert.cpp.

540 {
541 return data().m_crl_distribution_points;
542}

Referenced by Botan::PKIX::check_crl(), and to_string().

◆ decode_from()

void Botan::X509_Object::decode_from ( BER_Decoder & from)
overridevirtualinherited

Decode a BER encoded X509_Object See ASN1_Object::decode_from()

Implements Botan::ASN1_Object.

Definition at line 67 of file x509_obj.cpp.

67 {
68 from.start_sequence()
69 .start_sequence()
70 .raw_bytes(m_tbs_bits)
71 .end_cons()
72 .decode(m_sig_algo)
73 .decode(m_sig, ASN1_Type::BitString)
74 .end_cons();
75
76 force_decode();
77}

References Botan::BitString, Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::raw_bytes(), and Botan::BER_Decoder::start_sequence().

Referenced by Botan::X509_Object::load_data().

◆ encode_into()

void Botan::X509_Object::encode_into ( DER_Encoder & to) const
overridevirtualinherited

DER encode an X509_Object See ASN1_Object::encode_into()

Implements Botan::ASN1_Object.

Definition at line 54 of file x509_obj.cpp.

54 {
55 to.start_sequence()
56 .start_sequence()
57 .raw_bytes(signed_body())
58 .end_cons()
59 .encode(signature_algorithm())
61 .end_cons();
62}
const std::vector< uint8_t > & signed_body() const
Definition x509_obj.h:42
const AlgorithmIdentifier & signature_algorithm() const
Definition x509_obj.h:47
const std::vector< uint8_t > & signature() const
Definition x509_obj.h:37

References Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::raw_bytes(), Botan::X509_Object::signature(), Botan::X509_Object::signature_algorithm(), Botan::X509_Object::signed_body(), and Botan::DER_Encoder::start_sequence().

◆ extended_key_usage()

const std::vector< OID > & Botan::X509_Certificate::extended_key_usage ( ) const

Get the key usage as defined in the ExtendedKeyUsage extension of this certificate, or else an empty vector.

Returns
key usage

Definition at line 441 of file x509cert.cpp.

441 {
442 return data().m_extended_key_usage;
443}

Referenced by allowed_extended_usage(), has_ex_constraint(), and to_string().

◆ fingerprint()

std::string Botan::X509_Certificate::fingerprint ( std::string_view hash_name = "SHA-1") const
Returns
a fingerprint of the certificate
Parameters
hash_namehash function used to calculate the fingerprint

Definition at line 629 of file x509cert.cpp.

629 {
630 /*
631 * The SHA-1 and SHA-256 fingerprints are precomputed since these
632 * are the most commonly used. Especially, SHA-256 fingerprints are
633 * used for cycle detection during path construction.
634 *
635 * If SHA-1 or SHA-256 was missing at parsing time the vectors are
636 * left empty in which case we fall back to create_hex_fingerprint
637 * which will throw if the hash is unavailable.
638 */
639 if(hash_name == "SHA-256" && !data().m_fingerprint_sha256.empty()) {
640 return data().m_fingerprint_sha256;
641 } else if(hash_name == "SHA-1" && !data().m_fingerprint_sha1.empty()) {
642 return data().m_fingerprint_sha1;
643 } else {
644 return create_hex_fingerprint(this->BER_encode(), hash_name);
645 }
646}
std::vector< uint8_t > BER_encode() const
Definition asn1_obj.cpp:19
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)
Definition pk_keys.cpp:38

References Botan::ASN1_Object::BER_encode(), and Botan::create_hex_fingerprint().

Referenced by Botan::Certificate_Store_In_SQL::affirm_cert(), Botan::PKIX::build_certificate_path(), Botan::Certificate_Store_In_SQL::find_key(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::Certificate_Store_In_SQL::insert_key(), Botan::Certificate_Store_In_SQL::remove_cert(), and Botan::Certificate_Store_In_SQL::revoke_cert().

◆ has_constraints()

bool Botan::X509_Certificate::has_constraints ( Key_Constraints constraints) const

Returns true if and only if the specified

Parameters
constraintsare included in the key usage extension.

Typically for applications you want allowed_usage instead.

Definition at line 457 of file x509cert.cpp.

457 {
458 // Unlike allowed_usage, returns false if constraints was not set
459 return constraints().includes(usage);
460}

References constraints(), and Botan::Key_Constraints::includes().

◆ has_ex_constraint() [1/2]

bool Botan::X509_Certificate::has_ex_constraint ( const OID & ex_constraint) const

Returns true if and only if OID

Parameters
ex_constraintis included in the extended key extension.

Definition at line 520 of file x509cert.cpp.

520 {
521 const std::vector<OID>& ex = extended_key_usage();
522 return (std::find(ex.begin(), ex.end(), usage) != ex.end());
523}

References extended_key_usage().

◆ has_ex_constraint() [2/2]

bool Botan::X509_Certificate::has_ex_constraint ( std::string_view ex_constraint) const

Returns true if and only if OID

Parameters
ex_constraintis included in the extended key extension.

Definition at line 516 of file x509cert.cpp.

516 {
517 return has_ex_constraint(OID::from_string(ex_constraint));
518}

References Botan::OID::from_string(), and has_ex_constraint().

Referenced by allowed_usage(), and has_ex_constraint().

◆ is_CA_cert()

bool Botan::X509_Certificate::is_CA_cert ( ) const

Check whether this certificate is a CA certificate.

Returns
true if this certificate is a CA certificate

Definition at line 421 of file x509cert.cpp.

421 {
422 if(data().m_version < 3 && data().m_self_signed) {
423 return true;
424 }
425
426 return data().m_is_ca_certificate;
427}

Referenced by allowed_usage(), Botan::PKIX::check_chain(), Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store(), Botan::Cert_Extension::Name_Constraints::validate(), and Botan::X509_CA::X509_CA().

◆ is_critical()

bool Botan::X509_Certificate::is_critical ( std::string_view ex_name) const

Check whenever a given X509 Extension is marked critical in this certificate.

Definition at line 528 of file x509cert.cpp.

528 {
530}
bool critical_extension_set(const OID &oid) const
Definition x509_ext.cpp:191
const Extensions & v3_extensions() const
Definition x509cert.cpp:453

References Botan::Extensions::critical_extension_set(), Botan::OID::from_string(), and v3_extensions().

Referenced by Botan::Cert_Extension::Name_Constraints::validate().

◆ is_self_signed()

bool Botan::X509_Certificate::is_self_signed ( ) const

Check whether this certificate is self signed. If the DN issuer and subject agree,

Returns
true if this certificate is self signed

Definition at line 345 of file x509cert.cpp.

345 {
346 return data().m_self_signed;
347}

Referenced by Botan::PKIX::build_certificate_path(), Botan::PKIX::check_chain(), Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store(), and to_string().

◆ is_serial_negative()

bool Botan::X509_Certificate::is_serial_negative ( ) const

Get the serial number's sign

Returns
1 iff the serial is negative.

Definition at line 401 of file x509cert.cpp.

401 {
402 return data().m_serial_negative;
403}

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

◆ issuer_alt_name()

const AlternativeName & Botan::X509_Certificate::issuer_alt_name ( ) const

Return the issuer alternative names (DNS, IP, ...)

Definition at line 556 of file x509cert.cpp.

556 {
557 return data().m_issuer_alt_name;
558}

Referenced by issuer_info().

◆ issuer_dn()

const X509_DN & Botan::X509_Certificate::issuer_dn ( ) const

Get the certificate's issuer distinguished name (DN).

Returns
issuer DN of this certificate

Definition at line 405 of file x509cert.cpp.

405 {
406 return data().m_issuer_dn;
407}

Referenced by Botan::PKIX::build_certificate_path(), Botan::PKIX::check_chain(), Botan::Certificate_Store_In_Memory::find_crl_for(), Botan::Certificate_Store_In_SQL::find_crl_for(), Botan::X509_CRL::is_revoked(), issuer_info(), Botan::OCSP::Request::Request(), and to_string().

◆ issuer_info()

std::vector< std::string > Botan::X509_Certificate::issuer_info ( std::string_view name) const

Get a value for a specific subject_info parameter name.

Parameters
namethe name of the parameter to look up. Possible names are "X509.Certificate.v2.key_id" or "X509v3.AuthorityKeyIdentifier".
Returns
value(s) of the specified parameter

Definition at line 596 of file x509cert.cpp.

596 {
597 return get_cert_user_info(req, issuer_dn(), issuer_alt_name());
598}
const AlternativeName & issuer_alt_name() const
Definition x509cert.cpp:556
const X509_DN & issuer_dn() const
Definition x509cert.cpp:405

References issuer_alt_name(), and issuer_dn().

◆ load_data()

void Botan::X509_Object::load_data ( DataSource & src)
protectedinherited

Decodes from src as either DER or PEM data, then calls force_decode()

Definition at line 23 of file x509_obj.cpp.

23 {
24 try {
25 if(ASN1::maybe_BER(in) && !PEM_Code::matches(in)) {
26 BER_Decoder dec(in);
27 decode_from(dec);
28 } else {
29 std::string got_label;
30 DataSource_Memory ber(PEM_Code::decode(in, got_label));
31
32 if(got_label != PEM_label()) {
33 bool is_alternate = false;
34 for(std::string_view alt_label : alternate_PEM_labels()) {
35 if(got_label == alt_label) {
36 is_alternate = true;
37 break;
38 }
39 }
40
41 if(!is_alternate) {
42 throw Decoding_Error("Unexpected PEM label for " + PEM_label() + " of " + got_label);
43 }
44 }
45
46 BER_Decoder dec(ber);
47 decode_from(dec);
48 }
49 } catch(Decoding_Error& e) {
50 throw Decoding_Error(PEM_label() + " decoding", e);
51 }
52}
void decode_from(BER_Decoder &from) override
Definition x509_obj.cpp:67
virtual std::vector< std::string > alternate_PEM_labels() const
Definition x509_obj.h:101
virtual std::string PEM_label() const =0
bool maybe_BER(DataSource &source)
Definition asn1_obj.cpp:192
bool matches(DataSource &source, std::string_view extra, size_t search_range)
Definition pem.cpp:137
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
Definition pem.cpp:62

References Botan::X509_Object::alternate_PEM_labels(), Botan::PEM_Code::decode(), Botan::X509_Object::decode_from(), Botan::PEM_Code::matches(), Botan::ASN1::maybe_BER(), and Botan::X509_Object::PEM_label().

Referenced by Botan::PKCS10_Request::PKCS10_Request(), Botan::PKCS10_Request::PKCS10_Request(), X509_Certificate(), X509_Certificate(), X509_Certificate(), Botan::X509_CRL::X509_CRL(), and Botan::X509_CRL::X509_CRL().

◆ load_subject_public_key()

std::unique_ptr< Public_Key > Botan::X509_Certificate::load_subject_public_key ( ) const

Create a public key object associated with the public key bits in this certificate. If the public key bits was valid for X.509 encoding purposes but invalid algorithmically (for example, RSA with an even modulus) that will be detected at this point, and an exception will be thrown.

Returns
subject public key of this certificate

Definition at line 611 of file x509cert.cpp.

611 {
612 return this->subject_public_key();
613}
std::unique_ptr< Public_Key > subject_public_key() const
Definition x509cert.cpp:603

References subject_public_key().

◆ make_signed()

std::vector< uint8_t > Botan::X509_Object::make_signed ( PK_Signer & signer,
RandomNumberGenerator & rng,
const AlgorithmIdentifier & alg_id,
const secure_vector< uint8_t > & tbs )
staticinherited

Create a signed X509 object.

Parameters
signerthe signer used to sign the object
rngthe random number generator to use
alg_idthe algorithm identifier of the signature scheme
tbsthe tbs bits to be signed
Returns
signed X509 object

Definition at line 124 of file x509_obj.cpp.

127 {
128 const std::vector<uint8_t> signature = signer.sign_message(tbs_bits, rng);
129
130 std::vector<uint8_t> output;
131 DER_Encoder(output)
132 .start_sequence()
133 .raw_bytes(tbs_bits)
134 .encode(algo)
136 .end_cons();
137
138 return output;
139}

References Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::raw_bytes(), Botan::PK_Signer::sign_message(), Botan::X509_Object::signature(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::PKCS10_Request::create(), and Botan::X509_CA::make_cert().

◆ matches_dns_name()

bool Botan::X509_Certificate::matches_dns_name ( std::string_view name) const

Check if a certain DNS name matches up with the information in the cert

Parameters
nameDNS name to match

Note: this will also accept a dotted quad input, in which case the SAN for IPv4 addresses will be checked.

Definition at line 648 of file x509cert.cpp.

648 {
649 if(name.empty()) {
650 return false;
651 }
652
653 if(auto req_ipv4 = string_to_ipv4(name)) {
654 const auto& ipv4_names = subject_alt_name().ipv4_address();
655 return ipv4_names.contains(req_ipv4.value());
656 } else {
657 auto issued_names = subject_info("DNS");
658
659 // Fall back to CN only if no SAN is included
660 if(!data().m_subject_alt_name_exists) {
661 issued_names = subject_info("Name");
662 }
663
664 for(const auto& issued_name : issued_names) {
665 if(host_wildcard_match(issued_name, name)) {
666 return true;
667 }
668 }
669 }
670
671 return false;
672}
const std::set< uint32_t > & ipv4_address() const
Return the set of IPv4 addresses included in this alternative name.
Definition pkix_types.h:157
std::vector< std::string > subject_info(std::string_view name) const
Definition x509cert.cpp:589
const AlternativeName & subject_alt_name() const
Definition x509cert.cpp:552
std::string name
bool host_wildcard_match(std::string_view issued_, std::string_view host_)
Definition parsing.cpp:252
std::optional< uint32_t > string_to_ipv4(std::string_view str)
Definition parsing.cpp:156

References Botan::host_wildcard_match(), Botan::AlternativeName::ipv4_address(), name, Botan::string_to_ipv4(), subject_alt_name(), and subject_info().

◆ name_constraints()

const NameConstraints & Botan::X509_Certificate::name_constraints ( ) const

Get the name constraints as defined in the NameConstraints extension of this certificate.

Returns
name constraints

Definition at line 449 of file x509cert.cpp.

449 {
450 return data().m_name_constraints;
451}

Referenced by to_string().

◆ not_after()

const X509_Time & Botan::X509_Certificate::not_after ( ) const

Get the notAfter of the certificate as X509_Time

Returns
notAfter of the certificate

Definition at line 353 of file x509cert.cpp.

353 {
354 return data().m_not_after;
355}

Referenced by Botan::PKIX::check_chain(), and to_string().

◆ not_before()

const X509_Time & Botan::X509_Certificate::not_before ( ) const

Get the notBefore of the certificate as X509_Time

Returns
notBefore of the certificate

Definition at line 349 of file x509cert.cpp.

349 {
350 return data().m_not_before;
351}

Referenced by Botan::PKIX::check_chain(), and to_string().

◆ ocsp_responder()

std::string Botan::X509_Certificate::ocsp_responder ( ) const

Return the listed address of an OCSP responder, or empty if not set

Definition at line 532 of file x509cert.cpp.

532 {
533 return data().m_ocsp_responder;
534}

Referenced by to_string().

◆ operator<()

bool Botan::X509_Certificate::operator< ( const X509_Certificate & other) const

Impose an arbitrary (but consistent) ordering, eg to allow sorting a container of certificate objects.

Returns
true if this is less than other by some unspecified criteria

Definition at line 682 of file x509cert.cpp.

682 {
683 /* If signature values are not equal, sort by lexicographic ordering of that */
684 if(this->signature() != other.signature()) {
685 return (this->signature() < other.signature());
686 }
687
688 // Then compare the signed contents
689 return this->signed_body() < other.signed_body();
690}

References Botan::X509_Object::signature(), and Botan::X509_Object::signed_body().

◆ operator=()

X509_Certificate & Botan::X509_Certificate::operator= ( const X509_Certificate & other)
default

◆ operator==()

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

Check to certificates for equality.

Returns
true both certificates are (binary) equal

Definition at line 677 of file x509cert.cpp.

677 {
678 return (this->signature() == other.signature() && this->signature_algorithm() == other.signature_algorithm() &&
679 this->signed_body() == other.signed_body());
680}

References Botan::X509_Object::signature(), Botan::X509_Object::signature_algorithm(), and Botan::X509_Object::signed_body().

◆ path_limit()

uint32_t Botan::X509_Certificate::path_limit ( ) const

Get the path limit as defined in the BasicConstraints extension of this certificate.

Returns
path limit

Definition at line 429 of file x509cert.cpp.

429 {
430 if(data().m_version < 3 && data().m_self_signed) {
431 return 32; // in theory infinite, but this is more than enough
432 }
433
434 return static_cast<uint32_t>(data().m_path_len_constraint);
435}

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

◆ PEM_encode()

std::string Botan::X509_Object::PEM_encode ( ) const
inherited
Returns
PEM encoding of this

Definition at line 82 of file x509_obj.cpp.

82 {
84}
std::string encode(const uint8_t der[], size_t length, std::string_view label, size_t width)
Definition pem.cpp:39

References Botan::ASN1_Object::BER_encode(), Botan::PEM_Code::encode(), and Botan::X509_Object::PEM_label().

◆ raw_issuer_dn()

const std::vector< uint8_t > & Botan::X509_Certificate::raw_issuer_dn ( ) const

Raw issuer DN bits

Definition at line 413 of file x509cert.cpp.

413 {
414 return data().m_issuer_dn_bits;
415}

Referenced by Botan::OCSP::CertID::is_id_for().

◆ raw_issuer_dn_sha256()

std::vector< uint8_t > Botan::X509_Certificate::raw_issuer_dn_sha256 ( ) const

SHA-256 of Raw issuer DN

Definition at line 615 of file x509cert.cpp.

615 {
616 if(data().m_issuer_dn_bits_sha256.empty()) {
617 throw Encoding_Error("X509_Certificate::raw_issuer_dn_sha256 called but SHA-256 disabled in build");
618 }
619 return data().m_issuer_dn_bits_sha256;
620}

◆ raw_subject_dn()

const std::vector< uint8_t > & Botan::X509_Certificate::raw_subject_dn ( ) const

Raw subject DN

Definition at line 417 of file x509cert.cpp.

417 {
418 return data().m_subject_dn_bits;
419}

Referenced by Botan::OCSP::CertID::CertID().

◆ raw_subject_dn_sha256()

std::vector< uint8_t > Botan::X509_Certificate::raw_subject_dn_sha256 ( ) const

SHA-256 of Raw subject DN

Definition at line 622 of file x509cert.cpp.

622 {
623 if(data().m_subject_dn_bits_sha256.empty()) {
624 throw Encoding_Error("X509_Certificate::raw_subject_dn_sha256 called but SHA-256 disabled in build");
625 }
626 return data().m_subject_dn_bits_sha256;
627}

Referenced by Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store().

◆ serial_number()

const std::vector< uint8_t > & Botan::X509_Certificate::serial_number ( ) const

Get the serial number of this certificate.

Returns
certificates serial number

Definition at line 397 of file x509cert.cpp.

397 {
398 return data().m_serial;
399}

Referenced by Botan::CRL_Entry::CRL_Entry(), Botan::OCSP::CertID::is_id_for(), Botan::X509_CRL::is_revoked(), and to_string().

◆ signature()

const std::vector< uint8_t > & Botan::X509_Object::signature ( ) const
inlineinherited
Returns
signature on tbs_data()

Definition at line 37 of file x509_obj.h.

37{ return m_sig; }

Referenced by Botan::X509_Object::encode_into(), Botan::X509_Object::make_signed(), operator<(), operator==(), and Botan::X509_Object::verify_signature().

◆ signature_algorithm()

const AlgorithmIdentifier & Botan::X509_Object::signature_algorithm ( ) const
inlineinherited
Returns
signature algorithm that was used to generate signature

Definition at line 47 of file x509_obj.h.

47{ return m_sig_algo; }

Referenced by Botan::PKIX::check_chain(), Botan::X509_Object::encode_into(), operator==(), to_string(), and Botan::X509_Object::verify_signature().

◆ signed_body()

const std::vector< uint8_t > & Botan::X509_Object::signed_body ( ) const
inlineinherited
Returns
signed body

Definition at line 42 of file x509_obj.h.

42{ return m_tbs_bits; }

Referenced by Botan::X509_Object::encode_into(), operator<(), and operator==().

◆ subject_alt_name()

const AlternativeName & Botan::X509_Certificate::subject_alt_name ( ) const

Return the subject alternative names (DNS, IP, ...)

Definition at line 552 of file x509cert.cpp.

552 {
553 return data().m_subject_alt_name;
554}

Referenced by Botan::NameConstraints::is_excluded(), Botan::NameConstraints::is_permitted(), Botan::GeneralName::matches(), matches_dns_name(), and subject_info().

◆ subject_dn()

◆ subject_info()

std::vector< std::string > Botan::X509_Certificate::subject_info ( std::string_view name) const

Get a value for a specific subject_info parameter name.

Parameters
namethe name of the parameter to look up. Possible names include "X509.Certificate.version", "X509.Certificate.serial", "X509.Certificate.start", "X509.Certificate.end", "X509.Certificate.v2.key_id", "X509.Certificate.public_key", "X509v3.BasicConstraints.path_constraint", "X509v3.BasicConstraints.is_ca", "X509v3.NameConstraints", "X509v3.ExtendedKeyUsage", "X509v3.CertificatePolicies", "X509v3.SubjectKeyIdentifier", "X509.Certificate.serial", "X520.CommonName", "X520.Organization", "X520.Country", "RFC822" (Email in SAN) or "PKCS9.EmailAddress" (Email in DN).
Returns
value(s) of the specified parameter

Definition at line 589 of file x509cert.cpp.

589 {
590 return get_cert_user_info(req, subject_dn(), subject_alt_name());
591}
const X509_DN & subject_dn() const
Definition x509cert.cpp:409

References subject_alt_name(), and subject_dn().

Referenced by Botan::NameConstraints::is_excluded(), Botan::NameConstraints::is_permitted(), and matches_dns_name().

◆ subject_key_id()

const std::vector< uint8_t > & Botan::X509_Certificate::subject_key_id ( ) const

Get the DER encoded SubjectKeyIdentifier of this certificate.

Returns
DER encoded SubjectKeyIdentifier

Definition at line 393 of file x509cert.cpp.

393 {
394 return data().m_subject_key_id;
395}

Referenced by Botan::Certificate_Store::certificate_known(), Botan::X509_CA::choose_extensions(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::Certificate_Store_In_SQL::remove_cert(), and to_string().

◆ subject_public_key()

std::unique_ptr< Public_Key > Botan::X509_Certificate::subject_public_key ( ) const

Create a public key object associated with the public key bits in this certificate. If the public key bits was valid for X.509 encoding purposes but invalid algorithmically (for example, RSA with an even modulus) that will be detected at this point, and an exception will be thrown.

Returns
subject public key of this certificate

Definition at line 603 of file x509cert.cpp.

603 {
604 try {
605 return std::unique_ptr<Public_Key>(X509::load_key(subject_public_key_info()));
606 } catch(std::exception& e) {
607 throw Decoding_Error("X509_Certificate::subject_public_key", e);
608 }
609}
const std::vector< uint8_t > & subject_public_key_info() const
Definition x509cert.cpp:373
std::unique_ptr< Public_Key > load_key(DataSource &source)
Definition x509_key.cpp:28

References Botan::X509::load_key(), and subject_public_key_info().

Referenced by Botan::PKIX::check_chain(), Botan::PKIX::check_crl(), load_subject_public_key(), to_string(), Botan::TLS::Certificate_Verify_12::verify(), and Botan::OCSP::Response::verify_signature().

◆ subject_public_key_algo()

const AlgorithmIdentifier & Botan::X509_Certificate::subject_public_key_algo ( ) const

Return the algorithm identifier of the public key

Definition at line 357 of file x509cert.cpp.

357 {
358 return data().m_subject_public_key_algid;
359}

Referenced by to_string().

◆ subject_public_key_bits()

const std::vector< uint8_t > & Botan::X509_Certificate::subject_public_key_bits ( ) const

Get the public key associated with this certificate. This includes the outer AlgorithmIdentifier

Returns
subject public key of this certificate

Definition at line 369 of file x509cert.cpp.

369 {
370 return data().m_subject_public_key_bits;
371}

◆ subject_public_key_bitstring()

const std::vector< uint8_t > & Botan::X509_Certificate::subject_public_key_bitstring ( ) const

Get the bit string of the public key associated with this certificate

Returns
public key bits

Definition at line 377 of file x509cert.cpp.

377 {
378 return data().m_subject_public_key_bitstring;
379}

Referenced by Botan::OCSP::CertID::CertID(), Botan::OCSP::CertID::is_id_for(), and to_string().

◆ subject_public_key_bitstring_sha1()

const std::vector< uint8_t > & Botan::X509_Certificate::subject_public_key_bitstring_sha1 ( ) const

Get the SHA-1 bit string of the public key associated with this certificate. This is used for OCSP among other protocols. This function will throw if SHA-1 is not available.

Returns
hash of subject public key of this certificate

Definition at line 381 of file x509cert.cpp.

381 {
382 if(data().m_subject_public_key_bitstring_sha1.empty()) {
383 throw Encoding_Error("X509_Certificate::subject_public_key_bitstring_sha1 called but SHA-1 disabled in build");
384 }
385
386 return data().m_subject_public_key_bitstring_sha1;
387}

Referenced by Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store().

◆ subject_public_key_info()

const std::vector< uint8_t > & Botan::X509_Certificate::subject_public_key_info ( ) const

Get the SubjectPublicKeyInfo associated with this certificate.

Returns
subject public key info of this certificate

Definition at line 373 of file x509cert.cpp.

373 {
374 return data().m_subject_public_key_bits_seq;
375}

Referenced by subject_public_key().

◆ tbs_data()

std::vector< uint8_t > Botan::X509_Object::tbs_data ( ) const
inherited

The underlying data that is to be or was signed

Returns
data that is or was signed

Definition at line 89 of file x509_obj.cpp.

89 {
90 return ASN1::put_in_sequence(m_tbs_bits);
91}
std::vector< uint8_t > put_in_sequence(const std::vector< uint8_t > &contents)
Definition asn1_obj.cpp:172

References Botan::ASN1::put_in_sequence().

Referenced by Botan::X509_Object::verify_signature().

◆ to_string()

std::string Botan::X509_Certificate::to_string ( ) const
Returns
a free-form string describing the certificate

Definition at line 699 of file x509cert.cpp.

699 {
700 std::ostringstream out;
701
702 out << "Version: " << this->x509_version() << "\n";
703 out << "Subject: " << subject_dn() << "\n";
704 out << "Issuer: " << issuer_dn() << "\n";
705 out << "Issued: " << this->not_before().readable_string() << "\n";
706 out << "Expires: " << this->not_after().readable_string() << "\n";
707
708 try {
709 auto pubkey = this->subject_public_key();
710 out << "Public Key [" << pubkey->algo_name() << "-" << pubkey->key_length() << "]\n\n";
711 out << X509::PEM_encode(*pubkey) << "\n";
712 } catch(const Decoding_Error& ex) {
713 const AlgorithmIdentifier& alg_id = this->subject_public_key_algo();
714 out << "Public Key Invalid!\n"
715 << " OID: " << alg_id.oid().to_formatted_string() << "\n"
716 << " Error: " << ex.what() << "\n"
717 << " Hex: " << hex_encode(this->subject_public_key_bitstring()) << "\n";
718 }
719
720 out << "Constraints:\n";
721 Key_Constraints constraints = this->constraints();
722 if(constraints.empty()) {
723 out << " No key constraints set\n";
724 } else {
726 out << " Digital Signature\n";
727 }
729 out << " Non-Repudiation\n";
730 }
732 out << " Key Encipherment\n";
733 }
735 out << " Data Encipherment\n";
736 }
738 out << " Key Agreement\n";
739 }
741 out << " Cert Sign\n";
742 }
744 out << " CRL Sign\n";
745 }
747 out << " Encipher Only\n";
748 }
750 out << " Decipher Only\n";
751 }
752 }
753
754 const std::vector<OID>& policies = this->certificate_policy_oids();
755 if(!policies.empty()) {
756 out << "Policies: "
757 << "\n";
758 for(const auto& oid : policies) {
759 out << " " << oid.to_string() << "\n";
760 }
761 }
762
763 const std::vector<OID>& ex_constraints = this->extended_key_usage();
764 if(!ex_constraints.empty()) {
765 out << "Extended Constraints:\n";
766 for(auto&& oid : ex_constraints) {
767 out << " " << oid.to_formatted_string() << "\n";
768 }
769 }
770
771 const NameConstraints& name_constraints = this->name_constraints();
772
773 if(!name_constraints.permitted().empty() || !name_constraints.excluded().empty()) {
774 out << "Name Constraints:\n";
775
776 if(!name_constraints.permitted().empty()) {
777 out << " Permit";
778 for(const auto& st : name_constraints.permitted()) {
779 out << " " << st.base();
780 }
781 out << "\n";
782 }
783
784 if(!name_constraints.excluded().empty()) {
785 out << " Exclude";
786 for(const auto& st : name_constraints.excluded()) {
787 out << " " << st.base();
788 }
789 out << "\n";
790 }
791 }
792
793 if(!ocsp_responder().empty()) {
794 out << "OCSP responder " << ocsp_responder() << "\n";
795 }
796
797 const std::vector<std::string> ca_issuers = this->ca_issuers();
798 if(!ca_issuers.empty()) {
799 out << "CA Issuers:\n";
800 for(const auto& ca_issuer : ca_issuers) {
801 out << " URI: " << ca_issuer << "\n";
802 }
803 }
804
805 for(const auto& cdp : crl_distribution_points()) {
806 out << "CRL " << cdp << "\n";
807 }
808
809 out << "Signature algorithm: " << this->signature_algorithm().oid().to_formatted_string() << "\n";
810
811 out << "Serial number: " << hex_encode(this->serial_number()) << "\n";
812
813 if(!this->authority_key_id().empty()) {
814 out << "Authority keyid: " << hex_encode(this->authority_key_id()) << "\n";
815 }
816
817 if(!this->subject_key_id().empty()) {
818 out << "Subject keyid: " << hex_encode(this->subject_key_id()) << "\n";
819 }
820
821 if(this->is_self_signed()) {
822 out << "Certificate is self signed\n";
823 }
824
825 return out.str();
826}
std::string readable_string() const
Returns a human friendly string replesentation of no particular formatting.
Definition asn1_time.cpp:92
const OID & oid() const
Definition asn1_obj.h:472
const std::vector< GeneralSubtree > & permitted() const
Definition pkix_types.h:378
const std::vector< GeneralSubtree > & excluded() const
Definition pkix_types.h:385
std::string to_formatted_string() const
Definition asn1_oid.cpp:139
const NameConstraints & name_constraints() const
Definition x509cert.cpp:449
const std::vector< uint8_t > & serial_number() const
Definition x509cert.cpp:397
const X509_Time & not_after() const
Definition x509cert.cpp:353
const std::vector< uint8_t > & authority_key_id() const
Definition x509cert.cpp:389
const std::vector< uint8_t > & subject_key_id() const
Definition x509cert.cpp:393
std::vector< std::string > crl_distribution_points() const
Definition x509cert.cpp:540
std::string ocsp_responder() const
Definition x509cert.cpp:532
uint32_t x509_version() const
Definition x509cert.cpp:341
const std::vector< OID > & certificate_policy_oids() const
Definition x509cert.cpp:445
bool is_self_signed() const
Definition x509cert.cpp:345
const AlgorithmIdentifier & subject_public_key_algo() const
Definition x509cert.cpp:357
std::vector< std::string > ca_issuers() const
Definition x509cert.cpp:536
const std::vector< uint8_t > & subject_public_key_bitstring() const
Definition x509cert.cpp:377
const X509_Time & not_before() const
Definition x509cert.cpp:349
std::string PEM_encode(const Public_Key &key)
Definition x509_key.cpp:21
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition hex.cpp:35

References authority_key_id(), ca_issuers(), certificate_policy_oids(), constraints(), crl_distribution_points(), Botan::Key_Constraints::CrlSign, Botan::Key_Constraints::DataEncipherment, Botan::Key_Constraints::DecipherOnly, Botan::Key_Constraints::DigitalSignature, Botan::Key_Constraints::empty(), Botan::Key_Constraints::EncipherOnly, Botan::NameConstraints::excluded(), extended_key_usage(), Botan::hex_encode(), Botan::Key_Constraints::includes(), is_self_signed(), issuer_dn(), Botan::Key_Constraints::KeyAgreement, Botan::Key_Constraints::KeyCertSign, Botan::Key_Constraints::KeyEncipherment, name_constraints(), Botan::Key_Constraints::NonRepudiation, not_after(), not_before(), ocsp_responder(), Botan::AlgorithmIdentifier::oid(), Botan::X509::PEM_encode(), Botan::NameConstraints::permitted(), Botan::ASN1_Time::readable_string(), serial_number(), Botan::X509_Object::signature_algorithm(), subject_dn(), subject_key_id(), subject_public_key(), subject_public_key_algo(), subject_public_key_bitstring(), Botan::OID::to_formatted_string(), Botan::Exception::what(), and x509_version().

◆ v2_issuer_key_id()

const std::vector< uint8_t > & Botan::X509_Certificate::v2_issuer_key_id ( ) const

Return the v2 issuer key ID. v2 key IDs are almost never used, instead see v3_subject_key_id.

Definition at line 361 of file x509cert.cpp.

361 {
362 return data().m_v2_issuer_key_id;
363}

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

◆ v2_subject_key_id()

const std::vector< uint8_t > & Botan::X509_Certificate::v2_subject_key_id ( ) const

Return the v2 subject key ID. v2 key IDs are almost never used, instead see v3_subject_key_id.

Definition at line 365 of file x509cert.cpp.

365 {
366 return data().m_v2_subject_key_id;
367}

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

◆ v3_extensions()

const Extensions & Botan::X509_Certificate::v3_extensions ( ) const

Get all extensions of this certificate.

Returns
certificate extensions

Definition at line 453 of file x509cert.cpp.

453 {
454 return data().m_v3_extensions;
455}

Referenced by Botan::PKIX::check_chain(), and is_critical().

◆ verify_signature()

std::pair< Certificate_Status_Code, std::string > Botan::X509_Object::verify_signature ( const Public_Key & key) const
inherited

Check the signature on this data

Parameters
keythe public key purportedly used to sign this data
Returns
status of the signature - OK if verified or otherwise an indicator of the problem preventing verification, along with the hash function that was used, for further policy checks. The second parameter is empty unless the validation was sucessful.

Definition at line 101 of file x509_obj.cpp.

101 {
102 try {
103 PK_Verifier verifier(pub_key, signature_algorithm());
104 const bool valid = verifier.verify_message(tbs_data(), signature());
105
106 if(valid) {
107 return std::make_pair(Certificate_Status_Code::VERIFIED, verifier.hash_function());
108 } else {
109 return std::make_pair(Certificate_Status_Code::SIGNATURE_ERROR, "");
110 }
111 } catch(Decoding_Error&) {
113 } catch(Algorithm_Not_Found&) {
114 return std::make_pair(Certificate_Status_Code::SIGNATURE_ALGO_UNKNOWN, "");
115 } catch(...) {
116 // This shouldn't happen, fallback to generic signature error
117 return std::make_pair(Certificate_Status_Code::SIGNATURE_ERROR, "");
118 }
119}
std::vector< uint8_t > tbs_data() const
Definition x509_obj.cpp:89

References Botan::PK_Verifier::hash_function(), Botan::X509_Object::signature(), Botan::SIGNATURE_ALGO_BAD_PARAMS, Botan::SIGNATURE_ALGO_UNKNOWN, Botan::X509_Object::signature_algorithm(), Botan::SIGNATURE_ERROR, Botan::X509_Object::tbs_data(), Botan::VERIFIED, and Botan::PK_Verifier::verify_message().

Referenced by Botan::PKIX::check_chain(), and Botan::X509_Object::check_signature().

◆ x509_version()

uint32_t Botan::X509_Certificate::x509_version ( ) const

Get the X509 version of this certificate object.

Returns
X509 version

Definition at line 341 of file x509cert.cpp.

341 {
342 return static_cast<uint32_t>(data().m_version);
343}

Referenced by Botan::PKIX::check_chain(), and to_string().


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