---
product: Chilkat
product_version: 11.7.0
language: pascal
language_label: Lazarus Pascal
class: CodeSign
license: bundle
platforms: windows
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/pascal_CodeSignRef.html
---
# Chilkat CodeSign — Lazarus Pascal — v11.7.0

> Chilkat 11.7.0 · language=pascal · class=CodeSign · platforms=windows
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/CodeSign.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/guide.md`.

## Purpose

**Available only on: windows.** Do not use this class on other platforms.

**Sign, verify, inspect, and remove Authenticode signatures on Windows executables, installers, and scripts.**

`Chilkat.CodeSign` works directly with Authenticode signatures on Windows executable files such as `.exe` and `.dll`, and, starting in v11.7.0, on Windows Installer packages (`.msi`), PowerShell files (`.ps1`, `.psm1`, `.psd1`), and VBScript files (`.vbs`). It provides functionality for applying a code-signing signature, validating whether a signed executable can be trusted, extracting signature information, retrieving the signer certificate, and removing an existing signature.

**Sign executables, installers, and scripts**

Apply Authenticode signatures to EXE, DLL, MSI, PowerShell, and VBScript files using a certificate and associated private key.

**Validate trust**

Check whether a signed executable has a valid signature and whether the signing certificate chain can be trusted.

**Inspect signatures**

Extract details about the Authenticode signature, including signer information and signature-related metadata.

**Retrieve signer certificates**

Get the certificate used to sign the executable and inspect it with `Chilkat.Cert`.

**Remove signatures**

Remove an existing Authenticode signature from a signed file when an unsigned output file is required.

**Diagnostics**

Use detailed diagnostic output to troubleshoot signing, certificate, trust-chain, timestamping, or validation problems.

**Common pattern:** Load or provide a code-signing certificate that has access to its private key, sign the target file, optionally add timestamping if supported by the signing workflow, then verify the resulting signature and inspect diagnostics if validation does not succeed.

For an extended overview, see [CodeSign Class Overview](https://www.chilkatsoft.com/codesign_class_overview.asp).

## Object creation, unlocking and error handling

**Create / Free**

```pascal
uses
  Chilkat.CodeSign;

var
  obj: TCodeSign;
begin
  obj := TCodeSign.Create;
  try
    if not obj.IsValid then
      raise Exception.Create('Failed to create a TCodeSign instance.');

    // ... use obj ...

  finally
    obj.Free;
  end;
end;
```

`constructor Create;`

Allocates the underlying CkCodeSign object and returns a new TCodeSign instance. Simply adding **Chilkat.CodeSign** to the unit's `uses` clause is enough to locate and bind to the Chilkat shared library (DLL / .so / .dylib) at runtime — no separate load step is required. Check `obj.IsValid` after calling `Create`; it is `False` if the underlying library could not be found/loaded or the object could not be allocated (for example, when unlicensed).

`destructor Destroy; override;`

Every TCodeSign created by calling `Create` should eventually be released by calling `.Free` (inherited from `TObject`). The destructor automatically disposes the underlying CkCodeSign handle. A native (unmanaged) memory leak occurs if the object is never freed.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Lazarus Pascal.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `property DebugLogFilePath: string read GetDebugLogFilePath write SetDebugLogFilePath;` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `property LastErrorHtml: string read GetLastErrorHtml;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `property LastErrorText: string read GetLastErrorText;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `property LastErrorXml: string read GetLastErrorXml;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `property LastMethodSuccess: Boolean read GetLastMethodSuccess write SetLastMethodSuccess;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `property VerboseLogging: Boolean read GetVerboseLogging write SetVerboseLogging;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `property Version: string read GetVersion;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `HeartbeatMs` | property, read/write | `property HeartbeatMs: Integer read GetHeartbeatMs write SetHeartbeatMs;` |
| `UncommonOptions` | property, read/write | `property UncommonOptions: string read GetUncommonOptions write SetUncommonOptions;` |
| `AddSignature` | method | `// cert is a TCert object. // options is a TJsonObject object. function AddSignature(const path: string;     cert: TChilkatBase;     options: TChilkatBase): Boolean;` |
| `GetSignerCert` | method | `// cert is a TCert object. function GetSignerCert(cert: TChilkatBase): Boolean;` |
| `RemoveSignature` | method | `function RemoveSignature(const path: string): Boolean;` |
| `VerifySignature` | method | `// sigInfo is a TJsonObject object. function VerifySignature(const path: string;     sigInfo: TChilkatBase): Boolean;` |

## Properties

### CodeSign.HeartbeatMs

`Chilkat 11.7.0 · pascal · CodeSign · HeartbeatMs · property · read/write · since 9.5.0.98`

```pascal
property HeartbeatMs: Integer read GetHeartbeatMs write SetHeartbeatMs;
```

**Full documentation for this property (same in every language):** [Event Callback Examples](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/event_callback_examples.md)

Specifies the approximate interval, in milliseconds, between `AbortCheck` event callbacks during supported operations. An event handler can request that the current operation be aborted.

The default is `0`, which disables `AbortCheck` callbacks. Setting a positive value enables periodic callbacks when an operation is sufficiently long-running; methods that finish quickly may complete without generating one.

**Callback interval:** The interval is a scheduling target rather than a real-time guarantee. Callback timing can vary while waiting for private-key hardware, a timestamp authority, certificate-chain processing, or other operating-system services.

### CodeSign.UncommonOptions

`Chilkat 11.7.0 · pascal · CodeSign · UncommonOptions · property · read/write · since 9.5.0.97`

```pascal
property UncommonOptions: string read GetUncommonOptions write SetUncommonOptions;
```

Provides a comma-separated list of specialized compatibility or validation options. The default is an empty string, which is appropriate for normal use.

| Option | Effect |
| :--- | :--- |
| `codesign-allow-expired-cert` | Prevents Authenticode verification from failing solely because the signing certificate is expired. |
| `codesign-allow-cert-padding` | Starting in v11.7.0. Prevents verification of an EXE or DLL from failing solely because the PE certificate table fails the strict check (extra data or entries outside the verified signature). The failed check is still reported in `LastErrorText`. Use only for files known to carry such data, such as some installers that store configuration data in the certificate table. |

**Use only for an explicit trust policy:** Each option relaxes only the one check it names; neither disables the file-integrity, signature, chain, or other validation checks. `codesign-allow-expired-cert` is not a substitute for timestamping. A signature carrying a valid trusted timestamp should ordinarily remain verifiable after the signing certificate expires without this option.

## Methods

### CodeSign.AddSignature

`Chilkat 11.7.0 · pascal · CodeSign · AddSignature · method · since 9.5.0.97`

```pascal
// cert is a TCert object.

// options is a TJsonObject object.

function  AddSignature(const path: string;
    cert: TChilkatBase;
    options: TChilkatBase): Boolean;
```

Adds a Microsoft Authenticode signature to the file specified by `path`. The file is modified in place. `cert` supplies the code-signing certificate and must provide access to its associated private key. `options` supplies the signing configuration as JSON.

Starting in v11.7.0, Windows Installer packages, PowerShell files, and VBScript files can be signed in addition to Windows executables and DLLs. The supported file types are:

| File type | Extensions | Where the signature is stored |
| :--- | :--- | :--- |
| Windows PE images | `.exe`, `.dll`, and other PE files such as `.sys` and `.ocx` | The PE certificate table. PE files are identified from the file content, not the extension. |
| Windows Installer packages (starting in v11.7.0) | `.msi` | The package's digital signature stream. |
| PowerShell scripts, modules, and data files (starting in v11.7.0) | `.ps1`, `.psm1`, `.psd1` | A comment block appended to the file (`# SIG # Begin signature block` ... `# SIG # End signature block`). The file's text encoding (UTF-8, UTF-8 with BOM, or UTF-16) is kept. |
| VBScript files (starting in v11.7.0) | `.vbs` | A comment block appended to the file (`'' SIG '' Begin signature block` ... `'' SIG '' End signature block`). |

Any other file type (for example `.js`, `.cab`, or `.cat`) causes the method to return `False`, with `LastErrorText` explaining that the file type is not supported, and the file is not modified. The file must already exist; this method does not create it.

Starting in v11.7.0, if the file is already Authenticode-signed, the existing signature is removed and replaced by the new one. (Before v11.7.0, signing an already-signed EXE or DLL added a second signature entry instead of replacing the first.)

**MSI packages and ECDSA certificates:** Windows does not accept an Authenticode signature on an MSI package when the signing certificate uses an ECDSA key. Windows signature checks, such as `signtool verify`, `Get-AuthenticodeSignature`, and the file's Digital Signatures properties, report the signature as invalid (`TRUST_E_BAD_DIGEST`, 0x80096010). This is a limitation of signed MSI files on Windows, not a Chilkat defect: an MSI signed by Microsoft's `signtool` with the same ECDSA certificate is rejected in the same way, and its signed content is identical to the signature Chilkat produces. Use an RSA code-signing certificate to sign MSI packages. ECDSA certificates work for EXE, DLL, PowerShell, and VBScript files.

Common `options` options include:

| JSON member | Purpose |
| :--- | :--- |
| `hashAlg` | Selects the file-digest algorithm, such as `sha256`. |
| `timestampToken.enabled` | Enables an RFC 3161 timestamp token. |
| `timestampToken.tsaUrl` | Specifies the timestamp authority URL. |
| `timestampToken.requestTsaCert` | Requests inclusion of the timestamp authority certificate. |
| `timestampToken.hashAlg` | Selects the timestamp-request digest algorithm, such as `sha256`. |

```
{
  "hashAlg": "sha256",
  "timestampToken": {
    "enabled": true,
    "tsaUrl": "http://timestamp.example.com",
    "requestTsaCert": true,
    "hashAlg": "sha256"
  }
}
```

**Timestamping is strongly recommended:** A trusted timestamp records that the signature existed while the code-signing certificate was valid. This normally allows the signature to continue validating after the signing certificate expires, provided the timestamp and certificate chains remain valid under the verifier's trust policy.

Returns True for success, False for failure.

### CodeSign.GetSignerCert

`Chilkat 11.7.0 · pascal · CodeSign · GetSignerCert · method · since 10.0.1`

```pascal
// cert is a TCert object.

function  GetSignerCert(cert: TChilkatBase): Boolean;
```

Retrieves the X.509 signer certificate discovered by the most recent call to `VerifySignature` on this `CodeSign` object. If the certificate is fully available, `cert` is loaded with it and the method returns `True`. Otherwise, the method returns `False`.

The returned object contains the public certificate only; it does not provide the signer's private key. Call this method after `VerifySignature` and use the same `CodeSign` instance.

Starting in v11.7.0, the signer certificate is available only after a call to `VerifySignature` that returned `True`. After a failed verification, this method returns `False`.

**Certificate retrieval versus trust:** Successfully retrieving the signer certificate does not independently validate the signature or establish trust. Use the result of `VerifySignature` and the returned signature information when making a trust decision.

Returns True for success, False for failure.

### CodeSign.RemoveSignature

`Chilkat 11.7.0 · pascal · CodeSign · RemoveSignature · method · since 9.5.0.97`

```pascal
function  RemoveSignature(const path: string): Boolean;
```

Removes the embedded Authenticode signature from the file specified by `path`: a Windows executable or DLL, or, starting in v11.7.0, a Windows Installer package (`.msi`), PowerShell file (`.ps1`, `.psm1`, `.psd1`), or VBScript file (`.vbs`). The file is modified in place. Returns `True` if the signature is successfully removed; otherwise returns `False`.

For PowerShell and VBScript files, the signature comment block is removed from the end of the file. For MSI packages, the digital signature stream and the extended signature stream (`MsiDigitalSignatureEx`) are removed.

**Effect of removal:** The resulting file is no longer Authenticode-signed and no longer carries the removed publisher and timestamp information. This operation does not delete the signing certificate from a Windows certificate store or alter the private key. Keep a backup when the original signed file must be retained.

Returns True for success, False for failure.

### CodeSign.VerifySignature

`Chilkat 11.7.0 · pascal · CodeSign · VerifySignature · method · since 9.5.0.97`

```pascal
// sigInfo is a TJsonObject object.

function  VerifySignature(const path: string;
    sigInfo: TChilkatBase): Boolean;
```

Verifies the embedded Microsoft Authenticode signature of the file specified by `path`: a Windows executable or DLL, or, starting in v11.7.0, a Windows Installer package (`.msi`), PowerShell file (`.ps1`, `.psm1`, `.psd1`), or VBScript file (`.vbs`). See `AddSignature` for the supported file types. Other file types cause the method to return `False`. Structured information about the signature, signer, certificate chain, digest algorithms, timestamp, and validation result is written to `sigInfo`.

Returns `True` when the signature satisfies the applicable Authenticode validation checks under the current Windows trust configuration. This includes confirming that the signed portions of the file have not changed and evaluating the signing certificate and timestamp information, as applicable. An unsigned file or a signature that does not validate causes the method to return `False`. Inspect `sigInfo` and `LastErrorText` for details.

Starting in v11.7.0, verification of an EXE or DLL also includes a strict check of the PE certificate table: it must hold exactly one signature entry, containing exactly the signature that was verified, with no extra data. Data in the certificate table is not covered by the Authenticode signature (see CVE-2013-3900), so anything hidden there would be unsigned. A file that fails this check causes the method to return `False` unless the `codesign-allow-cert-padding` option is set in `UncommonOptions`.

MSI packages signed with an ECDSA certificate: this method can return `True` for such a package, while Windows itself reports the signature as invalid. This is a limitation of signed MSI files on Windows, not a Chilkat defect; see the note in `AddSignature`.

**What successful verification means:** Authenticode verifies publisher identity, file integrity, and certificate trust according to the validation policy. It does not prove that the software is bug-free, safe to execute, or free of malicious behavior. Trust results can also depend on the Windows trusted-root store, certificate-chain availability, timestamp validity, revocation policy, and other system trust settings.

Returns True for success, False for failure.

## Events and callbacks

Chilkat for Pascal supports three synchronous event callbacks: `OnAbortCheck`, `OnPercentDone`, and `OnProgressInfo`. Each is a property of the class; assign a method of one of your own objects (an *of object* handler) to receive the callbacks, or assign `nil` to unhook. The handler types are declared in the `Chilkat.Base` unit:

```pascal
TChilkatAbortCheckEvent   = function(Sender: TChilkatBase): Boolean of object;
TChilkatPercentDoneEvent  = function(Sender: TChilkatBase; PctDone: Integer): Boolean of object;
TChilkatProgressInfoEvent = procedure(Sender: TChilkatBase; const Name, Value: string) of object;
```

All Chilkat methods are synchronous, so callbacks are invoked on the thread that called the method -- if the method was called from the main thread, it is safe to access UI elements from the handler. The `HeartbeatMs` property controls the frequency of `OnAbortCheck` callbacks (the default of 0 means no AbortCheck events fire). Returning `True` from an `OnAbortCheck` or `OnPercentDone` handler aborts the running method.

### CodeSign.AbortCheck (event)

`Chilkat 11.7.0 · pascal · CodeSign · AbortCheck · event`

```pascal
// TChilkatAbortCheckEvent = function(Sender: TChilkatBase): Boolean of object;

property OnAbortCheck: TChilkatAbortCheckEvent;
```

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.

**Event callback implementation:**

```pascal
// A handler is a method of one of your own classes, e.g. a form:
function TMyObject.CodeSignAbortCheck(Sender: TChilkatBase): Boolean;
begin
  // Called every HeartbeatMs milliseconds while a method is running.
  // Return True to abort the method; return False to continue.
  Result := False;
end;
```

**To add an event handler:**

```pascal
codesign := TCodeSign.Create;
codesign.HeartbeatMs := 250;   // fire OnAbortCheck 4 times per second
codesign.OnAbortCheck := MyObject.CodeSignAbortCheck;
```

### CodeSign.PercentDone (event)

`Chilkat 11.7.0 · pascal · CodeSign · PercentDone · event`

```pascal
// TChilkatPercentDoneEvent = function(Sender: TChilkatBase; PctDone: Integer): Boolean of object;

property OnPercentDone: TChilkatPercentDoneEvent;
```

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.

To abort the operation, set the `abort` output argument to `True`. This will cause the method to terminate and return a failure status or corresponding failure value.

**Event callback implementation:**

```pascal
// A handler is a method of one of your own classes, e.g. a form:
function TMyObject.CodeSignPercentDone(Sender: TChilkatBase; PctDone: Integer): Boolean;
begin
  // PctDone ranges from 1 to 100.
  WriteLn('Percent done: ', PctDone);
  // Return True to abort the method; return False to continue.
  Result := False;
end;
```

**To add an event handler:**

```pascal
codesign := TCodeSign.Create;
codesign.OnPercentDone := MyObject.CodeSignPercentDone;
```

### CodeSign.ProgressInfo (event)

`Chilkat 11.7.0 · pascal · CodeSign · ProgressInfo · event`

```pascal
// TChilkatProgressInfoEvent = procedure(Sender: TChilkatBase; const Name, Value: string) of object;

property OnProgressInfo: TChilkatProgressInfoEvent;
```

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.

Note: Some Chilkat methods don't fire any ProgressInfo events.

**Event callback implementation:**

```pascal
// A handler is a method of one of your own classes, e.g. a form:
procedure TMyObject.CodeSignProgressInfo(Sender: TChilkatBase; const Name, Value: string);
begin
  WriteLn(Name, ': ', Value);
end;
```

**To add an event handler:**

```pascal
codesign := TCodeSign.Create;
codesign.OnProgressInfo := MyObject.CodeSignProgressInfo;
```

## Related classes

[`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/Cert.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/JsonObject.md)