TrustedRoots Delphi DLL Reference Documentation

TrustedRoots

Current Version: 9.5.0.83

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

var
myObject: HCkTrustedRoots;

begin
myObject := CkTrustedRoots_Create();

// ...

CkTrustedRoots_Dispose(myObject);
end;
function CkTrustedRoots_Create: HCkTrustedRoots; stdcall;

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

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.

Properties

DebugLogFilePath
procedure CkTrustedRoots_getDebugLogFilePath(objHandle: HCkTrustedRoots; outPropVal: HCkString); stdcall;
procedure CkTrustedRoots_putDebugLogFilePath(objHandle: HCkTrustedRoots; newPropVal: PWideChar); stdcall;
function CkTrustedRoots__debugLogFilePath(objHandle: HCkTrustedRoots): 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:

  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
procedure CkTrustedRoots_getLastErrorHtml(objHandle: HCkTrustedRoots; outPropVal: HCkString); stdcall;
function CkTrustedRoots__lastErrorHtml(objHandle: HCkTrustedRoots): 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.

top
LastErrorText
procedure CkTrustedRoots_getLastErrorText(objHandle: HCkTrustedRoots; outPropVal: HCkString); stdcall;
function CkTrustedRoots__lastErrorText(objHandle: HCkTrustedRoots): 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.

top
LastErrorXml
procedure CkTrustedRoots_getLastErrorXml(objHandle: HCkTrustedRoots; outPropVal: HCkString); stdcall;
function CkTrustedRoots__lastErrorXml(objHandle: HCkTrustedRoots): 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.

top
LastMethodSuccess
function CkTrustedRoots_getLastMethodSuccess(objHandle: HCkTrustedRoots): wordbool; stdcall;
procedure CkTrustedRoots_putLastMethodSuccess(objHandle: HCkTrustedRoots; newPropVal: wordbool); stdcall;
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
function CkTrustedRoots_getNumCerts(objHandle: HCkTrustedRoots): Integer; stdcall;
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
RejectSelfSignedCerts
function CkTrustedRoots_getRejectSelfSignedCerts(objHandle: HCkTrustedRoots): wordbool; stdcall;
procedure CkTrustedRoots_putRejectSelfSignedCerts(objHandle: HCkTrustedRoots; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.80

Indicates whether all self-signed certificates are to be rejected in SSL/TLS connections. The default value of this property is False.

Note: This is for the case where the server certificate chain of authentication is 1 certificate long (i.e. the TLS server certificate itself is self-signed).

top
TrustSystemCaRoots
function CkTrustedRoots_getTrustSystemCaRoots(objHandle: HCkTrustedRoots): wordbool; stdcall;
procedure CkTrustedRoots_putTrustSystemCaRoots(objHandle: HCkTrustedRoots; newPropVal: wordbool); stdcall;
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
function CkTrustedRoots_getVerboseLogging(objHandle: HCkTrustedRoots): wordbool; stdcall;
procedure CkTrustedRoots_putVerboseLogging(objHandle: HCkTrustedRoots; 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.

top
Version
procedure CkTrustedRoots_getVersion(objHandle: HCkTrustedRoots; outPropVal: HCkString); stdcall;
function CkTrustedRoots__version(objHandle: HCkTrustedRoots): PWideChar; stdcall;

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

top

Methods

Activate
function CkTrustedRoots_Activate(objHandle: HCkTrustedRoots): wordbool; stdcall;
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
function CkTrustedRoots_AddCert(objHandle: HCkTrustedRoots;
    cert: HCkCert): wordbool; stdcall;
Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

More Information and Examples
top
AddJavaKeyStore
function CkTrustedRoots_AddJavaKeyStore(objHandle: HCkTrustedRoots;
    keystore: HCkJavaKeyStore): wordbool; stdcall;
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)
function CkTrustedRoots_AddJavaKeyStoreAsync(objHandle: HCkTrustedRoots;
    keystore: HCkJavaKeyStore): HCkTask; stdcall;
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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
Deactivate
function CkTrustedRoots_Deactivate(objHandle: HCkTrustedRoots): wordbool; stdcall;
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
function CkTrustedRoots_GetCert(objHandle: HCkTrustedRoots;
    index: Integer): HCkCert; stdcall;
Introduced in version 9.5.0.38

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

Returns nil on failure

More Information and Examples
top
LoadCaCertsPem
function CkTrustedRoots_LoadCaCertsPem(objHandle: HCkTrustedRoots;
    path: PWideChar): wordbool; stdcall;
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)
function CkTrustedRoots_LoadCaCertsPemAsync(objHandle: HCkTrustedRoots;
    path: PWideChar): HCkTask; stdcall;
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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top
LoadTaskCaller
function CkTrustedRoots_LoadTaskCaller(objHandle: HCkTrustedRoots;
    task: HCkTask): wordbool; stdcall;
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

top

Events

Chilkat supports event callbacks for the Delphi DLL starting in version 9.5.0.82.

AbortCheck
function MyAbortCheck(): Integer; cdecl;
Introduced in version 9.5.0.82

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return True to abort; return False to continue (not abort)

More Information and Examples
top
PercentDone
function MyPercentDone(pctDone: Integer): Integer; cdecl;
Introduced in version 9.5.0.82

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 event is only fired 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 operations (Chilkat method calls) 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).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return True to abort; return False to continue (not abort)

More Information and Examples
top
ProgressInfo
procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;
Introduced in version 9.5.0.82

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

More Information and Examples
top
TaskCompleted
procedure MyTaskCompleted(task: HCkTask) cdecl;
Introduced in version 9.5.0.82

Called in the background thread when an asynchronous task completes.

top