CertStore Swift Reference Documentation

CkoCertStore

Current Version: 10.1.0

Represents a collection of certificates that can be loaded from various sources, including:

  • .pfx or .p12 file containing certificates and private keys.
  • PEM file containing multiple certificates and keys.
  • Windows Certificate Store
  • Apple Keychain (starting in version Chilkat v10.0.0)
  • Connected Smartcards and USB Tokens

Object Creation

let obj = CkoCertStore()!

Properties

DebugLogFilePath
debugLogFilePath: String!

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
lastErrorHtml: String! (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
lastErrorText: String! (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
lastErrorXml: String! (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
lastMethodSuccess: Bool

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
NumCertificates
numCertificates: Int (read-only)

The number of certificates held in the certificate store.

top
SmartCardPin
smartCardPin: String!
Introduced in version 9.5.0.86

Can be set to the PIN value for a certificate / private key stored on a smart card.

top
UncommonOptions
uncommonOptions: String!
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.

top
VerboseLogging
verboseLogging: Bool

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: String! (read-only)

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

More Information and Examples
top

Methods

AddCertificate
addCertificate(cert: CkoCert) -> Bool

Beginning with Chilkat v10.0.0, on macOS and iOS, this adds the certificate, including any private keys and intermediate CA certificates, to the Apple Keychain.

Returns true for success, false for failure.

More Information and Examples
top
CloseCertStore
close() -> Bool
Introduced in version 9.5.0.94

This method closes any open certificate stores, removes all certificates from the object, and sets the NumCertificates property back to 0.

Returns true for success, false for failure.

top
FindCert
findCert(json: CkoJsonObject, cert: CkoCert) -> Bool
Introduced in version 10.1.2

Searches for a certificate using the criteria in json and stores the result in cert. See the examples below for details.

Returns true for success, false for failure.

top
FindCertBySerial
findCert(bySerial: String) -> CkoCert
This method is deprecated. It will be removed in a future version.

This method is deprecated and will be removed in a future major version. Use FindCert instead.

Returns nil on failure

More Information and Examples
top
FindCertBySha1Thumbprint
findCert(bySha1Thumbprint: String) -> CkoCert
This method is deprecated. It will be removed in a future version.

This method is deprecated and will be removed in a future major version. Use FindCert instead.

Returns nil on failure

More Information and Examples
top
FindCertBySubjectCN
findCert(bySubjectCN: String) -> CkoCert
This method is deprecated. It will be removed in a future version.

This method is deprecated and will be removed in a future major version. Use FindCert instead.

Returns nil on failure

More Information and Examples
top
FindCertBySubjectE
findCert(bySubjectE: String) -> CkoCert
This method is deprecated. It will be removed in a future version.

This method is deprecated and will be removed in a future major version. Use FindCert instead.

Returns nil on failure

More Information and Examples
top
FindCertBySubjectO
findCert(bySubjectO: String) -> CkoCert
This method is deprecated. It will be removed in a future version.

This method is deprecated and will be removed in a future major version. Use FindCert instead.

Returns nil on failure

More Information and Examples
top
GetCert
getCert(index: Int, cert: CkoCert) -> Bool
Introduced in version 10.1.2

Loads the Nth certificate into cert. The first certificate is at index 0.

Returns true for success, false for failure.

top
GetCertificate
getCertificate(index: Int) -> CkoCert
This method is deprecated. It will be removed in a future version.

Returns the Nth certificate from the store, with indexing starting at 0. This function is deprecated; please use GetCert instead, as demonstrated in the example below.

Returns nil on failure

top
LoadPemFile
loadPemFile(pemPath: String) -> Bool

Loads the certificates contained within a PEM formatted file.

Returns true for success, false for failure.

top
LoadPemStr
loadPemStr(pemString: String) -> Bool

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

Returns true for success, false for failure.

top
LoadPfxBd
loadPfxBd(bd: CkoBinData, password: String) -> Bool
Introduced in version 10.1.2

Loads the PFX/P12 bytes contained in bd. password is the password to the PFX.

Returns true for success, false for failure.

top
LoadPfxFile
loadPfxFile(path: String, password: String) -> Bool

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.

top
OpenCurrentUserStore
openCurrentUserStore(readOnly: Bool) -> Bool

Starting in version 10.0.0, this method opens the Apple Keychain on MacOS and iOS systems. The readOnly is ignored.

After opening the store, you can search for certificates using the Find* methods. Alternatively, you can iterate through the certificates by indexing from 0 to NumCertificates-1, using GetCertificate to access each one.

Returns true for success, false for failure.

More Information and Examples
top
OpenSmartcard
openSmartcard(csp: String) -> Bool
Introduced in version 10.1.2

This function identifies connected HSM devices such as smart cards and USB tokens, and loads the certificates from each device. It has been significantly enhanced in Chilkat v10.1.2 and is compatible with Windows, MacOS, iOS, and Linux. Android is not supported.

Note: If multiple HSM devices are connected, avoid setting the SmartCardPin property unless all devices share the same PIN. Otherwise, Chilkat will attempt to use that PIN for each device, which could cause issues.

Returns true for success, false for failure.

top
RemoveCertificate
removeCertificate(cert: CkoCert) -> Bool

(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