TChilkatTrustedRoots Delphi ActiveX Reference Documentation

TChilkatTrustedRoots

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.

Importing the Chilkat ActiveX into Delphi

Important: Whenever upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) will be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TChilkatTrustedRoots;
...
begin
obj := TChilkatTrustedRoots.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

property DebugLogFilePath: WideString

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.

property LastBinaryResult: OleVariant readonly

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

property LastErrorHtml: WideString readonly

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.

property LastErrorText: WideString readonly

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

property LastErrorXml: WideString readonly

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.

property LastMethodSuccess: Integer

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

property LastStringResult: WideString readonly

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

property LastStringResultLen: Integer readonly

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

property NumCerts: Integer readonly

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.

property TrustSystemCaRoots: Integer

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 1. Set this property equal to 0 to prevent Chilkat from automatically trusting system-provided root CA certificates.

HTTP - Verify Server is a Trusted Root CA

property VerboseLogging: Integer

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.

property Version: WideString readonly

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

Methods

function Activate(): Integer;

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

function AddCert(cert: TChilkatCert): Integer;

Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

Use a Custom Set of Trusted Root Certificates

function AddJavaKeyStore(keystore: TChilkatJavaKeyStore): Integer;

Introduced in version 9.5.0.44

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

Returns 1 for success, 0 for failure.

Load Certs from Java KeyStore into Trusted CA Roots

function AddJavaKeyStoreAsync(keystore: TChilkatJavaKeyStore): TChilkatTask;

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

How to Run an Asynchronous Task

function Deactivate(): Integer;

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 1 for success, 0 for failure.

function GetCert(index: Integer): TChilkatCert;

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

Load CA Cert Bundle into Trusted Roots

function LoadCaCertsPem(path: WideString): Integer;

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

function LoadCaCertsPemAsync(path: WideString): TChilkatTask;

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

How to Run an Asynchronous Task

Events

procedure AbortCheck(ASender: TObject; out abort: Integer);

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.

Delphi ActiveX Event callback implementation:

procedure TForm1.trustedrootsAbortCheck(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  trustedroots: TChilkatTrustedRoots;

begin
  trustedroots := TChilkatTrustedRoots.Create(Self);
  trustedroots.OnAbortCheck := trustedrootsAbortCheck;
  // ...

procedure BinaryData(ASender: TObject; data: OleVariant; length: Integer);

Binary data provided by certain methods.

Delphi ActiveX Event callback implementation:

procedure TForm1.trustedrootsBinaryData(ASender: TObject;  data: OleVariant; length: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  trustedroots: TChilkatTrustedRoots;

begin
  trustedroots := TChilkatTrustedRoots.Create(Self);
  trustedroots.OnBinaryData := trustedrootsBinaryData;
  // ...

procedure PercentDone(ASender: TObject; pctDone: Integer; out abort: Integer);

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.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

Delphi ActiveX Event callback implementation:

procedure TForm1.trustedrootsPercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  trustedroots: TChilkatTrustedRoots;

begin
  trustedroots := TChilkatTrustedRoots.Create(Self);
  trustedroots.OnPercentDone := trustedrootsPercentDone;
  // ...

procedure ProgressInfo(ASender: TObject; const name: WideString; const value: WideString);

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.

Delphi ActiveX Event callback implementation:

procedure TForm1.trustedrootsProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  trustedroots: TChilkatTrustedRoots;

begin
  trustedroots := TChilkatTrustedRoots.Create(Self);
  trustedroots.OnProgressInfo := trustedrootsProgressInfo;
  // ...

procedure TaskCompleted(ASender: TObject; const task: IChilkatTask);

Called in the background thread when an asynchronous task completes.

Delphi TaskCompleted Event Callback Example

Delphi ActiveX Event callback implementation:

procedure TForm1.trustedrootsTaskCompleted(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  trustedroots: TChilkatTrustedRoots;

begin
  trustedroots := TChilkatTrustedRoots.Create(Self);
  trustedroots.OnTaskCompleted := trustedrootsTaskCompleted;
  // ...

procedure TextData(ASender: TObject; const data: WideString);

Text data provided by certain methods.

Delphi ActiveX Event callback implementation:

procedure TForm1.trustedrootsTextData(ASender: TObject;  const data: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  trustedroots: TChilkatTrustedRoots;

begin
  trustedroots := TChilkatTrustedRoots.Create(Self);
  trustedroots.OnTextData := trustedrootsTextData;
  // ...