Botan::Certificate_Store_Windows Class Reference

#include <certstor_windows.h>

Inheritance diagram for Botan::Certificate_Store_Windows:

Public Member Functions
std::vector< X509_DN >	all_subjects () const override
bool	certificate_known (const X509_Certificate &cert) const
	Certificate_Store_Windows ()
	Certificate_Store_Windows (Certificate_Store_Windows &&)=default
	Certificate_Store_Windows (const Certificate_Store_Windows &)=default
bool	contains (const X509_Certificate &cert) const override
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_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
Certificate_Store_Windows &	operator= (Certificate_Store_Windows &&)=default
Certificate_Store_Windows &	operator= (const Certificate_Store_Windows &)=default

Detailed Description

Certificate Store that is backed by the system trust store on Windows.

Definition at line 26 of file certstor_windows.h.

Constructor & Destructor Documentation

Certificate_Store_Windows() [1/3]

Botan::Certificate_Store_Windows::Certificate_Store_Windows

(

)

Definition at line 376 of file certstor_windows.cpp.

: m_impl(std::make_shared<Certificate_Store_Windows_Impl>()) {}

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

Certificate_Store_Windows() [2/3]

Botan::Certificate_Store_Windows::Certificate_Store_Windows ( const Certificate_Store_Windows & )

default

References Certificate_Store_Windows().

Certificate_Store_Windows() [3/3]

Botan::Certificate_Store_Windows::Certificate_Store_Windows ( Certificate_Store_Windows && )

default

References Certificate_Store_Windows().

Member Function Documentation

all_subjects()

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

overridevirtual

Returns

DNs for all certificates managed by the store

Implements Botan::Certificate_Store.

Definition at line 378 of file certstor_windows.cpp.

                                                                 {
   return m_impl->all_subjects();
}

certificate_known()

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

inherited

Old version of contains

Definition at line 24 of file certstor.cpp.

                                                                            {
   return contains(cert);
}

References contains().

Referenced by find_cert_by_issuer_dn_and_serial_number().

contains()

bool Botan::Certificate_Store_Windows::contains ( const X509_Certificate & cert ) const

overridevirtual

Returns

whether this certificate is contained within the store

Parameters

cert	certificate to be searched

Default implementation uses find_all_certs

Reimplemented from Botan::Certificate_Store.

Definition at line 414 of file certstor_windows.cpp.

                                                                           {
   return m_impl->contains(cert);
}

find_all_certs()

std::vector< X509_Certificate > Botan::Certificate_Store_Windows::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 387 of file certstor_windows.cpp.

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

find_cert()

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

Returns

the first certificate that matches

Reimplemented from Botan::Certificate_Store.

Definition at line 382 of file certstor_windows.cpp.

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

find_cert_by_issuer_dn_and_serial_number()

std::optional< X509_Certificate > Botan::Certificate_Store_Windows::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_dn	the distinguished name of the issuer
serial_number	the certificate's serial number

Returns

a matching certificate or nullopt otherwise

Implements Botan::Certificate_Store.

Definition at line 403 of file certstor_windows.cpp.

                                                                         {
   return m_impl->find_cert_by_issuer_dn_and_serial_number(issuer_dn, serial_number);
}

find_cert_by_pubkey_sha1()

std::optional< X509_Certificate > Botan::Certificate_Store_Windows::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 392 of file certstor_windows.cpp.

                                             {
   return m_impl->find_cert_by_pubkey_sha1(key_hash);
}

find_cert_by_raw_subject_dn_sha256()

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

overridevirtual

Exceptions

Not_Implemented

as this is not possible in the Windows system cert API

Implements Botan::Certificate_Store.

Definition at line 397 of file certstor_windows.cpp.

                                                 {
   BOTAN_UNUSED(subject_hash);
   throw Not_Implemented("Certificate_Store_Windows::find_cert_by_raw_subject_dn_sha256");
}

References BOTAN_UNUSED.

find_crl_for()

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

overridevirtual

Not Yet Implemented

Returns

nullptr;

Reimplemented from Botan::Certificate_Store.

Definition at line 408 of file certstor_windows.cpp.

                                                                                                   {
   // TODO: this could be implemented by using the CertFindCRLInStore function
   BOTAN_UNUSED(subject);
   return std::nullopt;
}

References BOTAN_UNUSED.

operator=() [1/2]

Certificate_Store_Windows & Botan::Certificate_Store_Windows::operator= ( Certificate_Store_Windows && )

default

References Certificate_Store_Windows().

operator=() [2/2]

Certificate_Store_Windows & Botan::Certificate_Store_Windows::operator= ( const Certificate_Store_Windows & )

default

References Certificate_Store_Windows().

---

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

• src/lib/x509/certstor_system_windows/certstor_windows.h
• src/lib/x509/certstor_system_windows/certstor_windows.cpp