--- product: Chilkat product_version: 11.7.0 language: pascal language_label: Lazarus Pascal class: CertStore license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/pascal_CertStoreRef.html --- # Chilkat CertStore — Lazarus Pascal — v11.7.0 > Chilkat 11.7.0 · language=pascal · class=CertStore > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/CertStore.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/guide.md`. ## Purpose **Open, search, manage, and use certificate collections from many sources.** `Chilkat.CertStore` is the Chilkat class for working with collections of X.509 certificates. It can open and manage certificates from system stores, Apple Keychain, Windows registry or file stores, memory stores, PEM files, PFX/P12 files, and smart card or USB token devices. It supports loading, searching, iterating, adding, removing, and closing certificate stores, with platform-specific behavior for Windows and Apple Keychain. **Open certificate stores** Access certificates from Windows certificate stores, Apple Keychain, files, memory stores, PEM bundles, PFX/P12 files, and hardware tokens. **Search and retrieve certs** Find certificates by subject, issuer, serial number, thumbprint, email, private-key availability, or other identifying information. **Iterate collections** Enumerate certificates in a store and retrieve each certificate as a `Chilkat.Cert` object for inspection or use. **Add and remove certificates** Add certificates to writable stores, remove certificates where supported, and manage store contents from application code. **Private-key backed certs** Work with certificates that have associated private keys from PFX/P12, operating-system stores, smart cards, USB tokens, or other providers. **Use across Chilkat** Pass retrieved certificates to other Chilkat classes for TLS client authentication, S/MIME, signing, encryption, decryption, and verification. **Common pattern:** Open the appropriate certificate store, search or iterate to find the needed certificate, retrieve it as a `Chilkat.Cert`, and then pass that certificate to the Chilkat class that needs it. Use certificate stores when the application should select from existing system, file-based, keychain, or hardware-backed certificates. For an extended overview, see [CertStore Class Overview](https://www.chilkatsoft.com/certstore_class_overview.asp). ## Object creation, unlocking and error handling **Create / Free** ```pascal uses Chilkat.CertStore; var obj: TCertStore; begin obj := TCertStore.Create; try if not obj.IsValid then raise Exception.Create('Failed to create a TCertStore instance.'); // ... use obj ... finally obj.Free; end; end; ``` `constructor Create;` Allocates the underlying CkCertStore object and returns a new TCertStore instance. Simply adding **Chilkat.CertStore** to the unit's `uses` clause is enough to locate and bind to the Chilkat shared library (DLL / .so / .dylib) at runtime — no separate load step is required. Check `obj.IsValid` after calling `Create`; it is `False` if the underlying library could not be found/loaded or the object could not be allocated (for example, when unlicensed). `destructor Destroy; override;` Every TCertStore created by calling `Create` should eventually be released by calling `.Free` (inherited from `TObject`). The destructor automatically disposes the underlying CkCertStore handle. A native (unmanaged) memory leak occurs if the object is never freed. Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Lazarus Pascal. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `property DebugLogFilePath: string read GetDebugLogFilePath write SetDebugLogFilePath;` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastErrorHtml` | `property LastErrorHtml: string read GetLastErrorHtml;` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `property LastErrorText: string read GetLastErrorText;` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `property LastErrorXml: string read GetLastErrorXml;` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `property LastMethodSuccess: Boolean read GetLastMethodSuccess write SetLastMethodSuccess;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `VerboseLogging` | `property VerboseLogging: Boolean read GetVerboseLogging write SetVerboseLogging;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `property Version: string read GetVersion;` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `AvoidWindowsPkAccess` | property, read/write | `property AvoidWindowsPkAccess: Boolean read GetAvoidWindowsPkAccess write SetAvoidWindowsPkAccess;` | | `NumCertificates` | property, read-only | `property NumCertificates: Integer read GetNumCertificates;` | | `SmartCardPin` | property, read/write | `property SmartCardPin: string read GetSmartCardPin write SetSmartCardPin;` | | `UncommonOptions` | property, read/write | `property UncommonOptions: string read GetUncommonOptions write SetUncommonOptions;` | | `AddCertificate` | method | `// cert is a TCert object. function AddCertificate(cert: TChilkatBase): Boolean;` | | `CloseCertStore` | method | `function CloseCertStore: Boolean;` | | `CreateFileStore` | method | `function CreateFileStore(const filename: string): Boolean;` | | `CreateMemoryStore` | method | `function CreateMemoryStore: Boolean;` | | `CreateRegistryStore` | method | `function CreateRegistryStore(const regRoot: string;     const regPath: string): Boolean;` | | `FindCert` | method | `// json is a TJsonObject object. // cert is a TCert object. function FindCert(json: TChilkatBase;     cert: TChilkatBase): Boolean;` | | `GetCert` | method | `// cert is a TCert object. function GetCert(index: Integer;     cert: TChilkatBase): Boolean;` | | `LoadPemFile` | method | `function LoadPemFile(const pemPath: string): Boolean;` | | `LoadPemStr` | method | `function LoadPemStr(const pemString: string): Boolean;` | | `LoadPfxBd` | method | `// bd is a TBinData object. function LoadPfxBd(bd: TChilkatBase;     const password: string): Boolean;` | | `LoadPfxFile` | method | `function LoadPfxFile(const pfxFilename: string;     const password: string): Boolean;` | | `OpenCurrentUserStore` | method | `function OpenCurrentUserStore(bReadOnly: Boolean): Boolean;` | | `OpenFileStore` | method | `function OpenFileStore(const filename: string;     bReadOnly: Boolean): Boolean;` | | `OpenLocalSystemStore` | method | `function OpenLocalSystemStore(bReadOnly: Boolean): Boolean;` | | `OpenRegistryStore` | method | `function OpenRegistryStore(const regRoot: string;     const regPath: string;     bReadOnly: Boolean): Boolean;` | | `OpenSmartcard` | method | `function OpenSmartcard(const csp: string): Boolean;` | | `OpenWindowsStore` | method | `function OpenWindowsStore(const storeLocation: string;     const storeName: string;     bReadOnly: Boolean): Boolean;` | | `RemoveCertificate` | method | `// cert is a TCert object. function RemoveCertificate(cert: TChilkatBase): Boolean;` | ## Properties ### CertStore.AvoidWindowsPkAccess `Chilkat 11.7.0 · pascal · CertStore · AvoidWindowsPkAccess · property · read/write` ```pascal property AvoidWindowsPkAccess: Boolean read GetAvoidWindowsPkAccess write SetAvoidWindowsPkAccess; ``` 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`. ### CertStore.NumCertificates `Chilkat 11.7.0 · pascal · CertStore · NumCertificates · property · read-only` ```pascal property NumCertificates: Integer read GetNumCertificates; ``` The number of certificates held in the certificate store. ### CertStore.SmartCardPin `Chilkat 11.7.0 · pascal · CertStore · SmartCardPin · property · read/write · since 9.5.0.86` ```pascal property SmartCardPin: string read GetSmartCardPin write SetSmartCardPin; ``` Can be set to the PIN value for a certificate / private key stored on a smart card. ### CertStore.UncommonOptions `Chilkat 11.7.0 · pascal · CertStore · UncommonOptions · property · read/write · since 9.5.0.87` ```pascal property UncommonOptions: string read GetUncommonOptions write SetUncommonOptions; ``` This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty. ## Methods ### CertStore.AddCertificate `Chilkat 11.7.0 · pascal · CertStore · AddCertificate · method` ```pascal // cert is a TCert object. function AddCertificate(cert: TChilkatBase): Boolean; ``` On Windows, this updates or adds `cert` to the open Windows certificate store. Note: This imports the certificate without the private key. The `Chilkat.Pfx.ImportToWindows` method must be called to import a certificate with a private key. 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. ### CertStore.CloseCertStore `Chilkat 11.7.0 · pascal · CertStore · CloseCertStore · method · since 9.5.0.94` ```pascal function CloseCertStore: Boolean; ``` 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. ### CertStore.CreateFileStore `Chilkat 11.7.0 · pascal · CertStore · CreateFileStore · method` ```pascal function CreateFileStore(const filename: string): Boolean; ``` 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. ### CertStore.CreateMemoryStore `Chilkat 11.7.0 · pascal · CertStore · CreateMemoryStore · method` ```pascal function CreateMemoryStore: Boolean; ``` 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. ### CertStore.CreateRegistryStore `Chilkat 11.7.0 · pascal · CertStore · CreateRegistryStore · method` ```pascal function CreateRegistryStore(const regRoot: string;     const regPath: string): Boolean; ``` 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. ### CertStore.FindCert `Chilkat 11.7.0 · pascal · CertStore · FindCert · method · since 10.1.2` ```pascal // json is a TJsonObject object. // cert is a TCert object. function FindCert(json: TChilkatBase;     cert: TChilkatBase): Boolean; ``` Searches for a certificate using criteria from `json` and stores the result in `cert`. If multiple criteria are provided, it searches each one sequentially and returns the first match. Preference is given to non-expired certificates, so if both expired and non-expired certificates match, the non-expired one is selected. See the examples below for details. Returns True for success, False for failure. ### CertStore.GetCert `Chilkat 11.7.0 · pascal · CertStore · GetCert · method · since 10.1.2` ```pascal // cert is a TCert object. function GetCert(index: Integer;     cert: TChilkatBase): Boolean; ``` Loads the Nth certificate into `cert`. The first certificate is at index 0. Returns True for success, False for failure. ### CertStore.LoadPemFile `Chilkat 11.7.0 · pascal · CertStore · LoadPemFile · method` ```pascal function LoadPemFile(const pemPath: string): Boolean; ``` Loads the certificates contained within a PEM formatted file. Returns True for success, False for failure. ### CertStore.LoadPemStr `Chilkat 11.7.0 · pascal · CertStore · LoadPemStr · method` ```pascal function LoadPemStr(const pemString: string): Boolean; ``` Loads the certificates contained within an in-memory PEM formatted string. Returns True for success, False for failure. ### CertStore.LoadPfxBd `Chilkat 11.7.0 · pascal · CertStore · LoadPfxBd · method · since 10.1.2` ```pascal // bd is a TBinData object. function LoadPfxBd(bd: TChilkatBase;     const password: string): Boolean; ``` Loads the PFX/P12 bytes contained in `bd`. `password` is the password to the PFX. Returns True for success, False for failure. ### CertStore.LoadPfxFile `Chilkat 11.7.0 · pascal · CertStore · LoadPfxFile · method` ```pascal function LoadPfxFile(const pfxFilename: string;     const password: string): Boolean; ``` 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. ### CertStore.OpenCurrentUserStore `Chilkat 11.7.0 · pascal · CertStore · OpenCurrentUserStore · method` ```pascal function OpenCurrentUserStore(bReadOnly: Boolean): Boolean; ``` On Windows, this method opens the **Current-User\\Personal** certificate store in the registry. Set `bReadOnly` 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 `bReadOnly` 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. ### CertStore.OpenFileStore `Chilkat 11.7.0 · pascal · CertStore · OpenFileStore · method` ```pascal function OpenFileStore(const filename: string;     bReadOnly: Boolean): Boolean; ``` (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. ### CertStore.OpenLocalSystemStore `Chilkat 11.7.0 · pascal · CertStore · OpenLocalSystemStore · method` ```pascal function OpenLocalSystemStore(bReadOnly: Boolean): Boolean; ``` (This method is only available on Microsoft Windows operating systems.) Opens the registry-based Local-Computer\\Personal certificate store. Set `bReadOnly` = `True` if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting `bReadOnly` = `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. ### CertStore.OpenRegistryStore `Chilkat 11.7.0 · pascal · CertStore · OpenRegistryStore · method` ```pascal function OpenRegistryStore(const regRoot: string;     const regPath: string;     bReadOnly: Boolean): Boolean; ``` (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 `bReadOnly` = `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. ### CertStore.OpenSmartcard `Chilkat 11.7.0 · pascal · CertStore · OpenSmartcard · method · since 10.1.2` ```pascal function OpenSmartcard(const csp: string): Boolean; ``` 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 yet supported.) Note: The `csp` is no longer used and is ignored. Applications should pass an empty string. 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. ### CertStore.OpenWindowsStore `Chilkat 11.7.0 · pascal · CertStore · OpenWindowsStore · method · since 9.5.0.49` ```pascal function OpenWindowsStore(const storeLocation: string;     const storeName: string;     bReadOnly: Boolean): Boolean; ``` (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 `bReadOnly` = `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. ### CertStore.RemoveCertificate `Chilkat 11.7.0 · pascal · CertStore · RemoveCertificate · method` ```pascal // cert is a TCert object. function RemoveCertificate(cert: TChilkatBase): Boolean; ``` (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. ## Related classes [`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/BinData.md), [`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/Cert.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/JsonObject.md)