10#include <botan/x509_ext.h>
11#include <botan/x509cert.h>
12#include <botan/der_enc.h>
13#include <botan/ber_dec.h>
14#include <botan/hash.h>
15#include <botan/internal/loadstor.h>
16#include <botan/internal/bit_ops.h>
25std::unique_ptr<Certificate_Extension>
26extension_from_oid(
const OID& oid)
29 return std::make_unique<Cert_Extension::Subject_Key_ID>();
32 return std::make_unique<Cert_Extension::Key_Usage>();
35 return std::make_unique<Cert_Extension::Subject_Alternative_Name>();
38 return std::make_unique<Cert_Extension::Issuer_Alternative_Name>();
41 return std::make_unique<Cert_Extension::Basic_Constraints>();
44 return std::make_unique<Cert_Extension::CRL_Number>();
47 return std::make_unique<Cert_Extension::CRL_ReasonCode>();
50 return std::make_unique<Cert_Extension::Authority_Key_ID>();
53 return std::make_unique<Cert_Extension::Name_Constraints>();
56 return std::make_unique<Cert_Extension::CRL_Distribution_Points>();
59 return std::make_unique<Cert_Extension::CRL_Issuing_Distribution_Point>();
62 return std::make_unique<Cert_Extension::Certificate_Policies>();
65 return std::make_unique<Cert_Extension::Extended_Key_Usage>();
68 return std::make_unique<Cert_Extension::Authority_Information_Access>();
78std::unique_ptr<Certificate_Extension>
79Extensions::create_extn_obj(
const OID& oid,
81 const std::vector<uint8_t>& body)
83 const std::string oid_str = oid.to_string();
85 auto extn = extension_from_oid(oid);
90 extn = std::make_unique<Cert_Extension::Unknown_Extension>(oid, critical);
95 extn->decode_inner(body);
97 catch(Decoding_Error&)
99 extn = std::make_unique<Cert_Extension::Unknown_Extension>(oid, critical);
100 extn->decode_inner(body);
109 const std::vector<X509_Certificate>& ,
110 std::vector<std::set<Certificate_Status_Code>>& ,
121 if(m_extension_info.contains(extn->oid_of()))
123 const std::string
name = extn->oid_name();
127 const OID oid = extn->oid_of();
128 Extensions_Info info(critical, std::move(extn));
129 m_extension_oids.push_back(oid);
130 m_extension_info.emplace(oid, info);
135 if(m_extension_info.contains(extn->oid_of()))
140 const OID oid = extn->oid_of();
141 Extensions_Info info(critical, std::move(extn));
142 m_extension_oids.push_back(oid);
143 m_extension_info.emplace(oid, info);
149 const bool erased = m_extension_info.erase(oid) > 0;
153 m_extension_oids.erase(std::find(m_extension_oids.begin(), m_extension_oids.end(), oid));
164 const OID oid = extn->oid_of();
165 Extensions_Info info(critical, std::move(extn));
166 m_extension_oids.push_back(oid);
167 m_extension_info.emplace(oid, info);
172 return (m_extension_info.find(oid) != m_extension_info.end());
177 auto i = m_extension_info.find(oid);
178 if(i != m_extension_info.end())
179 return i->second.is_critical();
185 auto i = m_extension_info.find(oid);
186 if(i == m_extension_info.end())
187 throw Invalid_Argument(
"Extensions::get_extension_bits no such extension set");
189 return i->second.bits();
194 auto extn = m_extension_info.find(oid);
195 if(extn == m_extension_info.end())
198 return &extn->second.obj();
212 std::vector<std::pair<std::unique_ptr<Certificate_Extension>,
bool>> exts;
213 exts.reserve(m_extension_info.size());
214 for(
auto&& ext : m_extension_info)
218 ext.second.obj().copy(),
219 ext.second.is_critical())
227 std::map<OID, std::pair<std::vector<uint8_t>,
bool>> out;
228 for(
auto&& ext : m_extension_info)
230 out.emplace(ext.first,
231 std::make_pair(ext.second.bits(),
232 ext.second.is_critical()));
242 for(
const auto& ext_info : m_extension_info)
244 const OID& oid = ext_info.first;
245 const bool should_encode = ext_info.second.obj().should_encode();
249 const bool is_critical = ext_info.second.is_critical();
250 const std::vector<uint8_t>& ext_value = ext_info.second.bits();
266 m_extension_oids.clear();
267 m_extension_info.clear();
275 std::vector<uint8_t> bits;
283 auto obj = create_extn_obj(oid, critical, bits);
284 Extensions_Info info(critical, bits, std::move(obj));
286 m_extension_oids.push_back(oid);
287 m_extension_info.emplace(oid, info);
292namespace Cert_Extension {
300 throw Invalid_State(
"Basic_Constraints::get_path_limit: Not a CA");
307std::vector<uint8_t> Basic_Constraints::encode_inner()
const
309 std::vector<uint8_t> output;
315 .encode_optional(m_path_limit, NO_CERT_PATH_LIMIT)
324void Basic_Constraints::decode_inner(
const std::vector<uint8_t>& in)
339std::vector<uint8_t> Key_Usage::encode_inner()
const
341 if(m_constraints.
empty())
342 throw Encoding_Error(
"Cannot encode empty PKIX key constraints");
344 const size_t constraint_bits = m_constraints.
value();
345 const size_t unused_bits =
ctz(
static_cast<uint32_t
>(constraint_bits));
347 std::vector<uint8_t> der;
349 der.push_back(2 + ((unused_bits < 8) ? 1 : 0));
350 der.push_back(unused_bits % 8);
351 der.push_back((constraint_bits >> 8) & 0xFF);
352 if(constraint_bits & 0xFF)
353 der.push_back(constraint_bits & 0xFF);
361void Key_Usage::decode_inner(
const std::vector<uint8_t>& in)
365 BER_Object obj = ber.get_next_object();
369 if(obj.length() != 2 && obj.length() != 3)
370 throw BER_Decoding_Error(
"Bad size for BITSTRING in usage constraint");
374 const uint8_t* bits = obj.bits();
377 throw BER_Decoding_Error(
"Invalid unused bits in usage constraint");
379 const uint8_t mask =
static_cast<uint8_t
>(0xFF << bits[0]);
381 if(obj.length() == 2)
385 else if(obj.length() == 3)
390 m_constraints = Key_Constraints(usage);
396std::vector<uint8_t> Subject_Key_ID::encode_inner()
const
398 std::vector<uint8_t> output;
406void Subject_Key_ID::decode_inner(
const std::vector<uint8_t>& in)
418 m_key_id.resize(hash->output_length());
420 hash->update(pub_key);
421 hash->final(m_key_id.data());
424 const size_t max_skid_len = (192 / 8);
425 if(m_key_id.size() > max_skid_len)
426 m_key_id.resize(max_skid_len);
432std::vector<uint8_t> Authority_Key_ID::encode_inner()
const
434 std::vector<uint8_t> output;
445void Authority_Key_ID::decode_inner(
const std::vector<uint8_t>& in)
455std::vector<uint8_t> Subject_Alternative_Name::encode_inner()
const
457 std::vector<uint8_t> output;
458 DER_Encoder(output).encode(m_alt_name);
465std::vector<uint8_t> Issuer_Alternative_Name::encode_inner()
const
467 std::vector<uint8_t> output;
468 DER_Encoder(output).encode(m_alt_name);
475void Subject_Alternative_Name::decode_inner(
const std::vector<uint8_t>& in)
477 BER_Decoder(in).
decode(m_alt_name);
483void Issuer_Alternative_Name::decode_inner(
const std::vector<uint8_t>& in)
485 BER_Decoder(in).
decode(m_alt_name);
491std::vector<uint8_t> Extended_Key_Usage::encode_inner()
const
493 std::vector<uint8_t> output;
504void Extended_Key_Usage::decode_inner(
const std::vector<uint8_t>& in)
512std::vector<uint8_t> Name_Constraints::encode_inner()
const
514 throw Not_Implemented(
"Name_Constraints encoding");
521void Name_Constraints::decode_inner(
const std::vector<uint8_t>& in)
523 std::vector<GeneralSubtree> permit, exclude;
525 BER_Decoder ext = ber.start_sequence();
526 BER_Object per = ext.get_next_object();
533 throw Encoding_Error(
"Empty Name Contraint list");
536 BER_Object exc = ext.get_next_object();
542 throw Encoding_Error(
"Empty Name Contraint list");
547 if(permit.empty() && exclude.empty())
548 throw Encoding_Error(
"Empty Name Contraint extension");
550 m_name_constraints = NameConstraints(std::move(permit),std::move(exclude));
554 const std::vector<X509_Certificate>& cert_path,
555 std::vector<std::set<Certificate_Status_Code>>& cert_status,
558 if(!m_name_constraints.
permitted().empty() || !m_name_constraints.
excluded().empty())
565 const bool issuer_name_constraint_critical =
569 for(
size_t j = 0; j < pos; ++j)
571 bool permitted = m_name_constraints.
permitted().empty();
574 for(
const auto& c: m_name_constraints.
permitted())
576 switch(c.base().matches(cert_path.at(j)))
583 failed = issuer_name_constraint_critical;
591 for(
const auto& c: m_name_constraints.
excluded())
593 switch(c.base().matches(cert_path.at(j)))
600 failed = issuer_name_constraint_critical;
607 if(failed || !permitted)
623 Policy_Information() =
default;
624 explicit Policy_Information(
const OID& oid) : m_oid(oid) {}
626 const OID& oid()
const {
return m_oid; }
628 void encode_into(DER_Encoder& codec)
const override
630 codec.start_sequence()
635 void decode_from(BER_Decoder& codec)
override
637 codec.start_sequence()
652std::vector<uint8_t> Certificate_Policies::encode_inner()
const
654 std::vector<Policy_Information> policies;
656 policies.reserve(m_oids.size());
657 for(
const auto& oid : m_oids)
658 policies.push_back(Policy_Information(oid));
660 std::vector<uint8_t> output;
663 .encode_list(policies)
671void Certificate_Policies::decode_inner(
const std::vector<uint8_t>& in)
673 std::vector<Policy_Information> policies;
675 BER_Decoder(in).decode_list(policies);
677 for(
const auto& policy : policies)
678 m_oids.push_back(policy.oid());
684 const std::vector<X509_Certificate>& ,
685 std::vector<std::set<Certificate_Status_Code>>& cert_status,
688 std::set<OID> oid_set(m_oids.begin(), m_oids.end());
689 if(oid_set.size() != m_oids.size())
695std::vector<uint8_t> Authority_Information_Access::encode_inner()
const
699 std::vector<uint8_t> output;
710void Authority_Information_Access::decode_inner(
const std::vector<uint8_t>& in)
761 return std::make_unique<CRL_Number>(m_crl_number);
767std::vector<uint8_t> CRL_Number::encode_inner()
const
769 std::vector<uint8_t> output;
777void CRL_Number::decode_inner(
const std::vector<uint8_t>& in)
786std::vector<uint8_t> CRL_ReasonCode::encode_inner()
const
788 std::vector<uint8_t> output;
796void CRL_ReasonCode::decode_inner(
const std::vector<uint8_t>& in)
798 size_t reason_code = 0;
800 m_reason =
static_cast<CRL_Code>(reason_code);
803std::vector<uint8_t> CRL_Distribution_Points::encode_inner()
const
805 throw Not_Implemented(
"CRL_Distribution_Points encoding");
808void CRL_Distribution_Points::decode_inner(
const std::vector<uint8_t>& buf)
811 .decode_list(m_distribution_points)
814 std::stringstream ss;
816 for(
const auto& distribution_point : m_distribution_points)
818 auto contents = distribution_point.point().contents();
820 for(
const auto& pair : contents)
822 ss << pair.first <<
": " << pair.second <<
" ";
826 m_crl_distribution_urls.push_back(ss.str());
844std::vector<uint8_t> CRL_Issuing_Distribution_Point::encode_inner()
const
849void CRL_Issuing_Distribution_Point::decode_inner(
const std::vector<uint8_t>& buf)
854void OCSP_NoCheck::decode_inner(
const std::vector<uint8_t>& buf)
859std::vector<uint8_t> Unknown_Extension::encode_inner()
const
864void Unknown_Extension::decode_inner(
const std::vector<uint8_t>& bytes)
BER_Object get_next_object()
BER_Decoder & decode(bool &out)
BER_Decoder & verify_end()
BER_Decoder & decode_list(std::vector< T > &out, ASN1_Type type_tag=ASN1_Type::Sequence, ASN1_Class class_tag=ASN1_Class::Universal)
BER_Decoder start_sequence()
BER_Decoder start_context_specific(uint32_t tag)
BER_Decoder & decode_optional(T &out, ASN1_Type type_tag, ASN1_Class class_tag, const T &default_value=T())
BER_Decoder & decode_optional_string(std::vector< uint8_t, Alloc > &out, ASN1_Type real_type, uint32_t expected_tag, ASN1_Class class_tag=ASN1_Class::ContextSpecific)
BER_Decoder & decode_optional_implicit(T &out, ASN1_Type type_tag, ASN1_Class class_tag, ASN1_Type real_type, ASN1_Class real_class, const T &default_value=T())
size_t get_path_limit() const
void decode_from(BER_Decoder &) override
void encode_into(DER_Encoder &) const override
size_t get_crl_number() const
std::unique_ptr< Certificate_Extension > copy() const override
void validate(const X509_Certificate &subject, const X509_Certificate &issuer, const std::vector< X509_Certificate > &cert_path, std::vector< std::set< Certificate_Status_Code > > &cert_status, size_t pos) override
void validate(const X509_Certificate &subject, const X509_Certificate &issuer, const std::vector< X509_Certificate > &cert_path, std::vector< std::set< Certificate_Status_Code > > &cert_status, size_t pos) override
virtual void validate(const X509_Certificate &subject, const X509_Certificate &issuer, const std::vector< X509_Certificate > &cert_path, std::vector< std::set< Certificate_Status_Code > > &cert_status, size_t pos)
DER_Encoder & add_object(ASN1_Type type_tag, ASN1_Class class_tag, const uint8_t rep[], size_t length)
DER_Encoder & encode_optional(const T &value, const T &default_value)
DER_Encoder & start_sequence()
DER_Encoder & encode_if(bool pred, DER_Encoder &enc)
DER_Encoder & encode(bool b)
const Certificate_Extension * get_extension_object(const OID &oid) const
std::map< OID, std::pair< std::vector< uint8_t >, bool > > extensions_raw() const
std::unique_ptr< Certificate_Extension > get(const OID &oid) const
void decode_from(BER_Decoder &) override
bool remove(const OID &oid)
std::vector< uint8_t > get_extension_bits(const OID &oid) const
bool critical_extension_set(const OID &oid) const
std::vector< std::pair< std::unique_ptr< Certificate_Extension >, bool > > extensions() const
void encode_into(DER_Encoder &) const override
void replace(std::unique_ptr< Certificate_Extension > extn, bool critical=false)
bool add_new(std::unique_ptr< Certificate_Extension > extn, bool critical=false)
bool extension_set(const OID &oid) const
void add(std::unique_ptr< Certificate_Extension > extn, bool critical=false)
static std::unique_ptr< HashFunction > create_or_throw(std::string_view algo_spec, std::string_view provider="")
const std::vector< GeneralSubtree > & permitted() const
const std::vector< GeneralSubtree > & excluded() const
static OID from_string(std::string_view str)
bool is_critical(std::string_view ex_name) const
int(* final)(unsigned char *, CTX *)
std::string to_string(const BER_Object &obj)
constexpr size_t ctz(T n)
constexpr uint16_t make_uint16(uint8_t i0, uint8_t i1)