CertStore Delphi DLL Reference Documentation

CertStore

Current Version: 9.5.0.73

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.

Create/Dispose

var
myObject: HCkCertStore;

begin
myObject := CkCertStore_Create();

// ...

CkCertStore_Dispose(myObject);
end;
function CkCertStore_Create: HCkCertStore; stdcall;

Creates an instance of the HCkCertStore object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkCertStore_Dispose(handle: HCkCertStore); stdcall;

Objects created by calling CkCertStore_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AvoidWindowsPkAccess
function CkCertStore_getAvoidWindowsPkAccess(objHandle: HCkCertStore): wordbool; stdcall;
procedure CkCertStore_putAvoidWindowsPkAccess(objHandle: HCkCertStore; newPropVal: wordbool); stdcall;

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.

top
DebugLogFilePath
procedure CkCertStore_getDebugLogFilePath(objHandle: HCkCertStore; outPropVal: HCkString); stdcall;
procedure CkCertStore_putDebugLogFilePath(objHandle: HCkCertStore; newPropVal: PWideChar); stdcall;
function CkCertStore__debugLogFilePath(objHandle: HCkCertStore): PWideChar; stdcall;

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:

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

top
LastErrorHtml
procedure CkCertStore_getLastErrorHtml(objHandle: HCkCertStore; outPropVal: HCkString); stdcall;
function CkCertStore__lastErrorHtml(objHandle: HCkCertStore): PWideChar; stdcall;

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.

top
LastErrorText
procedure CkCertStore_getLastErrorText(objHandle: HCkCertStore; outPropVal: HCkString); stdcall;
function CkCertStore__lastErrorText(objHandle: HCkCertStore): PWideChar; stdcall;

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.

top
LastErrorXml
procedure CkCertStore_getLastErrorXml(objHandle: HCkCertStore; outPropVal: HCkString); stdcall;
function CkCertStore__lastErrorXml(objHandle: HCkCertStore): PWideChar; stdcall;

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.

top
LastMethodSuccess
function CkCertStore_getLastMethodSuccess(objHandle: HCkCertStore): wordbool; stdcall;
procedure CkCertStore_putLastMethodSuccess(objHandle: HCkCertStore; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

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.

top
NumCertificates
function CkCertStore_getNumCertificates(objHandle: HCkCertStore): Integer; stdcall;

The number of certificates held in the certificate store.

top
NumEmailCerts
function CkCertStore_getNumEmailCerts(objHandle: HCkCertStore): Integer; stdcall;

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

top
VerboseLogging
function CkCertStore_getVerboseLogging(objHandle: HCkCertStore): wordbool; stdcall;
procedure CkCertStore_putVerboseLogging(objHandle: HCkCertStore; newPropVal: wordbool); stdcall;

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.

top
Version
procedure CkCertStore_getVersion(objHandle: HCkCertStore; outPropVal: HCkString); stdcall;
function CkCertStore__version(objHandle: HCkCertStore): PWideChar; stdcall;

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

top

Methods

AddCertificate
function CkCertStore_AddCertificate(objHandle: HCkCertStore;
    cert: HCkCert): wordbool; stdcall;

(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.

top
CreateFileStore
function CkCertStore_CreateFileStore(objHandle: HCkCertStore;
    filename: PWideChar): wordbool; stdcall;

(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.

top
CreateMemoryStore
function CkCertStore_CreateMemoryStore(objHandle: HCkCertStore): wordbool; stdcall;

(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.

top
CreateRegistryStore
function CkCertStore_CreateRegistryStore(objHandle: HCkCertStore;
    regRoot: PWideChar;
    regPath: PWideChar): wordbool; stdcall;

(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.

top
FindCertByRfc822Name
function CkCertStore_FindCertByRfc822Name(objHandle: HCkCertStore;
    name: PWideChar): HCkCert; stdcall;

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.

Returns nil on failure

top
FindCertBySerial
function CkCertStore_FindCertBySerial(objHandle: HCkCertStore;
    str: PWideChar): HCkCert; stdcall;

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

Returns nil on failure.

Returns nil on failure

top
FindCertBySha1Thumbprint
function CkCertStore_FindCertBySha1Thumbprint(objHandle: HCkCertStore;
    str: PWideChar): HCkCert; stdcall;

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

Returns nil on failure.

Returns nil on failure

More Information and Examples
top
FindCertBySubject
function CkCertStore_FindCertBySubject(objHandle: HCkCertStore;
    str: PWideChar): HCkCert; stdcall;

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 nil on failure.

Returns nil on failure

top
FindCertBySubjectCN
function CkCertStore_FindCertBySubjectCN(objHandle: HCkCertStore;
    str: PWideChar): HCkCert; stdcall;

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

Returns nil on failure.

Returns nil on failure

top
FindCertBySubjectE
function CkCertStore_FindCertBySubjectE(objHandle: HCkCertStore;
    str: PWideChar): HCkCert; stdcall;

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 nil on failure.

Returns nil on failure

top
FindCertBySubjectO
function CkCertStore_FindCertBySubjectO(objHandle: HCkCertStore;
    str: PWideChar): HCkCert; stdcall;

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

Returns nil on failure.

Returns nil on failure

top
FindCertForEmail
function CkCertStore_FindCertForEmail(objHandle: HCkCertStore;
    emailAddress: PWideChar): HCkCert; stdcall;

(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 nil on failure.

Returns nil on failure

top
GetCertificate
function CkCertStore_GetCertificate(objHandle: HCkCertStore;
    index: Integer): HCkCert; stdcall;

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

Returns nil on failure.

Returns nil on failure

top
GetEmailCert
function CkCertStore_GetEmailCert(objHandle: HCkCertStore;
    index: Integer): HCkCert; stdcall;

(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 nil on failure.

Returns nil on failure

top
LoadPemFile
function CkCertStore_LoadPemFile(objHandle: HCkCertStore;
    pemPath: PWideChar): wordbool; stdcall;

Loads the certificates contained within a PEM formatted file.

Returns True for success, False for failure.

top
LoadPemStr
function CkCertStore_LoadPemStr(objHandle: HCkCertStore;
    pemString: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

top
LoadPfxData
function CkCertStore_LoadPfxData(objHandle: HCkCertStore;
    pfxData: HCkByteData;
    password: PWideChar): wordbool; stdcall;

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.

top
LoadPfxData2
function CkCertStore_LoadPfxData2(objHandle: HCkCertStore;
    pByteData: pbyte;
    szByteData: LongWord;
    password: PWideChar): wordbool; stdcall;

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.

top
LoadPfxFile
function CkCertStore_LoadPfxFile(objHandle: HCkCertStore;
    pfxFilename: PWideChar;
    password: PWideChar): wordbool; stdcall;

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.

Returns True for success, False for failure.

top
OpenCurrentUserStore
function CkCertStore_OpenCurrentUserStore(objHandle: HCkCertStore;
    readOnly: wordbool): wordbool; stdcall;

(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.

top
OpenFileStore
function CkCertStore_OpenFileStore(objHandle: HCkCertStore;
    filename: PWideChar;
    readOnly: wordbool): wordbool; stdcall;

(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.

top
OpenLocalSystemStore
function CkCertStore_OpenLocalSystemStore(objHandle: HCkCertStore;
    readOnly: wordbool): wordbool; stdcall;

(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.

top
OpenRegistryStore
function CkCertStore_OpenRegistryStore(objHandle: HCkCertStore;
    regRoot: PWideChar;
    regPath: PWideChar;
    readOnly: wordbool): wordbool; stdcall;

(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.

top
OpenWindowsStore
function CkCertStore_OpenWindowsStore(objHandle: HCkCertStore;
    storeLocation: PWideChar;
    storeName: PWideChar;
    readOnly: wordbool): wordbool; stdcall;
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.

top
RemoveCertificate
function CkCertStore_RemoveCertificate(objHandle: HCkCertStore;
    cert: HCkCert): wordbool; stdcall;

(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.

top
SaveLastError
function CkCertStore_SaveLastError(objHandle: HCkCertStore;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top