CertStore PureBasic Reference Documentation

CertStore

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

obj.i = CkCertStore::ckCreate()

; Make sure to dispose of the object when finished like this:
CkCertStore::ckDispose(obj);

Properties

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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.

Declare.s ckLastErrorText(obj.i) ; (read-only)

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.

Concept of LastErrorText

LastErrorText Standard Information

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Declare.i ckNumCertificates(obj.i) ; (read-only)

The number of certificates held in the certificate store.

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Declare.s ckVersion(obj.i) ; (read-only)

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

Methods

Declare.i ckFindCertByRfc822Name(obj.i, name.s)

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 0 on failure

Declare.i ckFindCertBySerial(obj.i, str.s)

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

Returns 0 on failure.

Returns 0 on failure

Declare.i ckFindCertBySha1Thumbprint(obj.i, str.s)

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

Returns 0 on failure.

Returns 0 on failure

Declare.i ckFindCertBySubject(obj.i, str.s)

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

Returns 0 on failure

Declare.i ckFindCertBySubjectCN(obj.i, str.s)

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

Returns 0 on failure.

Returns 0 on failure

Declare.i ckFindCertBySubjectE(obj.i, str.s)

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

Returns 0 on failure

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

Declare.i ckFindCertBySubjectO(obj.i, str.s)

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

Returns 0 on failure.

Returns 0 on failure

Declare.i ckGetCertificate(obj.i, index.l)

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

Returns 0 on failure.

Returns 0 on failure

Declare.i ckLoadPemFile(obj.i, pemPath.s)

Loads the certificates contained within a PEM formatted file.

Returns 1 for success, 0 for failure.

Declare.i ckLoadPemStr(obj.i, pemString.s)

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

Returns 1 for success, 0 for failure.

Declare.i ckLoadPfxFile(obj.i, pfxFilename.s, password.s)

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 1 for success, 0 for failure.

Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.