Botan  2.19.1
Crypto and TLS for C++11
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
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 std::string &usage) const
 
bool allowed_extended_usage (const OID &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
 
bool check_signature (const Public_Key *key) const
 
Key_Constraints constraints () const
 
std::string crl_distribution_point () const
 
void decode_from (class BER_Decoder &from) override
 
void encode_into (class DER_Encoder &to) const override
 
std::string end_time () const
 
std::vector< std::string > ex_constraints () const
 
const std::vector< OID > & extended_key_usage () const
 
std::string fingerprint (const std::string &hash_name="SHA-1") const
 
bool has_constraints (Key_Constraints constraints) const
 
bool has_ex_constraint (const std::string &ex_constraint) const
 
bool has_ex_constraint (const OID &ex_constraint) const
 
std::string hash_used_for_signature () const
 
bool is_CA_cert () const
 
bool is_critical (const std::string &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 (const std::string &name) const
 
std::unique_ptr< Public_Keyload_subject_public_key () const
 
bool matches_dns_name (const std::string &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
 
std::vector< std::string > policies () 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
 
std::string start_time () const
 
const AlternativeNamesubject_alt_name () const
 
const X509_DNsubject_dn () const
 
std::vector< std::string > subject_info (const std::string &name) const
 
const std::vector< uint8_t > & subject_key_id () const
 
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
 
Certificate_Status_Code verify_signature (const Public_Key &key) const
 
 X509_Certificate (DataSource &source)
 
 X509_Certificate (const std::vector< uint8_t > &in)
 
 X509_Certificate (const uint8_t data[], size_t length)
 
 X509_Certificate ()=default
 
 X509_Certificate (const X509_Certificate &other)=default
 
uint32_t x509_version () const
 

Static Public Member Functions

static std::unique_ptr< PK_Signerchoose_sig_format (AlgorithmIdentifier &sig_algo, const Private_Key &key, RandomNumberGenerator &rng, const std::string &hash_fn, const std::string &padding_algo)
 
static std::vector< uint8_t > make_signed (class 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 37 of file x509cert.h.

Constructor & Destructor Documentation

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 85 of file x509cert.cpp.

References Botan::X509_Object::load_data().

86  {
87  load_data(src);
88  }
void load_data(DataSource &src)
Definition: x509_obj.cpp:52
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 90 of file x509cert.cpp.

References Botan::X509_Object::load_data().

91  {
92  DataSource_Memory src(vec.data(), vec.size());
93  load_data(src);
94  }
void load_data(DataSource &src)
Definition: x509_obj.cpp:52
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 96 of file x509cert.cpp.

References Botan::X509_Object::load_data().

97  {
98  DataSource_Memory src(data, len);
99  load_data(src);
100  }
void load_data(DataSource &src)
Definition: x509_obj.cpp:52
Botan::X509_Certificate::X509_Certificate ( )
default

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

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

Member Function Documentation

bool Botan::X509_Certificate::allowed_extended_usage ( const std::string &  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 539 of file x509cert.cpp.

References Botan::OID::from_string().

Referenced by allowed_usage().

540  {
542  }
bool allowed_extended_usage(const std::string &usage) const
Definition: x509cert.cpp:539
static OID from_string(const std::string &str)
Definition: asn1_oid.cpp:62
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 544 of file x509cert.cpp.

References extended_key_usage().

545  {
546  const std::vector<OID>& ex = extended_key_usage();
547  if(ex.empty())
548  return true;
549 
550  if(std::find(ex.begin(), ex.end(), usage) != ex.end())
551  return true;
552 
553  return false;
554  }
const std::vector< OID > & extended_key_usage() const
Definition: x509cert.cpp:512
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 532 of file x509cert.cpp.

References constraints(), and Botan::NO_CONSTRAINTS.

Referenced by allowed_usage().

533  {
534  if(constraints() == NO_CONSTRAINTS)
535  return true;
536  return ((constraints() & usage) == usage);
537  }
Key_Constraints constraints() const
Definition: x509cert.cpp:507
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 556 of file x509cert.cpp.

References allowed_extended_usage(), allowed_usage(), Botan::CERTIFICATE_AUTHORITY, Botan::DATA_ENCIPHERMENT, Botan::DIGITAL_SIGNATURE, Botan::ENCRYPTION, is_CA_cert(), Botan::KEY_AGREEMENT, Botan::KEY_ENCIPHERMENT, Botan::NON_REPUDIATION, Botan::OCSP_RESPONDER, Botan::TLS_CLIENT_AUTH, Botan::TLS_SERVER_AUTH, and Botan::UNSPECIFIED.

557  {
558  // These follow suggestions in RFC 5280 4.2.1.12
559 
560  switch(usage)
561  {
563  return true;
564 
567 
570 
573 
575  return is_CA_cert();
576 
579  }
580 
581  return false;
582  }
bool is_CA_cert() const
Definition: x509cert.cpp:491
bool allowed_usage(Key_Constraints usage) const
Definition: x509cert.cpp:532
bool allowed_extended_usage(const std::string &usage) const
Definition: x509cert.cpp:539
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 450 of file x509cert.cpp.

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

451  {
452  return data().m_authority_key_id;
453  }
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(), 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
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 618 of file x509cert.cpp.

Referenced by to_string().

619  {
620  return data().m_ca_issuers;
621  }
const std::vector< OID > & Botan::X509_Certificate::certificate_policy_oids ( ) const

Definition at line 517 of file x509cert.cpp.

Referenced by policies(), and to_string().

518  {
519  return data().m_cert_policies;
520  }
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 178 of file x509_obj.cpp.

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

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

179  {
180  const Certificate_Status_Code code = verify_signature(pub_key);
181  return (code == Certificate_Status_Code::VERIFIED);
182  }
Certificate_Status_Code verify_signature(const Public_Key &key) const
Definition: x509_obj.cpp:184
Certificate_Status_Code
Definition: pkix_enums.h:17
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 the object will be deleted after use (this should have been a std::unique_ptr<Public_Key>)
Returns
true if the signature is valid, otherwise false

Definition at line 170 of file x509_obj.cpp.

References Botan::X509_Object::check_signature(), and Botan::X509_Object::PEM_label().

171  {
172  if(!pub_key)
173  throw Invalid_Argument("No key provided for " + PEM_label() + " signature check");
174  std::unique_ptr<const Public_Key> key(pub_key);
175  return check_signature(*key);
176  }
virtual std::string PEM_label() const =0
bool check_signature(const Public_Key &key) const
Definition: x509_obj.cpp:178
std::unique_ptr< PK_Signer > Botan::X509_Object::choose_sig_format ( AlgorithmIdentifier sig_algo,
const Private_Key key,
RandomNumberGenerator rng,
const std::string &  hash_fn,
const std::string &  padding_algo 
)
staticinherited

Definition at line 411 of file x509_obj.cpp.

References Botan::Public_Key::default_x509_signature_format().

Referenced by Botan::choose_sig_format(), and Botan::PKCS10_Request::create().

416  {
417  const Signature_Format format = key.default_x509_signature_format();
418 
419  const std::string emsa = choose_sig_algo(sig_algo, key, hash_fn, padding_algo);
420 
421  return std::unique_ptr<PK_Signer>(new PK_Signer(key, rng, emsa, format));
422  }
Signature_Format
Definition: pk_keys.h:23
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 507 of file x509cert.cpp.

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

508  {
509  return data().m_key_constraints;
510  }
std::string Botan::X509_Certificate::crl_distribution_point ( ) const

Return the CRL distribution point, or empty if not set

Definition at line 623 of file x509cert.cpp.

Referenced by to_string().

624  {
625  // just returns the first (arbitrarily)
626  if(data().m_crl_distribution_points.size() > 0)
627  return data().m_crl_distribution_points[0];
628  return "";
629  }
void Botan::X509_Object::decode_from ( class BER_Decoder from)
overridevirtualinherited

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

Implements Botan::ASN1_Object.

Definition at line 106 of file x509_obj.cpp.

References Botan::BIT_STRING, Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::BER_Decoder::raw_bytes(), Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

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

107  {
108  from.start_cons(SEQUENCE)
109  .start_cons(SEQUENCE)
110  .raw_bytes(m_tbs_bits)
111  .end_cons()
112  .decode(m_sig_algo)
113  .decode(m_sig, BIT_STRING)
114  .end_cons();
115 
116  force_decode();
117  }
void Botan::X509_Object::encode_into ( class DER_Encoder to) const
overridevirtualinherited

DER encode an X509_Object See ASN1_Object::encode_into()

Implements Botan::ASN1_Object.

Definition at line 92 of file x509_obj.cpp.

References Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::X509_Object::signature(), Botan::X509_Object::signature_algorithm(), Botan::X509_Object::signed_body(), and Botan::DER_Encoder::start_cons().

93  {
94  to.start_cons(SEQUENCE)
95  .start_cons(SEQUENCE)
96  .raw_bytes(signed_body())
97  .end_cons()
98  .encode(signature_algorithm())
99  .encode(signature(), BIT_STRING)
100  .end_cons();
101  }
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
std::string Botan::X509_Certificate::end_time ( ) const
inline

Get the notAfter of the certificate as a string

Returns
notAfter of the certificate

Definition at line 163 of file x509cert.h.

164  {
165  return not_after().to_string();
166  }
std::string to_string() const
Return an internal string representation of the time.
Definition: asn1_time.cpp:53
const X509_Time & not_after() const
Definition: x509cert.cpp:407
std::vector< std::string > Botan::X509_Certificate::ex_constraints ( ) const

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

Returns
key constraints

Definition at line 754 of file x509cert.cpp.

References extended_key_usage().

Referenced by to_string().

755  {
756  return lookup_oids(extended_key_usage());
757  }
const std::vector< OID > & extended_key_usage() const
Definition: x509cert.cpp:512
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 512 of file x509cert.cpp.

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

513  {
514  return data().m_extended_key_usage;
515  }
std::string Botan::X509_Certificate::fingerprint ( const std::string &  hash_name = "SHA-1") const
Returns
a fingerprint of the certificate
Parameters
hash_namehash function used to calculate the fingerprint

Definition at line 767 of file x509cert.cpp.

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

Referenced by Botan::Certificate_Store_In_SQL::affirm_cert(), 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().

768  {
769  /*
770  * The SHA-1 and SHA-256 fingerprints are precomputed since these
771  * are the most commonly used. Especially, SHA-256 fingerprints are
772  * used for cycle detection during path construction.
773  *
774  * If SHA-1 or SHA-256 was missing at parsing time the vectors are
775  * left empty in which case we fall back to create_hex_fingerprint
776  * which will throw if the hash is unavailable.
777  */
778  if(hash_name == "SHA-256" && data().m_fingerprint_sha256.size() > 0)
779  return data().m_fingerprint_sha256;
780  else if(hash_name == "SHA-1" && data().m_fingerprint_sha1.size() > 0)
781  return data().m_fingerprint_sha1;
782  else
783  return create_hex_fingerprint(this->BER_encode(), hash_name);
784  }
std::vector< uint8_t > BER_encode() const
Definition: asn1_obj.cpp:16
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17
bool Botan::X509_Certificate::has_constraints ( Key_Constraints  constraints) const

Returns true if the specified

Parameters
constraintsare included in the key usage extension.

Definition at line 584 of file x509cert.cpp.

References constraints(), and Botan::NO_CONSTRAINTS.

585  {
586  if(this->constraints() == NO_CONSTRAINTS)
587  {
588  return false;
589  }
590 
591  return ((this->constraints() & constraints) != 0);
592  }
Key_Constraints constraints() const
Definition: x509cert.cpp:507
bool Botan::X509_Certificate::has_ex_constraint ( const std::string &  ex_constraint) const

Returns true if and only if

Parameters
ex_constraint(referring to an extended key constraint, eg "PKIX.ServerAuth") is included in the extended key extension.

Definition at line 594 of file x509cert.cpp.

References Botan::OID::from_string().

595  {
596  return has_ex_constraint(OID::from_string(ex_constraint));
597  }
bool has_ex_constraint(const std::string &ex_constraint) const
Definition: x509cert.cpp:594
static OID from_string(const std::string &str)
Definition: asn1_oid.cpp:62
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 599 of file x509cert.cpp.

References extended_key_usage().

600  {
601  const std::vector<OID>& ex = extended_key_usage();
602  return (std::find(ex.begin(), ex.end(), usage) != ex.end());
603  }
const std::vector< OID > & extended_key_usage() const
Definition: x509cert.cpp:512
std::string Botan::X509_Object::hash_used_for_signature ( ) const
inherited
Returns
hash algorithm that was used to generate signature

Definition at line 138 of file x509_obj.cpp.

References Botan::AlgorithmIdentifier::get_oid(), Botan::parse_algorithm_name(), Botan::X509_Object::signature_algorithm(), Botan::split_on(), Botan::OID::to_formatted_string(), and Botan::OID::to_string().

139  {
140  const OID& oid = m_sig_algo.get_oid();
141  const std::vector<std::string> sig_info = split_on(oid.to_formatted_string(), '/');
142 
143  if(sig_info.size() == 1 && sig_info[0] == "Ed25519")
144  return "SHA-512";
145  else if(sig_info.size() != 2)
146  throw Internal_Error("Invalid name format found for " + oid.to_string());
147 
148  if(sig_info[1] == "EMSA4")
149  {
150  const OID hash_oid = decode_pss_params(signature_algorithm().get_parameters()).hash_algo.get_oid();
151  return hash_oid.to_formatted_string();
152  }
153  else
154  {
155  const std::vector<std::string> pad_and_hash =
156  parse_algorithm_name(sig_info[1]);
157 
158  if(pad_and_hash.size() != 2)
159  {
160  throw Internal_Error("Invalid name format " + sig_info[1]);
161  }
162 
163  return pad_and_hash[1];
164  }
165  }
std::vector< std::string > split_on(const std::string &str, char delim)
Definition: parsing.cpp:148
const AlgorithmIdentifier & signature_algorithm() const
Definition: x509_obj.h:47
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition: parsing.cpp:95
const OID & get_oid() const
Definition: asn1_obj.h:445
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 491 of file x509cert.cpp.

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

492  {
493  if(data().m_version < 3 && data().m_self_signed)
494  return true;
495 
496  return data().m_is_ca_certificate;
497  }
bool Botan::X509_Certificate::is_critical ( const std::string &  ex_name) const

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

Definition at line 608 of file x509cert.cpp.

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

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

609  {
611  }
bool critical_extension_set(const OID &oid) const
Definition: x509_ext.cpp:182
const Extensions & v3_extensions() const
Definition: x509cert.cpp:527
static OID from_string(const std::string &str)
Definition: asn1_oid.cpp:62
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 397 of file x509cert.cpp.

398  {
399  return data().m_self_signed;
400  }
bool Botan::X509_Certificate::is_serial_negative ( ) const

Get the serial number's sign

Returns
1 iff the serial is negative.

Definition at line 465 of file x509cert.cpp.

466  {
467  return data().m_serial_negative;
468  }
const AlternativeName & Botan::X509_Certificate::issuer_alt_name ( ) const

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

Definition at line 636 of file x509cert.cpp.

Referenced by issuer_info().

637  {
638  return data().m_issuer_alt_name;
639  }
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 471 of file x509cert.cpp.

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

472  {
473  return data().m_issuer_dn;
474  }
std::vector< std::string > Botan::X509_Certificate::issuer_info ( const std::string &  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 680 of file x509cert.cpp.

References authority_key_id(), Botan::X509_DN::get_attribute(), Botan::AlternativeName::get_attribute(), Botan::hex_encode(), issuer_alt_name(), issuer_dn(), raw_issuer_dn(), and v2_issuer_key_id().

681  {
682  if(issuer_dn().has_field(req))
683  return issuer_dn().get_attribute(req);
684 
685  if(issuer_alt_name().has_field(req))
686  return issuer_alt_name().get_attribute(req);
687 
688  // These will be removed later:
689  if(req == "X509.Certificate.v2.key_id")
690  return {hex_encode(this->v2_issuer_key_id())};
691  if(req == "X509v3.AuthorityKeyIdentifier")
692  return {hex_encode(this->authority_key_id())};
693  if(req == "X509.Certificate.dn_bits")
694  return {hex_encode(this->raw_issuer_dn())};
695 
696  return data().m_issuer_ds.get(req);
697  }
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:31
const std::vector< uint8_t > & authority_key_id() const
Definition: x509cert.cpp:450
const std::vector< uint8_t > & v2_issuer_key_id() const
Definition: x509cert.cpp:417
const X509_DN & issuer_dn() const
Definition: x509cert.cpp:471
const AlternativeName & issuer_alt_name() const
Definition: x509cert.cpp:636
std::vector< std::string > get_attribute(const std::string &attr) const
Definition: x509_dn.cpp:109
const std::vector< uint8_t > & raw_issuer_dn() const
Definition: x509cert.cpp:481
std::vector< std::string > get_attribute(const std::string &attr) const
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 52 of file x509_obj.cpp.

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(), X509_Certificate(), and Botan::X509_CRL::X509_CRL().

53  {
54  try {
55  if(ASN1::maybe_BER(in) && !PEM_Code::matches(in))
56  {
57  BER_Decoder dec(in);
58  decode_from(dec);
59  }
60  else
61  {
62  std::string got_label;
63  DataSource_Memory ber(PEM_Code::decode(in, got_label));
64 
65  if(got_label != PEM_label())
66  {
67  bool is_alternate = false;
68  for(std::string alt_label : alternate_PEM_labels())
69  {
70  if(got_label == alt_label)
71  {
72  is_alternate = true;
73  break;
74  }
75  }
76 
77  if(!is_alternate)
78  throw Decoding_Error("Unexpected PEM label for " + PEM_label() + " of " + got_label);
79  }
80 
81  BER_Decoder dec(ber);
82  decode_from(dec);
83  }
84  }
85  catch(Decoding_Error& e)
86  {
87  throw Decoding_Error(PEM_label() + " decoding", e);
88  }
89  }
virtual std::string PEM_label() const =0
bool maybe_BER(DataSource &source)
Definition: asn1_obj.cpp:222
virtual std::vector< std::string > alternate_PEM_labels() const
Definition: x509_obj.h:113
void decode_from(class BER_Decoder &from) override
Definition: x509_obj.cpp:106
bool matches(DataSource &source, const std::string &extra, size_t search_range)
Definition: pem.cpp:142
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
Definition: pem.cpp:68
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 702 of file x509cert.cpp.

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

Referenced by subject_public_key().

703  {
704  try
705  {
706  return std::unique_ptr<Public_Key>(X509::load_key(subject_public_key_info()));
707  }
708  catch(std::exception& e)
709  {
710  throw Decoding_Error("X509_Certificate::load_subject_public_key", e);
711  }
712  }
const std::vector< uint8_t > & subject_public_key_info() const
Definition: x509cert.cpp:432
Public_Key * load_key(DataSource &source)
Definition: x509_key.cpp:37
std::vector< uint8_t > Botan::X509_Object::make_signed ( class 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 303 of file x509_obj.cpp.

References Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::raw_bytes(), Botan::SEQUENCE, Botan::PK_Signer::sign_message(), Botan::X509_Object::signature(), and Botan::DER_Encoder::start_cons().

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

307  {
308  const std::vector<uint8_t> signature = signer->sign_message(tbs_bits, rng);
309 
310  std::vector<uint8_t> output;
311  DER_Encoder(output)
312  .start_cons(SEQUENCE)
313  .raw_bytes(tbs_bits)
314  .encode(algo)
315  .encode(signature, BIT_STRING)
316  .end_cons();
317 
318  return output;
319  }
const std::vector< uint8_t > & signature() const
Definition: x509_obj.h:37
bool Botan::X509_Certificate::matches_dns_name ( const std::string &  name) const

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

Parameters
nameDNS name to match

Definition at line 786 of file x509cert.cpp.

References Botan::host_wildcard_match(), and subject_info().

Referenced by botan_x509_cert_hostname_match().

787  {
788  if(name.empty())
789  return false;
790 
791  std::vector<std::string> issued_names = subject_info("DNS");
792 
793  // Fall back to CN only if no DNS names are set (RFC 6125 sec 6.4.4)
794  if(issued_names.empty())
795  issued_names = subject_info("Name");
796 
797  for(size_t i = 0; i != issued_names.size(); ++i)
798  {
799  if(host_wildcard_match(issued_names[i], name))
800  return true;
801  }
802 
803  return false;
804  }
bool host_wildcard_match(const std::string &issued_, const std::string &host_)
Definition: parsing.cpp:339
std::string name
std::vector< std::string > subject_info(const std::string &name) const
Definition: x509cert.cpp:645
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 522 of file x509cert.cpp.

Referenced by to_string().

523  {
524  return data().m_name_constraints;
525  }
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 407 of file x509cert.cpp.

Referenced by botan_x509_cert_not_after(), subject_info(), and to_string().

408  {
409  return data().m_not_after;
410  }
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 402 of file x509cert.cpp.

Referenced by botan_x509_cert_not_before(), subject_info(), and to_string().

403  {
404  return data().m_not_before;
405  }
std::string Botan::X509_Certificate::ocsp_responder ( ) const

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

Definition at line 613 of file x509cert.cpp.

Referenced by to_string().

614  {
615  return data().m_ocsp_responder;
616  }
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 816 of file x509cert.cpp.

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

817  {
818  /* If signature values are not equal, sort by lexicographic ordering of that */
819  if(this->signature() != other.signature())
820  {
821  return (this->signature() < other.signature());
822  }
823 
824  // Then compare the signed contents
825  return this->signed_body() < other.signed_body();
826  }
const std::vector< uint8_t > & signed_body() const
Definition: x509_obj.h:42
const std::vector< uint8_t > & signature() const
Definition: x509_obj.h:37
X509_Certificate& Botan::X509_Certificate::operator= ( const X509_Certificate other)
default
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 809 of file x509cert.cpp.

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

810  {
811  return (this->signature() == other.signature() &&
812  this->signature_algorithm() == other.signature_algorithm() &&
813  this->signed_body() == other.signed_body());
814  }
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
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 499 of file x509cert.cpp.

500  {
501  if(data().m_version < 3 && data().m_self_signed)
502  return 32; // in theory infinite, but this is more than enough
503 
504  return static_cast<uint32_t>(data().m_path_len_constraint);
505  }
std::string Botan::X509_Object::PEM_encode ( ) const
inherited
Returns
PEM encoding of this

Definition at line 122 of file x509_obj.cpp.

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

123  {
125  }
virtual std::string PEM_label() const =0
std::string encode(const uint8_t der[], size_t length, const std::string &label, size_t width)
Definition: pem.cpp:43
std::vector< uint8_t > BER_encode() const
Definition: asn1_obj.cpp:16
std::vector< std::string > Botan::X509_Certificate::policies ( ) const

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

Returns
certificate policies

Definition at line 762 of file x509cert.cpp.

References certificate_policy_oids().

Referenced by to_string().

763  {
764  return lookup_oids(certificate_policy_oids());
765  }
const std::vector< OID > & certificate_policy_oids() const
Definition: x509cert.cpp:517
const std::vector< uint8_t > & Botan::X509_Certificate::raw_issuer_dn ( ) const

Raw issuer DN bits

Definition at line 481 of file x509cert.cpp.

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

482  {
483  return data().m_issuer_dn_bits;
484  }
std::vector< uint8_t > Botan::X509_Certificate::raw_issuer_dn_sha256 ( ) const

SHA-256 of Raw issuer DN

Definition at line 719 of file x509cert.cpp.

720  {
721  if(data().m_issuer_dn_bits_sha256.empty())
722  throw Encoding_Error("X509_Certificate::raw_issuer_dn_sha256 called but SHA-256 disabled in build");
723  return data().m_issuer_dn_bits_sha256;
724  }
const std::vector< uint8_t > & Botan::X509_Certificate::raw_subject_dn ( ) const

Raw subject DN

Definition at line 486 of file x509cert.cpp.

Referenced by Botan::OCSP::CertID::CertID(), and subject_info().

487  {
488  return data().m_subject_dn_bits;
489  }
std::vector< uint8_t > Botan::X509_Certificate::raw_subject_dn_sha256 ( ) const

SHA-256 of Raw subject DN

Definition at line 726 of file x509cert.cpp.

727  {
728  if(data().m_subject_dn_bits_sha256.empty())
729  throw Encoding_Error("X509_Certificate::raw_subject_dn_sha256 called but SHA-256 disabled in build");
730  return data().m_subject_dn_bits_sha256;
731  }
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 460 of file x509cert.cpp.

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

461  {
462  return data().m_serial;
463  }
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.

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

37 { return m_sig; }
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.

Referenced by Botan::X509_Object::encode_into(), Botan::X509_Object::hash_used_for_signature(), operator==(), to_string(), Botan::X509_Object::verify_signature(), and Botan::X509_CA::X509_CA().

47 { return m_sig_algo; }
const std::vector<uint8_t>& Botan::X509_Object::signed_body ( ) const
inlineinherited
Returns
signed body

Definition at line 42 of file x509_obj.h.

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

42 { return m_tbs_bits; }
std::string Botan::X509_Certificate::start_time ( ) const
inline

Get the notBefore of the certificate as a string

Returns
notBefore of the certificate

Definition at line 154 of file x509cert.h.

155  {
156  return not_before().to_string();
157  }
const X509_Time & not_before() const
Definition: x509cert.cpp:402
std::string to_string() const
Return an internal string representation of the time.
Definition: asn1_time.cpp:53
const AlternativeName & Botan::X509_Certificate::subject_alt_name ( ) const

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

Definition at line 631 of file x509cert.cpp.

Referenced by Botan::GeneralName::matches(), and subject_info().

632  {
633  return data().m_subject_alt_name;
634  }
const X509_DN & Botan::X509_Certificate::subject_dn ( ) const

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

Returns
subject DN of this certificate

Definition at line 476 of file x509cert.cpp.

Referenced by Botan::Certificate_Store_Windows::all_subjects(), Botan::Certificate_Store::certificate_known(), Botan::Certificate_Store_In_SQL::insert_cert(), Botan::GeneralName::matches(), Botan::Certificate_Store_In_SQL::remove_cert(), Botan::OCSP::Request::Request(), Botan::X509_CA::sign_request(), subject_info(), and to_string().

477  {
478  return data().m_subject_dn;
479  }
std::vector< std::string > Botan::X509_Certificate::subject_info ( const std::string &  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 645 of file x509cert.cpp.

References Botan::X509_DN::get_attribute(), Botan::AlternativeName::get_attribute(), Botan::hex_encode(), not_after(), not_before(), raw_subject_dn(), serial_number(), subject_alt_name(), subject_dn(), subject_key_id(), Botan::ASN1::to_string(), Botan::ASN1_Time::to_string(), v2_subject_key_id(), and x509_version().

Referenced by matches_dns_name().

646  {
647  if(req == "Email")
648  return this->subject_info("RFC822");
649 
650  if(subject_dn().has_field(req))
651  return subject_dn().get_attribute(req);
652 
653  if(subject_alt_name().has_field(req))
654  return subject_alt_name().get_attribute(req);
655 
656  // These will be removed later:
657  if(req == "X509.Certificate.v2.key_id")
658  return {hex_encode(this->v2_subject_key_id())};
659  if(req == "X509v3.SubjectKeyIdentifier")
660  return {hex_encode(this->subject_key_id())};
661  if(req == "X509.Certificate.dn_bits")
662  return {hex_encode(this->raw_subject_dn())};
663  if(req == "X509.Certificate.start")
664  return {not_before().to_string()};
665  if(req == "X509.Certificate.end")
666  return {not_after().to_string()};
667 
668  if(req == "X509.Certificate.version")
669  return {std::to_string(x509_version())};
670  if(req == "X509.Certificate.serial")
671  return {hex_encode(serial_number())};
672 
673  return data().m_subject_ds.get(req);
674  }
const AlternativeName & subject_alt_name() const
Definition: x509cert.cpp:631
const std::vector< uint8_t > & subject_key_id() const
Definition: x509cert.cpp:455
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:31
const std::vector< uint8_t > & serial_number() const
Definition: x509cert.cpp:460
const std::vector< uint8_t > & v2_subject_key_id() const
Definition: x509cert.cpp:422
const X509_Time & not_before() const
Definition: x509cert.cpp:402
std::string to_string() const
Return an internal string representation of the time.
Definition: asn1_time.cpp:53
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:213
const std::vector< uint8_t > & raw_subject_dn() const
Definition: x509cert.cpp:486
const X509_Time & not_after() const
Definition: x509cert.cpp:407
uint32_t x509_version() const
Definition: x509cert.cpp:392
std::vector< std::string > get_attribute(const std::string &attr) const
Definition: x509_dn.cpp:109
std::vector< std::string > subject_info(const std::string &name) const
Definition: x509cert.cpp:645
const X509_DN & subject_dn() const
Definition: x509cert.cpp:476
std::vector< std::string > get_attribute(const std::string &attr) const
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 455 of file x509cert.cpp.

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

456  {
457  return data().m_subject_key_id;
458  }
Public_Key * Botan::X509_Certificate::subject_public_key ( ) const

Return a newly allocated copy of the public key associated with the subject of this certificate. This object is owned by the caller.

Prefer load_subject_public_key in new code

Returns
public key

Definition at line 714 of file x509cert.cpp.

References load_subject_public_key().

Referenced by to_string(), Botan::TLS::Certificate_Verify::verify(), and Botan::OCSP::Response::verify_signature().

715  {
716  return load_subject_public_key().release();
717  }
std::unique_ptr< Public_Key > load_subject_public_key() const
Definition: x509cert.cpp:702
const AlgorithmIdentifier & Botan::X509_Certificate::subject_public_key_algo ( ) const

Return the algorithm identifier of the public key

Definition at line 412 of file x509cert.cpp.

Referenced by to_string().

413  {
414  return data().m_subject_public_key_algid;
415  }
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 427 of file x509cert.cpp.

428  {
429  return data().m_subject_public_key_bits;
430  }
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 437 of file x509cert.cpp.

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

438  {
439  return data().m_subject_public_key_bitstring;
440  }
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 442 of file x509cert.cpp.

443  {
444  if(data().m_subject_public_key_bitstring_sha1.empty())
445  throw Encoding_Error("X509_Certificate::subject_public_key_bitstring_sha1 called but SHA-1 disabled in build");
446 
447  return data().m_subject_public_key_bitstring_sha1;
448  }
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 432 of file x509cert.cpp.

Referenced by load_subject_public_key().

433  {
434  return data().m_subject_public_key_bits_seq;
435  }
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 130 of file x509_obj.cpp.

References Botan::ASN1::put_in_sequence().

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

131  {
132  return ASN1::put_in_sequence(m_tbs_bits);
133  }
std::vector< uint8_t > put_in_sequence(const std::vector< uint8_t > &contents)
Definition: asn1_obj.cpp:195
std::string Botan::X509_Certificate::to_string ( ) const
Returns
a free-form string describing the certificate

Definition at line 836 of file x509cert.cpp.

References authority_key_id(), ca_issuers(), certificate_policy_oids(), constraints(), crl_distribution_point(), Botan::CRL_SIGN, Botan::DATA_ENCIPHERMENT, Botan::DECIPHER_ONLY, Botan::DIGITAL_SIGNATURE, Botan::ENCIPHER_ONLY, ex_constraints(), Botan::NameConstraints::excluded(), extended_key_usage(), Botan::AlgorithmIdentifier::get_oid(), Botan::hex_encode(), issuer_dn(), Botan::KEY_AGREEMENT, Botan::KEY_CERT_SIGN, Botan::KEY_ENCIPHERMENT, name_constraints(), Botan::NO_CONSTRAINTS, Botan::NON_REPUDIATION, not_after(), not_before(), ocsp_responder(), Botan::X509::PEM_encode(), Botan::NameConstraints::permitted(), policies(), Botan::ASN1_Time::readable_string(), serial_number(), Botan::X509_Object::signature_algorithm(), subject_dn(), subject_key_id(), subject_public_key(), subject_public_key_algo(), Botan::OID::to_formatted_string(), Botan::OID::to_string(), and x509_version().

837  {
838  std::ostringstream out;
839 
840  out << "Version: " << this->x509_version() << "\n";
841  out << "Subject: " << subject_dn() << "\n";
842  out << "Issuer: " << issuer_dn() << "\n";
843  out << "Issued: " << this->not_before().readable_string() << "\n";
844  out << "Expires: " << this->not_after().readable_string() << "\n";
845 
846  out << "Constraints:\n";
848  if(constraints == NO_CONSTRAINTS)
849  out << " None\n";
850  else
851  {
852  if(constraints & DIGITAL_SIGNATURE)
853  out << " Digital Signature\n";
854  if(constraints & NON_REPUDIATION)
855  out << " Non-Repudiation\n";
856  if(constraints & KEY_ENCIPHERMENT)
857  out << " Key Encipherment\n";
858  if(constraints & DATA_ENCIPHERMENT)
859  out << " Data Encipherment\n";
860  if(constraints & KEY_AGREEMENT)
861  out << " Key Agreement\n";
862  if(constraints & KEY_CERT_SIGN)
863  out << " Cert Sign\n";
864  if(constraints & CRL_SIGN)
865  out << " CRL Sign\n";
866  if(constraints & ENCIPHER_ONLY)
867  out << " Encipher Only\n";
868  if(constraints & DECIPHER_ONLY)
869  out << " Decipher Only\n";
870  }
871 
872  const std::vector<OID>& policies = this->certificate_policy_oids();
873  if(!policies.empty())
874  {
875  out << "Policies: " << "\n";
876  for(auto oid : policies)
877  out << " " << oid.to_string() << "\n";
878  }
879 
880  const std::vector<OID>& ex_constraints = this->extended_key_usage();
881  if(!ex_constraints.empty())
882  {
883  out << "Extended Constraints:\n";
884  for(auto&& oid : ex_constraints)
885  {
886  out << " " << oid.to_formatted_string() << "\n";
887  }
888  }
889 
890  const NameConstraints& name_constraints = this->name_constraints();
891 
892  if(!name_constraints.permitted().empty() || !name_constraints.excluded().empty())
893  {
894  out << "Name Constraints:\n";
895 
896  if(!name_constraints.permitted().empty())
897  {
898  out << " Permit";
899  for(auto st: name_constraints.permitted())
900  {
901  out << " " << st.base();
902  }
903  out << "\n";
904  }
905 
906  if(!name_constraints.excluded().empty())
907  {
908  out << " Exclude";
909  for(auto st: name_constraints.excluded())
910  {
911  out << " " << st.base();
912  }
913  out << "\n";
914  }
915  }
916 
917  if(!ocsp_responder().empty())
918  out << "OCSP responder " << ocsp_responder() << "\n";
919 
920  const std::vector<std::string> ca_issuers = this->ca_issuers();
921  if(!ca_issuers.empty())
922  {
923  out << "CA Issuers:\n";
924  for(size_t i = 0; i != ca_issuers.size(); i++)
925  out << " URI: " << ca_issuers[i] << "\n";
926  }
927 
928  if(!crl_distribution_point().empty())
929  out << "CRL " << crl_distribution_point() << "\n";
930 
931  out << "Signature algorithm: " << this->signature_algorithm().get_oid().to_formatted_string() << "\n";
932 
933  out << "Serial number: " << hex_encode(this->serial_number()) << "\n";
934 
935  if(this->authority_key_id().size())
936  out << "Authority keyid: " << hex_encode(this->authority_key_id()) << "\n";
937 
938  if(this->subject_key_id().size())
939  out << "Subject keyid: " << hex_encode(this->subject_key_id()) << "\n";
940 
941  try
942  {
943  std::unique_ptr<Public_Key> pubkey(this->subject_public_key());
944  out << "Public Key [" << pubkey->algo_name() << "-" << pubkey->key_length() << "]\n\n";
945  out << X509::PEM_encode(*pubkey);
946  }
947  catch(Decoding_Error&)
948  {
949  const AlgorithmIdentifier& alg_id = this->subject_public_key_algo();
950  out << "Failed to decode key with oid " << alg_id.get_oid().to_string() << "\n";
951  }
952 
953  return out.str();
954  }
const std::vector< uint8_t > & subject_key_id() const
Definition: x509cert.cpp:455
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:31
const std::vector< uint8_t > & serial_number() const
Definition: x509cert.cpp:460
std::vector< std::string > ca_issuers() const
Definition: x509cert.cpp:618
const AlgorithmIdentifier & subject_public_key_algo() const
Definition: x509cert.cpp:412
std::string PEM_encode(const Public_Key &key)
Definition: x509_key.cpp:28
const X509_Time & not_before() const
Definition: x509cert.cpp:402
const std::vector< uint8_t > & authority_key_id() const
Definition: x509cert.cpp:450
std::string ocsp_responder() const
Definition: x509cert.cpp:613
Key_Constraints constraints() const
Definition: x509cert.cpp:507
std::string to_formatted_string() const
Definition: asn1_oid.cpp:111
std::string crl_distribution_point() const
Definition: x509cert.cpp:623
const AlgorithmIdentifier & signature_algorithm() const
Definition: x509_obj.h:47
const std::vector< OID > & certificate_policy_oids() const
Definition: x509cert.cpp:517
const std::vector< OID > & extended_key_usage() const
Definition: x509cert.cpp:512
const X509_DN & issuer_dn() const
Definition: x509cert.cpp:471
const X509_Time & not_after() const
Definition: x509cert.cpp:407
const OID & get_oid() const
Definition: asn1_obj.h:445
uint32_t x509_version() const
Definition: x509cert.cpp:392
std::vector< std::string > policies() const
Definition: x509cert.cpp:762
const NameConstraints & name_constraints() const
Definition: x509cert.cpp:522
std::vector< std::string > ex_constraints() const
Definition: x509cert.cpp:754
std::string readable_string() const
Returns a human friendly string replesentation of no particular formatting.
Definition: asn1_time.cpp:93
Public_Key * subject_public_key() const
Definition: x509cert.cpp:714
const X509_DN & subject_dn() const
Definition: x509cert.cpp:476
Key_Constraints
Definition: pkix_enums.h:106
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 417 of file x509cert.cpp.

Referenced by issuer_info().

418  {
419  return data().m_v2_issuer_key_id;
420  }
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 422 of file x509cert.cpp.

Referenced by subject_info().

423  {
424  return data().m_v2_subject_key_id;
425  }
const Extensions & Botan::X509_Certificate::v3_extensions ( ) const

Get all extensions of this certificate.

Returns
certificate extensions

Definition at line 527 of file x509cert.cpp.

Referenced by is_critical().

528  {
529  return data().m_v3_extensions;
530  }
Certificate_Status_Code 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.

Definition at line 184 of file x509_obj.cpp.

References Botan::Public_Key::algo_name(), Botan::Public_Key::default_x509_signature_format(), Botan::AlgorithmIdentifier::get_oid(), hash_algo, Botan::X509_Object::signature(), Botan::SIGNATURE_ALGO_BAD_PARAMS, Botan::SIGNATURE_ALGO_UNKNOWN, Botan::X509_Object::signature_algorithm(), Botan::SIGNATURE_ERROR, Botan::split_on(), Botan::X509_Object::tbs_data(), Botan::OID::to_formatted_string(), Botan::ASN1::to_string(), Botan::UNTRUSTED_HASH, Botan::VERIFIED, and Botan::PK_Verifier::verify_message().

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

185  {
186  const std::vector<std::string> sig_info =
187  split_on(m_sig_algo.get_oid().to_formatted_string(), '/');
188 
189  if(sig_info.size() < 1 || sig_info.size() > 2 || sig_info[0] != pub_key.algo_name())
191 
192  const std::string pub_key_algo = sig_info[0];
193  std::string padding;
194  if(sig_info.size() == 2)
195  padding = sig_info[1];
196  else if(pub_key_algo == "Ed25519" || pub_key_algo == "XMSS")
197  padding = "Pure";
198  else
200 
201  const Signature_Format format = pub_key.default_x509_signature_format();
202 
203  if(padding == "EMSA4")
204  {
205  // "MUST contain RSASSA-PSS-params"
206  if(signature_algorithm().get_parameters().empty())
207  {
209  }
210 
211  Pss_params pss_parameter = decode_pss_params(signature_algorithm().get_parameters());
212 
213  // hash_algo must be SHA1, SHA2-224, SHA2-256, SHA2-384 or SHA2-512
214  const std::string hash_algo = pss_parameter.hash_algo.get_oid().to_formatted_string();
215  if(hash_algo != "SHA-160" &&
216  hash_algo != "SHA-224" &&
217  hash_algo != "SHA-256" &&
218  hash_algo != "SHA-384" &&
219  hash_algo != "SHA-512")
220  {
222  }
223 
224  const std::string mgf_algo = pss_parameter.mask_gen_algo.get_oid().to_formatted_string();
225  if(mgf_algo != "MGF1")
226  {
228  }
229 
230  // For MGF1, it is strongly RECOMMENDED that the underlying hash function be the same as the one identified by hashAlgorithm
231  // Must be SHA1, SHA2-224, SHA2-256, SHA2-384 or SHA2-512
232  if(pss_parameter.mask_gen_hash.get_oid() != pss_parameter.hash_algo.get_oid())
233  {
235  }
236 
237  if(pss_parameter.trailer_field != 1)
238  {
240  }
241 
242  padding += "(" + hash_algo + "," + mgf_algo + "," + std::to_string(pss_parameter.salt_len) + ")";
243  }
244  else
245  {
246  /*
247  * For all other signature types the signature parameters should
248  * be either NULL or empty. In theory there is some distinction between
249  * these but in practice they seem to be used somewhat interchangeably.
250  *
251  * The various RFCs all have prescriptions of what is allowed:
252  * RSA - NULL (RFC 3279)
253  * DSA - empty (RFC 3279)
254  * ECDSA - empty (RFC 3279)
255  * GOST - empty (RFC 4491)
256  * Ed25519 - empty (RFC 8410)
257  * XMSS - empty (draft-vangeest-x509-hash-sigs)
258  *
259  * But in practice we find RSA with empty and ECDSA will NULL all
260  * over the place so it's not really possible to enforce. For Ed25519
261  * and XMSS because they are new we attempt to enforce.
262  */
263  if(pub_key_algo == "Ed25519" || pub_key_algo == "XMSS")
264  {
265  if(!signature_algorithm().parameters_are_empty())
266  {
268  }
269  }
270  else
271  {
272  if(!signature_algorithm().parameters_are_null_or_empty())
273  {
275  }
276  }
277  }
278 
279  try
280  {
281  PK_Verifier verifier(pub_key, padding, format);
282  const bool valid = verifier.verify_message(tbs_data(), signature());
283 
284  if(valid)
286  else
288  }
289  catch(Algorithm_Not_Found&)
290  {
292  }
293  catch(...)
294  {
295  // This shouldn't happen, fallback to generic signature error
297  }
298  }
std::vector< std::string > split_on(const std::string &str, char delim)
Definition: parsing.cpp:148
Signature_Format
Definition: pk_keys.h:23
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:213
std::string to_formatted_string() const
Definition: asn1_oid.cpp:111
const AlgorithmIdentifier & signature_algorithm() const
Definition: x509_obj.h:47
const std::vector< uint8_t > & signature() const
Definition: x509_obj.h:37
const OID & get_oid() const
Definition: asn1_obj.h:445
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:22
std::vector< uint8_t > tbs_data() const
Definition: x509_obj.cpp:130
uint32_t Botan::X509_Certificate::x509_version ( ) const

Get the X509 version of this certificate object.

Returns
X509 version

Definition at line 392 of file x509cert.cpp.

Referenced by subject_info(), and to_string().

393  {
394  return static_cast<uint32_t>(data().m_version);
395  }

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