CkCertStore C++ Reference Documentation

CkCertStore

Current Version: 10.0.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
CkCertStore obj;

// Dynamically allocate/delete
CkCertStore *pObj = new CkCertStore();
// ...
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 char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

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

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText

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

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

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

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess

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

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

Any method that returns a string.
Any method returning a Chilkat object, binary bytes, or a date/time.
Any method returning a standard boolean status value where success = true and failure = false.
Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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 char *smartCardPin(void);
void put_SmartCardPin(const char *ansiOrUtf8Str);

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 char *uncommonOptions(void);
void put_UncommonOptions(const char *ansiOrUtf8Str);

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.

Utf8

bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

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 char *version(void);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddCertificate

bool AddCertificate(CkCert &cert);

(This method only available on Microsoft Windows operating systems.)
Adds a certificate to the store. If the certificate is already in the store, it is updated with the new information.

Returns true for success, false for failure.

More Information and Examples

Import a PFX/P12 into the Windows Certificate Stores

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 char *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 char *regRoot, const char *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

CkCert *FindCertByKeyContainer(const char *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

More Information and Examples

Find Certificate on Smartcard Currenty in Reader

FindCertByRfc822Name

CkCert *FindCertByRfc822Name(const char *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

CkCert *FindCertBySerial(const char *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

CkCert *FindCertBySha1Thumbprint(const char *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

CkCert *FindCertBySubject(const char *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

CkCert *FindCertBySubjectCN(const char *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

CkCert *FindCertBySubjectE(const char *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

CkCert *FindCertBySubjectO(const char *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

CkCert *FindCertForEmail(const char *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

CkCert *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

CkCert *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 char *pemPath);

Loads the certificates contained within a PEM formatted file.

Returns true for success, false for failure.

LoadPemStr

bool LoadPemStr(const char *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 char *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 char *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 char *pfxFilename, const char *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);

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Current-User\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.

More Information and Examples

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

OpenFileStore

bool OpenFileStore(const char *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 char *regRoot, const char *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 char *csp);

Introduced in version 9.5.0.80

Opens the certificate store on the smartcard currently in the reader or USB token.

The csp can be set to the name of the CSP (Cryptographic Service Provider) that should be used. If csp is an empty string, then the 1st CSP found matching one of the following names will be used:

Microsoft Smart Card Key Storage Provider
Microsoft Base Smart Card Crypto Provider
Bit4id Universal Middleware Provider
YubiHSM Key Storage Provider (starting in v9.5.0.83)
eToken Base Cryptographic Provider
FTSafe ePass1000 RSA Cryptographic Service Provider
SecureStoreCSP
EnterSafe ePass2003 CSP v2.0
Gemalto Classic Card CSP
PROXKey CSP India V1.0
PROXKey CSP India V2.0
TRUST KEY CSP V1.0
Watchdata Brazil CSP V1.0
Luna Cryptographic Services for Microsoft Windows
Luna SChannel Cryptographic Services for Microsoft Windows
Safenet RSA Full Cryptographic Provider
nCipher Enhanced Cryptographic Provider
SafeSign Standard Cryptographic Service Provider
SafeSign Standard RSA and AES Cryptographic Service Provider
MySmartLogon NFC CSP
NFC Connector Enterprise
ActivClient Cryptographic Service Provider
EnterSafe ePass2003 CSP v1.0
Oberthur Card Systems Cryptographic Provider
Athena ASECard Crypto CSP"

(This method is only available on Microsoft Windows operating systems.)

Returns true for success, false for failure.

More Information and Examples

Open Smartcard Certificate Store (or from USB Token)

OpenWindowsStore

bool OpenWindowsStore(const char *storeLocation, const char *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(CkCert &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.