CodeSign Delphi DLL Reference Documentation

CodeSign

Current Version: 10.0.0

Requires Chilkat Bundle License

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.

Create/Dispose

var
myObject: HCkCodeSign;

begin
myObject := CkCodeSign_Create();

// ...

CkCodeSign_Dispose(myObject);
end;

function CkCodeSign_Create: HCkCodeSign; stdcall;

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

Objects created by calling CkCodeSign_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 CkCodeSign_getDebugLogFilePath(objHandle: HCkCodeSign; outPropVal: HCkString); stdcall;
procedure CkCodeSign_putDebugLogFilePath(objHandle: HCkCodeSign; newPropVal: PWideChar); stdcall;
function CkCodeSign__debugLogFilePath(objHandle: HCkCodeSign): 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:

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

function CkCodeSign_getHeartbeatMs(objHandle: HCkCodeSign): Integer; stdcall;
procedure CkCodeSign_putHeartbeatMs(objHandle: HCkCodeSign; newPropVal: Integer); stdcall;

Introduced in version 9.5.0.98

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.

LastErrorHtml

procedure CkCodeSign_getLastErrorHtml(objHandle: HCkCodeSign; outPropVal: HCkString); stdcall;
function CkCodeSign__lastErrorHtml(objHandle: HCkCodeSign): 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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkCodeSign_getLastErrorText(objHandle: HCkCodeSign; outPropVal: HCkString); stdcall;
function CkCodeSign__lastErrorText(objHandle: HCkCodeSign): 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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkCodeSign_getLastErrorXml(objHandle: HCkCodeSign; outPropVal: HCkString); stdcall;
function CkCodeSign__lastErrorXml(objHandle: HCkCodeSign): 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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkCodeSign_getLastMethodSuccess(objHandle: HCkCodeSign): wordbool; stdcall;
procedure CkCodeSign_putLastMethodSuccess(objHandle: HCkCodeSign; newPropVal: wordbool); stdcall;

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.

UncommonOptions

procedure CkCodeSign_getUncommonOptions(objHandle: HCkCodeSign; outPropVal: HCkString); stdcall;
procedure CkCodeSign_putUncommonOptions(objHandle: HCkCodeSign; newPropVal: PWideChar); stdcall;
function CkCodeSign__uncommonOptions(objHandle: HCkCodeSign): PWideChar; stdcall;

Introduced in version 9.5.0.97

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.

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkCodeSign_getVerboseLogging(objHandle: HCkCodeSign): wordbool; stdcall;
procedure CkCodeSign_putVerboseLogging(objHandle: HCkCodeSign; 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.

Version

procedure CkCodeSign_getVersion(objHandle: HCkCodeSign; outPropVal: HCkString); stdcall;
function CkCodeSign__version(objHandle: HCkCodeSign): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddSignature

function CkCodeSign_AddSignature(objHandle: HCkCodeSign;
    path: PWideChar;
    cert: HCkCert;
    options: HCkJsonObject): wordbool; stdcall;

Introduced in version 9.5.0.97

Authenticode signs a DLL or EXE.

Returns True for success, False for failure.

More Information and Examples

Authenticode Sign an Executable (EXE) or DLL

AddSignatureAsync ⁽¹⁾

function CkCodeSign_AddSignatureAsync(objHandle: HCkCodeSign;
    path: PWideChar;
    cert: HCkCert;
    options: HCkJsonObject): HCkTask; stdcall;

Introduced in version 9.5.0.97

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

RemoveSignature

function CkCodeSign_RemoveSignature(objHandle: HCkCodeSign;
path: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.97

Removes the authenticode signature of a Windows executable or DLL. The path to the executable/DLL is passed in path.

Returns True for success, False for failure.

More Information and Examples

Remove the Authenticode Signature from an EXE or DLL

VerifySignature

function CkCodeSign_VerifySignature(objHandle: HCkCodeSign;
path: PWideChar;
sigInfo: HCkJsonObject): wordbool; stdcall;

Introduced in version 9.5.0.97

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 True if the signature is verified indicating the EXE or DLL can be trusted. Otherwise returns False.

Returns True for success, False for failure.

More Information and Examples

Verify Authenticode Signature of EXE or DLL

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

Delphi DLL AbortCheck Event Callback Example

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

Delphi DLL PercentDone Event Callback Example

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

Delphi DLL ProgressInfo Event Callback Example

TaskCompleted

procedure MyTaskCompleted(task: HCkTask) cdecl;

Introduced in version 9.5.0.82

Called in the background thread when an asynchronous task completes.

More Information and Examples

Delphi DLL TaskCompleted Event Callback Example

top