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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/auth/sasl_mechanism_registry.h"
#include "mongo/base/init.h"
#include "mongo/client/authenticate.h"
#include "mongo/db/auth/sasl_options.h"
#include "mongo/db/auth/user.h"
#include "mongo/db/connection_health_metrics_parameter_gen.h"
#include "mongo/logv2/log.h"
#include "mongo/util/exit_code.h"
#include "mongo/util/icu.h"
#include "mongo/util/net/socket_utils.h"
#include "mongo/util/quick_exit.h"
#include "mongo/util/scopeguard.h"
#include "mongo/util/sequence_util.h"
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kAccessControl
namespace mongo {
namespace {
const auto getSASLServerMechanismRegistry =
ServiceContext::declareDecoration<std::unique_ptr<SASLServerMechanismRegistry>>();
} // namespace
SASLServerMechanismRegistry& SASLServerMechanismRegistry::get(ServiceContext* serviceContext) {
auto& uptr = getSASLServerMechanismRegistry(serviceContext);
invariant(uptr);
return *uptr;
}
void SASLServerMechanismRegistry::set(ServiceContext* service,
std::unique_ptr<SASLServerMechanismRegistry> registry) {
getSASLServerMechanismRegistry(service) = std::move(registry);
}
SASLServerMechanismRegistry::SASLServerMechanismRegistry(ServiceContext* svcCtx,
std::vector<std::string> enabledMechanisms)
: _svcCtx(svcCtx), _enabledMechanisms(std::move(enabledMechanisms)) {}
void SASLServerMechanismRegistry::setEnabledMechanisms(std::vector<std::string> enabledMechanisms) {
_enabledMechanisms = std::move(enabledMechanisms);
}
StatusWith<std::unique_ptr<ServerMechanismBase>> SASLServerMechanismRegistry::getServerMechanism(
StringData mechanismName, std::string authenticationDatabase) {
auto& mechList = _getMapRef(authenticationDatabase);
auto it = std::find_if(mechList.begin(), mechList.end(), [&](const auto& mech) {
return (mech->mechanismName() == mechanismName);
});
if (it != mechList.end()) {
return (*it)->create(std::move(authenticationDatabase));
}
return Status(ErrorCodes::MechanismUnavailable,
str::stream() << "Unsupported mechanism '" << mechanismName
<< "' on authentication database '" << authenticationDatabase
<< "'");
}
void SASLServerMechanismRegistry::advertiseMechanismNamesForUser(OperationContext* opCtx,
UserName userName,
BSONObjBuilder* builder) {
// Authenticating the __system@local user to the admin database on mongos is required
// by the auth passthrough test suite.
auto systemUser = internalSecurity.getUser();
if (getTestCommandsEnabled() && userName.getUser() == (*systemUser)->getName().getUser() &&
userName.getDB() == "admin") {
userName = (*systemUser)->getName();
}
AuthorizationManager* authManager = AuthorizationManager::get(opCtx->getServiceContext());
UserHandle user;
const auto swUser = [&] {
if (gEnableDetailedConnectionHealthMetricLogLines) {
ScopedCallbackTimer timer([&](Microseconds elapsed) {
LOGV2(6788603,
"Auth metrics report",
"metric"_attr = "sasl_acquireUser",
"micros"_attr = elapsed.count());
});
}
return authManager->acquireUser(opCtx, UserRequest(userName, boost::none));
}();
if (!swUser.isOK()) {
auto& status = swUser.getStatus();
if (status.code() == ErrorCodes::UserNotFound) {
LOGV2(20251,
"Supported SASL mechanisms requested for unknown user",
"user"_attr = userName);
return;
}
uassertStatusOK(status);
}
user = std::move(swUser.getValue());
BSONArrayBuilder mechanismsBuilder;
const auto& mechList = _getMapRef(userName.getDB());
for (const auto& factoryIt : mechList) {
SecurityPropertySet properties = factoryIt->properties();
if (!properties.hasAllProperties(SecurityPropertySet{SecurityProperty::kNoPlainText,
SecurityProperty::kMutualAuth}) &&
userName.getDB() != "$external") {
continue;
}
auto mechanismEnabled = _mechanismSupportedByConfig(factoryIt->mechanismName());
if (!mechanismEnabled && userName == (*systemUser)->getName()) {
mechanismEnabled = factoryIt->isInternalAuthMech();
}
if (mechanismEnabled && factoryIt->canMakeMechanismForUser(user.get())) {
mechanismsBuilder << factoryIt->mechanismName();
}
}
builder->appendArray("saslSupportedMechs", mechanismsBuilder.arr());
}
bool SASLServerMechanismRegistry::_mechanismSupportedByConfig(StringData mechName) const {
return sequenceContains(_enabledMechanisms, mechName);
}
void appendMechs(const std::vector<std::unique_ptr<ServerFactoryBase>>& mechs,
std::vector<std::string>* pNames) {
std::transform(mechs.cbegin(),
mechs.cend(),
std::back_inserter(*pNames),
[](const std::unique_ptr<mongo::ServerFactoryBase>& factory) {
return factory->mechanismName().toString();
});
}
std::vector<std::string> SASLServerMechanismRegistry::getMechanismNames() const {
std::vector<std::string> names;
names.reserve(_externalMechs.size() + _internalMechs.size());
appendMechs(_externalMechs, &names);
appendMechs(_internalMechs, &names);
return names;
}
StringData ServerMechanismBase::getAuthenticationDatabase() const {
auto systemUser = internalSecurity.getUser();
if (getTestCommandsEnabled() && _authenticationDatabase == "admin" &&
getPrincipalName() == (*systemUser)->getName().getUser()) {
// Allows authenticating as the internal user against the admin database. This is to
// support the auth passthrough test framework on mongos (since you can't use the local
// database on a mongos, so you can't auth as the internal user without this).
return (*systemUser)->getName().getDB();
} else {
return _authenticationDatabase;
}
}
namespace {
ServiceContext::ConstructorActionRegisterer SASLServerMechanismRegistryInitializer{
"CreateSASLServerMechanismRegistry", {"EndStartupOptionStorage"}, [](ServiceContext* service) {
SASLServerMechanismRegistry::set(service,
std::make_unique<SASLServerMechanismRegistry>(
service, saslGlobalParams.authenticationMechanisms));
}};
ServiceContext::ConstructorActionRegisterer SASLServerMechanismRegistryValidationInitializer{
"ValidateSASLServerMechanismRegistry", [](ServiceContext* service) {
auto supportedMechanisms = SASLServerMechanismRegistry::get(service).getMechanismNames();
// Manually include MONGODB-X509 since there is no factory for it since it not a SASL
// mechanism
supportedMechanisms.push_back(auth::kMechanismMongoX509.toString());
// Error if the user tries to use a SASL mechanism that does not exist
for (const auto& mech : saslGlobalParams.authenticationMechanisms) {
auto it = std::find(supportedMechanisms.cbegin(), supportedMechanisms.cend(), mech);
if (it == supportedMechanisms.end()) {
LOGV2_ERROR(4742901,
"SASL Mechanism '{mechanism}' is not supported",
"Unsupported SASL mechanism",
"mechanism"_attr = mech);
// Quick Exit since we are in the middle of setting up ServiceContext
quickExit(ExitCode::badOptions);
}
}
}};
} // namespace
} // namespace mongo
|
