Cert Xojo Plugin Reference Documentation

Cert

Current Version: 9.5.0.75

Digital certificate component / class

Object Creation

Dim cert As New Chilkat.Cert

Properties

AuthorityKeyId
AuthorityKeyId As String (read-only)
Introduced in version 9.5.0.40

The authority key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.35.

top
CertVersion
CertVersion As Int32 (read-only)

The version of the certificate (1, 2, or 3). A value of 0 indicates an error -- the most likely cause being that the certificate object is empty (i.e. was never loaded with a certificate). Note: This is not the version of the software, it is the version of the X.509 certificate object. The version of the Chilkat certificate software is indicated by the Version property.

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
Expired
Expired As Boolean (read-only)

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.)

top
ForClientAuthentication
ForClientAuthentication As Boolean (read-only)

True if this certificate can be used for client authentication, otherwise False.

top
ForCodeSigning
ForCodeSigning As Boolean (read-only)

True if this certificate can be used for code signing, otherwise False.

top
ForSecureEmail
ForSecureEmail As Boolean (read-only)

True if this certificate can be used for sending secure email, otherwise False.

top
ForServerAuthentication
ForServerAuthentication As Boolean (read-only)

True if this certificate can be used for server authentication, otherwise False.

top
ForTimeStamping
ForTimeStamping As Boolean (read-only)

True if this certificate can be used for time stamping, otherwise False.

top
IntendedKeyUsage
IntendedKeyUsage As UInt32 (read-only)

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

top
IsRoot
IsRoot As Boolean (read-only)

True if this is the root certificate, otherwise False.

top
IssuerC
IssuerC As String (read-only)

The certificate issuer's country.

top
IssuerCN
IssuerCN As String (read-only)

The certificate issuer's common name.

top
IssuerDN
IssuerDN As String (read-only)

The issuer's full distinguished name.

top
IssuerE
IssuerE As String (read-only)

The certificate issuer's email address.

top
IssuerL
IssuerL As String (read-only)

The certificate issuer's locality, which could be a city, count, township, or other geographic region.

top
IssuerO
IssuerO As String (read-only)

The certificate issuer's organization, which is typically the company name.

top
IssuerOU
IssuerOU As String (read-only)

The certificate issuer's organizational unit, which is the unit within the organization.

top
IssuerS
IssuerS As String (read-only)

The certificate issuer's state or province.

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Boolean
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
OcspUrl
OcspUrl As String (read-only)

If present in the certificate's extensions, returns the OCSP URL of the certificate. (The Online Certificate Status Protocol (OCSP) is an Internet protocol used for obtaining the revocation status of an X.509 digital certificate.)

More Information and Examples
top
Revoked
Revoked As Boolean (read-only)

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).

top
Rfc822Name
Rfc822Name As String (read-only)

The RFC-822 name of the certificate. (Also known as the Subject Alternative Name.)

If the certificate contains a list of Subject Alternative Names, such as a list of host names to be protected by a single SSL certificate, then this property will contain the comma separated list of names.

top
SelfSigned
SelfSigned As Boolean (read-only)

True if this is a self-signed certificate, otherwise False.

top
SerialDecimal
SerialDecimal As String (read-only)
Introduced in version 9.5.0.75

The certificate's serial number as a decimal string.

top
SerialNumber
SerialNumber As String (read-only)

The certificate's serial number as a hexidecimal string.

top
Sha1Thumbprint
Sha1Thumbprint As String (read-only)

Hexidecimal string of the SHA-1 thumbprint for the certificate.

top
SignatureVerified
SignatureVerified As Boolean (read-only)

Returns True if the certificate and all certificates in the chain of authority have valid signatures, otherwise returns False.

top
SubjectC
SubjectC As String (read-only)

The certificate subject's country.

top
SubjectCN
SubjectCN As String (read-only)

The certificate subject's common name.

top
SubjectDN
SubjectDN As String (read-only)

The certificate subject's full distinguished name.

top
SubjectE
SubjectE As String (read-only)

The certificate subject's email address.

top
SubjectKeyId
SubjectKeyId As String (read-only)
Introduced in version 9.5.0.40

The subject key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.14.

top
SubjectL
SubjectL As String (read-only)

The certificate subject's locality, which could be a city, count, township, or other geographic region.

top
SubjectO
SubjectO As String (read-only)

The certificate subject's organization, which is typically the company name.

top
SubjectOU
SubjectOU As String (read-only)

The certificate subject's organizational unit, which is the unit within the organization.

top
SubjectS
SubjectS As String (read-only)

The certificate subject's state or province.

top
TrustedRoot
TrustedRoot As Boolean (read-only)

Returns True if the certificate has a trusted root authority, otherwise returns False.

Note: As of version 9.5.0.41, the notion of what your application deems as trusted becomes more specific. The TrustedRoots class/object was added in v9.5.0.0. Prior to this, a certificate was considered to be anchored by a trusted root if the certificate chain could be established to a root (self-signed) certificate, AND if the root certificate was located somewhere in the Windows registry-based certificate stores. There are two problems with this: (1) it's a Windows-only solution. This property would always return False on non-Windows systems, and (2) it might be considered not a strong enough set of conditions for trusting a root certificate.

As of version 9.5.0.41, this property pays attention to the new TrustedRoots class/object, which allows for an application to specificallly indicate which root certificates are to be trusted. Certificates may be added to the TrustedRoots object via the LoadCaCertsPem or AddCert methods, and then activated by calling the TrustedRoots.Activate method. The activated trusted roots are deemed to be trusted in any Chilkat API method/property that needs to make this determination. In addition, the TrustedRoots object has a property named TrustSystemCaRoots, which defaults to True, which allows for backward compatibility. It will trust CA certificates stored in the Windows registry-based certificate stores, or if on Linux, will trust certificates found in /etc/ssl/certs/ca-certificates.crt.

top
ValidFromStr
ValidFromStr As String (read-only)

The date (in RFC822 string format) that this certificate becomes (or became) valid. It is a GMT/UTC date that is returned.

top
ValidToStr
ValidToStr As String (read-only)

The date (in RFC822 string format) that this certificate becomes (or became) invalid. It is a GMT/UTC date that is returned.

top
VerboseLogging
VerboseLogging As Boolean

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "9.5.0.63"

top

Methods

CheckRevoked
Function CheckRevoked() As Int32

Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.

top
ExportCertDer
Function ExportCertDer() As MemoryBlock

Exports the digital certificate to ASN.1 DER format.

Returns Nil on failure

top
ExportCertDerBd
Function ExportCertDerBd(cerData As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.70

Exports the digital certificate in ASN.1 DER format to a BinData object.

Returns True for success, False for failure.

top
ExportCertDerFile
Function ExportCertDerFile(path As String) As Boolean

Exports the digital certificate to ASN.1 DER format binary file.

Returns True for success, False for failure.

top
ExportCertPem
Function ExportCertPem() As String

Exports the digital certificate to an unencrypted PEM formatted string.

Returns Nil on failure

More Information and Examples
top
ExportCertPemFile
Function ExportCertPemFile(path As String) As Boolean

Exports the digital certificate to an unencrypted PEM formatted file.

Returns True for success, False for failure.

More Information and Examples
top
ExportCertXml
Function ExportCertXml() As String

Exports a certificate to an XML format where the XML tags are the names of the ASN.1 objects that compose the X.509 certificate. Binary data is either hex or base64 encoded. (The binary data for a "bits" ASN.1 tag is hex encoded, whereas for all other ASN.1 tags, such as "octets", it is base64.)

Returns Nil on failure

top
ExportPrivateKey
Function ExportPrivateKey() As Chilkat.PrivateKey

Exports the certificate's private key.

Returns Nil on failure

top
ExportPublicKey
Function ExportPublicKey() As Chilkat.PublicKey

Exports the certificate's public key.

Returns Nil on failure

More Information and Examples
top
ExportToPfxBd
Function ExportToPfxBd(password As String, includeCertChain As Boolean, pfxData As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.70

Exports the certificate and private key (if available) to pfxData. The password is what will be required to access the PFX contents at a later time. If includeCertChain is True, then the certificates in the chain of authority are also included in the PFX.

Returns True for success, False for failure.

top
ExportToPfxData
Function ExportToPfxData(password As String, includeCertChain As Boolean) As MemoryBlock
Introduced in version 9.5.0.31

Exports the certificate and private key (if available) to an in-memory PFX image. The password is what will be required to access the PFX contents at a later time. If includeCertChain is True, then the certificates in the chain of authority are also included in the PFX.

Returns Nil on failure

top
FindIssuer
Function FindIssuer() As Chilkat.Cert

Finds and returns the issuer certificate. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate. (The IsRoot property can be check to see if the certificate is a root (or self-issued) certificate.)

Returns Nil on failure

top
GetCertChain
Function GetCertChain() As Chilkat.CertChain
Introduced in version 9.5.0.40

Returns a certficate chain object containing all the certificates (including this one), in the chain of authentication to the trusted root (if possible). If this certificate object was loaded from a PFX, then the certiicates contained in the PFX are automatically available for building the certificate chain. The UseCertVault method can be called to provide additional certificates that might be required to build the cert chain. Finally, the TrustedRoots object can be used to provide a way of making trusted root certificates available.

Note: Prior to v9.5.0.50, this method would fail if the certificate chain could not be completed to the root. Starting in v9.5.0.50, the incomplete certificate chain will be returned. The certificate chain's ReachesRoot property can be examined to see if the chain was completed to the root.

On Windows systems, the registry-based certificate stores are automatically consulted if needed to locate intermediate or root certificates in the chain.

Returns Nil on failure

top
GetEncoded
Function GetEncoded() As String

Returns a base64 encoded string representation of the certificate's binary DER format, which can be passed to SetFromEncoded to recreate the certificate object.

Returns Nil on failure

top
GetExtensionAsXml
Function GetExtensionAsXml(oid As String) As String
Introduced in version 9.5.0.49

Returns the certificate extension data in XML format (converted from ASN.1). The oid is an OID, such as the ones listed here: http://www.alvestrand.no/objectid/2.5.29.html

Note: In many cases, the data within the XML is returned base64 encoded. An application may need to take one further step to base64 decode the information contained within the XML.

Returns Nil on failure

top
GetPrivateKeyPem
Function GetPrivateKeyPem() As String

Exports the certificate's private key to a PEM string (if the private key is available).

Returns Nil on failure

top
GetSpkiFingerprint
Function GetSpkiFingerprint(hashAlg As String, encoding As String) As String
Introduced in version 9.5.0.55

Returns the SPKI Fingerprint suitable for use in pinning. (See RFC 7469.) An SPKI Fingerprint is defined as the output of a known cryptographic hash algorithm whose input is the DER-encoded ASN.1 representation of the Subject Public Key Info (SPKI) of an X.509 certificate. The hashAlg specifies the hash algorithm and may be "sha256", "sha384", "sha512", "sha1", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding specifies the encoding, and may be "base64", "hex", or any of the encoding modes specified in the article at the link below.

Returns Nil on failure

More Information and Examples
top
GetValidFromDt
Function GetValidFromDt() As Chilkat.CkDateTime

Returns the date/time this certificate becomes (or became) valid.

Returns Nil on failure

top
GetValidToDt
Function GetValidToDt() As Chilkat.CkDateTime

Returns the date/time this certificate becomes (or became) invalid.

Returns Nil on failure

top
HashOf
Function HashOf(part As String, hashAlg As String, encoding As String) As String
Introduced in version 9.5.0.75

Returns an encoded hash of a particular part of the certificate. The part may be one of the following:

  • IssuerDN
  • IssuerPublicKey
  • SubjectDN
  • SubjectPublicKey

The hashAlg is the name of the hash algorithm, such as "sha1", "sha256", "sha384", "sha512", "md5", etc. The encoding is the format to return, such as "hex", "base64", etc.

Returns Nil on failure

top
HasPrivateKey
Function HasPrivateKey() As Boolean

Returns true if the private key is installed on the local system for the certificate.

top
LoadByCommonName
Function LoadByCommonName(cn As String) As Boolean

(Relevant only when running on a Microsoft Windows operating system.) 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.

top
LoadByEmailAddress
Function LoadByEmailAddress(emailAddress As String) As Boolean

(Relevant only when running on a Microsoft Windows operating system.) 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.

More Information and Examples
top
LoadByIssuerAndSerialNumber
Function LoadByIssuerAndSerialNumber(issuerCN As String, serialNumber As String) As Boolean

(Relevant only when running on a Microsoft Windows operating system.) Searches the Windows Local Machine and Current User registry-based certificate stores for a certificate matching the issuerCN and having an issuer matching the serialNumber. If found, the certificate is loaded and ready for use.

Returns True for success, False for failure.

top
LoadFromBase64
Function LoadFromBase64(encodedCert As String) As Boolean

Loads an ASN.1 or DER encoded certificate represented in a Base64 string.

Returns True for success, False for failure.

More Information and Examples
top
LoadFromBd
Function LoadFromBd(certBytes As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.70

Loads an X.509 certificate from the ASN.1 DER encoded bytes contained in certBytes.

Returns True for success, False for failure.

top
LoadFromBinary
Function LoadFromBinary(data As MemoryBlock) As Boolean

Loads an X.509 certificate from ASN.1 DER encoded bytes.

Returns True for success, False for failure.

top
LoadFromFile
Function LoadFromFile(path As String) As Boolean

Loads a certificate from a .cer, .crt, .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.

Returns True for success, False for failure.

top
LoadPem
Function LoadPem(strPem As String) As Boolean
Introduced in version 9.5.0.49

Loads the certificate from a PEM string.

Returns True for success, False for failure.

top
LoadPfxBd
Function LoadPfxBd(pfxData As Chilkat.BinData, password As String) As Boolean
Introduced in version 9.5.0.70

Loads the certificate from the PFX contained in pfxData. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns True for success, False for failure.

top
LoadPfxData
Function LoadPfxData(pfxData As MemoryBlock, password As String) As Boolean

Loads a PFX from an in-memory image of a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns True for success, False for failure.

top
LoadPfxFile
Function LoadPfxFile(pfxPath As String, password As String) As Boolean

Loads a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns True for success, False for failure.

top
LoadTaskResult
Function LoadTaskResult(task As Chilkat.Task) As Boolean
Introduced in version 9.5.0.52

Loads the certificate from a completed asynchronous task.

Returns True for success, False for failure.

top
PemFileToDerFile
Function PemFileToDerFile(fromPath As String, toPath As String) As Boolean

Converts a PEM file to a DER file.

Returns True for success, False for failure.

top
SaveLastError
Function SaveLastError(path As String) As Boolean

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
SaveToFile
Function SaveToFile(path As String) As Boolean

Saves a certificate object to a .cer file.

Returns True for success, False for failure.

top
SetFromEncoded
Function SetFromEncoded(encodedCert As String) As Boolean

Initializes the certificate object from a base64 encoded string representation of the certificate's binary DER format.

Returns True for success, False for failure.

top
SetPrivateKey
Function SetPrivateKey(privKey As Chilkat.PrivateKey) As Boolean

Used to associate a private key with the certificate for subsequent (PKCS7) signature creation or decryption.

Returns True for success, False for failure.

top
SetPrivateKeyPem
Function SetPrivateKeyPem(privKeyPem As String) As Boolean

Same as SetPrivateKey, but the key is provided in unencrypted PEM format. (Note: The privKeyPem is not a file path, it is the actual PEM text.)

Returns True for success, False for failure.

top
UseCertVault
Function UseCertVault(vault As Chilkat.XmlCertVault) As Boolean
Introduced in version 9.5.0.40

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains and verifying the certificate signature to the trusted root.

Returns True for success, False for failure.

top
VerifySignature
Function VerifySignature() As Boolean
Introduced in version 9.5.0.40

Verifies the certificate signature, as well as the signatures of all certificates in the chain of authentication to the trusted root. Returns True if all signatures are verified to the trusted root. Otherwise returns False.

top