CkCertStore

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

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.

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.

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.

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.

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.

The number of certificates held in the certificate store.

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

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.

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

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.

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

On Windows, this updates or adds cert to the open Windows certificate store.

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.

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.

This method, available only on Microsoft Windows, creates a new file-based certificate store. You can save certificates to this store by using the AddCertificate function.

Internally, the Microsoft function CertOpenStore is called with the provider type CERT_STORE_PROV_FILE and the flag CERT_STORE_CREATE_NEW_FLAG, to create a new, empty certificate store that is backed by a file.

Returns true for success, false for failure.

This method, available only on Microsoft Windows, creates an in-memory certificate store. Certificates may be added by calling AddCertificate.

Internally, the Microsoft function CertOpenStore is called with the provider type CERT_STORE_PROV_MEMORY to create a new in-memory certificate store. This store acts as a temporary container for managing certificates during runtime. The store exists only in memory and is not backed by a file or persistent storage. Certificates can be added, retrieved, or removed, but the store is lost when the application ends unless explicitly saved elsewhere.

Returns true for success, false for failure.

This method, available only on Microsoft Windows, creates a new registry-based certificate store. You can save certificates to this store by using the AddCertificate function.

Internally, the Microsoft function CertOpenStore is called with the provider type CERT_STORE_PROV_REG and a registry key to create a new, empty certificate store in the Windows registry.

regRoot can be the string "CurrentUser" or "LocalMachine". regPath is a registry key path such as "Software/MyApplication/Certificates".

Returns true for success, false for failure.

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.

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

Returns nil on failure

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

Returns nil on failure

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

Returns nil on failure

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

Returns nil on failure

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

Returns nil on failure

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

Returns nil on failure

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

Returns true for success, false for failure.

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

Loads the certificates contained within a PEM formatted file.

Returns true for success, false for failure.

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

Returns true for success, false for failure.

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

Returns true for success, false for failure.

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.

On Windows, this method opens the Current-User\Personal certificate store in the registry. Set readOnly to true to open the store in read-only mode, which allows you to fetch certificates without adding or removing them. This prevents "permission denied" errors that require read-write access.

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.

(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 true for success, false for failure.

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

(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 = true 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 true for success, false for failure.

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.

(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 = true 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 true for success, false for failure.

(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.