CertChain DataFlex Reference Documentation

CertChain

Current Version: 10.1.2

Contains certificates in a chain of authentication to a trusted root.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoCertChain
Get Create(RefClass(cComChilkatCertChain)) to hoCertChain

Properties

DebugLogFilePath

Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastBinaryResult

Function ComLastBinaryResult Returns Variant

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to True. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

Function ComLastErrorHtml Returns String

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

Function ComLastErrorText Returns String

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

Function ComLastErrorXml Returns String

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

Function ComLastStringResult Returns String

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

Function ComLastStringResultLen Returns Integer

The length, in characters, of the string contained in the LastStringResult property.

NumCerts

Function ComNumCerts Returns Integer

Introduced in version 9.5.0.40

The number of certificates in the chain. The end-user subscriber certificate is at index 0. This is the certificate most removed from the trusted root. Intermediate certificates are at indices 1 to NumCerts - 2. The trusted root (or self-signed certificate) is at index NumCerts - 1.

NumExpiredCerts

Function ComNumExpiredCerts Returns Integer

Introduced in version 9.5.0.40

Returns the number of certificates in the chain that have expired.

ReachesRoot

Function ComReachesRoot Returns Boolean

Introduced in version 9.5.0.44

True if this certificate chain extends all the way to the root certificate. The root certificate is either a trusted CA root or a self-signed certificate. In both cases, the issuer of a root certificate is itself.

UncommonOptions

Function ComUncommonOptions Returns String
Procedure Set ComUncommonOptions String value

Introduced in version 9.5.0.98

Can be set to a comma separated list of keywords to specify uncommon options. The current uncommon options are:

PkiPathV1.ExcludeRoot Exclude the root certificate in the X509PKIPathv1 method.

VerboseLogging

Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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.

Version

Function ComVersion Returns String

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetCert

Function ComGetCert Integer index Returns cComChilkatCert

Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns null on failure

More Information and Examples

Get Certificate Chain Certs Build Certificate Chain from Base64 Certificates

IsRootTrusted

Function ComIsRootTrusted cComChilkatTrustedRoots trustedRoots Returns Boolean

Introduced in version 9.5.0.40

Returns True if the root of the certificate chain is a certificate found in trustedRoots.

LoadX5C

Function ComLoadX5C cComChilkatJsonObject jwk Returns Boolean

Introduced in version 9.5.0.66

Loads a certificate chain from the "x5c" parameter of a JWK (JSON Web Key).

Returns True for success, False for failure.

VerifyCertSignatures

Function ComVerifyCertSignatures Returns Boolean

Introduced in version 9.5.0.40

Verifies the certificate signatures to the root. Returns True if all certificate signatures are valid.

X509PKIPathv1

Function ComX509PKIPathv1 Returns String

Introduced in version 9.5.0.88

Returns the base64 representation of an X509PKIPathv1 containing the certificates in this chain. This is typically used in an X.509 Binary Security Token. It is a PKIPath that contains an ordered list of X.509 public certificates packaged in a PKIPath. The X509PKIPathv1 token type may be used to represent a certificate path. (This is sometimes used in XAdES signatures.)

Returns null on failure