CertChain PureBasic Reference Documentation

CertChain

Current Version: 10.1.2

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

Object Creation

obj.i = CkCertChain::ckCreate()

; Make sure to dispose of the object when finished like this:
CkCertChain::ckDispose(obj);

Properties

DebugLogFilePath

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

LastErrorHtml

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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

Declare.s ckLastErrorText(obj.i) ; (read-only)

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

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicates the success or failure of the most recent method call: 1 means success, 0 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

Declare.i ckNumCerts(obj.i) ; (read-only)

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

Declare.i ckNumExpiredCerts(obj.i) ; (read-only)

Introduced in version 9.5.0.40

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

ReachesRoot

Declare.i ckReachesRoot(obj.i) ; (read-only)

Introduced in version 9.5.0.44

1 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

Declare.s ckUncommonOptions(obj.i)
Declare setCkUncommonOptions(obj.i, value.s)

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

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Version

Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

GetCert

Declare.i ckGetCert(obj.i, index.l)

Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns 0 on failure

More Information and Examples

Get Certificate Chain Certs Build Certificate Chain from Base64 Certificates

IsRootTrusted

Declare.i ckIsRootTrusted(obj.i, trustedRoots.i)

Introduced in version 9.5.0.40

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

LoadX5C

Declare.i ckLoadX5C(obj.i, jwk.i)

Introduced in version 9.5.0.66

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

Returns 1 for success, 0 for failure.

VerifyCertSignatures

Declare.i ckVerifyCertSignatures(obj.i)

Introduced in version 9.5.0.40

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

X509PKIPathv1

Declare.s ckX509PKIPathv1(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.