CertChain Delphi DLL Reference Documentation

CertChain

Current Version: 10.0.0

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, 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:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes 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 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.

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

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

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;

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.

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 "9.5.0.94"

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.