9 #include <botan/x509cert.h>
10 #include <botan/datastor.h>
11 #include <botan/pk_keys.h>
12 #include <botan/x509_ext.h>
13 #include <botan/ber_dec.h>
14 #include <botan/parsing.h>
15 #include <botan/bigint.h>
16 #include <botan/oids.h>
17 #include <botan/hash.h>
18 #include <botan/hex.h>
24 struct X509_Certificate_Data
26 std::vector<uint8_t> m_serial;
27 AlgorithmIdentifier m_sig_algo_inner;
30 std::vector<uint8_t> m_issuer_dn_bits;
31 std::vector<uint8_t> m_subject_dn_bits;
32 X509_Time m_not_before;
33 X509_Time m_not_after;
34 std::vector<uint8_t> m_subject_public_key_bits;
35 std::vector<uint8_t> m_subject_public_key_bits_seq;
36 std::vector<uint8_t> m_subject_public_key_bitstring;
37 std::vector<uint8_t> m_subject_public_key_bitstring_sha1;
38 AlgorithmIdentifier m_subject_public_key_algid;
40 std::vector<uint8_t> m_v2_issuer_key_id;
41 std::vector<uint8_t> m_v2_subject_key_id;
42 Extensions m_v3_extensions;
44 std::vector<OID> m_extended_key_usage;
45 std::vector<uint8_t> m_authority_key_id;
46 std::vector<uint8_t> m_subject_key_id;
47 std::vector<OID> m_cert_policies;
49 std::vector<std::string> m_crl_distribution_points;
50 std::string m_ocsp_responder;
51 std::vector<std::string> m_ca_issuers;
53 AlternativeName m_subject_alt_name;
54 AlternativeName m_issuer_alt_name;
55 NameConstraints m_name_constraints;
57 Data_Store m_subject_ds;
58 Data_Store m_issuer_ds;
61 size_t m_path_len_constraint = 0;
63 bool m_self_signed =
false;
64 bool m_is_ca_certificate =
false;
65 bool m_serial_negative =
false;
68 std::string X509_Certificate::PEM_label()
const
73 std::vector<std::string> X509_Certificate::alternate_PEM_labels()
const
75 return {
"X509 CERTIFICATE" };
95 #if defined(BOTAN_TARGET_OS_HAS_FILESYSTEM)
105 std::unique_ptr<X509_Certificate_Data> parse_x509_cert_body(
const X509_Object& obj)
107 std::unique_ptr<X509_Certificate_Data> data(
new X509_Certificate_Data);
110 BER_Object public_key;
111 BER_Object v3_exts_data;
113 BER_Decoder(obj.signed_body())
116 .decode(data->m_sig_algo_inner)
117 .decode(data->m_issuer_dn)
119 .decode(data->m_not_before)
120 .decode(data->m_not_after)
122 .decode(data->m_subject_dn)
123 .get_next(public_key)
124 .decode_optional_string(data->m_v2_issuer_key_id,
BIT_STRING, 1)
125 .decode_optional_string(data->m_v2_subject_key_id,
BIT_STRING, 2)
126 .get_next(v3_exts_data)
127 .verify_end(
"TBSCertificate has extra data after extensions block");
129 if(data->m_version > 2)
130 throw Decoding_Error(
"Unknown X.509 cert version " +
std::to_string(data->m_version));
131 if(obj.signature_algorithm() != data->m_sig_algo_inner)
132 throw Decoding_Error(
"X.509 Certificate had differing algorithm identifers in inner and outer ID fields");
137 data->m_serial_negative = serial_bn.is_negative();
140 data->m_version += 1;
147 AlgorithmIdentifier public_key_alg_id;
148 BER_Decoder(public_key).decode(public_key_alg_id).discard_remaining();
150 const std::vector<std::string> public_key_info =
153 if(!public_key_info.empty() && public_key_info[0] ==
"RSA")
156 if(public_key_info.size() >= 2)
158 if(public_key_info[1] ==
"EMSA4")
174 if(public_key_alg_id != obj.signature_algorithm())
176 throw Decoding_Error(
"Algorithm identifier mismatch");
185 throw Decoding_Error(
"RSA algorithm parameters field MUST contain NULL");
190 data->m_subject_public_key_bits.assign(public_key.bits(), public_key.bits() + public_key.length());
194 BER_Decoder(data->m_subject_public_key_bits)
195 .decode(data->m_subject_public_key_algid)
196 .decode(data->m_subject_public_key_bitstring,
BIT_STRING);
201 BER_Decoder(v3_exts_data).decode(data->m_v3_extensions).verify_end();
203 else if(v3_exts_data.is_set())
205 throw BER_Bad_Tag(
"Unknown tag in X.509 cert", v3_exts_data.tagging());
209 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Key_Usage>())
211 data->m_key_constraints = ext->get_constraints();
218 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Subject_Key_ID>())
220 data->m_subject_key_id = ext->get_key_id();
223 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Authority_Key_ID>())
225 data->m_authority_key_id = ext->get_key_id();
228 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Name_Constraints>())
230 data->m_name_constraints = ext->get_name_constraints();
233 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Basic_Constraints>())
235 if(ext->get_is_ca() ==
true)
240 data->m_is_ca_certificate =
true;
241 data->m_path_len_constraint = ext->get_path_limit();
246 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Issuer_Alternative_Name>())
248 data->m_issuer_alt_name = ext->get_alt_name();
251 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Subject_Alternative_Name>())
253 data->m_subject_alt_name = ext->get_alt_name();
256 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Extended_Key_Usage>())
258 data->m_extended_key_usage = ext->get_oids();
261 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Certificate_Policies>())
263 data->m_cert_policies = ext->get_policy_oids();
266 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::Authority_Information_Access>())
268 data->m_ocsp_responder = ext->ocsp_responder();
269 data->m_ca_issuers = ext->ca_issuers();
272 if(
auto ext = data->m_v3_extensions.get_extension_object_as<Cert_Extension::CRL_Distribution_Points>())
274 data->m_crl_distribution_points = ext->crl_distribution_urls();
278 if(data->m_subject_dn == data->m_issuer_dn)
280 if(data->m_subject_key_id.empty() ==
false && data->m_authority_key_id.empty() ==
false)
282 data->m_self_signed = (data->m_subject_key_id == data->m_authority_key_id);
291 data->m_self_signed =
true;
295 std::unique_ptr<Public_Key> pub_key(
X509::load_key(data->m_subject_public_key_bits_seq));
302 data->m_self_signed =
true;
306 data->m_self_signed =
false;
319 sha1->update(data->m_subject_public_key_bitstring);
320 data->m_subject_public_key_bitstring_sha1 = sha1->final_stdvec();
324 data->m_subject_ds.add(data->m_subject_dn.contents());
325 data->m_issuer_ds.add(data->m_issuer_dn.contents());
326 data->m_v3_extensions.contents_to(data->m_subject_ds, data->m_issuer_ds);
336 void X509_Certificate::force_decode()
340 std::unique_ptr<X509_Certificate_Data> data = parse_x509_cert_body(*
this);
342 m_data.reset(data.release());
345 const X509_Certificate_Data& X509_Certificate::data()
const
347 if(m_data ==
nullptr)
349 throw Invalid_State(
"X509_Certificate uninitialized");
351 return *m_data.get();
356 return static_cast<uint32_t
>(data().m_version);
361 return data().m_self_signed;
366 return data().m_not_before;
371 return data().m_not_after;
376 return data().m_subject_public_key_algid;
381 return data().m_v2_issuer_key_id;
386 return data().m_v2_subject_key_id;
391 return data().m_subject_public_key_bits;
396 return data().m_subject_public_key_bits_seq;
401 return data().m_subject_public_key_bitstring;
406 if(data().m_subject_public_key_bitstring_sha1.empty())
407 throw Encoding_Error(
"X509_Certificate::subject_public_key_bitstring_sha1 called but SHA-1 disabled in build");
409 return data().m_subject_public_key_bitstring_sha1;
414 return data().m_authority_key_id;
419 return data().m_subject_key_id;
424 return data().m_serial;
429 return data().m_serial_negative;
435 return data().m_issuer_dn;
440 return data().m_subject_dn;
445 return data().m_issuer_dn_bits;
450 return data().m_subject_dn_bits;
455 if(data().m_version < 3 && data().m_self_signed)
458 return data().m_is_ca_certificate;
463 if(data().m_version < 3 && data().m_self_signed)
466 return static_cast<uint32_t
>(data().m_path_len_constraint);
471 return data().m_key_constraints;
476 return data().m_extended_key_usage;
481 return data().m_cert_policies;
486 return data().m_name_constraints;
491 return data().m_v3_extensions;
512 if(std::find(ex.begin(), ex.end(), usage) != ex.end())
564 return (std::find(ex.begin(), ex.end(), usage) != ex.end());
577 return data().m_ocsp_responder;
582 return data().m_ca_issuers;
588 if(data().m_crl_distribution_points.size() > 0)
589 return data().m_crl_distribution_points[0];
595 return data().m_subject_alt_name;
600 return data().m_issuer_alt_name;
606 std::vector<std::string>
619 if(req ==
"X509.Certificate.v2.key_id")
621 if(req ==
"X509v3.SubjectKeyIdentifier")
623 if(req ==
"X509.Certificate.dn_bits")
625 if(req ==
"X509.Certificate.start")
627 if(req ==
"X509.Certificate.end")
630 if(req ==
"X509.Certificate.version")
632 if(req ==
"X509.Certificate.serial")
635 return data().m_subject_ds.get(req);
641 std::vector<std::string>
651 if(req ==
"X509.Certificate.v2.key_id")
653 if(req ==
"X509v3.AuthorityKeyIdentifier")
655 if(req ==
"X509.Certificate.dn_bits")
658 return data().m_issuer_ds.get(req);
670 catch(std::exception& e)
672 throw Decoding_Error(
"X509_Certificate::load_subject_public_key", e);
680 return hash->final_stdvec();
687 return hash->final_stdvec();
695 std::vector<std::string> lookup_oids(
const std::vector<OID>& oids)
697 std::vector<std::string> out;
699 for(
const OID& oid : oids)
701 out.push_back(oid.to_formatted_string());
734 std::vector<std::string> issued_names =
subject_info(
"DNS");
737 if(issued_names.empty())
740 for(
size_t i = 0; i != issued_names.size(); ++i)
776 return !(cert1 == cert2);
781 std::ostringstream out;
785 out <<
"Issuer: " <<
issuer_dn() <<
"\n";
789 out <<
"Constraints:\n";
796 out <<
" Digital Signature\n";
798 out <<
" Non-Repudiation\n";
800 out <<
" Key Encipherment\n";
802 out <<
" Data Encipherment\n";
804 out <<
" Key Agreement\n";
806 out <<
" Cert Sign\n";
808 out <<
" CRL Sign\n";
810 out <<
" Encipher Only\n";
812 out <<
" Decipher Only\n";
816 if(!policies.empty())
818 out <<
"Policies: " <<
"\n";
819 for(
auto oid : policies)
820 out <<
" " << oid.to_string() <<
"\n";
824 if(!ex_constraints.empty())
826 out <<
"Extended Constraints:\n";
827 for(
auto&& oid : ex_constraints)
829 out <<
" " << oid.to_formatted_string() <<
"\n";
835 if(!name_constraints.
permitted().empty() || !name_constraints.
excluded().empty())
837 out <<
"Name Constraints:\n";
839 if(!name_constraints.
permitted().empty())
842 for(
auto st: name_constraints.
permitted())
844 out <<
" " << st.base();
849 if(!name_constraints.
excluded().empty())
852 for(
auto st: name_constraints.
excluded())
854 out <<
" " << st.base();
864 if(!ca_issuers.empty())
866 out <<
"CA Issuers:\n";
867 for(
size_t i = 0; i != ca_issuers.size(); i++)
868 out <<
" URI: " << ca_issuers[i] <<
"\n";
887 out <<
"Public Key [" << pubkey->algo_name() <<
"-" << pubkey->key_length() <<
"]\n\n";
893 out <<
"Failed to decode key with oid " << alg_id.
get_oid().
to_string() <<
"\n";
const AlternativeName & subject_alt_name() const
const std::vector< uint8_t > & subject_public_key_info() const
const std::vector< uint8_t > & subject_key_id() const
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
bool operator!=(const AlgorithmIdentifier &a1, const AlgorithmIdentifier &a2)
bool operator==(const X509_Certificate &other) const
const std::vector< uint8_t > & serial_number() const
static std::unique_ptr< HashFunction > create_or_throw(const std::string &algo_spec, const std::string &provider="")
const std::vector< uint8_t > & v2_subject_key_id() const
std::vector< std::string > ca_issuers() const
const std::vector< uint8_t > & signed_body() const
const AlgorithmIdentifier & subject_public_key_algo() const
std::string PEM_encode(const Public_Key &key)
std::vector< std::string > split_on(const std::string &str, char delim)
bool is_serial_negative() const
const X509_Time & not_before() const
static std::vector< uint8_t > encode(const BigInt &n)
BOTAN_UNSTABLE_API std::string oid2str_or_empty(const OID &oid)
const std::vector< uint8_t > & authority_key_id() const
bool matches_dns_name(const std::string &name) const
std::string ocsp_responder() const
Key_Constraints constraints() const
const std::vector< GeneralSubtree > & permitted() const
std::string to_string(const BER_Object &obj)
bool allowed_usage(Key_Constraints usage) const
std::string to_formatted_string() const
std::string crl_distribution_point() const
const std::vector< uint8_t > & subject_public_key_bitstring() const
const AlgorithmIdentifier & signature_algorithm() const
const std::vector< uint8_t > & subject_public_key_bits() const
const std::vector< uint8_t > & raw_subject_dn() const
const std::vector< uint8_t > & signature() const
const std::vector< uint8_t > & subject_public_key_bitstring_sha1() const
std::string fingerprint(const std::string &hash_name="SHA-1") const
bool host_wildcard_match(const std::string &issued_, const std::string &host_)
const std::vector< OID > & certificate_policy_oids() const
const std::vector< uint8_t > & v2_issuer_key_id() const
Public_Key * subject_public_key() const
bool critical_extension_set(const OID &oid) const
const std::vector< GeneralSubtree > & excluded() const
const std::vector< OID > & extended_key_usage() const
const X509_DN & issuer_dn() const
std::unique_ptr< Public_Key > load_subject_public_key() const
std::string to_string() const
const X509_Time & not_after() const
const AlternativeName & issuer_alt_name() const
std::string to_string() const
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
bool has_ex_constraint(const std::string &ex_constraint) const
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
std::vector< uint8_t > BER_encode() const
void load_data(DataSource &src)
std::vector< uint8_t > raw_issuer_dn_sha256() const
bool operator<(const X509_Certificate &other) const
const OID & get_oid() const
uint32_t x509_version() const
std::vector< std::string > policies() const
std::vector< std::string > get_attribute(const std::string &attr) const
std::vector< uint8_t > put_in_sequence(const std::vector< uint8_t > &contents)
const std::vector< uint8_t > & raw_issuer_dn() const
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
std::string to_string() const
Return an internal string representation of the time.
const Extensions & v3_extensions() const
std::vector< uint8_t > raw_subject_dn_sha256() const
uint32_t path_limit() const
const NameConstraints & name_constraints() const
bool is_self_signed() const
std::vector< std::string > subject_info(const std::string &name) const
bool is_critical(const std::string &ex_name) const
std::vector< std::string > ex_constraints() const
bool allowed_extended_usage(const std::string &usage) const
std::string readable_string() const
Returns a human friendly string replesentation of no particular formatting.
std::vector< std::string > issuer_info(const std::string &name) const
bool has_constraints(Key_Constraints constraints) const
X509_Certificate()=default
const X509_DN & subject_dn() const
std::vector< std::string > get_attribute(const std::string &attr) const
Public_Key * load_key(DataSource &source)
static OID from_string(const std::string &str)