Chilkat VB.NET Cert Class Reference
Cert
* This is a freeware class/component/library.
Digital certificate component / class
Properties
CspName As String (ReadOnly)
If the HasKeyContainer property is true, then the certificate is linked to a key container and this property contains the name of the associated CSP (cryptographic service provider). When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.
Expired As Boolean (ReadOnly)
Has a value of true if the certificate or any certificate in the chain of authority has expired. This information is not available when running on Windows 95/98 computers.
ForClientAuthentication As Boolean (ReadOnly)
true if this certificate can be used for client authentication, otherwise false.
ForCodeSigning As Boolean (ReadOnly)
true if this certificate can be used for code signing, otherwise false.
ForSecureEmail As Boolean (ReadOnly)
true if this certificate can be used for sending secure email, otherwise false.
ForServerAuthentication As Boolean (ReadOnly)
true if this certificate can be used for server authentication, otherwise false.
ForTimeStamping As Boolean (ReadOnly)
true if this certificate can be used for time stamping, otherwise false.
HasKeyContainer As Boolean (ReadOnly)
Indicates whether this certificate is linked to a key container. If true then the certificate is linked to a key container (usually containing a private key). If false, then it is not.
When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.
IntendedKeyUsage As Integer (ReadOnly)
Bitflags indicating the intended usages of the certificate.
The flags are:
Digital Signature: 0x80
Non-Repudiation: 0x40
Key Encipherment: 0x20
Data Encipherment: 0x10
Key Agreement: 0x08
Certificate Signing: 0x04
CRL Signing: 0x02
Encipher-Only: 0x01
IsRoot As Boolean (ReadOnly)
true if this is the root certificate, otherwise false.
IssuerC As String (ReadOnly)
The certificate issuer's country.
IssuerCN As String (ReadOnly)
The certificate issuer's common name.
IssuerDN As String (ReadOnly)
The issuer's full distinguished name.
IssuerE As String (ReadOnly)
The certificate issuer's email address.
IssuerL As String (ReadOnly)
The certificate issuer's locality, which could be a city, count, township, or other geographic region.
IssuerO As String (ReadOnly)
The certificate issuer's organization, which is typically the company name.
IssuerOU As String (ReadOnly)
The certificate issuer's organizational unit, which is the unit within the organization.
IssuerS As String (ReadOnly)
The certificate issuer's state or province.
KeyContainerName As String (ReadOnly)
If the HasKeyContainer property is true, then the certificate is linked to a key container and this property contains the name of the key container.
When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.
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.
MachineKeyset As Boolean (ReadOnly)
If the HasKeyContainer property is true, then the certificate is linked to a key container and this property indicates whether the key container is in the machine's keyset or in the keyset specific to the logged on user's account. If true, the key container is within the machine keyset. If false, it's in the user's keyset.
When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.
Revoked As Boolean (ReadOnly)
true if the certificate or any certificate in the chain of authority has been revoked. This information is not available when running on Windows 95/98 computers.
Note: If this property is false, it could mean that it was not able to check the revocation status. Because of this uncertainty, a CheckRevoked method has been added. It returns an integer indicating one of three possible states: 1 (revoked) , 0 (not revoked), -1 (unable to check revocation status).
Rfc822Name As String (ReadOnly)
The RFC-822 name of the certificate.
SerialNumber As String (ReadOnly)
The certificate's serial number.
Sha1Thumbprint As String (ReadOnly)
Hexidecimal string of the SHA-1 thumbprint for the certificate.
SignatureVerified As Boolean (ReadOnly)
True if the certificate and all certificates in the chain of authority have valid signatures. This information is not available when running on Windows 95/98 computers.
Silent As Boolean (ReadOnly)
If the HasKeyContainer property is true, then the certificate is linked to a key container and this property indicates whether accessing the private key will cause the operating system to launch an interactive warning dialog. If false a warning dialog will be displayed. If true then private key accesses are silent.
When a certificate is linked to a key container , the following properties will provide information about the key container and private key: CspName, KeyContainerName, MachineKeyset, and Silent.
SubjectC As String (ReadOnly)
The certificate subject's country.
SubjectCN As String (ReadOnly)
The certificate subject's common name.
SubjectDN As String (ReadOnly)
The certificate subject's full distinguished name.
SubjectE As String (ReadOnly)
The certificate subject's email address.
SubjectL As String (ReadOnly)
The certificate subject's locality, which could be a city, count, township, or other geographic region.
SubjectO As String (ReadOnly)
The certificate subject's organization, which is typically the company name.
SubjectOU As String (ReadOnly)
The certificate subject's organizational unit, which is the unit within the organization.
SubjectS As String (ReadOnly)
The certificate subject's state or province.
TrustedRoot As Boolean (ReadOnly)
True if the certificate has a trusted root authority. This information is not available when running on Windows 95/98 computers.
ValidFrom As Date (ReadOnly)
The date this certificate becomes (or became) valid.
ValidTo As Date (ReadOnly)
The date this certificate becomes (or became) invalid.
Version As String (ReadOnly)
The version of this component, such as "1.0"
Methods
Function CheckRevoked() As Integer
Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.
Function ExportCertDer() As Byte()
Exports the digital certificate to ASN.1 DER format. Returns a byte array containing the DER encoded certificate. Returns Nothing on failure
Function ExportCertDerFile(ByVal filename As String) As Boolean
Exports the digital certificate to ASN.1 DER format binary file. Returns true for success, false for failure.
Function ExportCertPem() As String
Exports the digital certificate to an unencrypted PEM formatted string. Returns Nothing on failure
Function ExportCertPemFile(ByVal filename As String) As Boolean
Exports the digital certificate to an unencrypted PEM formatted file. Returns true for success, false for failure.
Function ExportPrivateKey() As PrivateKey
Exports the certificate's private key. Returns a Chilkat.PrivateKey object if successful. Otherwise returns null.
Function ExportPublicKey() As PublicKey
Exports the certificate's public key. Returns a Chilkat.PublicKey object if successful. Otherwise returns null.
Function ExportToPfxFile(ByVal pfxFilename As String, ByVal password As String, ByVal bIncludeChain As Boolean) As Boolean
To be documented soon...
Function GetEncoded() As String
Returns an encoded string representation of the certificate, which can be passed to SetFromEncoded to recreate the certificate object. Returns Nothing on failure
Function HasPrivateKey() As Boolean
Returns true if the private key is installed on the local system for the certificate. This information is not available when running on Windows 95/98 computers.
Function LinkPrivateKey(ByVal keyContainerName As String, ByVal bMachineKeyset As Boolean, ByVal bForSigning As Boolean) As Boolean
Associates a private key with a certificate. The private key is specified by providing the name of the key container where it can be found. The 2nd argument indicates whether the key container is from the machine-wide keyset (true), or from the keyset specific to the logged-on user (false). Private keys can be imported into a key container by calling the KeyContainer's ImportPrivateKey method. Once a certificate has been linked, the private key is available for creating digital signatures or decrypting. Note: Certificates imported from a PFX or from a Certificate Authority will already be "linked" and it is not necessary to call this method. Returns true for success, false for failure.
Function LoadByCommonName(ByVal cn As String) As Boolean
Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate having the common name specified. If found, the certificate is loaded and ready for use. Returns true for success, false for failure. Select Cert for Encrypted Email
Function LoadByEmailAddress(ByVal emailAddress As String) As Boolean
Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate containing the email address specified. If found, the certificate is loaded and ready for use. Returns true for success, false for failure. Select Cert for Encrypted Email
Function LoadFromBase64(ByVal encodedCert As String) As Boolean
Loads an ASN.1 or DER encoded certificate represented in a Base64 string.
Function LoadFromBinary(ByVal data As Byte()) As Boolean
Loads an ASN.1 or DER encoded certificate represented as a binary blob.
Function LoadFromFile(ByVal filename As String) As Boolean
Loads a certificate from a .cer, .p7b, or .pem file. This method accepts certificates from files in any of the following formats:
1. DER encoded binary X.509 (.CER)
2. Base-64 encoded X.509 (.CER)
3. Cryptographic Message Syntax Standard - PKCS #7 Certificates (.P7B)
4. 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.
Function LoadPfxData(ByVal pfxData As Byte(), ByVal password As String) As Boolean
To be documented soon...
Function LoadPfxFile(ByVal pfxFilename As String, ByVal password As String) As Boolean
To be documented soon...
Function PemFileToDerFile(ByVal inFilename As String, ByVal outFilename As String) As Boolean
Converts a PEM file to a DER file. 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.
Function SaveToFile(ByVal filename As String) As Boolean
Saves a certificate object to a .cer file. Returns true for success, false for failure.
Function SetFromEncoded(ByVal encodedCert As String) As Boolean
Initializes the certificate object from an encoded string created by the GetEncoded method.
|