CertStore Swift Reference Documentation
CkoCertStore
Current Version: 10.1.0
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
let obj = CkoCertStore()!
Properties
DebugLogFilePath
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.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
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.
topNumCertificates
The number of certificates held in the certificate store.
topSmartCardPin
Can be set to the PIN value for a certificate / private key stored on a smart card.
topUncommonOptions
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.
topVerboseLogging
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.
topVersion
Methods
AddCertificate
Starting with Chilkat version 10.0.0, on macOS and iOS, this adds the certificate, along with any private keys and intermediate CA certificates, to the Apple Keychain.
Returns true for success, false for failure.
CloseCertStore
(This method only available on Microsoft Windows operating systems.)
Closes the certificate store previously opened by one of the Open* methods.
Returns true for success, false for failure.
topFindCertByRfc822Name
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
topFindCertBySerial
Finds and returns the certificate that has the matching serial number.
Returns nil on failure.
Returns nil on failure
topFindCertBySha1Thumbprint
Finds a certificate by it's SHA-1 thumbprint. The thumbprint is a hexidecimal string.
Returns nil on failure.
Returns nil on failure
topFindCertBySubject
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
topFindCertBySubjectCN
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
topFindCertBySubjectE
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
topFindCertBySubjectO
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
topGetCertificate
Returns the Nth certificate in the store. The first certificate is at index 0.
Returns nil on failure.
Returns nil on failure
topGetEmailCert
(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
topLoadPemFile
Loads the certificates contained within a PEM formatted file.
Returns true for success, false for failure.
topLoadPemStr
Loads the certificates contained within an in-memory PEM formatted string.
Returns true for success, false for failure.
topLoadPfxData
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.
topLoadPfxFile
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.
OpenCurrentUserStore
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.
OpenSmartcard
On Windows, the system utilizes Microsoft CNG and/or CryptoAPI for accessing connected smartcards and USB tokens. For potentially better results, use Cert.LoadFromSmartcard, which can automatically detect and select between PKCS11, ScMinidriver, MS CNG, and MS CryptoAPI. On macOS and iOS, the Apple Keychain is employed.
Note: Chilkat version 10.0.0 and later supports Apple Keychain. csp is deprecated and unused; always pass an empty string for csp.
Returns true for success, false for failure.
RemoveCertificate
(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