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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/*
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kAccessControl
#include "mongo/db/auth/sasl_options.h"
#include "mongo/base/status.h"
#include "mongo/db/server_parameters.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/net/socket_utils.h"
#include "mongo/util/options_parser/startup_option_init.h"
#include "mongo/util/options_parser/startup_options.h"
namespace mongo {
SASLGlobalParams saslGlobalParams;
// For backward compatability purposes, "scramIterationCount" refers to the SHA-1 variant.
// The SHA-256 variant, as well as all future parameters, will use their specific name.
constexpr auto scramSHA1IterationCountServerParameter = "scramIterationCount"_sd;
constexpr auto scramSHA256IterationCountServerParameter = "scramSHA256IterationCount"_sd;
const int defaultScramSHA1IterationCount = 10000;
const int minimumScramSHA1IterationCount = 5000;
const int defaultScramSHA256IterationCount = 15000;
const int minimumScramSHA256IterationCount = 5000;
SASLGlobalParams::SASLGlobalParams() {
// Authentication mechanisms supported by default.
authenticationMechanisms.push_back("MONGODB-X509");
authenticationMechanisms.push_back("SCRAM-SHA-1");
authenticationMechanisms.push_back("SCRAM-SHA-256");
// Default iteration count for SCRAM authentication.
scramSHA1IterationCount.store(defaultScramSHA1IterationCount);
scramSHA256IterationCount.store(defaultScramSHA256IterationCount);
// Default value for auth failed delay
authFailedDelay.store(0);
}
Status addSASLOptions(moe::OptionSection* options) {
moe::OptionSection saslOptions("SASL Options");
saslOptions
.addOptionChaining("security.authenticationMechanisms",
"",
moe::StringVector,
"List of supported authentication mechanisms. "
"Default is SCRAM-SHA-1 and MONGODB-X509.")
.setSources(moe::SourceYAMLConfig);
saslOptions
.addOptionChaining(
"security.sasl.hostName", "", moe::String, "Fully qualified server domain name")
.setSources(moe::SourceYAMLConfig);
saslOptions
.addOptionChaining("security.sasl.serviceName",
"",
moe::String,
"Registered name of the service using SASL")
.setSources(moe::SourceYAMLConfig);
saslOptions
.addOptionChaining("security.sasl.saslauthdSocketPath",
"",
moe::String,
"Path to Unix domain socket file for saslauthd")
.setSources(moe::SourceYAMLConfig);
Status ret = options->addSection(saslOptions);
if (!ret.isOK()) {
log() << "Failed to add sasl option section: " << ret.toString();
return ret;
}
return Status::OK();
}
Status storeSASLOptions(const moe::Environment& params) {
bool haveAuthenticationMechanisms = false;
bool haveHostName = false;
bool haveServiceName = false;
bool haveAuthdPath = false;
bool haveScramSHA1IterationCount = false;
bool haveScramSHA256IterationCount = false;
int scramSHA1IterationCount = defaultScramSHA1IterationCount;
// Check our setParameter options first so that these values can be properly overridden via
// the command line even though the options have different names.
if (params.count("setParameter")) {
std::map<std::string, std::string> parameters =
params["setParameter"].as<std::map<std::string, std::string>>();
for (std::map<std::string, std::string>::iterator parametersIt = parameters.begin();
parametersIt != parameters.end();
parametersIt++) {
if (parametersIt->first == "authenticationMechanisms") {
haveAuthenticationMechanisms = true;
} else if (parametersIt->first == "saslHostName") {
haveHostName = true;
} else if (parametersIt->first == "saslServiceName") {
haveServiceName = true;
} else if (parametersIt->first == "saslauthdPath") {
haveAuthdPath = true;
} else if (parametersIt->first == scramSHA1IterationCountServerParameter) {
haveScramSHA1IterationCount = true;
// If the value here is non-numeric, atoi() will fail to parse.
// We can ignore that error since the ExportedServerParameter
// will catch it for us.
scramSHA1IterationCount = atoi(parametersIt->second.c_str());
} else if (parametersIt->first == scramSHA256IterationCountServerParameter) {
haveScramSHA256IterationCount = true;
}
}
}
if (params.count("security.authenticationMechanisms") && !haveAuthenticationMechanisms) {
saslGlobalParams.authenticationMechanisms =
params["security.authenticationMechanisms"].as<std::vector<std::string>>();
}
if (params.count("security.sasl.hostName") && !haveHostName) {
saslGlobalParams.hostName = params["security.sasl.hostName"].as<std::string>();
}
if (params.count("security.sasl.serviceName") && !haveServiceName) {
saslGlobalParams.serviceName = params["security.sasl.serviceName"].as<std::string>();
}
if (params.count("security.sasl.saslauthdSocketPath") && !haveAuthdPath) {
saslGlobalParams.authdPath = params["security.sasl.saslauthdSocketPath"].as<std::string>();
}
if (params.count("security.sasl.scramIterationCount") && !haveScramSHA1IterationCount) {
scramSHA1IterationCount = params["security.sasl.scramIterationCount"].as<int>();
saslGlobalParams.scramSHA1IterationCount.store(scramSHA1IterationCount);
}
if (!haveScramSHA256IterationCount) {
if (params.count("security.sasl.scramSHA256IterationCount")) {
saslGlobalParams.scramSHA256IterationCount.store(
params["security.sasl.scramSHA256IterationCount"].as<int>());
} else {
// If scramSHA256IterationCount isn't provided explicitly,
// then fall back on scramIterationCount if it is greater than
// the default scramSHA256IterationCount.
saslGlobalParams.scramSHA256IterationCount.store(
std::max<int>(scramSHA1IterationCount, defaultScramSHA256IterationCount));
}
}
if (saslGlobalParams.hostName.empty())
saslGlobalParams.hostName = getHostNameCached();
if (saslGlobalParams.serviceName.empty())
saslGlobalParams.serviceName = "mongodb";
return Status::OK();
}
MONGO_MODULE_STARTUP_OPTIONS_REGISTER(SASLOptions)(InitializerContext* context) {
return addSASLOptions(&moe::startupOptions);
}
MONGO_STARTUP_OPTIONS_STORE(SASLOptions)(InitializerContext* context) {
return storeSASLOptions(moe::startupOptionsParsed);
}
// SASL Startup Parameters, making them settable via setParameter on the command line or in the
// legacy INI config file. None of these parameters are modifiable at runtime.
ExportedServerParameter<std::vector<std::string>, ServerParameterType::kStartupOnly>
SASLAuthenticationMechanismsSetting(ServerParameterSet::getGlobal(),
"authenticationMechanisms",
&saslGlobalParams.authenticationMechanisms);
ExportedServerParameter<std::string, ServerParameterType::kStartupOnly> SASLHostNameSetting(
ServerParameterSet::getGlobal(), "saslHostName", &saslGlobalParams.hostName);
ExportedServerParameter<std::string, ServerParameterType::kStartupOnly> SASLServiceNameSetting(
ServerParameterSet::getGlobal(), "saslServiceName", &saslGlobalParams.serviceName);
ExportedServerParameter<std::string, ServerParameterType::kStartupOnly> SASLAuthdPathSetting(
ServerParameterSet::getGlobal(), "saslauthdPath", &saslGlobalParams.authdPath);
class ExportedScramIterationCountParameter
: public ExportedServerParameter<int, ServerParameterType::kStartupAndRuntime> {
public:
ExportedScramIterationCountParameter(StringData name, AtomicInt32* value, int minimum)
: ExportedServerParameter<int, ServerParameterType::kStartupAndRuntime>(
ServerParameterSet::getGlobal(), name.toString(), value),
_minimum(minimum) {}
virtual Status validate(const int& newValue) {
if (newValue < _minimum) {
return Status(
ErrorCodes::BadValue,
mongoutils::str::stream() << "Invalid value for SCRAM iteration count: " << newValue
<< " is less than the minimum SCRAM iteration count, "
<< _minimum);
}
return Status::OK();
}
private:
int _minimum;
};
ExportedScramIterationCountParameter scramSHA1IterationCountParam(
scramSHA1IterationCountServerParameter,
&saslGlobalParams.scramSHA1IterationCount,
minimumScramSHA1IterationCount);
ExportedScramIterationCountParameter scramSHA256IterationCountParam(
scramSHA256IterationCountServerParameter,
&saslGlobalParams.scramSHA256IterationCount,
minimumScramSHA256IterationCount);
} // namespace mongo
|
