Chilkat VB.NET CertStore Class Reference
CertStore
* This is a freeware class/component/library.
Represents a collection of certificates. The certificates may be loaded from a PFX (PKCS#12) or from a Windows-based certificate store. Many of the methods of this class are only applicable when running on a MS Windows operating system. The methods for opening, creating, and modifying Windows-based certificate stores (registry-based, file-based, and memory-based) are (of course) Windows-only. However, the methods for loading certs from PFX (PKCS#12), are valid on all supported operating systems, including Linux, MAC OS X, Windows, etc.
Object Creation
(C#)
Chilkat.CertStore obj = new Chilkat.CertStore();
(VB.NET)
Dim obj As New Chilkat.CertStore()
Properties
AvoidWindowsPkAccess As Boolean
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.
LastErrorHtml As String (ReadOnly)
Error information in HTML format for the last method called.
LastErrorText As String (ReadOnly)
Error information in plain-text format for the last method called.
LastErrorXml As String (ReadOnly)
Error information in XML format for the last method called.
NumCertificates As Integer (ReadOnly)
The number of certificates held in the certificate store.
NumEmailCerts As Integer (ReadOnly)
The number of certificates that can be used for sending secure email within this store.
VerboseLogging As Boolean
If set to True, then the LastErrorText may contain more verbose logging.
Version As String (ReadOnly)
The version of this component, such as "1.0"
Methods
Function AddCertificate(ByVal cert As Cert) As Boolean
Adds a certificate to the store. If the certificate is already in the store, it is updated with the new information. Returns true for success, false for failure.
Function CreateFileStore(ByVal filename As String) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Creates a new file-based certificate store. Certificates may be saved to this store by calling AddCertificate. Returns true for success, false for failure.
Function CreateMemoryStore() As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Creates an in-memory certificate store. Certificates may be added by calling AddCertificate. Returns true for success, false for failure.
Function CreateRegistryStore(ByVal regRoot As String, ByVal regPath As String) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Creates a registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates". Returns true for success, false for failure.
Function FindCertByRfc822Name(ByVal name As String) As Cert
Locates a certificate by its RFC 822 name and returns it if found.
Returns Nothing on failure.
Function FindCertBySerial(ByVal str As String) As Cert
Finds and returns the certificate that has the matching serial number.
Returns Nothing on failure.
Function FindCertBySha1Thumbprint(ByVal str As String) As Cert
Finds a certificate by it's SHA-1 thumbprint. The thumbprint is a hexidecimal string.
Returns Nothing on failure.
Function FindCertBySubject(ByVal str As String) As Cert
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.
Returns Nothing on failure.
Function FindCertBySubjectCN(ByVal str As String) As Cert
Finds a certificate where the SubjectCN property (common name) matches exactly (but case insensitive) with the passed string
Returns Nothing on failure.
Function FindCertBySubjectE(ByVal str As String) As Cert
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.
Returns Nothing on failure.
Function FindCertBySubjectO(ByVal str As String) As Cert
Finds a certificate where the SubjectO property (organization) matches exactly (but case insensitive) with the passed string.
Returns Nothing on failure.
Function FindCertForEmail(ByVal emailAddress As String) As Cert
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.
Returns Nothing on failure.
Function GetCertificate(ByVal index As Integer) As Cert
Returns the Nth certificate in the store. The first certificate is at index 0.
Returns Nothing on failure.
Function GetEmailCert(ByVal index As Integer) As Cert
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.
Returns Nothing on failure.
Function LoadPfxData(ByVal pfxData As Byte(), ByVal password As String) As Boolean
Loads a PFX from an in-memory image of 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. Returns true for success, false for failure.
Function LoadPfxFile(ByVal pfxFilename As String, ByVal password As String) As 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. Returns true for success, false for failure.
Function OpenChilkatStore(ByVal readOnly As Boolean) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) 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 = True if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = True will prevent many "permission denied" errors. Once loaded, the certificates within the store 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 contained in the store. Returns true for success, false for failure.
Function OpenCurrentUserStore(ByVal readOnly As Boolean) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Opens the registry-based current-user certificate store. Set readOnly = True if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = True will prevent many "permission denied" errors. Once loaded, the certificates within the store 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 contained in the store. Returns true for success, false for failure.
Function OpenFileStore(ByVal filename As String, ByVal readOnly As Boolean) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Opens a file-based certificate store. Once loaded, the certificates within the store 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 contained in the store. Returns true for success, false for failure.
Function OpenOutlookStore(ByVal readOnly As Boolean) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Opens the registry-based certificate store used by Outlook. Set readOnly = True if you are only fetching certificates and not updating the certificate store (i.e. you are not adding or removing certificates). Setting readOnly = True will prevent many "permission denied" errors. Once loaded, the certificates within the store 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 contained in the store. Returns true for success, false for failure.
Function OpenRegistryStore(ByVal regRoot As String, ByVal regPath As String, ByVal readOnly As Boolean) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) Opens an arbitrary registry-based certificate store. regRoot must be "CurrentUser" or "LocalMachine". regPath is a registry path such as "Software/MyApplication/Certificates". Once loaded, the certificates within the store 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 contained in the store. Returns true for success, false for failure.
Function RemoveCertificate(ByVal cert As Cert) As Boolean
(Relevant only when running on a Microsoft Windows operating system.) 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.
Function SaveLastError(ByVal filename As String) As Boolean
Saves the last error information to an XML formatted file.
|