Skip to content

Commit 7ded584

Browse files
committed
Update windows-specific-properties.md
1 parent 2454b7c commit 7ded584

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

docs/windows-specific-properties.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@
3535
<disableFinishedPage>true|false</disableFinishedPage>
3636
<createDesktopIconTask>true|false</createDesktopIconTask>
3737

38+
<!-- signing properties -->
39+
<signing>
40+
<keystore>path/to/keystore</keystore>
41+
<storepass>password</storepass>
42+
<alias>cert_alias</alias>
43+
[...]
44+
</signing>
45+
3846
</winConfig>
3947
```
4048

@@ -82,4 +90,28 @@ Property `winConfig.setupMode` can be set with 3 possible values:
8290

8391
- **installForAllUsers** *(default value)*: installs the app for the all users in `%ProgramFiles%` folder (behaviour can be changed when running setup installer from command-line with `/currentuser` argument).
8492
- **installForCurrentUser**: installs the app for the current user in `%USERPROFILE%\AppData\Local\Programs` folder (behaviour can be changed when running setup installer from command-line with `/allusers` argument).
85-
- **askTheUser**: asks to the final user if the app has to be installed for all users or only for the current user.
93+
- **askTheUser**: asks to the final user if the app has to be installed for all users or only for the current user.
94+
95+
## Signing properties
96+
97+
| | Mandatory | Default value | Description |
98+
| ----------- | ------------------------------------------------------------ | ------------- | ------------------------------------------------------------ |
99+
| `storetype` | :x: | `JKS` | The type of the keystore: JKS (Java keystore), PKCS12 (`.p12` or `.pfx` files), PKCS11. |
100+
| `keystore` | :heavy_check_mark:, unless `certfile` and `keyfile` are specified. | | The keystore file, or the SunPKCS11 configuration file. |
101+
| `certfile` | :heavy_check_mark:, unless `keystore` is specified. | `true` | The file containing the PKCS#7 certificate chain (`.p7b` or `.spc` files). |
102+
| `keyfile` | :heavy_check_mark:, unless `keystore` is specified. | `true` | The file containing the private key. `PEM` and `PVK` files are supported. |
103+
| `storepass` | :x: | `true` | The password to open the keystore. |
104+
| `alias` | :heavy_check_mark:, if `keystore` is specified and more than one alias exist | `true` | The alias of the certificate used for signing in the keystore. Java code signing certificates can be used for Authenticode signatures. |
105+
| `keypass` | :x: | `null` | The password of the private key. When using a keystore, this parameter can be omitted if the keystore shares the same password. |
106+
| `alg` | :x: | `SHA-256` | The digest algorithm (`SHA-1`, `SHA-256`, `SHA-384` or `SHA-512`). |
107+
108+
### Example using a Java KeyStore
109+
110+
```xml
111+
<signing>
112+
<keystore>c:\Users\fvarrui\keystore.jks</keystore>
113+
<storepass>123456</storepass>
114+
<alias>fvarrui</alias>
115+
</signing>
116+
```
117+

0 commit comments

Comments
 (0)