Interface WindowsSignOptions

See the documentation for @electron/windows-sign for details.

interface WindowsSignOptions {
    automaticallySelectCertificate?: boolean;
    certificateFile?: string;
    certificatePassword?: string;
    continueOnError?: boolean;
    debug?: boolean;
    description?: string;
    hookFunction?: HookFunction;
    hookModulePath?: string;
    signJavaScript?: boolean;
    signToolPath?: string;
    signWithParams?: string | string[];
    timestampServer?: string;
    website?: string;
}

Hierarchy

  • Omit<WindowsInternalSignOptions, "appDirectory">
    • WindowsSignOptions

Properties

automaticallySelectCertificate? certificateFile? certificatePassword? continueOnError? debug? description? hookFunction? hookModulePath? signJavaScript? signToolPath? signWithParams? timestampServer? website?

Properties

Optional automaticallySelectCertificate

automaticallySelectCertificate?: boolean

Automatically selects the best signing certificate according to SignTool. Will be passed to signtool.exe as /a.

Default Value

true

Optional certificateFile

certificateFile?: string

Path to a .pfx code signing certificate. Will use process.env.WINDOWS_CERTIFICATE_FILE if this option is not provided.

Optional certificatePassword

certificatePassword?: string

Password to certificateFile. If you don't provide this, you need to provide the signWithParams option. Will use process.env.WINDOWS_CERTIFICATE_PASSWORD if this option is not provided.

Optional continueOnError

continueOnError?: boolean

Optional debug

debug?: boolean

Enables debug logging.

Default Value

false

Optional description

description?: string

Description of the signed content. Will be passed to signtool.exe as /d.

Optional hookFunction

hookFunction?: HookFunction

A hook function called for each file that needs to be signed. Use this for full control over your app's signing logic. @electron/windows-sign will not attempt to sign with SignTool if a custom hook is detected.

Optional hookModulePath

hookModulePath?: string

A path to a JavaScript file, exporting a single function that will be called for each file that needs to be signed. Use this for full control over your app's signing logic. @electron/windows-sign will not attempt to sign with SignTool if a custom hook is detected.

Optional signJavaScript

signJavaScript?: boolean

Whether or not to sign JavaScript files.

Default Value

false

Optional signToolPath

signToolPath?: string

Path to the signtool.exe used to sign. Will use vendor/signtool.exe if not provided.

Optional signWithParams

signWithParams?: string | string[]

Additional parameters to pass to signtool.exe.

See

Microsoft's SignTool.exe documentation

Optional timestampServer

timestampServer?: string

Path to a timestamp server. Will use process.env.WINDOWS_TIMESTAMP_SERVER if this option is not provided.

Default Value

http://timestamp.digicert.com

Optional website

website?: string

URL for the expanded description of the signed content. Will be passed to signtool.exe as /du.

Settings

Member Visibility

Theme

On This Page

automaticallySelectCertificatecertificateFilecertificatePasswordcontinueOnErrordebugdescriptionhookFunctionhookModulePathsignJavaScriptsignToolPathsignWithParamstimestampServerwebsite