CertStore Unicode C++ Reference Documentation

CkCertStoreW

Current Version: 10.1.0

Represents a collection of certificates. The certificates may be loaded from a PFX (PKCS#12) or from a Windows-based certificate store.

Many of the methods of this class are only applicable when running on a MS Windows operating system. The methods for opening, creating, and modifying Windows-based certificate stores (registry-based, file-based, and memory-based) are (of course) Windows-only. However, the methods for loading certs from PFX (PKCS#12), are valid on all supported operating systems, including Linux, MAC OS X, Windows, etc.

Object Creation

// Local variable on the stack
CkCertStoreW obj;

// Dynamically allocate/delete
CkCertStoreW *pObj = new CkCertStoreW();
// ...
delete pObj;

Properties

AvoidWindowsPkAccess

bool get_AvoidWindowsPkAccess(void);
void put_AvoidWindowsPkAccess(bool newVal);

Applies only when running on a Microsoft Windows operating system. If true, then any method that returns a certificate will not try to also access the associated private key, assuming one exists. This is useful if the certificate was installed with high-security such that a private key access would trigger the Windows OS to display a security warning dialog. The default value of this property is false.

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumCertificates

int get_NumCertificates(void);

The number of certificates held in the certificate store.

NumEmailCerts

int get_NumEmailCerts(void);

(This property only available on Microsoft Windows operating systems.)
The number of certificates that can be used for sending secure email within this store.

SmartCardPin

void get_SmartCardPin(CkString &str);
const wchar_t *smartCardPin(void);
void put_SmartCardPin(const wchar_t *str);

Introduced in version 9.5.0.86

Can be set to the PIN value for a certificate / private key stored on a smart card.

UncommonOptions

void get_UncommonOptions(CkString &str);
const wchar_t *uncommonOptions(void);
void put_UncommonOptions(const wchar_t *str);

Introduced in version 9.5.0.87

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

void get_Version(CkString &str);
const wchar_t *version(void);

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddCertificate

bool AddCertificate(CkCertW &cert);

On Windows, this updates or adds cert to the open certificate store.

Starting with Chilkat version 10.0.0, on macOS and iOS, this adds the certificate, along with any private keys and intermediate CA certificates, to the Apple Keychain.

Returns true for success, false for failure.

More Information and Examples

Import a PFX/P12 into the Windows Certificate Stores Apple Keychain - Import Pfx

CloseCertStore

bool CloseCertStore(void);

Introduced in version 9.5.0.94

(This method only available on Microsoft Windows operating systems.)
Closes the certificate store previously opened by one of the Open* methods.

Returns true for success, false for failure.

CreateFileStore

bool CreateFileStore(const wchar_t *filename);

(This method only available on Microsoft Windows operating systems.)
Creates a new file-based certificate store. Certificates may be saved to this store by calling AddCertificate.

Returns true for success, false for failure.

CreateMemoryStore

bool CreateMemoryStore(void);

(This method only available on Microsoft Windows operating systems.)
Creates an in-memory certificate store. Certificates may be added by calling AddCertificate.

Returns true for success, false for failure.

CreateRegistryStore

bool CreateRegistryStore(const wchar_t *regRoot, const wchar_t *regPath);

(This method only available on Microsoft Windows operating systems.)
Creates a registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates".

Returns true for success, false for failure.

FindCertByKeyContainer

CkCertW *FindCertByKeyContainer(const wchar_t *name);

Introduced in version 9.5.0.77

Finds a certificate by it's key container name.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindCertByRfc822Name

CkCertW *FindCertByRfc822Name(const wchar_t *name);

Locates and returns a certificate by its RFC 822 name.

If multiple certificates match, then non-expired certificates will take precedence over expired certificates. In other words, Chilkat will aways return the non-expired certificate over the expired certificate.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindCertBySerial

CkCertW *FindCertBySerial(const wchar_t *str);

Finds and returns the certificate that has the matching serial number.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindCertBySha1Thumbprint

CkCertW *FindCertBySha1Thumbprint(const wchar_t *str);

Finds a certificate by it's SHA-1 thumbprint. The thumbprint is a hexidecimal string.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

Find a Certificate by it's SHA-1 Thumbprint

FindCertBySubject

CkCertW *FindCertBySubject(const wchar_t *str);

Finds a certificate where one of the Subject properties (SubjectCN, SubjectE, SubjectO, SubjectOU, SubjectL, SubjectST, SubjectC) matches exactly (but case insensitive) with the passed string. A match in SubjectCN will be tried first, followed by SubjectE, and SubjectO. After that, the first match found in SubjectOU, SubjectL, SubjectST, or SubjectC, but in no guaranteed order, is returned. All matches are case insensitive.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindCertBySubjectCN

CkCertW *FindCertBySubjectCN(const wchar_t *str);

Finds a certificate where the SubjectCN property (common name) matches exactly (but case insensitive) with the passed string

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindCertBySubjectE

CkCertW *FindCertBySubjectE(const wchar_t *str);

Finds a certificate where the SubjectE property (email address) matches exactly (but case insensitive) with the passed string. This function differs from FindCertForEmail in that the certificate does not need to match the ForSecureEmail property.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

Find Certificate for Email Address in Current-User Certificate Store (Windows-Only)

FindCertBySubjectO

CkCertW *FindCertBySubjectO(const wchar_t *str);

Finds a certificate where the SubjectO property (organization) matches exactly (but case insensitive) with the passed string.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindCertForEmail

CkCertW *FindCertForEmail(const wchar_t *emailAddress);

(This method only available on Microsoft Windows operating systems.)
Finds a certificate that can be used to send secure email to the passed email address. A certificate matches only if the ForSecureEmail property is TRUE, and the email address matches exactly (but case insensitive) with the SubjectE property. Returns NULL if no matches are found.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetCertificate

CkCertW *GetCertificate(int index);

Returns the Nth certificate in the store. The first certificate is at index 0.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetEmailCert

CkCertW *GetEmailCert(int index);

(This method only available on Microsoft Windows operating systems.)
Returns the Nth email certificate in the store. The first certificate is at index 0. Use the NumEmailCertificates property to get the number of email certificates.

Returns NULL on failure.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

LoadPemFile

bool LoadPemFile(const wchar_t *pemPath);

Loads the certificates contained within a PEM formatted file.

Returns true for success, false for failure.

LoadPemStr

bool LoadPemStr(const wchar_t *pemString);

Loads the certificates contained within an in-memory PEM formatted string.

Returns true for success, false for failure.

LoadPfxData

bool LoadPfxData(CkByteData &pfxData, const wchar_t *password);

Loads a PFX from an in-memory image of a PFX file. Once loaded, the certificates within the PFX may be searched via the Find* methods. It is also possible to iterate from 0 to NumCertficates-1, calling GetCertificate for each index, to retrieve each certificate within the PFX.

Returns true for success, false for failure.

LoadPfxData2

bool LoadPfxData2(const void *pByteData, unsigned long szByteData, const wchar_t *password);

Loads a PFX from an in-memory image of a PFX file. Once loaded, the certificates within the PFX may be searched via the Find* methods. It is also possible to iterate from 0 to NumCertficates-1, calling GetCertificate for each index, to retrieve each certificate within the PFX.

Returns true for success, false for failure.

LoadPfxFile

bool LoadPfxFile(const wchar_t *pfxFilename, const wchar_t *password);

Loads a PFX file. Once loaded, the certificates within the PFX may be searched via the Find* methods. It is also possible to iterate from 0 to NumCertficates-1, calling GetCertificate for each index, to retrieve each certificate within the PFX.

Note: This method does not import certificates into the Windows certificate stores. The purpose of this method is to load a .pfx/.p12 into this object so that other API methods can be called to explore or search the contents of the PFX. The Chilkat Pfx class also provides similar functionality.

Returns true for success, false for failure.

More Information and Examples

Load PFX/P12 File into Certificate Store Object

OpenCurrentUserStore

bool OpenCurrentUserStore(bool readOnly);

On Windows, this method opens the Current-User\Personal certificate store in the registry. Set readOnly to true to open the store in read-only mode, which allows you to fetch certificates without adding or removing them. This prevents "permission denied" errors that require read-write access.

Starting in version 10.0.0, this method opens the Apple Keychain on MacOS and iOS systems. The readOnly is ignored.

After opening the store, you can search for certificates using the Find* methods. Alternatively, you can iterate through the certificates by indexing from 0 to NumCertificates-1, using GetCertificate to access each one.

Returns true for success, false for failure.

More Information and Examples

List Certificates in the Current User Certificate Store (Windows Only)Apple Keychain - List Certificates

OpenFileStore

bool OpenFileStore(const wchar_t *filename, bool readOnly);

(This method only available on Microsoft Windows operating systems.)
Opens a file-based certificate store.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns true for success, false for failure.

OpenLocalSystemStore

bool OpenLocalSystemStore(bool readOnly);

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Local-Computer\Personal certificate store. Set readOnly = true if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = true causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns true for success, false for failure.

OpenRegistryStore

bool OpenRegistryStore(const wchar_t *regRoot, const wchar_t *regPath, bool readOnly);

(This method only available on Microsoft Windows operating systems.)
Opens an arbitrary registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates".

Setting readOnly = true causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns true for success, false for failure.

OpenSmartcard

bool OpenSmartcard(const wchar_t *csp);

Introduced in version 9.5.0.80

On Windows, the system utilizes Microsoft CNG and/or CryptoAPI for accessing connected smartcards and USB tokens. For potentially better results, use Cert.LoadFromSmartcard, which can automatically detect and select between PKCS11, ScMinidriver, MS CNG, and MS CryptoAPI. On macOS and iOS, the Apple Keychain is employed.

Note: Chilkat version 10.0.0 and later supports Apple Keychain. csp is deprecated and unused; always pass an empty string for csp.

Returns true for success, false for failure.

More Information and Examples

Open Smartcard Certificate Store (or from USB Token)Apple Keychain - List Certs on Smartcards and USB Tokens

OpenWindowsStore

bool OpenWindowsStore(const wchar_t *storeLocation, const wchar_t *storeName, bool readOnly);

Introduced in version 9.5.0.49

(This method only available on Microsoft Windows operating systems.)
Opens a Microsoft Windows certificate store. storeLocation must be "CurrentUser" or "LocalMachine". storeName is the name of the certificate store to open. It may be any of the following:

AddressBook: Certificate store for other users.
AuthRoot: Certificate store for third-party certification authorities (CAs).
CertificationAuthority: Certificate store for intermediate certification authorities (CAs).
Disallowed: Certificate store for revoked certificates.
My: Certificate store for personal certificates.
Root: Certificate store for trusted root certification authorities (CAs).
TrustedPeople: Certificate store for directly trusted people and resources.
TrustedPublisher: Certificate store for directly trusted publishers.

Setting readOnly = true causes the certificate store to be opened read-only, and will prevent "permission denied" errors caused by the need for read-write permission.

Once loaded, the certificates within the store may be searched via the Find* methods. An application may also iterate from 0 to NumCertficates-1 and call GetCertificate to access each certificate by index.

Returns true for success, false for failure.

More Information and Examples

Find a Certificate in the "Other People" Windows Certificate Store

RemoveCertificate

bool RemoveCertificate(CkCertW &cert);

(This method only available on Microsoft Windows operating systems.)
Removes the passed certificate from the store. The certificate object passed as the argument can no longer be used once removed.

Returns true for success, false for failure.