TChilkatCodeSign Delphi ActiveX Reference Documentation
TChilkatCodeSign
Current Version: 10.0.0
A class for signing Windows executables and DLLs, and for verifying signed executables and DLLs. This is a Windows-only class. The class and functions will exist on non-Windows systems, but will be no-op functions (stubs) that simply return a failed status.
Importing the Chilkat ActiveX into Delphi
Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.
Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).
Two things are required to use an ActiveX in Delphi:
- 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.
- See also: ActiveX Registration Tutorial
- 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_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.
To import the Chilkat type library, do the following:
- In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
- Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
- Check the "Generate Component Wrappers" checkbox.
- Select a directory where the unit files (.pas and .dcr) should be generated.
- Select "Create Unit" and then "Finish".
- Add the .pas to your Delphi project.
To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_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_TLB;
Object Creation
var obj: TChilkatCodeSign; ... begin obj := TChilkatCodeSign.Create(Self); ... // When finished, free the object instance. obj.Free();
Properties
DebugLogFilePath
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
HeartbeatMs
This property is only valid in programming environment and languages that allow for event callbacks.
Specifies the time interval in milliseconds between AbortCheck events. A value of 0 (the default) indicate that no AbortCheck events will fire. Any HTTP operation can be aborted via the AbortCheck event.
topLastBinaryResult
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).
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
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.
topLastStringResult
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).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topUncommonOptions
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
Can be set to a list of the following comma separated keywords:
- "codesign-allow-expired-cert" - Don't fail authenticode signature validation because the signing certificate is expired.
VerboseLogging
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.
topVersion
Methods
AddSignature
Authenticode signs a DLL or EXE.
Returns 1 for success, 0 for failure.
AddSignatureAsync (1)
Creates an asynchronous task to call the AddSignature 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
topRemoveSignature
Removes the authenticode signature of a Windows executable or DLL. The path to the executable/DLL is passed in path.
Returns 1 for success, 0 for failure.
VerifySignature
Verifies the signature of a Windows executable or DLL. The path to the executable/DLL is passed in path. Information about the signature is returned in sigInfo. Returns 1 if the signature is verified indicating the EXE or DLL can be trusted. Otherwise returns 0.
Returns 1 for success, 0 for failure.
Events
AbortCheck
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.codesignAbortCheck(ASender: TObject; out abort: Integer); begin // Application code goes here... end; procedure TForm1.Button1Click(Sender: TObject); var codesign: TChilkatCodeSign; begin codesign := TChilkatCodeSign.Create(Self); codesign.OnAbortCheck := codesignAbortCheck; // ...
PercentDone
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.codesignPercentDone(ASender: TObject; pctDone: Integer; out abort: Integer); begin // Application code goes here... end; procedure TForm1.Button1Click(Sender: TObject); var codesign: TChilkatCodeSign; begin codesign := TChilkatCodeSign.Create(Self); codesign.OnPercentDone := codesignPercentDone; // ...
ProgressInfo
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.codesignProgressInfo(ASender: TObject; const name: WideString; const value: WideString); begin // Application code goes here... end; procedure TForm1.Button1Click(Sender: TObject); var codesign: TChilkatCodeSign; begin codesign := TChilkatCodeSign.Create(Self); codesign.OnProgressInfo := codesignProgressInfo; // ...
TaskCompleted
Called in the background thread when an asynchronous task completes.
Delphi ActiveX Event callback implementation:
procedure TForm1.codesignTaskCompleted(ASender: TObject; const task: IChilkatTask); begin // Application code goes here... end; procedure TForm1.Button1Click(Sender: TObject); var codesign: TChilkatCodeSign; begin codesign := TChilkatCodeSign.Create(Self); codesign.OnTaskCompleted := codesignTaskCompleted; // ...