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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/**
* 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.
*/
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kAccessControl
#include "mongo/db/auth/authentication_session.h"
#include "mongo/client/authenticate.h"
#include "mongo/db/audit.h"
#include "mongo/db/client.h"
#include "mongo/logv2/log.h"
namespace mongo {
namespace {
constexpr auto kDiagnosticLogLevel = 3;
Status crossVerifyUserNames(const UserName& oldUser, const UserName& newUser) noexcept {
if (oldUser.getFullName().empty()) {
return Status::OK();
}
if (!getTestCommandsEnabled()) {
// Authenticating the __system@local user to the admin database on mongos is required
// by the auth passthrough test suite, hence we forgive this set of errors in testing.
if (oldUser.getDB() != newUser.getDB()) {
return {ErrorCodes::ProtocolError,
"Attempt to switch database target during SASL authentication."};
}
}
if (oldUser.getUser().empty() || newUser.getUser().empty()) {
// If we don't have a user and our databases match, no harm and nothing more to do.
return Status::OK();
}
if (oldUser.getUser() != newUser.getUser()) {
return {ErrorCodes::ProtocolError, "Attempt to switch user during SASL authentication."};
}
return Status::OK();
}
const auto getAuthenticationSession =
Client::declareDecoration<boost::optional<AuthenticationSession>>();
class AuthenticationClientObserver final : public ServiceContext::ClientObserver {
public:
void onCreateClient(Client* client) override {}
void onDestroyClient(Client* client) override {
auto& maybeSession = getAuthenticationSession(client);
if (maybeSession) {
maybeSession->markFailed(
{ErrorCodes::AuthenticationAbandoned,
"Authentication session abandoned, client has likely disconnected"});
}
}
void onCreateOperationContext(OperationContext* opCtx) override {}
void onDestroyOperationContext(OperationContext* opCtx) override {}
};
auto registerer = ServiceContext::ConstructorActionRegisterer{
"AuthenticationClientObserver", [](ServiceContext* service) {
service->registerClientObserver(std::make_unique<AuthenticationClientObserver>());
}};
auto makeAppender(ServerMechanismBase* mech) {
return [mech](BSONObjBuilder* bob) {
if (mech) {
mech->appendExtraInfo(bob);
}
};
}
} // namespace
AuthenticationSession::StepGuard::StepGuard(OperationContext* opCtx, StepType currentStep)
: _opCtx(opCtx), _currentStep(currentStep) {
auto client = _opCtx->getClient();
LOGV2_DEBUG(
5286300, kDiagnosticLogLevel, "Starting authentication step", "step"_attr = _currentStep);
auto& maybeSession = getAuthenticationSession(client);
ON_BLOCK_EXIT([&] {
if (maybeSession) {
// If we successfully made/kept a session, update it and track it.
auto& session = *maybeSession;
_session = &session;
}
});
auto createSession = [&] {
if (maybeSession) {
maybeSession->markFailed(
{ErrorCodes::AuthenticationAbandoned, "Overridden by new authentication session"});
}
maybeSession.emplace(client);
};
auto startActiveSession = [&] {
if (maybeSession) {
invariant(maybeSession->_lastStep);
auto lastStep = *maybeSession->_lastStep;
if (lastStep == StepType::kSaslSupportedMechanisms) {
// We can follow saslSupportedMechanisms with saslStart or authenticate.
return;
}
}
createSession();
};
switch (_currentStep) {
case StepType::kSaslSupportedMechanisms: {
createSession();
authCounter.incSaslSupportedMechanismsReceived();
} break;
case StepType::kSpeculativeAuthenticate:
case StepType::kSpeculativeSaslStart: {
startActiveSession();
maybeSession->_isSpeculative = true;
} break;
case StepType::kAuthenticate:
case StepType::kSaslStart: {
startActiveSession();
} break;
case StepType::kSaslContinue: {
uassert(ErrorCodes::ProtocolError, "No SASL session state found", maybeSession);
uassert(ErrorCodes::ProtocolError,
"saslContinue must follow saslStart",
maybeSession->_mech);
} break;
}
}
AuthenticationSession::StepGuard::~StepGuard() {
auto& maybeSession = getAuthenticationSession(_opCtx->getClient());
if (maybeSession) {
LOGV2_DEBUG(5286301,
kDiagnosticLogLevel,
"Finished authentication step",
"step"_attr = _currentStep);
if (maybeSession->_isFinished) {
// We're done with this session, reset it.
maybeSession.reset();
} else {
maybeSession->_lastStep = _currentStep;
}
}
}
AuthenticationSession* AuthenticationSession::get(Client* client) {
auto& maybeSession = getAuthenticationSession(client);
tassert(5286302, "Unable to retrieve authentication session", static_cast<bool>(maybeSession));
return &(*maybeSession);
}
void AuthenticationSession::setMechanismName(StringData mechanismName) {
LOGV2_DEBUG(
5286200, kDiagnosticLogLevel, "Setting mechanism name", "mechanism"_attr = mechanismName);
tassert(5286201, "Attempt to change the mechanism name", _mechName.empty());
_mechName = mechanismName.toString();
_mechCounter = authCounter.getMechanismCounter(_mechName);
_mechCounter->incAuthenticateReceived();
if (_isSpeculative) {
_mechCounter->incSpeculativeAuthenticateReceived();
}
}
void AuthenticationSession::_verifyUserNameFromSaslSupportedMechanisms(const UserName& userName) {
if (auto status = crossVerifyUserNames(_ssmUserName, userName); !status.isOK()) {
LOGV2(5286202,
"Different user name was supplied to saslSupportedMechs",
"error"_attr = status);
// Reset _ssmUserName since we have found a conflict.
auto ssmUserName = std::exchange(_ssmUserName, {});
auto event = audit::AuthenticateEvent(auth::kSaslSupportedMechanisms,
ssmUserName.getDB(),
ssmUserName.getUser(),
makeAppender(_mech.get()),
ErrorCodes::AuthenticationAbandoned);
audit::logAuthentication(_client, event);
}
}
void AuthenticationSession::setUserNameForSaslSupportedMechanisms(UserName userName) {
_verifyUserNameFromSaslSupportedMechanisms(userName);
_ssmUserName = userName;
}
void AuthenticationSession::updateUserName(UserName userName) {
LOGV2_DEBUG(5286203, kDiagnosticLogLevel, "Updating user name", "userName"_attr = userName);
_verifyUserNameFromSaslSupportedMechanisms(userName);
uassertStatusOK(crossVerifyUserNames(_userName, userName));
_userName = userName;
}
void AuthenticationSession::setMechanism(std::unique_ptr<ServerMechanismBase> mech,
boost::optional<BSONObj> options) {
tassert(5286303, "Attempted to override previous authentication mechanism", !_mech);
_mech = std::move(mech);
if (options) {
invariant(options->isOwned());
uassertStatusOK(_mech->setOptions(*options));
}
LOGV2_DEBUG(5286304, kDiagnosticLogLevel, "Determined mechanism for authentication");
}
void AuthenticationSession::setAsClusterMember() {
if (std::exchange(_isClusterMember, true)) {
return;
}
_mechCounter->incClusterAuthenticateReceived();
LOGV2_DEBUG(5286305, kDiagnosticLogLevel, "Marking as cluster member");
}
void AuthenticationSession::_finish() {
_isFinished = true;
if (_mech) {
// Since both isClusterMember() and getPrincipalName() can return differently over the
// course of authentication, only get the values when we finish.
if (_mech->isClusterMember()) {
setAsClusterMember();
}
updateUserName({_mech->getPrincipalName(), _mech->getAuthenticationDatabase()});
}
}
void AuthenticationSession::markSuccessful() {
_finish();
_mechCounter->incAuthenticateSuccessful();
if (_isClusterMember) {
_mechCounter->incClusterAuthenticateSuccessful();
}
if (_isSpeculative) {
_mechCounter->incSpeculativeAuthenticateSuccessful();
}
auto event = audit::AuthenticateEvent(_mechName,
_userName.getDB(),
_userName.getUser(),
makeAppender(_mech.get()),
ErrorCodes::OK);
audit::logAuthentication(_client, event);
LOGV2_DEBUG(5286306,
kDiagnosticLogLevel,
"Successfully authenticated",
"client"_attr = _client->getRemote(),
"isSpeculative"_attr = _isSpeculative,
"isClusterMember"_attr = _isClusterMember,
"mechanism"_attr = _mechName,
"user"_attr = _userName.getUser(),
"db"_attr = _userName.getDB());
}
void AuthenticationSession::markFailed(const Status& status) {
_finish();
auto event = audit::AuthenticateEvent(_mechName,
_userName.getDB(),
_userName.getUser(),
makeAppender(_mech.get()),
status.code());
audit::logAuthentication(_client, event);
LOGV2_DEBUG(5286307,
kDiagnosticLogLevel,
"Failed to authenticate",
"client"_attr = _client->getRemote(),
"isSpeculative"_attr = _isSpeculative,
"isClusterMember"_attr = _isClusterMember,
"mechanism"_attr = _mechName,
"user"_attr = _userName.getUser(),
"db"_attr = _userName.getDB(),
"error"_attr = status);
}
} // namespace mongo
|