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

> Chilkat 11.7.0 · language=tcl · 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/tcl/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

**Object Creation**

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkCodeSign]
```

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 Tcl.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## 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` | `string # ckStr is a CkString CkCodeSign_get_DebugLogFilePath $this $ckStr set strVal [CkCodeSign_get_debugLogFilePath $this] CkCodeSign_put_DebugLogFilePath $this $strVal` | 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` | `string # ckStr is a CkString CkCodeSign_get_LastErrorHtml $this $ckStr set strVal [CkCodeSign_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkCodeSign_get_LastErrorText $this $ckStr set strVal [CkCodeSign_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkCodeSign_get_LastErrorXml $this $ckStr set strVal [CkCodeSign_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkCodeSign_get_LastMethodSuccess $this] CkCodeSign_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkCodeSign_get_Utf8 $this] CkCodeSign_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkCodeSign_get_VerboseLogging $this] CkCodeSign_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkCodeSign_get_Version $this $ckStr set strVal [CkCodeSign_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `UncommonOptions` | property, read/write | `string # ckStr is a CkString CkCodeSign_get_UncommonOptions $this $ckStr set strVal [CkCodeSign_get_uncommonOptions $this] CkCodeSign_put_UncommonOptions $this $strVal` |
| `AddSignature` | method | `# path is a string # cert is a CkCert # options is a CkJsonObject set status [CkCodeSign_AddSignature $this $path $cert $options]` |
| `GetSignerCert` | method | `# cert is a CkCert set status [CkCodeSign_GetSignerCert $this $cert]` |
| `RemoveSignature` | method | `# path is a string set status [CkCodeSign_RemoveSignature $this $path]` |
| `VerifySignature` | method | `# path is a string # sigInfo is a CkJsonObject set status [CkCodeSign_VerifySignature $this $path $sigInfo]` |

## Properties

### CodeSign.UncommonOptions

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

```tcl
string
# ckStr is a CkString

CkCodeSign_get_UncommonOptions $this $ckStr

set strVal [CkCodeSign_get_uncommonOptions $this]

CkCodeSign_put_UncommonOptions $this $strVal
```

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 · tcl · CodeSign · AddSignature · method · since 9.5.0.97`

```tcl
# path is a string

# cert is a CkCert

# options is a CkJsonObject

set status [CkCodeSign_AddSignature $this $path  $cert  $options]
```

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

Async variant: `AddSignatureAsync` — same arguments, returns a `Task` (see Async variants below).

### CodeSign.GetSignerCert

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

```tcl
# cert is a CkCert

set status [CkCodeSign_GetSignerCert $this $cert]
```

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 `1`. Otherwise, the method returns `0`.

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 `1`. After a failed verification, this method returns `0`.

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

### CodeSign.RemoveSignature

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

```tcl
# path is a string

set status [CkCodeSign_RemoveSignature $this $path]
```

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 `1` if the signature is successfully removed; otherwise returns `0`.

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

### CodeSign.VerifySignature

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

```tcl
# path is a string

# sigInfo is a CkJsonObject

set status [CkCodeSign_VerifySignature $this $path  $sigInfo]
```

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 `0`. Structured information about the signature, signer, certificate chain, digest algorithms, timestamp, and validation result is written to `sigInfo`.

Returns `1` 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 `0`. 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 `0` unless the `codesign-allow-cert-padding` option is set in `UncommonOptions`.

MSI packages signed with an ECDSA certificate: this method can return `1` 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 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```tcl
# returns a CkTask

# path is a string

# cert is a CkCert

# options is a CkJsonObject

set ret_task [CkCodeSign_AddSignatureAsync $this $path  $cert  $options]
```

## Related classes

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