TrustedRoots C Reference Documentation

TrustedRoots

Used to set and manage the CA root certificates trusted by your application. This applies to PKCS7 (S/MIME) signature validation and SSL/TLS server certificates.

Create/Dispose

HCkTrustedRoots CkTrustedRoots_Create(void);

Creates an instance of the HCkTrustedRoots 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 CkTrustedRoots_Dispose(HCkTrustedRoots handle);

Objects created by calling CkTrustedRoots_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 CkTrustedRoots_Dispose.

Callback Functions

Callback Functions are Introduced in Chilkat v9.5.0.56

void CkTrustedRoots_setAbortCheck(HCkHttp cHandle, BOOL (*fnAbortCheck)());

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

C Example using Callback Functions

void CkTrustedRoots_setPercentDone(HCkHttp cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkTrustedRoots_setProgressInfo(HCkHttp cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkTrustedRoots_setTaskCompleted(HCkHttp cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

void CkTrustedRoots_getDebugLogFilePath(HCkTrustedRoots cHandle, HCkString retval);

void CkTrustedRoots_putDebugLogFilePath(HCkTrustedRoots cHandle, const char *newVal);

const char *CkTrustedRoots_debugLogFilePath(HCkTrustedRoots 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 CkTrustedRoots_getLastErrorHtml(HCkTrustedRoots cHandle, HCkString retval);

const char *CkTrustedRoots_lastErrorHtml(HCkTrustedRoots 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 CkTrustedRoots_getLastErrorText(HCkTrustedRoots cHandle, HCkString retval);

const char *CkTrustedRoots_lastErrorText(HCkTrustedRoots 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 CkTrustedRoots_getLastErrorXml(HCkTrustedRoots cHandle, HCkString retval);

const char *CkTrustedRoots_lastErrorXml(HCkTrustedRoots 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 CkTrustedRoots_getLastMethodSuccess(HCkTrustedRoots cHandle);

void CkTrustedRoots_putLastMethodSuccess(HCkTrustedRoots 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 CkTrustedRoots_getNumCerts(HCkTrustedRoots cHandle);

Introduced in version 9.5.0.38

The number of certificates contained within this object.

This is the number of certificates explicitly added by the methods AddCert, AddJavaKeyStore, and LoadCaCertsPem.

BOOL CkTrustedRoots_getTrustSystemCaRoots(HCkTrustedRoots cHandle);

void CkTrustedRoots_putTrustSystemCaRoots(HCkTrustedRoots cHandle, BOOL newVal);

Introduced in version 9.5.0.41

Indicates whether the operating system's CA root certificates are automatically trusted.

On a Windows operating system, this would be the registry-based CA certificate stores. On a Linux system, this could be /etc/ssl/certs/ca-certificates.crt, if it exists. The default value is TRUE. Set this property equal to FALSE to prevent Chilkat from automatically trusting system-provided root CA certificates.

HTTP - Verify Server is a Trusted Root CA

BOOL CkTrustedRoots_getUtf8(HCkTrustedRoots cHandle);

void CkTrustedRoots_putUtf8(HCkTrustedRoots 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 CkTrustedRoots_getVerboseLogging(HCkTrustedRoots cHandle);

void CkTrustedRoots_putVerboseLogging(HCkTrustedRoots 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 CkTrustedRoots_getVersion(HCkTrustedRoots cHandle, HCkString retval);

const char *CkTrustedRoots_version(HCkTrustedRoots cHandle);

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

Methods

BOOL CkTrustedRoots_Activate(HCkTrustedRoots cHandle);

Introduced in version 9.5.0.38

Activates this collection of trusted roots as the set of CA and self-signed root certificates that are to be trusted Chilkat-wide for PKCS7 signature validation and SSL/TLS server certificate validation.

HTTP - Verify Server is a Trusted Root CA

BOOL CkTrustedRoots_AddCert(HCkTrustedRoots cHandle, HCkCert cert);

Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

Use a Custom Set of Trusted Root Certificates

BOOL CkTrustedRoots_AddJavaKeyStore(HCkTrustedRoots cHandle, HCkJavaKeyStore keystore);

Introduced in version 9.5.0.44

Adds the trusted certificates from a Java key store to the collection of trusted roots.

Returns TRUE for success, FALSE for failure.

Load Certs from Java KeyStore into Trusted CA Roots

HCkTask CkTrustedRoots_AddJavaKeyStoreAsync(HCkTrustedRoots cHandle, HCkJavaKeyStore keystore);

Introduced in version 9.5.0.44

Creates an asynchronous task to call the AddJavaKeyStore method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkTrustedRoots_Deactivate(HCkTrustedRoots cHandle);

Introduced in version 9.5.0.40

Deactivates a previously set of activated trusted roots so that all roots / self-signed certificates are implicitly trusted.

Returns TRUE for success, FALSE for failure.

HCkCert CkTrustedRoots_GetCert(HCkTrustedRoots cHandle, int index);

Introduced in version 9.5.0.38

Returns the Nth cert contained within this object. The 1st certificate is at index 0.

Returns NULL on failure

Load CA Cert Bundle into Trusted Roots

BOOL CkTrustedRoots_LoadCaCertsPem(HCkTrustedRoots cHandle, const char *path);

Introduced in version 9.5.0.38

Loads a CA bundle in PEM format. This is a file containing CA root certificates that are to be trusted. An example of one such file is the CA certs from mozilla.org exported to a cacert.pem file by the mk-ca-bundle tool located here: http://curl.haxx.se/docs/caextract.html.

Note: This can also be called to load the /etc/ssl/certs/ca-certificates.crt file on Linux systems.

Load CA Cert Bundle into Trusted Roots

HCkTask CkTrustedRoots_LoadCaCertsPemAsync(HCkTrustedRoots cHandle, const char *path);

Introduced in version 9.5.0.38

Creates an asynchronous task to call the LoadCaCertsPem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkTrustedRoots_SaveLastError(HCkTrustedRoots 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.