CodeSign Delphi DLL Reference Documentation
CodeSign
Current Version: 11.1.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.
Create/Dispose
var myObject: HCkCodeSign; begin myObject := CkCodeSign_Create(); // ... CkCodeSign_Dispose(myObject); end;
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.
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_putDebugLogFilePath(objHandle: HCkCodeSign; newPropVal: PWideChar); stdcall;
function CkCodeSign__debugLogFilePath(objHandle: HCkCodeSign): PWideChar; stdcall;
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
See the notes about PWideChar memory ownership and validity.
HeartbeatMs
procedure CkCodeSign_putHeartbeatMs(objHandle: HCkCodeSign; newPropVal: Integer); stdcall;
The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.
LastErrorHtml
function CkCodeSign__lastErrorHtml(objHandle: HCkCodeSign): PWideChar; stdcall;
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkCodeSign__lastErrorText(objHandle: HCkCodeSign): PWideChar; stdcall;
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkCodeSign__lastErrorXml(objHandle: HCkCodeSign): PWideChar; stdcall;
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkCodeSign_putLastMethodSuccess(objHandle: HCkCodeSign; newPropVal: wordbool); stdcall;
Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
UncommonOptions
procedure CkCodeSign_putUncommonOptions(objHandle: HCkCodeSign; newPropVal: PWideChar); stdcall;
function CkCodeSign__uncommonOptions(objHandle: HCkCodeSign): PWideChar; stdcall;
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.
topVerboseLogging
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
function CkCodeSign__version(objHandle: HCkCodeSign): PWideChar; stdcall;
Version of the component/library, such as "10.1.0"
See the notes about PWideChar memory ownership and validity.
Methods
AddSignature
path: PWideChar;
cert: HCkCert;
options: HCkJsonObject): wordbool; stdcall;
Authenticode signs a DLL or EXE.
Returns True for success, False for failure.
AddSignatureAsync (1)
path: PWideChar;
cert: HCkCert;
options: HCkJsonObject): HCkTask; stdcall;
Creates an asynchronous task to call the AddSignature method with the arguments provided.
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
GetSignerCert
This method retrieves the signer certificate after calling VerifySignature. If successful and the signer certificate is fully available, cert will contain the certificate.
Returns True for success, False for failure.
topRemoveSignature
path: PWideChar): wordbool; stdcall;
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.
VerifySignature
path: PWideChar;
sigInfo: HCkJsonObject): wordbool; stdcall;
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.
Events
AbortCheck
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. Return True to abort; return False to continue (not abort)
PercentDone
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
Return True to abort; return False to continue (not abort)
ProgressInfo
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.