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 (const Certificate_Store_Windows &)=default
	Certificate_Store_Windows (Certificate_Store_Windows &&)=default
std::vector< std::shared_ptr< const X509_Certificate > >	find_all_certs (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
std::shared_ptr< const X509_Certificate >	find_cert (const X509_DN &subject_dn, const std::vector< uint8_t > &key_id) const override
std::shared_ptr< const X509_Certificate >	find_cert_by_pubkey_sha1 (const std::vector< uint8_t > &key_hash) const override
std::shared_ptr< const X509_Certificate >	find_cert_by_raw_subject_dn_sha256 (const std::vector< uint8_t > &subject_hash) const override
std::shared_ptr< const X509_CRL >	find_crl_for (const X509_Certificate &subject) const override
Certificate_Store_Windows &	operator= (const Certificate_Store_Windows &)=default
Certificate_Store_Windows &	operator= (Certificate_Store_Windows &&)=default

Detailed Description

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

Definition at line 18 of file certstor_windows.h.

Constructor & Destructor Documentation

Botan::Certificate_Store_Windows::Certificate_Store_Windows

(

)

Definition at line 189 of file certstor_windows.cpp.

{}

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

default

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

default

Member Function Documentation

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 191 of file certstor_windows.cpp.

References Botan::X509_Certificate::subject_dn().

   {
   std::vector<X509_DN> subject_dns;
   for(const auto store_name : cert_store_names)
      {
      Handle_Guard<HCERTSTORE> windows_cert_store = open_cert_store(store_name);
      Handle_Guard<PCCERT_CONTEXT> cert_context = nullptr;

      // Handle_Guard::assign exchanges the underlying pointer. No RAII is needed here, because the Windows API takes care of
      // freeing the previous context.
      while(cert_context.assign(CertEnumCertificatesInStore(windows_cert_store.get(), cert_context.get())))
         {
         X509_Certificate cert(cert_context->pbCertEncoded, cert_context->cbCertEncoded);
         subject_dns.push_back(cert.subject_dn());
         }
      }

   return subject_dns;
   }

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.

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

         {
         return find_cert(cert.subject_dn(), cert.subject_key_id()) != nullptr;
         }

Cert_Vector 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 218 of file certstor_windows.cpp.

   {
   return find_cert_by_dn_and_key_id(subject_dn, key_id, false);
   }

Cert_Pointer 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

Implements Botan::Certificate_Store.

Definition at line 211 of file certstor_windows.cpp.

   {
   const auto certs = find_cert_by_dn_and_key_id(subject_dn, key_id, true);
   return certs.empty() ? nullptr : certs.front();
   }

Cert_Pointer 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 225 of file certstor_windows.cpp.

   {
   if(key_hash.size() != 20)
      {
      throw Invalid_Argument("Certificate_Store_Windows::find_cert_by_pubkey_sha1 invalid hash");
      }

   CRYPT_HASH_BLOB blob;
   blob.cbData = static_cast<DWORD>(key_hash.size());
   blob.pbData = const_cast<BYTE*>(key_hash.data());

   auto filter = [](const Cert_Vector&, Cert_Pointer) { return true; };

   const auto certs = search_cert_stores(blob, CERT_FIND_KEY_IDENTIFIER, filter, true);
   return certs.empty() ? nullptr : certs.front();
   }

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

overridevirtual

Exceptions

Botan::Not_Implemented

Implements Botan::Certificate_Store.

Definition at line 242 of file certstor_windows.cpp.

References BOTAN_UNUSED.

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

std::shared_ptr< const 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 249 of file certstor_windows.cpp.

References BOTAN_UNUSED.

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

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

default

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

default

---

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