CodeSign PHP ActiveX Reference Documentation

CodeSign

Current Version: 11.5.0

Chilkat.CodeSign

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

Chilkat.CodeSign works directly with Authenticode signatures on Windows executable files such as .exe and .dll. 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 EXE and DLL files

Apply Authenticode signatures to Windows executable 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 Windows executable 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 .exe or .dll, optionally add timestamping if supported by the signing workflow, then verify the resulting signature and inspect diagnostics if validation does not succeed.

Object Creation

Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.CodeSign");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.CodeSign");

Properties

DebugLogFilePath
string DebugLogFilePath

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.

More Information and Examples
top
LastBinaryResult
VARIANT LastBinaryResult (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to true. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
string LastErrorHtml (read-only)

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.

top
LastErrorText
string LastErrorText (read-only)

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.

top
LastErrorXml
string LastErrorXml (read-only)

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.

top
LastMethodSuccess
bool LastMethodSuccess

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

top
LastStringResult
string LastStringResult (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

top
LastStringResultLen
int LastStringResultLen (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
UncommonOptions
string UncommonOptions
Introduced in version 9.5.0.97

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

OptionEffect
codesign-allow-expired-certPrevents Authenticode verification from failing solely because the signing certificate is expired.
Use only for an explicit trust policy: This option relaxes the certificate-expiration check; it does not disable file-integrity, signature, chain, or other validation checks. It 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.

top
VerboseLogging
bool VerboseLogging

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.

top
Version
string Version (read-only)

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

More Information and Examples
top

Methods

AddSignature
bool AddSignature(string path, Chilkat.Cert cert, Chilkat.JsonObject options)
Introduced in version 9.5.0.97

Adds a Microsoft Authenticode signature to the Windows executable or DLL 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.

Common options options include:

JSON memberPurpose
hashAlgSelects the file-digest algorithm, such as sha256.
timestampToken.enabledEnables an RFC 3161 timestamp token.
timestampToken.tsaUrlSpecifies the timestamp authority URL.
timestampToken.requestTsaCertRequests inclusion of the timestamp authority certificate.
timestampToken.hashAlgSelects 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.

More Information and Examples
top
AddSignatureAsync (1)
Chilkat.Task AddSignatureAsync(string path, Chilkat.Cert cert, Chilkat.JsonObject options)
Introduced in version 9.5.0.97

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

Returns null on failure

top
GetSignerCert
bool GetSignerCert(Chilkat.Cert cert)
Introduced in version 10.0.1

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.

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.

top
RemoveSignature
bool RemoveSignature(string path)
Introduced in version 9.5.0.97

Removes the embedded Authenticode signature from the Windows executable or DLL specified by path. The file is modified in place. Returns true if the signature is successfully removed; otherwise returns false.

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.

top
VerifySignature
bool VerifySignature(string path, Chilkat.JsonObject sigInfo)
Introduced in version 9.5.0.97

Verifies the embedded Microsoft Authenticode signature of the Windows executable or DLL specified by path. 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.

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.

More Information and Examples
top