CertStore SQL Server Reference Documentation
CertStore
Current Version: 11.6.0
Chilkat.CertStore
Access certificates from Windows certificate stores, Apple Keychain,
files, memory stores, PEM bundles, PFX/P12 files, and hardware tokens.
Find certificates by subject, issuer, serial number, thumbprint, email,
private-key availability, or other identifying information.
Enumerate certificates in a store and retrieve each certificate as a
Add certificates to writable stores, remove certificates where supported,
and manage store contents from application code.
Work with certificates that have associated private keys from PFX/P12,
operating-system stores, smart cards, USB tokens, or other providers.
Pass retrieved certificates to other Chilkat classes for TLS client
authentication, S/MIME, signing, encryption, decryption, and verification.
For an extended overview, see
CertStore Class Overview.
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
Search and retrieve certs
Iterate collections
Chilkat.Cert object for inspection or use.
Add and remove certificates
Private-key backed certs
Use across Chilkat
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.
Object Creation
DECLARE @hr int
DECLARE @certStore int
EXEC @hr = sp_OACreate 'Chilkat.CertStore', @certStore OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @certStore ...
EXEC @hr = sp_OADestroy @certStoreT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.CertStore.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @certStore, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
AvoidWindowsPkAccess
EXEC sp_OASetProperty @certStore, 'AvoidWindowsPkAccess', @iValue
Applies only when running on a Microsoft Windows operating system. If 1, 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 0.
DebugLogFilePath
EXEC sp_OASetProperty @certStore, 'DebugLogFilePath', @sValue
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
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
EXEC sp_OASetProperty @certStore, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumCertificates
The number of certificates held in the certificate store.
topSmartCardPin
EXEC sp_OASetProperty @certStore, 'SmartCardPin', @sValue
Can be set to the PIN value for a certificate / private key stored on a smart card.
topUncommonOptions
EXEC sp_OASetProperty @certStore, 'UncommonOptions', @sValue
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
EXEC sp_OASetProperty @certStore, 'VerboseLogging', @iValue
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AddCertificate
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 1 for success, 0 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 1 for success, 0 for failure.
topCreateFileStore
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 1 for success, 0 for failure.
topCreateMemoryStore
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 1 for success, 0 for failure.
topCreateRegistryStore
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 1 for success, 0 for failure.
topFindCert
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 1 for success, 0 for failure.
GetCert
Loads the Nth certificate into cert. The first certificate is at index 0.
Returns 1 for success, 0 for failure.
LoadPemFile
Loads the certificates contained within a PEM formatted file.
Returns 1 for success, 0 for failure.
topLoadPemStr
Loads the certificates contained within an in-memory PEM formatted string.
Returns 1 for success, 0 for failure.
topLoadPfxBd
Loads the PFX/P12 bytes contained in bd. password is the password to the PFX.
Returns 1 for success, 0 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 1 for success, 0 for failure.
OpenCurrentUserStore
On Windows, this method opens the Current-User\Personal certificate store in the registry. Set readOnly to 1 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 1 for success, 0 for failure.
OpenFileStore
(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 1 for success, 0 for failure.
topOpenLocalSystemStore
(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Local-Computer\Personal certificate store. Set readOnly = 1 if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = 1 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 1 for success, 0 for failure.
topOpenOutlookStore
(This method is only available on Microsoft Windows operating systems.)
Opens the registry-based Current-User\Other People certificate store. This is the certificate store use by Microsot Outlook. Set readOnly = 1 if only fetching certificates and not updating the certificate store (i.e. certificates will not be added or removed). Setting readOnly = 1 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 1 for success, 0 for failure.
topOpenRegistryStore
(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 = 1 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 1 for success, 0 for failure.
topOpenSmartcard
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 1 for success, 0 for failure.
OpenWindowsStore
(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 = 1 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 1 for success, 0 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 1 for success, 0 for failure.
top