1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/config.h"
- "mongo/util/net/ssl_options.h"
configs:
section: "TLS Options"
source: [ yaml, cli, ini ]
# Name these initializers so they can be invoked from ssl_options_test.cpp
initializer: SSLServerOptionsIDL
imports:
- "mongo/db/basic_types.idl"
configs:
"net.tls.tlsOnNormalPorts":
description: "Use TLS on configured ports"
short_name: tlsOnNormalPorts
deprecated_name: "net.ssl.sslOnNormalPorts"
deprecated_short_name: sslOnNormalPorts
arg_vartype: Switch
source: [ cli, ini ]
conflicts: [ "net.tls.mode", "net.ssl.mode" ]
"net.tls.mode":
description: "Set the TLS operation mode (disabled|allowTLS|preferTLS|requireTLS)"
short_name: tlsMode
arg_vartype: String
conflicts: "net.ssl.mode"
"net.ssl.mode":
description: "Set the SSL operation mode (disabled|allowSSL|preferSSL|requireSSL)"
short_name: sslMode
arg_vartype: String
conflicts: "net.tls.mode"
hidden: true
"net.tls.certificateKeyFile":
description: >-
Certificate and key file for TLS. Certificate is presented in response to inbound connections
always. Certificate is also presented for outbound connections if tlsClusterFile is not
specified.
short_name: tlsCertificateKeyFile
deprecated_name: "net.ssl.PEMKeyFile"
deprecated_short_name: sslPEMKeyFile
arg_vartype: String
"net.tls.certificateKeyFilePassword":
description: "Password to unlock key in the TLS certificate key file"
short_name: tlsCertificateKeyFilePassword
deprecated_name: "net.ssl.PEMKeyPassword"
deprecated_short_name: sslPEMKeyPassword
arg_vartype: String
cpp_varname: sslGlobalParams.sslPEMKeyPassword
implicit: ''
redact: true
"net.tls.clusterFile":
description: >-
Certificate and key file for internal TLS authentication. Certificate is presented on outbound
connections if specified.
short_name: tlsClusterFile
deprecated_name: "net.ssl.clusterFile"
deprecated_short_name: sslClusterFile
arg_vartype: String
"net.tls.clusterPassword":
description: "Internal authentication key file password"
short_name: tlsClusterPassword
deprecated_name: "net.ssl.clusterPassword"
deprecated_short_name: sslClusterPassword
arg_vartype: String
cpp_varname: sslGlobalParams.sslClusterPassword
implicit: ''
redact: true
"net.tls.CAFile":
description: >-
Certificate Authority file for TLS. Used to verify remote certificates presented in response
to outbound connections. Also used to verify remote certificates from inbound connections if
tlsClusterCAFile is not specified.
short_name: tlsCAFile
deprecated_name: "net.ssl.CAFile"
deprecated_short_name: sslCAFile
arg_vartype: String
"net.tls.clusterCAFile":
description: "CA used for verifying remotes during inbound connections"
short_name: tlsClusterCAFile
deprecated_name: "net.ssl.clusterCAFile"
deprecated_short_name: sslClusterCAFile
arg_vartype: String
"net.tls.CRLFile":
description: "Certificate Revocation List file for TLS"
short_name: tlsCRLFile
deprecated_name: "net.ssl.CRLFile"
deprecated_short_name: sslCRLFile
arg_vartype: String
"net.tls.tlsCipherConfig":
description: "OpenSSL cipher configuration string"
short_name: tlsCipherConfig
deprecated_name: "net.ssl.sslCipherConfig"
deprecated_short_name: sslCipherConfig
arg_vartype: String
hidden: true
"net.tls.disabledProtocols":
description: "Comma separated list of TLS protocols to disable [TLS1_0,TLS1_1,TLS1_2,TLS1_3]"
short_name: tlsDisabledProtocols
deprecated_name: "net.ssl.disabledProtocols"
deprecated_short_name: sslDisabledProtocols
arg_vartype: String
"net.tls.allowConnectionsWithoutCertificates":
# Alias for --tlsWeakCertificateValidation.
description: "Allow client to connect without presenting a certificate"
short_name: tlsAllowConnectionsWithoutCertificates
deprecated_name:
- "net.tls.weakCertificateValidation"
- "net.ssl.weakCertificateValidation"
- "net.ssl.allowConnectionsWithoutCertificates"
deprecated_short_name:
- tlsWeakCertificateValidation
- sslWeakCertificateValidation
- sslAllowConnectionsWithoutCertificates
arg_vartype: Switch
cpp_varname: sslGlobalParams.sslWeakCertificateValidation
"net.tls.allowInvalidHostnames":
description: "Allow server certificates to provide non-matching hostnames"
short_name: tlsAllowInvalidHostnames
deprecated_name: "net.ssl.allowInvalidHostnames"
deprecated_short_name: sslAllowInvalidHostnames
arg_vartype: Switch
cpp_varname: sslGlobalParams.sslAllowInvalidHostnames
"net.tls.allowInvalidCertificates":
description: "Allow connections to servers with invalid certificates"
short_name: tlsAllowInvalidCertificates
deprecated_name: "net.ssl.allowInvalidCertificates"
deprecated_short_name: sslAllowInvalidCertificates
arg_vartype: Switch
cpp_varname: sslGlobalParams.sslAllowInvalidCertificates
# Certificate Selectors are only available on OSX/Windows with --ssl-provider=native (or auto)
"net.tls.certificateSelector":
description: "TLS Certificate in system store"
short_name: tlsCertificateSelector
deprecated_name: "net.ssl.certificateSelector"
deprecated_short_name: sslCertificateSelector
arg_vartype: String
conflicts: [ "net.tls.certificateKeyFile", "net.tls.certificateKeyFilePassword" ]
condition:
preprocessor: "defined(MONGO_CONFIG_SSL_CERTIFICATE_SELECTORS)"
"net.tls.clusterCertificateSelector":
description: "SSL/TLS Certificate in system store for internal TLS authentication"
short_name: tlsClusterCertificateSelector
deprecated_name: "net.ssl.clusterCertificateSelector"
deprecated_short_name: sslClusterCertificateSelector
arg_vartype: String
conflicts: [ "net.tls.clusterFile", "net.tls.clusterFilePassword" ]
condition:
preprocessor: "defined(MONGO_CONFIG_SSL_CERTIFICATE_SELECTORS)"
"net.tls.logVersions":
description: "Comma separated list of TLS protocols to log on connect [TLS1_0,TLS1_1,TLS1_2,TLS1_3]"
short_name: tlsLogVersions
arg_vartype: String
"net.tls.clusterAuthX509.extensionValue":
description: >-
If specified, clients who expect to be regarded as cluster members
must present a valid X.509 certificate containing an X.509 extension
for OID 1.3.6.1.4.1.34601.2.1.2 which contains the specified value.
short_name: tlsClusterAuthX509ExtensionValue
arg_vartype: String
conflicts: "net.tls.clusterAuthX509.attributes"
"net.tls.clusterAuthX509.attributes":
description: >-
If specified, clients performing X.509 authentication must present a certificate with a
subject name with the exact attributes and values provided in this config option to be
treated as peer cluster nodes.
short_name: tlsClusterAuthX509Attributes
arg_vartype: String
conflicts: "net.tls.clusterAuthX509.extensionValue"
|