Botan 3.5.0
Crypto and TLS for C&
Botan::Flatfile_Certificate_Store Class Referencefinal

#include <certstor_flatfile.h>

Inheritance diagram for Botan::Flatfile_Certificate_Store:
Botan::Certificate_Store

Public Member Functions

std::vector< X509_DNall_subjects () const override
 
bool certificate_known (const X509_Certificate &cert) const
 
std::vector< X509_Certificatefind_all_certs (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
 
virtual std::optional< X509_Certificatefind_cert (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const
 
std::optional< X509_Certificatefind_cert_by_pubkey_sha1 (const std::vector< uint8_t > &key_hash) const override
 
std::optional< X509_Certificatefind_cert_by_raw_subject_dn_sha256 (const std::vector< uint8_t > &subject_hash) const override
 
std::optional< X509_CRLfind_crl_for (const X509_Certificate &subject) const override
 
 Flatfile_Certificate_Store (const Flatfile_Certificate_Store &)=default
 
 Flatfile_Certificate_Store (Flatfile_Certificate_Store &&)=default
 
 Flatfile_Certificate_Store (std::string_view file, bool ignore_non_ca=false)
 
Flatfile_Certificate_Storeoperator= (const Flatfile_Certificate_Store &)=default
 
Flatfile_Certificate_Storeoperator= (Flatfile_Certificate_Store &&)=default
 

Detailed Description

Certificate Store that is backed by a file of PEMs of trusted CAs.

Definition at line 22 of file certstor_flatfile.h.

Constructor & Destructor Documentation

◆ Flatfile_Certificate_Store() [1/3]

Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store ( std::string_view file,
bool ignore_non_ca = false )

Construct a new Certificate_Store given a file path to a file including PEMs of trusted self-signed CAs.

Parameters
filethe name of the file to read certificates from
ignore_non_caif true, certs that are not self-signed CA certs will be ignored. Otherwise (if false), an exception will be thrown instead.

Definition at line 37 of file certstor_flatfile.cpp.

37 {
38 if(file.empty()) {
39 throw Invalid_Argument("Flatfile_Certificate_Store::Flatfile_Certificate_Store invalid file path");
40 }
41
42 DataSource_Stream file_stream(file);
43
44 for(const std::vector<uint8_t>& der : decode_all_certificates(file_stream)) {
45 X509_Certificate cert(der);
46
47 /*
48 * Various weird or misconfigured system roots include intermediate certificates,
49 * or even stranger certificates which are not valid for cert issuance at all.
50 * Previously this code would error on such cases as an obvious misconfiguration,
51 * but we cannot fix the trust store. So instead just ignore any such certificate.
52 */
53 if(cert.is_self_signed() && cert.is_CA_cert()) {
54 m_all_subjects.push_back(cert.subject_dn());
55 m_dn_to_cert[cert.subject_dn()].push_back(cert);
56 m_pubkey_sha1_to_cert.emplace(cert.subject_public_key_bitstring_sha1(), cert);
57 m_subject_dn_sha256_to_cert.emplace(cert.raw_subject_dn_sha256(), cert);
58 } else if(!ignore_non_ca) {
59 throw Invalid_Argument("Flatfile_Certificate_Store received non CA cert " + cert.subject_dn().to_string());
60 }
61 }
62
63 if(m_all_subjects.empty()) {
64 throw Invalid_Argument("Flatfile_Certificate_Store::Flatfile_Certificate_Store cert file is empty");
65 }
66}

References Botan::X509_Certificate::is_CA_cert(), Botan::X509_Certificate::is_self_signed(), Botan::X509_Certificate::raw_subject_dn_sha256(), Botan::X509_Certificate::subject_dn(), Botan::X509_Certificate::subject_public_key_bitstring_sha1(), and Botan::X509_DN::to_string().

◆ Flatfile_Certificate_Store() [2/3]

Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store ( const Flatfile_Certificate_Store & )
default

◆ Flatfile_Certificate_Store() [3/3]

Botan::Flatfile_Certificate_Store::Flatfile_Certificate_Store ( Flatfile_Certificate_Store && )
default

Member Function Documentation

◆ all_subjects()

std::vector< X509_DN > Botan::Flatfile_Certificate_Store::all_subjects ( ) const
overridevirtual
Returns
DNs for all certificates managed by the store

Implements Botan::Certificate_Store.

Definition at line 68 of file certstor_flatfile.cpp.

68 {
69 return m_all_subjects;
70}

◆ certificate_known()

bool Botan::Certificate_Store::certificate_known ( const X509_Certificate & cert) const
inlineinherited
Returns
whether the certificate is known
Parameters
certcertififcate to be searched

Definition at line 70 of file certstor.h.

70 {
71 return find_cert(cert.subject_dn(), cert.subject_key_id()).has_value();
72 }
virtual std::optional< X509_Certificate > find_cert(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const
Definition certstor.cpp:20

References Botan::X509_Certificate::subject_dn(), and Botan::X509_Certificate::subject_key_id().

◆ find_all_certs()

std::vector< X509_Certificate > Botan::Flatfile_Certificate_Store::find_all_certs ( const X509_DN & subject_dn,
const std::vector< uint8_t > & key_id ) const
overridevirtual

Find all certificates with a given Subject DN. Subject DN and even the key identifier might not be unique.

Implements Botan::Certificate_Store.

Definition at line 72 of file certstor_flatfile.cpp.

73 {
74 std::vector<X509_Certificate> found_certs;
75 try {
76 const auto certs = m_dn_to_cert.at(subject_dn);
77
78 for(const auto& cert : certs) {
79 if(key_id.empty() || key_id == cert.subject_key_id()) {
80 found_certs.push_back(cert);
81 }
82 }
83 } catch(const std::out_of_range&) {
84 return {};
85 }
86
87 return found_certs;
88}

◆ find_cert()

std::optional< X509_Certificate > Botan::Certificate_Store::find_cert ( const X509_DN & subject_dn,
const std::vector< uint8_t > & key_id ) const
virtualinherited

Find a certificate by Subject DN and (optionally) key identifier

Parameters
subject_dnthe subject's distinguished name
key_idan optional key id
Returns
a matching certificate or nullopt otherwise If more than one certificate in the certificate store matches, then a single value is selected arbitrarily.

Reimplemented in Botan::Certificate_Store_In_Memory, Botan::Certificate_Store_In_SQL, Botan::Certificate_Store_MacOS, Botan::Certificate_Store_Windows, and Botan::System_Certificate_Store.

Definition at line 20 of file certstor.cpp.

21 {
22 const auto certs = find_all_certs(subject_dn, key_id);
23
24 if(certs.empty()) {
25 return std::nullopt;
26 }
27
28 // `count` might be greater than 1, but we'll just select the first match
29 return certs.front();
30}
virtual std::vector< X509_Certificate > find_all_certs(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const =0

References Botan::Certificate_Store::find_all_certs().

Referenced by Botan::OCSP::Response::find_signing_certificate().

◆ find_cert_by_pubkey_sha1()

std::optional< X509_Certificate > Botan::Flatfile_Certificate_Store::find_cert_by_pubkey_sha1 ( const std::vector< uint8_t > & key_hash) const
overridevirtual

Find a certificate by searching for one with a matching SHA-1 hash of public key.

Returns
a matching certificate or nullptr otherwise

Implements Botan::Certificate_Store.

Definition at line 90 of file certstor_flatfile.cpp.

91 {
92 if(key_hash.size() != 20) {
93 throw Invalid_Argument("Flatfile_Certificate_Store::find_cert_by_pubkey_sha1 invalid hash");
94 }
95
96 auto found_cert = m_pubkey_sha1_to_cert.find(key_hash);
97
98 if(found_cert != m_pubkey_sha1_to_cert.end()) {
99 return found_cert->second;
100 }
101
102 return std::nullopt;
103}

◆ find_cert_by_raw_subject_dn_sha256()

std::optional< X509_Certificate > Botan::Flatfile_Certificate_Store::find_cert_by_raw_subject_dn_sha256 ( const std::vector< uint8_t > & subject_hash) const
overridevirtual

Find a certificate by searching for one with a matching SHA-256 hash of raw subject name. Used for OCSP.

Parameters
subject_hashSHA-256 hash of the subject's raw name
Returns
a matching certificate or nullopt otherwise

Implements Botan::Certificate_Store.

Definition at line 105 of file certstor_flatfile.cpp.

106 {
107 if(subject_hash.size() != 32) {
108 throw Invalid_Argument("Flatfile_Certificate_Store::find_cert_by_raw_subject_dn_sha256 invalid hash");
109 }
110
111 auto found_cert = m_subject_dn_sha256_to_cert.find(subject_hash);
112
113 if(found_cert != m_subject_dn_sha256_to_cert.end()) {
114 return found_cert->second;
115 }
116
117 return std::nullopt;
118}

◆ find_crl_for()

std::optional< X509_CRL > Botan::Flatfile_Certificate_Store::find_crl_for ( const X509_Certificate & subject) const
overridevirtual

Fetching CRLs is not supported by this certificate store. This will always return an empty list.

Reimplemented from Botan::Certificate_Store.

Definition at line 120 of file certstor_flatfile.cpp.

120 {
121 BOTAN_UNUSED(subject);
122 return {};
123}
#define BOTAN_UNUSED
Definition assert.h:118

References BOTAN_UNUSED.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

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