CertChain Delphi DLL Reference Documentation

CertChain

Current Version: 10.1.2

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

Create/Dispose

var
myObject: HCkCertChain;

begin
myObject := CkCertChain_Create();

// ...

CkCertChain_Dispose(myObject);
end;

function CkCertChain_Create: HCkCertChain; stdcall;

Creates an instance of the HCkCertChain object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkCertChain_Dispose(handle: HCkCertChain); stdcall;

Objects created by calling CkCertChain_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath

procedure CkCertChain_getDebugLogFilePath(objHandle: HCkCertChain; outPropVal: HCkString); stdcall;
procedure CkCertChain_putDebugLogFilePath(objHandle: HCkCertChain; newPropVal: PWideChar); stdcall;
function CkCertChain__debugLogFilePath(objHandle: HCkCertChain): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkCertChain_getLastErrorHtml(objHandle: HCkCertChain; outPropVal: HCkString); stdcall;
function CkCertChain__lastErrorHtml(objHandle: HCkCertChain): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkCertChain_getLastErrorText(objHandle: HCkCertChain; outPropVal: HCkString); stdcall;
function CkCertChain__lastErrorText(objHandle: HCkCertChain): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkCertChain_getLastErrorXml(objHandle: HCkCertChain; outPropVal: HCkString); stdcall;
function CkCertChain__lastErrorXml(objHandle: HCkCertChain): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkCertChain_getLastMethodSuccess(objHandle: HCkCertChain): wordbool; stdcall;
procedure CkCertChain_putLastMethodSuccess(objHandle: HCkCertChain; newPropVal: wordbool); stdcall;

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.

NumCerts

function CkCertChain_getNumCerts(objHandle: HCkCertChain): Integer; stdcall;

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 CkCertChain_getNumExpiredCerts(objHandle: HCkCertChain): Integer; stdcall;

Introduced in version 9.5.0.40

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

ReachesRoot

function CkCertChain_getReachesRoot(objHandle: HCkCertChain): wordbool; stdcall;

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

procedure CkCertChain_getUncommonOptions(objHandle: HCkCertChain; outPropVal: HCkString); stdcall;
procedure CkCertChain_putUncommonOptions(objHandle: HCkCertChain; newPropVal: PWideChar); stdcall;
function CkCertChain__uncommonOptions(objHandle: HCkCertChain): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkCertChain_getVerboseLogging(objHandle: HCkCertChain): wordbool; stdcall;
procedure CkCertChain_putVerboseLogging(objHandle: HCkCertChain; newPropVal: wordbool); stdcall;

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

procedure CkCertChain_getVersion(objHandle: HCkCertChain; outPropVal: HCkString); stdcall;
function CkCertChain__version(objHandle: HCkCertChain): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetCert

function CkCertChain_GetCert(objHandle: HCkCertChain;
index: Integer): HCkCert; stdcall;

Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns nil on failure

More Information and Examples

Get Certificate Chain Certs Build Certificate Chain from Base64 Certificates

IsRootTrusted

function CkCertChain_IsRootTrusted(objHandle: HCkCertChain;
trustedRoots: HCkTrustedRoots): wordbool; stdcall;

Introduced in version 9.5.0.40

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

LoadX5C

function CkCertChain_LoadX5C(objHandle: HCkCertChain;
jwk: HCkJsonObject): wordbool; stdcall;

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 CkCertChain_VerifyCertSignatures(objHandle: HCkCertChain): wordbool; stdcall;

Introduced in version 9.5.0.40

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

X509PKIPathv1

function CkCertChain_X509PKIPathv1(objHandle: HCkCertChain;
outStr: HCkString): wordbool; stdcall;
function CkCertChain__x509PKIPathv1(objHandle: HCkCertChain): PWideChar; stdcall;

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 True for success, False for failure.

See the notes about PWideChar memory ownership and validity.