Botan::System_Certificate_Store Class Reference

#include <certstor_system.h>

Inheritance diagram for Botan::System_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
std::optional< X509_Certificate >	find_cert (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) 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
	System_Certificate_Store ()

Detailed Description

Definition at line 14 of file certstor_system.h.

Constructor & Destructor Documentation

System_Certificate_Store()

Botan::System_Certificate_Store::System_Certificate_Store

(

)

Definition at line 23 of file certstor_system.cpp.

                                                   {
#if defined(BOTAN_HAS_CERTSTOR_MACOS)
   m_system_store = std::make_shared<Certificate_Store_MacOS>();
#elif defined(BOTAN_HAS_CERTSTOR_WINDOWS)
   m_system_store = std::make_shared<Certificate_Store_Windows>();
#elif defined(BOTAN_HAS_CERTSTOR_FLATFILE) && defined(BOTAN_SYSTEM_CERT_BUNDLE)
   m_system_store = std::make_shared<Flatfile_Certificate_Store>(BOTAN_SYSTEM_CERT_BUNDLE, true);
#else
   throw Not_Implemented("No system certificate store available in this build");
#endif
}

Member Function Documentation

all_subjects()

std::vector< X509_DN > Botan::System_Certificate_Store::all_subjects ( ) const

overridevirtual

Implements Botan::Certificate_Store.

Definition at line 59 of file certstor_system.cpp.

                                                                {
   return m_system_store->all_subjects();
}

certificate_known()

bool Botan::Certificate_Store::certificate_known ( const X509_Certificate & cert ) const

inlineinherited

Returns

whether the certificate is known

Parameters

cert	certififcate to be searched

Definition at line 70 of file certstor.h.

                                                                 {
         return find_cert(cert.subject_dn(), cert.subject_key_id()).has_value();
      }

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

find_all_certs()

std::vector< X509_Certificate > Botan::System_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 40 of file certstor_system.cpp.

                                                                                                               {
   return m_system_store->find_all_certs(subject_dn, key_id);
}

find_cert()

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

overridevirtual

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

Parameters

subject_dn	the subject's distinguished name
key_id	an 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 from Botan::Certificate_Store.

Definition at line 35 of file certstor_system.cpp.

                                                                                                            {
   return m_system_store->find_cert(subject_dn, key_id);
}

find_cert_by_pubkey_sha1()

std::optional< X509_Certificate > Botan::System_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. Used for OCSP.

Parameters

key_hash

SHA-1 hash of the subject's public key

Returns

a matching certificate or nullopt otherwise

Implements Botan::Certificate_Store.

Definition at line 45 of file certstor_system.cpp.

                                             {
   return m_system_store->find_cert_by_pubkey_sha1(key_hash);
}

find_cert_by_raw_subject_dn_sha256()

std::optional< X509_Certificate > Botan::System_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_hash

SHA-256 hash of the subject's raw name

Returns

a matching certificate or nullopt otherwise

Implements Botan::Certificate_Store.

Definition at line 50 of file certstor_system.cpp.

                                                 {
   return m_system_store->find_cert_by_raw_subject_dn_sha256(subject_hash);
}

find_crl_for()

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

overridevirtual

Finds a CRL for the given certificate

Parameters

subject

the subject certificate

Returns

the CRL for subject or nullopt otherwise

Reimplemented from Botan::Certificate_Store.

Definition at line 55 of file certstor_system.cpp.

                                                                                                  {
   return m_system_store->find_crl_for(subject);
}

---

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

• src/lib/x509/certstor_system/certstor_system.h
• src/lib/x509/certstor_system/certstor_system.cpp