ChilkatCertStore ActiveX Reference
ChilkatCertStore
* This is a freeware class/component/library.
Represents a certificate store. The certificate store can be registry-based, file-based, or in-memory. Allows certificates to be added, removed, or retrieved.
Object Creation
(Visual Basic 6.0)
Dim obj As New ChilkatCertStore
(ASP)
set obj = Server.CreateObject("Chilkat.CertStore")
(VBScript)
set obj = CreateObject("Chilkat.CertStore")
(Delphi)
obj := TChilkatCertStore.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.CertStore')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.CertStore', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.CertStore");
Properties
LastErrorHtml As String (read-only)
Error information in HTML format for the last method called.
LastErrorText As String (read-only)
Error information in plain-text format for the last method called.
LastErrorXml As String (read-only)
Error information in XML format for the last method called.
LinkForSigning As Long
If 1 then the certificates returned by the various FindCert* methods are linked internally with the corresponding private key (if it exists) before being returned. This property must be set to 1 if the returned digital certificate is to be used for creating a digital signature. The default value of this property is 0.
NumCertificates As Long (read-only)
The number of certificates held in the certificate store.
NumEmailCerts As Long (read-only)
The number of certificates that can be used for sending secure email within this store.
Version As String (read-only)
The version of this component, such as "1.0"
Methods
AddCertificate(cert As ChilkatCert)
Adds a certificate to the store. If the certificate is already in the store, it is updated with the new information.
CreateFileStore(filename As String) As Long
Creates a new file-based certificate store. Certificates may be saved to this store by calling AddCertificate. Returns 1 for success, 0 for failure.
CreateMemoryStore() As Long
Creates an in-memory certificate store. Certificates may be added by calling AddCertificate. Returns 1 for success, 0 for failure.
CreateRegistryStore(regRoot As String, regPath As String) As Long
Creates a registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates". Returns 1 for success, 0 for failure.
FindCertByRfc822Name(name As String) As ChilkatCert
Locates a certificate by its RFC 822 name and returns it if found. Otherwise returns NULL.
FindCertBySerial(serialNumber As String) As ChilkatCert
Finds and returns the certificate that has the matching serial number.
FindCertBySha1Thumbprint(str As String) As ChilkatCert
Finds a certificate by it's SHA-1 thumbprint. The thumbprint is a hexidecimal string.
FindCertBySubject(str As String) As ChilkatCert
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.
FindCertBySubjectCN(commonName As String) As ChilkatCert
Finds a certificate where the SubjectCN property (common name) matches exactly (but case insensitive) with the passed string.
FindCertBySubjectE(emailAddress As String) As ChilkatCert
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.
FindCertBySubjectO(organization As String) As ChilkatCert
Finds a certificate where the SubjectO property (organization) matches exactly (but case insensitive) with the passed string.
FindCertForEmail(emailAddress As String) As ChilkatCert
Finds a certificate that can be used to send secure email to the passed email address. A certificate matches only if the ForSecureEmail property is TRUE, and the email address matches exactly (but case insensitive) with the SubjectE property. Returns NULL if no matches are found.
GetCertificate(index As Long) As ChilkatCert
Returns the Nth certificate in the store. The first certificate is at index 0.
GetEmailCert(index As Long) As ChilkatCert
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.
LoadPfxData(pfxData As Variant, password As String) As Long
Loads a PFX from an in-memory image of a PFX file. Returns 1 for success, 0 for failure.
LoadPfxFile(pfxFilename As String, password As String) As Long
Loads a PFX file. Returns 1 for success, 0 for failure.
OpenChilkatStore(readOnly As Long) As Long
Opens the registry-based local machine certificate store having the path "Software/Chilkat/SystemCertificates". If the certificate store does not exist, it is automatically created. Set readOnly = 1 if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = 1 will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
OpenCurrentUserStore(readOnly As Long) As Long
Opens the registry-based current-user certificate store. Set readOnly = 1 if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = 1 will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
OpenFileStore(filename As String, readOnly As Long) As Long
Opens a file-based certificate store. Returns 1 for success, 0 for failure.
OpenLocalSystemStore(readOnly As Long) As Long
Opens the registry-based local machine certificate store. Set readOnly = 1 if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = 1 will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
OpenOutlookStore(readOnly As Long) As Long
Opens the registry-based certificate store used by Outlook. Set readOnly = 1 if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = 1 will prevent many "permission denied" errors. Returns 1 for success, 0 for failure.
OpenRegistryStore(regRoot As String, regPath As String, readOnly As Long) As Long
Opens an arbitrary registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates". Returns 1 for success, 0 for failure.
RemoveCertificate(cert As ChilkatCert)
Removes the passed certificate from the store. The certificate object passed as the argument can no longer be used once removed.
SaveLastError(filename As String)
Saves the last error information to an XML formatted file.
|