CertStore Xojo Plugin Reference Documentation

CertStore

Current Version: 9.5.0.75

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

Dim certStore As New Chilkat.CertStore

Properties

DebugLogFilePath
DebugLogFilePath As String

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
LastErrorHtml As String (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.

top
LastErrorText
LastErrorText As String (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.

top
LastErrorXml
LastErrorXml As String (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.

top
LastMethodSuccess
LastMethodSuccess As Boolean
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
NumCertificates As Int32 (read-only)

The number of certificates held in the certificate store.

top
VerboseLogging
VerboseLogging As Boolean

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
Version As String (read-only)

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

top

Methods

FindCertByRfc822Name
Function FindCertByRfc822Name(name As String) As Chilkat.Cert

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 FindCertBySerial(str As String) As Chilkat.Cert

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

Returns Nil on failure.

Returns Nil on failure

top
FindCertBySha1Thumbprint
Function FindCertBySha1Thumbprint(str As String) As Chilkat.Cert

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 FindCertBySubject(str As String) As Chilkat.Cert

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 FindCertBySubjectCN(str As String) As Chilkat.Cert

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 FindCertBySubjectE(str As String) As Chilkat.Cert

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 FindCertBySubjectO(str As String) As Chilkat.Cert

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
GetCertificate
Function GetCertificate(index As Int32) As Chilkat.Cert

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

Returns Nil on failure.

Returns Nil on failure

top
LoadPemFile
Function LoadPemFile(pemPath As String) As Boolean

Loads the certificates contained within a PEM formatted file.

Returns True for success, False for failure.

top
LoadPemStr
Function LoadPemStr(pemString As String) As Boolean

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

Returns True for success, False for failure.

top
LoadPfxData
Function LoadPfxData(pfxData As MemoryBlock, password As String) As Boolean

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 LoadPfxFile(pfxFilename As String, password As String) As Boolean

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
SaveLastError
Function SaveLastError(path As String) As Boolean

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

Returns True for success, False for failure.

top