MS Authenticode Signer
ENTERPRISE This is a SignServer Enterprise feature.
The signer has the fully qualified class name: org.signserver.module.msauthcode.signer.MSAuthCodeSigner.
Overview
The MS Authenticode signer signs portable executable files such as Windows executables and shared libraries (.exe, .dll and .ocx etc) according to the Windows Authenticode Portable Executable Signature Format, and also Windows installer packages (.msi), PowerShell scripts (.ps1, .psm1 and .psd1), Windows Catalog Files (.cat), and Cabinet archives (.cab). The signature can optionally include a timestamp response from a TSA using the RFC#3161, or legacy Authenticode format.
Note that MSI files larger than 2 GB are currently not supported.
Available Properties
| Property | Description |
|---|---|
| PROGRAM_NAME | Program name to embed in the signature. Optional, default: none. |
| ALLOW_PROGRAM_NAME_OVERRIDE | If the requestor should be able to override the program name by supplying it as a request metadata property. Optional, default: false. |
| PROGRAM_URL | Program URL to embed in the signature. Optional, default: none. |
| ALLOW_PROGRAM_URL_OVERRIDE | If the requestor should be able to override the program URL by supplying it as a request metadata property. Optional, default: false. |
| ENCODING | Sets the character encoding when signing PowerShell scripts (.ps1). Optional, default: utf-8. |
| ALLOW_ENCODING_OVERRIDE | If the requestor should be able to override the encoding by supplying it as a request metadata property. Optional, default: false. |
| SIGNATUREALGORITHM | Signature algorithm. Optional, default: depending on the signing key, SHA256withRSA, SHA256withDSA or SHA256withECDSA. |
| DIGESTALGORITHM | Algorithm for the digest of the binary. Optional, default: SHA256. |
| TSA_WORKER | Worker ID or name of internal (Authenticode or RFC#3161) time-stamp signer in the same SignServer. Optional, default: none. This property cannot be combined with TSA_URL. |
| TSA_URL | URL of external (Authenticode or RFC#3161) time-stamp authority. Optional, default: none. This property cannot be combined with TSA_WORKER. |
| TSA_USERNAME | Login username used if the TSA uses HTTP Basic Auth. Optional, default: none. |
| TSA_PASSWORD | Login password used if the TSA uses HTTP Basic Auth. Required if TSA_USERNAME is specified, default: none. |
| DO_LOGREQUEST_DIGEST | If a digest of the request should be computed and logged. Optional, default: true. |
| LOGREQUEST_DIGESTALGORITHM | Algorithm used to create the message digest (hash) of the request document to put in the log. Default: SHA256. |
| DO_LOGRESPONSE_DIGEST | If a digest of the response should be computed and logged. Optional, default: true. |
| LOGRESPONSE_DIGESTALGORITHM | Algorithm used to create the message digest (hash) of the response document to put in the log. Default: SHA256. |
| TIMESTAMP_FORMAT | Specifies the timestamp format to use. Default: RFC3161. Allowed values: RFC3161, AUTHENTICODE. If the value AUTHENTICODE is set, a legacy Authenticode timestamp signer is assumed, rather than a standard RFC3161-compliant one. |
| KEEPSIGNATURES | True if existing signature should be kept. Optional, default: True.
|
Property only available when signing PE and PS1 file types.Request Properties
This worker can accept the following request metadata properties, given that they are configured to be allowed:
| Property | Description |
|---|---|
| PROGRAM_NAME | Program name text to use instead of the configured one (if any). Specifying an empty value removes the configured program name. Without ALLOW_PROGRAM_NAME_OVERRIDE configured in the worker request, including this request property will not be allowed. |
| PROGRAM_URL | Program URL to use instead of the configured one (if any). Specifying an empty value removes the configured program URL. Without ALLOW_PROGRAM_URL_OVERRIDE configured in the worker request, including this request property will not be allowed. |
| ENCODING | Overrides the encoding when signing PowerShell scripts (.ps1). Without ALLOW_ENCODING_OVERRIDE configured in the worker request, including this request property will not be allowed. |
| FILE_TYPE | Option to specify that the supplied file is using a specific file type. Normally this is optional and the PE, MSI, and CAT file types are detected based on the content of the files and PS1 files are detected based on the file extension of the provided file name (if one). In order to support PowerShell scripts even if the file name is not provided or the extension is not one of .ps1, .psm1 or .psd1, the FILE_TYPE request property can be explicitly set in the request. Supported values: PE, MSI, PS1, or CAT. |
Worker Log Fields
| Field | Description |
|---|---|
| REQUEST_DIGEST | A message digest (hash) for the request document in hex encoding. |
| REQUEST_DIGEST_ALGORITHM | The name of the message digest (hash) algorithm used for the request digest in the log. |
| RESPONSE_DIGEST | A message digest (hash) for the response document in hex encoding. |
| RESPONSE_DIGEST_ALGORITHM | The name of the message digest (hash) algorithm used for the response digest in the log. |
| FILE_TYPE | The type of file that was detected or requested to be signed. |