CPKIFCAPICertUpdate2 Class Reference
#include <CAPICertUpdate2.h>
Detailed Description
The CPKIFCAPICertUpdate2 class can be used to add certificates to a Microsoft CAPI certificate store. It implements one PKI-related interface: IPKIFCertRepositoryUpdate. Each instance of this class is associated with a specific Microsoft CAPI certificate store. The constructor takes two parameters that are used to specify which certificate store is associated with an instance of this class. The default constructor parameters are:
CERT_SYSTEM_STORE_CURRENT_USER "CA"These parameters are passed to the Windows CertOpenStore function upon initialization. Consult Microsoft MSDN documentation for details on various options that may be used to target an alternative certificate store. Typically, this class is not used directly by applications and is primarily intended for as a colleague associated with a cache mediator used by the path builder.
TSP-enforcing: No
Definition at line 43 of file CAPICertUpdate2.h.
Public Member Functions | |
| CPKIFCAPICertUpdate2 (int sysStoRegLoc=CERT_SYSTEM_STORE_CURRENT_USER, const char *store=g_defCACCAPIStore) | |
| virtual | ~CPKIFCAPICertUpdate2 (void) |
| void | Initialize (void) |
| void | AddCertificate (CertType certType, const CPKIFCertificatePtr &cert) |
Constructor & Destructor Documentation
| CPKIFCAPICertUpdate2::CPKIFCAPICertUpdate2 | ( | int | sysStoRegLoc = CERT_SYSTEM_STORE_CURRENT_USER, |
|
| const char * | store = g_defCACCAPIStore | |||
| ) |
Interface: External
This function creates and initializes CPKIFCAPICertUpdate2 objects. The parameters determine which certificate store is associated with an instance of CPKIFCAPICertUpdate2. The default certificate store is the "CA" store associated with the current Windows user. For Windows services using PKIF, the sysStoRegLoc parameter should be set to CERT_SYSTEM_STORE_LOCA_MACHINE and the store parameter can be left to the default value. Consult Microsoft MSDN documentation for details on various options that may be used to target an alternative certificate store.
This function does not attempt to open the certificate store identified by the parameters. An attempt to open the store will be made when the Initialize function is called, which occurs when an instance of CPKIFCAPICertUpdate2 is passed to the AddColleague function of a mediator class (presumably the CPKIFCacheMediator2 class).
- Returns:
- None
- Parameters:
-
sysStoRegLoc [in] An integer indicating which certificate store is associated with an instance of CPKIFCAPITrustRootCRLRepository2. store [in] An NULL terminated string indicating which certificate store is associated with an instance of CPKIFCAPITrustRootCRLRepository2.
Definition at line 49 of file CAPICertUpdate2.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_SR_CAPICERTUPDATE.
| CPKIFCAPICertUpdate2::~CPKIFCAPICertUpdate2 | ( | void | ) | [virtual] |
Interface: External
This function destroys CPKIFCAPICertUpdate2 objects.
- Returns:
- None
Definition at line 80 of file CAPICertUpdate2.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_SR_CAPICERTUPDATE.
Member Function Documentation
| void CPKIFCAPICertUpdate2::Initialize | ( | void | ) | [virtual] |
Interface: External
This function initializes an instance for use in a collection of IPKIFColleague objects held by a mediator. This function may generate an exception containing the following error code CACHE_CERT_STORE_OPEN_FAILED.
- Returns:
- None
- Exceptions:
-
CPKIFCacheException(CACHE_CERT_STORE_OPEN_FAILED)
Reimplemented from IPKIFColleague.
Definition at line 106 of file CAPICertUpdate2.cpp.
References CACHE_CERT_STORE_OPEN_FAILED, COMMON_ALREADY_INITIALIZED, LOG_STRING_DEBUG, LOG_STRING_WARN, RAISE_CACHE_EXCEPTION, TOOLKIT_SR_CAPICERTUPDATE, and TOOLKIT_SR_CAPIREPOSITORY.
| void CPKIFCAPICertUpdate2::AddCertificate | ( | CertType | certType, | |
| const CPKIFCertificatePtr & | cert | |||
| ) | [virtual] |
Interface: External
This class takes a certificate type and a pointer to a certificate. The certificate type value is ignored by this class (there is no CAPI storage of such information). If the certificate is not successfully added no error is returned. (The lack of an error return is due to the intended use of this class, i.e. as a non-critical facilitator of efficient path building). This function may generate an exception containing the following error code CACHE_CERT_STORE_OPEN_FAILED.
- Returns:
- None
- Exceptions:
-
CPKIFCacheException(CACHE_CERT_STORE_OPEN_FAILED) CPKIFCacheException(COMMON_NOT_INITIALIZED)
Implements IPKIFCertRepositoryUpdate.
Definition at line 141 of file CAPICertUpdate2.cpp.
References CACHE_UPDATE_FAILED, COMMON_NOT_INITIALIZED, LOG_STRING_DEBUG, LOG_STRING_ERROR, RAISE_CACHE_EXCEPTION, and TOOLKIT_SR_CAPICERTUPDATE.
The documentation for this class was generated from the following files:
