CertStore Tcl 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

set myCertStore [new CkCertStore]

Properties

AvoidWindowsPkAccess (boolean 1/0)

set boolVal [CkCertStore_get_AvoidWindowsPkAccess $myCertStore]
CkCertStore_put_AvoidWindowsPkAccess $myCertStore $boolVal

Applies only when running on a Microsoft Windows operating system. If 1, 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 0.

DebugLogFilePath (string)

# ckStr is a CkString
CkCertStore_get_DebugLogFilePath $myCertStore $ckStr
set strVal [CkCertStore_get_debugLogFilePath $myCertStore]
CkCertStore_put_DebugLogFilePath $myCertStore $strVal

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.

LastErrorHtml (string)

# ckStr is a CkString
CkCertStore_get_LastErrorHtml $myCertStore $ckStr
set strVal [CkCertStore_get_lastErrorHtml $myCertStore]

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 (string)

# ckStr is a CkString
CkCertStore_get_LastErrorText $myCertStore $ckStr
set strVal [CkCertStore_get_lastErrorText $myCertStore]

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

LastErrorXml (string)

# ckStr is a CkString
CkCertStore_get_LastErrorXml $myCertStore $ckStr
set strVal [CkCertStore_get_lastErrorXml $myCertStore]

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 (boolean 1/0)

set boolVal [CkCertStore_get_LastMethodSuccess $myCertStore]
CkCertStore_put_LastMethodSuccess $myCertStore $boolVal

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.

NumCertificates (integer)

set intVal [CkCertStore_get_NumCertificates $myCertStore]

The number of certificates held in the certificate store.

NumEmailCerts (integer)

set intVal [CkCertStore_get_NumEmailCerts $myCertStore]

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

Utf8 (boolean 1/0)

set boolVal [CkCertStore_get_Utf8 $myCertStore]
CkCertStore_put_Utf8 $myCertStore $boolVal

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

VerboseLogging (boolean 1/0)

set boolVal [CkCertStore_get_VerboseLogging $myCertStore]
CkCertStore_put_VerboseLogging $myCertStore $boolVal

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.

Version (string)

# ckStr is a CkString
CkCertStore_get_Version $myCertStore $ckStr
set strVal [CkCertStore_get_version $myCertStore]

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

Methods

# cert is a CkCert
set status [CkCertStore_AddCertificate $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 1 for success, 0 for failure.

# filename is a string
set status [CkCertStore_CreateFileStore $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 1 for success, 0 for failure.

set status [CkCertStore_CreateMemoryStore]

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

Returns 1 for success, 0 for failure.

# regRoot is a string
# regPath is a string
set status [CkCertStore_CreateRegistryStore $regRoot $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 1 for success, 0 for failure.

# returns a CkCert
# name is a string
set ret_cert [CkCertStore_FindCertByRfc822Name $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.

Returns NULL on failure

# returns a CkCert
# str is a string
set ret_cert [CkCertStore_FindCertBySerial $str]

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

Returns NULL on failure.

Returns NULL on failure

# returns a CkCert
# str is a string
set ret_cert [CkCertStore_FindCertBySha1Thumbprint $str]

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

Returns NULL on failure.

Returns NULL on failure

# returns a CkCert
# str is a string
set ret_cert [CkCertStore_FindCertBySubject $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.

Returns NULL on failure

# returns a CkCert
# str is a string
set ret_cert [CkCertStore_FindCertBySubjectCN $str]

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

Returns NULL on failure.

Returns NULL on failure

# returns a CkCert
# str is a string
set ret_cert [CkCertStore_FindCertBySubjectE $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.

Returns NULL on failure

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

# returns a CkCert
# str is a string
set ret_cert [CkCertStore_FindCertBySubjectO $str]

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

Returns NULL on failure.

Returns NULL on failure

# returns a CkCert
# emailAddress is a string
set ret_cert [CkCertStore_FindCertForEmail $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.

Returns NULL on failure

# returns a CkCert
# index is an integer
set ret_cert [CkCertStore_GetCertificate $index]

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

Returns NULL on failure.

Returns NULL on failure

# returns a CkCert
# index is an integer
set ret_cert [CkCertStore_GetEmailCert $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.

Returns NULL on failure

# pemPath is a string
set status [CkCertStore_LoadPemFile $pemPath]

Loads the certificates contained within a PEM formatted file.

Returns 1 for success, 0 for failure.

# pemString is a string
set status [CkCertStore_LoadPemStr $pemString]

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

Returns 1 for success, 0 for failure.

# pfxData is a CkByteData
# password is a string
set status [CkCertStore_LoadPfxData $pfxData $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 1 for success, 0 for failure.

# pfxFilename is a string
# password is a string
set status [CkCertStore_LoadPfxFile $pfxFilename $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.

Returns 1 for success, 0 for failure.

# readOnly is a boolean
set status [CkCertStore_OpenCurrentUserStore $readOnly]

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Current-User\Personal certificate store. Set readOnly = 1 if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = 1 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 1 for success, 0 for failure.

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

# filename is a string
# readOnly is a boolean
set status [CkCertStore_OpenFileStore $filename $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 1 for success, 0 for failure.

# readOnly is a boolean
set status [CkCertStore_OpenLocalSystemStore $readOnly]

(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Local-Computer\Personal certificate store. Set readOnly = 1 if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = 1 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 1 for success, 0 for failure.

# regRoot is a string
# regPath is a string
# readOnly is a boolean
set status [CkCertStore_OpenRegistryStore $regRoot $regPath $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 = 1 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 1 for success, 0 for failure.

# storeLocation is a string
# storeName is a string
# readOnly is a boolean
set status [CkCertStore_OpenWindowsStore $storeLocation $storeName $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 = 1 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 1 for success, 0 for failure.

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

# cert is a CkCert
set status [CkCertStore_RemoveCertificate $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 1 for success, 0 for failure.

# path is a string
set status [CkCertStore_SaveLastError $path]

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

Returns 1 for success, 0 for failure.