CertChain C Reference Documentation

CertChain

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

Create/Dispose

HCkCertChain CkCertChain_Create(void);

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

void CkCertChain_Dispose(HCkCertChain handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCertChain_Dispose.

Properties

void CkCertChain_getDebugLogFilePath(HCkCertChain cHandle, HCkString retval);

void CkCertChain_putDebugLogFilePath(HCkCertChain cHandle, const char *newVal);

const char *CkCertChain_debugLogFilePath(HCkCertChain cHandle);

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.

void CkCertChain_getLastErrorHtml(HCkCertChain cHandle, HCkString retval);

const char *CkCertChain_lastErrorHtml(HCkCertChain cHandle);

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.

void CkCertChain_getLastErrorText(HCkCertChain cHandle, HCkString retval);

const char *CkCertChain_lastErrorText(HCkCertChain cHandle);

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.

Concept of LastErrorText

LastErrorText Standard Information

void CkCertChain_getLastErrorXml(HCkCertChain cHandle, HCkString retval);

const char *CkCertChain_lastErrorXml(HCkCertChain cHandle);

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.

BOOL CkCertChain_getLastMethodSuccess(HCkCertChain cHandle);

void CkCertChain_putLastMethodSuccess(HCkCertChain cHandle, BOOL newVal);

Introduced in version 9.5.0.52

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.

int CkCertChain_getNumCerts(HCkCertChain cHandle);

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.

int CkCertChain_getNumExpiredCerts(HCkCertChain cHandle);

Introduced in version 9.5.0.40

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

BOOL CkCertChain_getReachesRoot(HCkCertChain cHandle);

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.

BOOL CkCertChain_getUtf8(HCkCertChain cHandle);

void CkCertChain_putUtf8(HCkCertChain cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

BOOL CkCertChain_getVerboseLogging(HCkCertChain cHandle);

void CkCertChain_putVerboseLogging(HCkCertChain cHandle, BOOL newVal);

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.

void CkCertChain_getVersion(HCkCertChain cHandle, HCkString retval);

const char *CkCertChain_version(HCkCertChain cHandle);

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

Methods

HCkCert CkCertChain_GetCert(HCkCertChain cHandle, int index);

Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns NULL on failure

BOOL CkCertChain_IsRootTrusted(HCkCertChain cHandle, HCkTrustedRoots trustedRoots);

Introduced in version 9.5.0.40

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

BOOL CkCertChain_LoadX5C(HCkCertChain cHandle, HCkJsonObject jwk);

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.

BOOL CkCertChain_SaveLastError(HCkCertChain cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

BOOL CkCertChain_VerifyCertSignatures(HCkCertChain cHandle);

Introduced in version 9.5.0.40

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