Botan 2.19.3
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::Certificate_Store Class Referenceabstract

#include <certstor.h>

Inheritance diagram for Botan::Certificate_Store:
Botan::Certificate_Store_In_Memory Botan::Certificate_Store_In_SQL Botan::Certificate_Store_MacOS Botan::Certificate_Store_Windows Botan::Flatfile_Certificate_Store Botan::System_Certificate_Store Botan::Certificate_Store_In_SQLite

Public Member Functions

virtual std::vector< X509_DNall_subjects () const =0
 
bool certificate_known (const X509_Certificate &cert) const
 
virtual std::vector< std::shared_ptr< const X509_Certificate > > find_all_certs (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const =0
 
virtual std::shared_ptr< const X509_Certificatefind_cert (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const
 
virtual std::shared_ptr< const X509_Certificatefind_cert_by_pubkey_sha1 (const std::vector< uint8_t > &key_hash) const =0
 
virtual std::shared_ptr< const X509_Certificatefind_cert_by_raw_subject_dn_sha256 (const std::vector< uint8_t > &subject_hash) const =0
 
virtual std::shared_ptr< const X509_CRLfind_crl_for (const X509_Certificate &subject) const
 
virtual ~Certificate_Store ()
 

Detailed Description

Certificate Store Interface

Definition at line 19 of file certstor.h.

Constructor & Destructor Documentation

◆ ~Certificate_Store()

Botan::Certificate_Store::~Certificate_Store ( )
virtual

Definition at line 17 of file certstor.cpp.

17{}

Member Function Documentation

◆ all_subjects()

virtual std::vector< X509_DN > Botan::Certificate_Store::all_subjects ( ) const
pure virtual

◆ certificate_known()

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

Definition at line 72 of file certstor.h.

73 {
74 return find_cert(cert.subject_dn(), cert.subject_key_id()) != nullptr;
75 }
virtual std::shared_ptr< const 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()

virtual std::vector< std::shared_ptr< const X509_Certificate > > Botan::Certificate_Store::find_all_certs ( const X509_DN subject_dn,
const std::vector< uint8_t > &  key_id 
) const
pure virtual

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

Implemented in Botan::Certificate_Store_In_Memory, Botan::Flatfile_Certificate_Store, Botan::Certificate_Store_In_SQL, Botan::System_Certificate_Store, Botan::Certificate_Store_MacOS, and Botan::Certificate_Store_Windows.

Referenced by find_cert().

◆ find_cert()

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

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 nullptr 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::System_Certificate_Store, Botan::Certificate_Store_MacOS, and Botan::Certificate_Store_Windows.

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 {
26 return nullptr; // certificate not found
27 }
28
29 // `count` might be greater than 1, but we'll just select the first match
30 return certs.front();
31 }
virtual std::vector< std::shared_ptr< const X509_Certificate > > find_all_certs(const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const =0

References find_all_certs().

◆ find_cert_by_pubkey_sha1()

virtual std::shared_ptr< const X509_Certificate > Botan::Certificate_Store::find_cert_by_pubkey_sha1 ( const std::vector< uint8_t > &  key_hash) const
pure virtual

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

Parameters
key_hashSHA-1 hash of the subject's public key
Returns
a matching certificate or nullptr otherwise

Implemented in Botan::Certificate_Store_In_Memory, Botan::Flatfile_Certificate_Store, Botan::Certificate_Store_In_SQL, Botan::System_Certificate_Store, Botan::Certificate_Store_MacOS, and Botan::Certificate_Store_Windows.

◆ find_cert_by_raw_subject_dn_sha256()

virtual std::shared_ptr< const X509_Certificate > Botan::Certificate_Store::find_cert_by_raw_subject_dn_sha256 ( const std::vector< uint8_t > &  subject_hash) const
pure virtual

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 nullptr otherwise

Implemented in Botan::Certificate_Store_In_Memory, Botan::Flatfile_Certificate_Store, Botan::Certificate_Store_In_SQL, Botan::System_Certificate_Store, Botan::Certificate_Store_MacOS, and Botan::Certificate_Store_Windows.

◆ find_crl_for()

std::shared_ptr< const X509_CRL > Botan::Certificate_Store::find_crl_for ( const X509_Certificate subject) const
virtual

Finds a CRL for the given certificate

Parameters
subjectthe subject certificate
Returns
the CRL for subject or nullptr otherwise

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

Definition at line 33 of file certstor.cpp.

34 {
35 return {};
36 }

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