CertStore Objective-C Reference Documentation
CkoCertStore
Current Version: 10.1.2
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
CkoCertStore *obj = [[CkoCertStore alloc] init];
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: YES means success, NO 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 YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
AddCertificate
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 YES for success, NO for failure.
CloseCertStore
This method closes any open certificate stores, removes all certificates from the object, and sets the NumCertificates property back to 0.
Returns YES for success, NO for failure.
topFindCert
Searches for a certificate using the criteria in json and stores the result in cert. See the examples below for details.
Returns YES for success, NO for failure.
FindCertBySerial
This method is deprecated and will be removed in a future major version. Use FindCert instead.
Returns nil on failure
FindCertBySha1Thumbprint
This method is deprecated and will be removed in a future major version. Use FindCert instead.
Returns nil on failure
FindCertBySubjectCN
This method is deprecated and will be removed in a future major version. Use FindCert instead.
Returns nil on failure
FindCertBySubjectE
This method is deprecated and will be removed in a future major version. Use FindCert instead.
Returns nil on failure
FindCertBySubjectO
This method is deprecated and will be removed in a future major version. Use FindCert instead.
Returns nil on failure
GetCert
Loads the Nth certificate into cert. The first certificate is at index 0.
Returns YES for success, NO for failure.
GetCertificate
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
LoadPemFile
Loads the certificates contained within a PEM formatted file.
Returns YES for success, NO for failure.
topLoadPemStr
Loads the certificates contained within an in-memory PEM formatted string.
Returns YES for success, NO for failure.
topLoadPfxBd
Loads the PFX/P12 bytes contained in bd. password is the password to the PFX.
Returns YES for success, NO for failure.
topLoadPfxFile
password:(NSString *)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.
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 YES for success, NO 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 YES for success, NO for failure.
OpenSmartcard
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 YES for success, NO 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 YES for success, NO for failure.
top