CodeSign

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.

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.

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.

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.

Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

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

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

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.

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

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:

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

Common options options include:

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

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AddSignature method with the arguments provided.

Returns NULL on failure

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.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.

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.

Returns 1 for success, 0 for failure.