Page History
Name
Sign-JS7Workflow.ps1
SYNOPSIS
Digitally signs JS7 workflows and related files for secure deployment in a JS7 environment operated for security level "high"
...
Sign-JS7Workflow.ps1 [[-File] <String>] [[-Dir] <String>] [[-Keystore] <String>] [[-Key] <String>] [[-Cert] <String>] [[-Credentials] <PSCredential>] [-AskForCredentials] [[-Thumbprint] <String>] [[-Hash] <String>] [[-LogDir] <String>] [-ShowLogs] [-WhatIf] [-Confirm] [<CommonParameters>]
...
-File <String>
Specifies the path to a *.workflow.json or *.jobresource.json file to be signed.
If this argument is omitted then the -Dir argument will be used to look up workflow files.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Dir
-Dir <String>
Specifies the path to a directory holding *.workflow.json or *.jobresource.json files to be signed. Any sub-directories will be traversed recursively.
By default the current directory is used.
Required? | false |
Position? | 2 |
Default value | . |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Keystore
-Keystore <String>
Specifies the path to a keystore file that holds the private key and certificate used for signing.
The argument can be populated from the JS7_SIGN_KEYSTORE environment variable.
Only one of the -Keystore and -Key arguments can be used. If both arguments are omitted then the Windows Certificate Store will be used.
Required? | false |
Position? | 3 |
Default value | $env:JS7_SIGN_KEYSTORE |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Key
-Key <String>
Specifies the path to the key file that holds the private key used for signing.
The argument can be populated from the JS7_SIGN_KEY environment variable.
Only one of the -Key and -Keystore arguments can be used. If both arguments are omitted then the Windows Certificate Store will be used.
Required? | false |
Position? | 4 |
Default value | $env:JS7_SIGN_KEY |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Cert
-Cert <String>
Specifies the path to the certificate file used for signing.
The argument can be populated from the JS7_SIGN_CERT environment variable.
Only one of the -Cert and -Keystore arguments can be used. If both arguments are omitted then the Windows Certificate Store will be used.
Required? | false |
Position? | 5 |
Default value | $env:JS7_SIGN_CERT |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Credentials
-Credentials <PSCredential>
Optionally specifies a PowerShell credentials object that holds the password used for access to the key file or keystore.
Required? | false |
Position? | 6 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
AskForCredentials
-AskForCredentials <SwitchParameter>
Optionally prompts for user input of the password used to acess the key file or keystore. The alias argument -P is available.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Thumbprint
-Thumbprint <String>
Optionally specifies the thumbprint of the code signing certificate to be used. A thumbprint identifies a certificate.
It is required to specify the thumbprint if more than one code signing certificate is available from the indicated keystore or Windows Certificate Store.
Required? | false |
Position? | 7 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Hash
-Hash <String>
Optionally specifies the hash algorithm used for signatures.
Required? | false |
Position? | 8 |
Default value | sha256 |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
LogDir
-LogDir <String>
Required? | false |
Position? |
9 | |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
ShowLogs
-ShowLogs <SwitchParameter>
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
Required? | false |
Position? | named |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
Required? | false |
Position? | named |
Default value | |
Accept pipeline input? | false |
Accept wildcard characters? | false |
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
...