|
Digital
Certificate ActiveX Reference
Chilkat
Certificate makes it easy to gather information about the certificates
on your computer. It also allows you to add or remove individual
certificates from certificate stores.
The Chilkat
Certificate ActiveX control provides three (3) classes. Only one
of these, ChilkatCreateCS, is an object that can be added to a
Visual Basic form.
ChilkatCreateCS
Properties •
Methods
This
object is only used to create ChilkatCertStore objects.
ChilkatCertStore
Properties
• Methods
This
object represents a certificate store. Certificate stores can
reside in the registry, within files, or in memory. This object
provides a simple and common interface for any type of certificate
store.
ChilkatCert
Properties
• Methods
This
object represents a certificate within a certificate store. ChilkatCert
doesn't allow you to modify the information in a certificate,
but you can easily gather information from the certificate, such
as it's subject, issuer, intended purpose, etc.
ChilkatCert
Properties
- ForClientAuthentication
As Boolean read-only
- TRUE if this certificate
can be used for client authentication.
-
- ForCodeSigning
As Boolean read-only
- TRUE if this certificate
can be used for code signing.
-
- ForSecureEmail
As Boolean read-only
- TRUE if this certificate
can be used for sending secure email.
-
- ForServerAuthentication
As Boolean read-only
- TRUE if this certificate
can be used for server authentication.
-
- ForTimeStamping
As Boolean read-only
- TRUE if this certificate
can be used for time stamping.
-
- SerialNumber
As String read-only
- The certificate's
serial number.
-
- IssuerCN As
String read-only
- The certificate
issuer's common name. The issuer identifies the issuer of the
certificate.
-
- IssuerDN As
String read-only
- The issuer's full
distinguished name.
-
- IssuerE As String
read-only
- The certificate
issuer's email address.
-
- IssuerOU As
String read-only
- The certificate
issuer's organizational unit, which is the unit within the organization.
The issuer identifies the issuer of the certificate.
-
- IssuerO As String
read-only
- The certificate
issuer's organization, which is typically the company name.
The issuer identifies the issuer of the certificate.
-
- IssuerL As String
read-only
- The certificate
issuer's locality, which could be a city, count, township, or
other geographic region. The issuer identifies the issuer of
the certificate.
-
- IssuerS As String
read-only
- The certificate
issuer's state or province. The issuer identifies the issuer
of the certificate.
-
- IssuerC As String
read-only
- The certificate
issuer's country. The issuer identifies the issuer of the certificate.
-
- SubjectCN As
String read-only
- The certificate
subject's common name. The subject identifies the owner of the
certificate.
-
- SubjectDN As
String read-only
- The subject's full
distinguished name.
-
- SubjectE As
String read-only
- The certificate
subject's email address.
-
- SubjectOU As
String read-only
- The certificate
subject's organizational unit, which is the unit within the
organization. The subject identifies the owner of the certificate.
-
- SubjectO As
String read-only
- The certificate
subject's organization, which is typically the company name.
The subject identifies the owner of the certificate.
-
- SubjectL As
String read-only
- The certificate
subject's locality, which could be a city, count, township,
or other geographic region. The subject identifies the owner
of the certificate.
-
- SubjectS As
String read-only
- The certificate
subject's state or province. The subject identifies the owner
of the certificate.
-
- SubjectC As
String read-only
- The certificate
subject's country. The subject identifies the owner of the certificate.
-
- ValidFrom As
Date read-only
- The date this certificate
becomes (or became) valid.
-
- ValidTo As Date
read-only
- The date this certificate
becomes (or became) invalid.
-
- Version As String
read-only
- The version of
this component, such as "1.0"
ChilkatCert
Methods
- GetEncoded()
As String
- Returns an encoded
string representation of the certificate, which can be passed
to SetFromEncoded to recreate the certificate object.
- IsExpired()
As Long (v3.1.0)
- Returns 1 if the
certificate is expired, or 0 if it is not yet expired.
- SetFromEncoded(encodedCert
As String)
- Initializes the
certificate object from an encoded string created by the GetEncoded
method.
- LoadFromFile(filename
As String)
- Loads a certificate
from a .cer, .p7b, or .pem file. This method accepts certificates
from files in any of the following formats:
- • DER
encoded binary X.509 (.CER)
• Base-64 encoded X.509 (.CER)
• Cryptographic Message Syntax Standard - PKCS #7 Certificates
(.P7B)
• PEM format
This method decodes the certificate based on the contents
if finds within the file, and not based on the file extension.
If your certificate is in a file having a different extension,
try loading it using this method before assuming it won't
work. This method does not load .p12 or .pfx (PKCS #12)
files.
- LoadFromBase64(encodedCert
As String)
- Loads an ASN.1
or DER encoded certificate represented in a Base64 string.
- LoadFromBinary(encodedCertBlob
As Variant)
- Loads an ASN.1
or DER encoded certificate represented as a binary blob.
ChilkatCertStore
Properties
- NumCertificates
As Long read-only
- The number of certificates
held in the certificate store.
-
- NumEmailCertificates
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"
ChilkatCertStore
Methods
- AddCertificate(certificate
As ChilkatCert)
- Adds the passed
certificate to the store. If the certificate is already in the
store, it is updated with the new information.
-
- FindCertForEmail(emailAddress
As String) As ChilkatCert
- Finds the certificate
that can be used to send secure email to the passed email address.
Returns NULL if none are found.
-
- 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.
-
- FindCertBySerial(serialNumber
As String) As ChilkatCert
- Finds the certificate
that has the matching serial number.
-
- 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(str
As String) As ChilkatCert
- Finds a certificate
where the SubjectCN property (common name) matches exactly (but
case insensitive) with the passed string.
-
- FindCertBySubjectE(str
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(str
As String) As ChilkatCert
- Finds a certificate
where the SubjectO property (organization) matches exactly (but
case insensitive) with the passed string.
-
- 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.
-
- RemoveCertificate(certificate
As ChilkatCert)
- Removes the passed
certificate from the store. The certificate object passed as
the argument can no longer be used once removed.
ChilkatCreateCS
Properties
- ReadOnly As
Long read-write
- Determines whether
certificate stores are opened with read-only or read/write permissions.
Only applies to methods such as OpenCurrentUserStore, where
the a readOnly parameter is not present. The default is TRUE
(1).
- Version As String
read-only
- The version of
this component, such as "1.0"
ChilkatCreateCS
Methods
- CreateFileStore(filename
As String) As ChilkatCertStore
- Creates a file-based
certificate store. If 'filename' already exists, the method
will fail.
- CreateMemoryStore()
As ChilkatCertStore
- Creates a temporary
certificate store in memory that is initially empty.
- CreateRegistryStore(hiveName
As String, regPath As String) As ChilkatCertStore
- Creates a registry-based
certificate store. The 'hiveName' can either be "CurrentUser"
or "LocalMachine". The 'regPath' argument should
be specified without a leading slash, such as "Software/Chilkat/MyCertStore".
OpenChilkatStore()
As ChilkatCertStore
- Opens the certificate
store used by Chilkat Mail and returns the object representing
that store.
- OpenCurrentUserStore()
As ChilkatCertStore
- Opens the local
system's Current User Certificate Store and returns the object
representing that store.
- OpenFileStore(filename
As String, readOnly As Long) As ChilkatCertStore
- Opens an existing
file certificate store. To open it read-only, readOnly should
be non-zero.
- OpenLocalSystemStore()
As ChilkatCertStore
- Opens the local
system's Local Machine Certificate Store and returns the object
representing that store.
- OpenOutlookStore()
As ChilkatCertStore
- Opens the certificate
store used by Microsoft Outlook (and Office) and returns the
object representing that store.
- OpenRegistryStore(hiveName
As String, regPath As String) As ChilkatCertStore
- Opens an existing
registry-based certificate store. 'hiveName' should be either
"CurrentUser" or "LocalMachine". The 'regPath'
argument should be specified without a leading slash, such
as "Software/Chilkat/MyCertStore".
- SaveXmlLog(filename
As String)
- Saves the log
to an XML formatted file. The log contains any errors or other
information accumulated from previous method calls to any
of the classes/objects in the Chilkat Certificate component.
- UnlockComponent(unlockCode
As String)
- The Chilkat Certificate
component no longer needs to be unlocked starting with version
1.3.1. You do not have to call this method.
|
