Skip to content

Commit 2c7338b

Browse files
committed
global: Add ssl_server_ prefix to ssl server settings
1 parent 0887b5d commit 2c7338b

File tree

9 files changed

+96
-97
lines changed

9 files changed

+96
-97
lines changed

data/settings.js

Lines changed: 43 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4409,8 +4409,8 @@ It is usually neither necessary nor advisable to change the default.`
44094409
auth_ssl_require_client_cert: {
44104410
default: 'no',
44114411
seealso: [
4412-
'ssl_ca_file',
4413-
'ssl_request_client_cert',
4412+
'ssl_server_ca_file',
4413+
'ssl_server_request_client_cert',
44144414
'[[link,ssl_configuration]]',
44154415
],
44164416
values: setting_types.BOOLEAN,
@@ -4421,7 +4421,7 @@ provided.`
44214421

44224422
auth_ssl_username_from_cert: {
44234423
default: 'no',
4424-
seealso: [ 'ssl_cert_username_field' ],
4424+
seealso: [ 'ssl_server_cert_username_field' ],
44254425
values: setting_types.BOOLEAN,
44264426
text: `
44274427
Setting to \`yes\` indicates that the username should be taken from the
@@ -4432,7 +4432,7 @@ Generally, this will be either \`commonName\` or \`x500UniqueIdentifier\`.
44324432
The text is looked up from subject DN's specified field using OpenSSL's
44334433
X509_NAME_get_text_by_NID() function. By default the CommonName field is
44344434
used. You can change the field with
4435-
[[setting,ssl_cert_username_field,name]] setting (parsed using OpenSSL's
4435+
[[setting,ssl_server_cert_username_field,name]] setting (parsed using OpenSSL's
44364436
OBJ_txt2nid() function).
44374437
44384438
\`x500UniqueIdentifier\` is a common choice.`
@@ -10013,7 +10013,7 @@ This setting affects the \`secured\` state of connections. See
1001310013
[[link,secured_connections]].`
1001410014
},
1001510015

10016-
ssl_alt_cert_file: {
10016+
ssl_server_alt_cert_file: {
1001710017
seealso: [ 'ssl', '[[link,ssl_configuration]]' ],
1001810018
values: setting_types.FILE,
1001910019
text: `
@@ -10025,29 +10025,29 @@ This is useful when migrating to e.g. an ECDSA certificate.
1002510025
Example:
1002610026
1002710027
\`\`\`[dovecot.conf]
10028-
ssl_alt_cert_file = /path/to/alternative/cert.pem
10028+
ssl_server_alt_cert_file = /path/to/alternative/cert.pem
1002910029
\`\`\``
1003010030
},
1003110031

10032-
ssl_alt_key_file: {
10033-
seealso: [ 'ssl', 'ssl_alt_cert_file', '[[link,ssl_configuration]]' ],
10032+
ssl_server_alt_key_file: {
10033+
seealso: [ 'ssl', 'ssl_server_alt_cert_file', '[[link,ssl_configuration]]' ],
1003410034
values: setting_types.FILE,
1003510035
text: `
10036-
Private key for [[setting,ssl_alt_cert_file]].
10036+
Private key for [[setting,ssl_server_alt_cert_file]].
1003710037
1003810038
Example:
1003910039
1004010040
\`\`\`[dovecot.conf]
10041-
ssl_alt_key_file = /path/to/alternative/key.pem
10042-
ssl_alt_cert_file = /path/to/alternative/cert.pem
10041+
ssl_server_alt_key_file = /path/to/alternative/key.pem
10042+
ssl_server_alt_cert_file = /path/to/alternative/cert.pem
1004310043
\`\`\``
1004410044
},
1004510045

10046-
ssl_ca_file: {
10046+
ssl_server_ca_file: {
1004710047
seealso: [
1004810048
'ssl',
1004910049
'ssl_client_require_valid_cert',
10050-
'ssl_request_client_cert',
10050+
'ssl_server_request_client_cert',
1005110051
],
1005210052
values: setting_types.FILE,
1005310053
text: `
@@ -10058,30 +10058,30 @@ valid.
1005810058
Example:
1005910059
1006010060
\`\`\`[dovecot.conf]
10061-
ssl_ca_file = /etc/dovecot/ca.crt
10062-
ssl_request_client_cert = yes
10061+
ssl_server_ca_file = /etc/dovecot/ca.crt
10062+
ssl_server_request_client_cert = yes
1006310063
auth_ssl_require_client_cert = yes
1006410064
\`\`\``
1006510065
},
1006610066

10067-
ssl_cert_file: {
10068-
seealso: [ 'ssl', 'ssl_key_file', '[[link,ssl_configuration]]' ],
10067+
ssl_server_cert_file: {
10068+
seealso: [ 'ssl', 'ssl_server_key_file', '[[link,ssl_configuration]]' ],
1006910069
values: setting_types.FILE,
1007010070
text: `
1007110071
Path to the PEM-encoded X.509 SSL/TLS certificate presented for incoming
1007210072
imap/pop3/etc. client connections.
1007310073
10074-
The [[setting,ssl_key_file]] is also needed for the private certificate.
10074+
The [[setting,ssl_server_key_file]] is also needed for the private certificate.
1007510075
1007610076
Example:
1007710077
1007810078
\`\`\`[dovecot.conf]
10079-
ssl_cert_file = /etc/ssl/private/dovecot.crt
10080-
ssl_key_file = /etc/ssl/private/dovecot.key
10079+
ssl_server_cert_file = /etc/ssl/private/dovecot.crt
10080+
ssl_server_key_file = /etc/ssl/private/dovecot.key
1008110081
\`\`\``
1008210082
},
1008310083

10084-
ssl_cert_username_field: {
10084+
ssl_server_cert_username_field: {
1008510085
default: 'commonName',
1008610086
seealso: [ 'ssl', '[[link,ssl_configuration]]' ],
1008710087
values: setting_types.STRING,
@@ -10232,7 +10232,7 @@ ssl_curve_list = P-521:P-384:P-256
1023210232
\`\`\``
1023310233
},
1023410234

10235-
ssl_dh_file: {
10235+
ssl_server_dh_file: {
1023610236
seealso: [ 'ssl', '[[link,ssl_configuration]]' ],
1023710237
values: setting_types.FILE,
1023810238
text: `
@@ -10246,7 +10246,7 @@ You can generate a new parameters file by, for example, running
1024610246
Example:
1024710247
1024810248
\`\`\`[dovecot.conf]
10249-
ssl_dh_file = /path/to/dh.pem
10249+
ssl_server_dh_file = /path/to/dh.pem
1025010250
\`\`\``
1025110251
},
1025210252

@@ -10258,35 +10258,35 @@ ssl_dh_file = /path/to/dh.pem
1025810258
Require a valid certificate when connecting to external SSL services?`
1025910259
},
1026010260

10261-
ssl_key_file: {
10261+
ssl_server_key_file: {
1026210262
seealso: [
1026310263
'ssl',
10264-
'ssl_cert_file',
10265-
'ssl_key_password',
10264+
'ssl_server_cert_file',
10265+
'ssl_server_key_password',
1026610266
'[[link,ssl_configuration]]',
1026710267
],
1026810268
values: setting_types.FILE,
1026910269
text: `
1027010270
Path to the PEM-encoded X.509 SSL/TLS private key for
10271-
[[setting,ssl_cert_file]].
10271+
[[setting,ssl_server_cert_file]].
1027210272
1027310273
Example:
1027410274
1027510275
\`\`\`[dovecot.conf]
10276-
ssl_cert_file = /etc/ssl/private/dovecot.crt
10277-
ssl_key_file = /etc/ssl/private/dovecot.key
10276+
ssl_server_cert_file = /etc/ssl/private/dovecot.crt
10277+
ssl_server_key_file = /etc/ssl/private/dovecot.key
1027810278
\`\`\``
1027910279
},
1028010280

10281-
ssl_key_password: {
10282-
seealso: [ 'ssl', 'ssl_key_file', '[[link,ssl_configuration]]' ],
10281+
ssl_server_key_password: {
10282+
seealso: [ 'ssl', 'ssl_server_key_file', '[[link,ssl_configuration]]' ],
1028310283
values: setting_types.STRING,
1028410284
text: `
10285-
The password to use if [[setting,ssl_key_file]] is password-protected.
10285+
The password to use if [[setting,ssl_server_key_file]] is password-protected.
1028610286
1028710287
Since this file is often world-readable, you may wish to specify the path
1028810288
to a file containing the password, rather than the password itself, by
10289-
using the format \`ssl_key_password = <path\` here. The path should
10289+
using the format \`ssl_server_key_password = <path\` here. The path should
1029010290
be to a root-owned file with mode 0600.
1029110291
1029210292
Alternatively, you can supply the password via the -p parameter at startup.`
@@ -10342,28 +10342,27 @@ Currently supported options are:
1034210342
: Disable SSL session tickets.`
1034310343
},
1034410344

10345-
ssl_prefer_server_ciphers: {
10346-
default: 'no',
10345+
ssl_server_prefer_ciphers: {
10346+
default: 'client',
1034710347
seealso: [ 'ssl', '[[link,ssl_configuration]]' ],
10348-
values: setting_types.BOOLEAN,
10348+
values: setting_types.ENUM,
10349+
values_enum: [ 'client', 'server' ],
1034910350
text: `
10350-
If enabled, give preference to the server's cipher list over a client's
10351-
list. This setting is used only for server connections.`
10351+
Whether to give preference to the server's cipher list over a client's
10352+
list.`
1035210353
},
1035310354

10354-
ssl_require_crl: {
10355+
ssl_server_require_crl: {
1035510356
default: 'yes',
10356-
seealso: [ 'ssl', 'ssl_ca_file', '[[link,ssl_configuration]]' ],
10357+
seealso: [ 'ssl', 'ssl_server_ca_file', '[[link,ssl_configuration]]' ],
1035710358
values: setting_types.BOOLEAN,
1035810359
text: `
1035910360
If enabled, the CRL check must succeed for presented SSL client
1036010361
certificate and any intermediate certificates. The CRL list is generally
10361-
appended to the [[setting,ssl_ca_file]] file.
10362-
10363-
This setting is used only for server connections.`
10362+
appended to the [[setting,ssl_server_ca_file]] file.`
1036410363
},
1036510364

10366-
ssl_request_client_cert: {
10365+
ssl_server_request_client_cert: {
1036710366
changed: {
1036810367
settings_ssl_request_client_cert_changed: `
1036910368
Renamed from \`ssl_verify_client_cert\` setting.`

docs/core/config/guides/quick.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ namespace inbox {
5656
passdb pam {
5757
}
5858
59-
ssl_cert_file = /etc/dovecot/ssl-cert.pem
60-
ssl_key_file = /etc/dovecot/ssl-key.pem
59+
ssl_server_cert_file = /etc/dovecot/ssl-cert.pem
60+
ssl_server_key_file = /etc/dovecot/ssl-key.pem
6161
```
6262
:::
6363

@@ -175,8 +175,8 @@ them than the defaults.
175175

176176
## SSL and Plaintext Authentication
177177

178-
Configure SSL certificate and private key paths with [[setting,ssl_cert_file]]
179-
and [[setting,ssl_key_file]] settings.
178+
Configure SSL certificate and private key paths with [[setting,ssl_server_cert_file]]
179+
and [[setting,ssl_server_key_file]] settings.
180180

181181
An easy way to build a self-signed test certificate is using Dovecot's
182182
`doc/mkcert.sh` script. For more information see [[link,ssl_configuration]].

docs/core/config/service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ parsed data in simpler format to config clients.
232232
* Only root should be able to connect to its UNIX listener, unless there
233233
are no secrets in the configuration.
234234

235-
Passwords are obviously secrets, but less obviously [[setting,ssl_key_file]]
235+
Passwords are obviously secrets, but less obviously [[setting,ssl_server_key_file]]
236236
is also a secret, since it contains the actual SSL key data instead of
237237
only a filename.
238238

0 commit comments

Comments
 (0)