Botan 3.11.0
Crypto and TLS for C&
Public Member Functions | List of all members
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_DN > all_subjects () const override
bool certificate_known (const X509_Certificate &cert) const
std::vector< X509_Certificate > find_all_certs (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
virtual std::optional< X509_Certificate > find_cert (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const
std::optional< X509_Certificate > find_cert_by_issuer_dn_and_serial_number (const X509_DN &issuer_dn, std::span< const uint8_t > serial_number) const override
std::optional< X509_Certificate > find_cert_by_pubkey_sha1 (const std::vector< uint8_t > &key_hash) const override
std::optional< X509_Certificate > find_cert_by_raw_subject_dn_sha256 (const std::vector< uint8_t > &subject_hash) const override
std::optional< X509_CRL > find_crl_for (const X509_Certificate &subject) const override
 Flatfile_Certificate_Store (const Flatfile_Certificate_Store &)=default
 Flatfile_Certificate_Store (Flatfile_Certificate_Store &&)=default
BOTAN_FUTURE_EXPLICIT Flatfile_Certificate_Store (std::string_view file, bool ignore_non_ca=false)
Flatfile_Certificate_Store & operator= (const Flatfile_Certificate_Store &)=default
Flatfile_Certificate_Store & operator= (Flatfile_Certificate_Store &&)=default
 ~Flatfile_Certificate_Store () override=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 41 of file certstor_flatfile.cpp.

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

References Botan::X509_Certificate::is_CA_cert(), Botan::X509_Certificate::is_self_signed(), Botan::X509_Certificate::issuer_dn(), 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().

Referenced by Flatfile_Certificate_Store(), Flatfile_Certificate_Store(), operator=(), and operator=().

◆ Flatfile_Certificate_Store() [2/3]

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

References Flatfile_Certificate_Store().

◆ Flatfile_Certificate_Store() [3/3]

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

References Flatfile_Certificate_Store().

◆ ~Flatfile_Certificate_Store()

Botan::Flatfile_Certificate_Store::~Flatfile_Certificate_Store ( )
overridedefault

References all_subjects(), find_all_certs(), find_cert_by_issuer_dn_and_serial_number(), find_cert_by_pubkey_sha1(), find_cert_by_raw_subject_dn_sha256(), and find_crl_for().

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 73 of file certstor_flatfile.cpp.

73 {
74 return m_all_subjects;
75}

Referenced by ~Flatfile_Certificate_Store().

◆ certificate_known()

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

Definition at line 80 of file certstor.h.

80 {
81 return find_cert(cert.subject_dn(), cert.subject_key_id()).has_value();
82 }
Botan::Certificate_Store::find_cert
virtual std::optional< X509_Certificate > find_cert(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const
Definition certstor.cpp:22

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

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

◆ 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 77 of file certstor_flatfile.cpp.

78 {
79 if(!m_dn_to_cert.contains(subject_dn)) {
80 return {};
81 }
82
83 const auto& certs = m_dn_to_cert.at(subject_dn);
84
85 std::vector<X509_Certificate> found_certs;
86 for(const auto& cert : certs) {
87 if(key_id.empty() || key_id == cert.subject_key_id()) {
88 found_certs.push_back(cert);
89 }
90 }
91
92 return found_certs;
93}

Referenced by ~Flatfile_Certificate_Store().

◆ 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 22 of file certstor.cpp.

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

References find_all_certs().

Referenced by certificate_known(), Botan::OCSP::Response::find_signing_certificate(), and ~Certificate_Store().

◆ find_cert_by_issuer_dn_and_serial_number()

std::optional< X509_Certificate > Botan::Flatfile_Certificate_Store::find_cert_by_issuer_dn_and_serial_number ( const X509_DN & issuer_dn,
std::span< const uint8_t > serial_number ) const
overridevirtual

Find a certificate by searching for one with a matching issuer DN and serial number. Used for CMS or PKCS#7.

Parameters
issuer_dnthe distinguished name of the issuer
serial_numberthe certificate's serial number
Returns
a matching certificate or nullopt otherwise

Implements Botan::Certificate_Store.

Definition at line 125 of file certstor_flatfile.cpp.

126 {
127 if(!m_issuer_dn_to_cert.contains(issuer_dn)) {
128 return std::nullopt;
129 }
130
131 const auto& certs = m_issuer_dn_to_cert.at(issuer_dn);
132
133 for(const auto& cert : certs) {
134 if(std::ranges::equal(cert.serial_number(), serial_number)) {
135 return cert;
136 }
137 }
138
139 return std::nullopt;
140}

Referenced by ~Flatfile_Certificate_Store().

◆ 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 95 of file certstor_flatfile.cpp.

96 {
97 if(key_hash.size() != 20) {
98 throw Invalid_Argument("Flatfile_Certificate_Store::find_cert_by_pubkey_sha1 invalid hash");
99 }
100
101 auto found_cert = m_pubkey_sha1_to_cert.find(key_hash);
102
103 if(found_cert != m_pubkey_sha1_to_cert.end()) {
104 return found_cert->second;
105 }
106
107 return std::nullopt;
108}

Referenced by ~Flatfile_Certificate_Store().

◆ 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 110 of file certstor_flatfile.cpp.

111 {
112 if(subject_hash.size() != 32) {
113 throw Invalid_Argument("Flatfile_Certificate_Store::find_cert_by_raw_subject_dn_sha256 invalid hash");
114 }
115
116 auto found_cert = m_subject_dn_sha256_to_cert.find(subject_hash);
117
118 if(found_cert != m_subject_dn_sha256_to_cert.end()) {
119 return found_cert->second;
120 }
121
122 return std::nullopt;
123}

Referenced by ~Flatfile_Certificate_Store().

◆ 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 142 of file certstor_flatfile.cpp.

142 {
143 BOTAN_UNUSED(subject);
144 return {};
145}
BOTAN_UNUSED
#define BOTAN_UNUSED
Definition assert.h:144

References BOTAN_UNUSED.

Referenced by ~Flatfile_Certificate_Store().

◆ operator=() [1/2]

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

References Flatfile_Certificate_Store().

◆ operator=() [2/2]

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

References Flatfile_Certificate_Store().

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0