TrustedRoots Unicode C Reference Documentation

TrustedRoots

Current Version: 9.5.0.73

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

HCkTrustedRootsW instance = CkTrustedRootsW_Create();
// ...
CkTrustedRootsW_Dispose(instance);
HCkTrustedRootsW CkTrustedRootsW_Create(void);

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

void CkTrustedRootsW_Dispose(HCkTrustedRootsW handle);

Objects created by calling CkTrustedRootsW_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 CkTrustedRootsW_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkTrustedRootsW_setAbortCheck(HCkTrustedRootsW cHandle, BOOL (*fnAbortCheck)(void));

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.

void CkTrustedRootsW_setPercentDone(HCkTrustedRootsW 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 CkTrustedRootsW_setProgressInfo(HCkTrustedRootsW cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *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 CkTrustedRootsW_setTaskCompleted(HCkTrustedRootsW cHandle, void (*fnTaskCompleted)(HCkTaskW 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

DebugLogFilePath
void CkTrustedRootsW_getDebugLogFilePath(HCkTrustedRootsW cHandle, HCkString retval);
void CkTrustedRootsW_putDebugLogFilePath(HCkTrustedRootsW cHandle, const wchar_t *newVal);
const wchar_t *CkTrustedRootsW_debugLogFilePath(HCkTrustedRootsW 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.

top
LastErrorHtml
void CkTrustedRootsW_getLastErrorHtml(HCkTrustedRootsW cHandle, HCkString retval);
const wchar_t *CkTrustedRootsW_lastErrorHtml(HCkTrustedRootsW 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.

top
LastErrorText
void CkTrustedRootsW_getLastErrorText(HCkTrustedRootsW cHandle, HCkString retval);
const wchar_t *CkTrustedRootsW_lastErrorText(HCkTrustedRootsW 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.

top
LastErrorXml
void CkTrustedRootsW_getLastErrorXml(HCkTrustedRootsW cHandle, HCkString retval);
const wchar_t *CkTrustedRootsW_lastErrorXml(HCkTrustedRootsW 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.

top
LastMethodSuccess
BOOL CkTrustedRootsW_getLastMethodSuccess(HCkTrustedRootsW cHandle);
void CkTrustedRootsW_putLastMethodSuccess(HCkTrustedRootsW 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.

top
NumCerts
int CkTrustedRootsW_getNumCerts(HCkTrustedRootsW 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.

top
TrustSystemCaRoots
BOOL CkTrustedRootsW_getTrustSystemCaRoots(HCkTrustedRootsW cHandle);
void CkTrustedRootsW_putTrustSystemCaRoots(HCkTrustedRootsW 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.

More Information and Examples
top
VerboseLogging
BOOL CkTrustedRootsW_getVerboseLogging(HCkTrustedRootsW cHandle);
void CkTrustedRootsW_putVerboseLogging(HCkTrustedRootsW 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.

top
Version
void CkTrustedRootsW_getVersion(HCkTrustedRootsW cHandle, HCkString retval);
const wchar_t *CkTrustedRootsW_version(HCkTrustedRootsW cHandle);

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

top

Methods

Activate
BOOL CkTrustedRootsW_Activate(HCkTrustedRootsW 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.

More Information and Examples
top
AddCert
BOOL CkTrustedRootsW_AddCert(HCkTrustedRootsW cHandle, HCkCertW cert);
Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

More Information and Examples
top
AddJavaKeyStore
BOOL CkTrustedRootsW_AddJavaKeyStore(HCkTrustedRootsW cHandle, HCkJavaKeyStoreW 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.

top
AddJavaKeyStoreAsync (1)
HCkTaskW CkTrustedRootsW_AddJavaKeyStoreAsync(HCkTrustedRootsW cHandle, HCkJavaKeyStoreW 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

top
Deactivate
BOOL CkTrustedRootsW_Deactivate(HCkTrustedRootsW 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.

top
GetCert
HCkCertW CkTrustedRootsW_GetCert(HCkTrustedRootsW 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

More Information and Examples
top
LoadCaCertsPem
BOOL CkTrustedRootsW_LoadCaCertsPem(HCkTrustedRootsW cHandle, const wchar_t *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.

More Information and Examples
top
LoadCaCertsPemAsync (1)
HCkTaskW CkTrustedRootsW_LoadCaCertsPemAsync(HCkTrustedRootsW cHandle, const wchar_t *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

top
SaveLastError
BOOL CkTrustedRootsW_SaveLastError(HCkTrustedRootsW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

top