Cert Lianja Reference Documentation

Cert

Current Version: 9.5.0.75

Digital certificate component / class

Object Creation

loObject = createobject("CkCert")

Properties

AuthorityKeyId
AuthorityKeyId As Character (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
AvoidWindowsPkAccess
AvoidWindowsPkAccess As Boolean

Applies only when running on a Microsoft Windows operating system. If .T., 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 .F..

top
CertVersion
CertVersion As Numeric (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
CspName
CspName As Character (read-only)

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is .T., 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.

top
DebugLogFilePath
DebugLogFilePath As Character

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

.T. if this certificate can be used for client authentication, otherwise .F..

top
ForCodeSigning
ForCodeSigning As Boolean (read-only)

.T. if this certificate can be used for code signing, otherwise .F..

top
ForSecureEmail
ForSecureEmail As Boolean (read-only)

.T. if this certificate can be used for sending secure email, otherwise .F..

top
ForServerAuthentication
ForServerAuthentication As Boolean (read-only)

.T. if this certificate can be used for server authentication, otherwise .F..

top
ForTimeStamping
ForTimeStamping As Boolean (read-only)

.T. if this certificate can be used for time stamping, otherwise .F..

top
HasKeyContainer
HasKeyContainer As Boolean (read-only)

(Relevant only when running on a Microsoft Windows operating system.) Indicates whether this certificate is linked to a key container. If .T. then the certificate is linked to a key container (usually containing a private key). If .F., 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.

top
IntendedKeyUsage
IntendedKeyUsage As Numeric (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)

.T. if this is the root certificate, otherwise .F..

top
IssuerC
IssuerC As Character (read-only)

The certificate issuer's country.

top
IssuerCN
IssuerCN As Character (read-only)

The certificate issuer's common name.

top
IssuerDN
IssuerDN As Character (read-only)

The issuer's full distinguished name.

top
IssuerE
IssuerE As Character (read-only)

The certificate issuer's email address.

top
IssuerL
IssuerL As Character (read-only)

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

top
IssuerO
IssuerO As Character (read-only)

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

top
IssuerOU
IssuerOU As Character (read-only)

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

top
IssuerS
IssuerS As Character (read-only)

The certificate issuer's state or province.

top
KeyContainerName
KeyContainerName As Character (read-only)

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is .T., 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.

top
LastErrorHtml
LastErrorHtml As Character (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 Character (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 Character (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 .T. indicates success, a value of .F. 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 = .T. and failure = .F..
  • 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 .T.. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
MachineKeyset
MachineKeyset As Boolean (read-only)

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is .T., 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 .T., the key container is within the machine keyset. If .F., 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.

top
OcspUrl
OcspUrl As Character (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
PrivateKeyExportable
PrivateKeyExportable As Boolean (read-only)

(Relevant only when running on a Microsoft Windows operating system.) Indicates whether the private key was installed with security settings that allow it to be re-exported.

top
Revoked
Revoked As Boolean (read-only)

.T. 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 .F., 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 Character (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)

.T. if this is a self-signed certificate, otherwise .F..

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

The certificate's serial number as a decimal string.

top
SerialNumber
SerialNumber As Character (read-only)

The certificate's serial number as a hexidecimal string.

top
Sha1Thumbprint
Sha1Thumbprint As Character (read-only)

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

top
SignatureVerified
SignatureVerified As Boolean (read-only)

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

top
Silent
Silent As Boolean (read-only)

(Relevant only when running on a Microsoft Windows operating system.) If the HasKeyContainer property is .T., 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 .F. a warning dialog will be displayed. If .T. 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.

top
SmartCardPin
SmartCardPin As Character
Introduced in version 9.5.0.75

Can be set to the PIN value for a certificate / private key stored on a smart card.

top
SubjectC
SubjectC As Character (read-only)

The certificate subject's country.

top
SubjectCN
SubjectCN As Character (read-only)

The certificate subject's common name.

top
SubjectDN
SubjectDN As Character (read-only)

The certificate subject's full distinguished name.

top
SubjectE
SubjectE As Character (read-only)

The certificate subject's email address.

top
SubjectKeyId
SubjectKeyId As Character (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 Character (read-only)

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

top
SubjectO
SubjectO As Character (read-only)

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

top
SubjectOU
SubjectOU As Character (read-only)

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

top
SubjectS
SubjectS As Character (read-only)

The certificate subject's state or province.

top
TrustedRoot
TrustedRoot As Boolean (read-only)

Returns .T. if the certificate has a trusted root authority, otherwise returns .F..

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 .F. 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 .T., 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 Character (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 Character (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 .T., then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is .F.. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As Character (read-only)

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

top

Methods

CheckRevoked
CheckRevoked() As Numeric

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

top
ExportCertDerBd
ExportCertDerBd(cerData As CkBinData) As Boolean
Introduced in version 9.5.0.70

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

Returns .T. for success, .F. for failure.

top
ExportCertDerFile
ExportCertDerFile(path As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
ExportCertPem
ExportCertPem() As Character

Exports the digital certificate to an unencrypted PEM formatted string.

Returns .F. on failure

More Information and Examples
top
ExportCertPemFile
ExportCertPemFile(path As Character) As Boolean

Exports the digital certificate to an unencrypted PEM formatted file.

Returns .T. for success, .F. for failure.

More Information and Examples
top
ExportCertXml
ExportCertXml() As Character

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 .F. on failure

top
ExportPrivateKey
ExportPrivateKey() As CkPrivateKey

Exports the certificate's private key.

Returns .F. on failure

top
ExportPublicKey
ExportPublicKey() As CkPublicKey

Exports the certificate's public key.

Returns .F. on failure

More Information and Examples
top
ExportToPfxBd
ExportToPfxBd(password As Character, includeCertChain As Boolean, pfxData As CkBinData) 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 .T., then the certificates in the chain of authority are also included in the PFX.

Returns .T. for success, .F. for failure.

top
ExportToPfxFile
ExportToPfxFile(pfxFilename As Character, pfxPassword As Character, bIncludeCertChain As Boolean) As Boolean

Exports the certificate and private key (if available) to a PFX (.pfx or .p12) file. The output PFX is secured using the pfxPassword. If bIncludeCertChain is .T., then the certificates in the chain of authority are also included in the PFX output file.

Returns .T. for success, .F. for failure.

More Information and Examples
top
FindIssuer
FindIssuer() As CkCert

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 .F. on failure

top
GetCertChain
GetCertChain() As CkCertChain
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 .F. on failure

top
GetEncoded
GetEncoded() As Character

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 .F. on failure

top
GetExtensionAsXml
GetExtensionAsXml(oid As Character) As Character
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 .F. on failure

top
GetPrivateKeyPem
GetPrivateKeyPem() As Character

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

Returns .F. on failure

top
GetSpkiFingerprint
GetSpkiFingerprint(hashAlg As Character, encoding As Character) As Character
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 .F. on failure

More Information and Examples
top
GetValidFromDt
GetValidFromDt() As CkDateTime

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

Returns .F. on failure

top
GetValidToDt
GetValidToDt() As CkDateTime

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

Returns .F. on failure

top
HashOf
HashOf(part As Character, hashAlg As Character, encoding As Character) As Character
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 .F. on failure

top
HasPrivateKey
HasPrivateKey() As Boolean

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

top
LinkPrivateKey
LinkPrivateKey(keyContainerName As Character, bMachineKeyset As Boolean, bForSigning As Boolean) As Boolean

(Relevant only when running on a Microsoft Windows operating system.) 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 (.T.), or from the keyset specific to the logged-on user (.F.). 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 .T. for success, .F. for failure.

top
LoadByCommonName
LoadByCommonName(cn As Character) 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 .T. for success, .F. for failure.

top
LoadByEmailAddress
LoadByEmailAddress(emailAddress As Character) 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 .T. for success, .F. for failure.

More Information and Examples
top
LoadByIssuerAndSerialNumber
LoadByIssuerAndSerialNumber(issuerCN As Character, serialNumber As Character) 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 .T. for success, .F. for failure.

top
LoadFromBase64
LoadFromBase64(encodedCert As Character) As Boolean

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

Returns .T. for success, .F. for failure.

More Information and Examples
top
LoadFromBd
LoadFromBd(certBytes As CkBinData) 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 .T. for success, .F. for failure.

top
LoadFromFile
LoadFromFile(path As Character) 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 .T. for success, .F. for failure.

top
LoadPem
LoadPem(strPem As Character) As Boolean
Introduced in version 9.5.0.49

Loads the certificate from a PEM string.

Returns .T. for success, .F. for failure.

top
LoadPfxBd
LoadPfxBd(pfxData As CkBinData, password As Character) 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 .T. for success, .F. for failure.

top
LoadPfxFile
LoadPfxFile(pfxPath As Character, password As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
LoadTaskResult
LoadTaskResult(task As CkTask) As Boolean
Introduced in version 9.5.0.52

Loads the certificate from a completed asynchronous task.

Returns .T. for success, .F. for failure.

top
PemFileToDerFile
PemFileToDerFile(fromPath As Character, toPath As Character) As Boolean

Converts a PEM file to a DER file.

Returns .T. for success, .F. for failure.

top
SaveLastError
SaveLastError(path As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
SaveToFile
SaveToFile(path As Character) As Boolean

Saves a certificate object to a .cer file.

Returns .T. for success, .F. for failure.

top
SetFromEncoded
SetFromEncoded(encodedCert As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
SetPrivateKey
SetPrivateKey(privKey As CkPrivateKey) As Boolean

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

Returns .T. for success, .F. for failure.

top
SetPrivateKeyPem
SetPrivateKeyPem(privKeyPem As Character) 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 .T. for success, .F. for failure.

top
UseCertVault
UseCertVault(vault As CkXmlCertVault) 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 .T. for success, .F. for failure.

top
VerifySignature
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 .T. if all signatures are verified to the trusted root. Otherwise returns .F..

top