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
318
|
/* Copyright 2014 MongoDB 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/client/cyrus_sasl_client_session.h"
#include "mongo/base/init.h"
#include "mongo/client/native_sasl_client_session.h"
#include "mongo/util/allocator.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/concurrency/mutex.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/signal_handlers_synchronous.h"
namespace mongo {
namespace {
SaslClientSession* createCyrusSaslClientSession(const std::string& mech) {
if (mech == "SCRAM-SHA-1") {
return new NativeSaslClientSession();
}
return new CyrusSaslClientSession();
}
/*
* Allocator functions to be used by the SASL library, if the client
* doesn't initialize the library for us.
*/
// Version 2.1.26 is the first version to use size_t in the allocator signatures
#if (SASL_VERSION_FULL >= ((2 << 16) | (1 << 8) | 26))
typedef size_t SaslAllocSize;
#else
typedef unsigned long SaslAllocSize;
#endif
typedef int(*SaslCallbackFn)();
void* saslOurMalloc(SaslAllocSize sz) {
return mongoMalloc(sz);
}
void* saslOurCalloc(SaslAllocSize count, SaslAllocSize size) {
void* ptr = calloc(count, size);
if (!ptr) {
reportOutOfMemoryErrorAndExit();
}
return ptr;
}
void* saslOurRealloc(void* ptr, SaslAllocSize sz) {
return mongoRealloc(ptr, sz);
}
/*
* Mutex functions to be used by the SASL library, if the client doesn't initialize the library
* for us.
*/
void* saslMutexAlloc(void) {
return new SimpleMutex("sasl");
}
int saslMutexLock(void* mutex) {
static_cast<SimpleMutex*>(mutex)->lock();
return SASL_OK;
}
int saslMutexUnlock(void* mutex) {
static_cast<SimpleMutex*>(mutex)->unlock();
return SASL_OK;
}
void saslMutexFree(void* mutex) {
delete static_cast<SimpleMutex*>(mutex);
}
/**
* Configures the SASL library to use allocator and mutex functions we specify,
* unless the client application has previously initialized the SASL library.
*/
MONGO_INITIALIZER(CyrusSaslAllocatorsAndMutexes)(InitializerContext*) {
sasl_set_alloc(saslOurMalloc,
saslOurCalloc,
saslOurRealloc,
free);
sasl_set_mutex(saslMutexAlloc,
saslMutexLock,
saslMutexUnlock,
saslMutexFree);
return Status::OK();
}
int saslClientLogSwallow(void *context, int priority, const char *message) {
return SASL_OK; // do nothing
}
/**
* Initializes the client half of the SASL library, but is effectively a no-op if the client
* application has already done it.
*
* If a client wishes to override this initialization but keep the allocator and mutex
* initialization, it should implement a MONGO_INITIALIZER_GENERAL with
* CyrusSaslAllocatorsAndMutexes as a prerequisite and CyrusSaslClientContext as a
* dependent. If it wishes to override both, it should implement a MONGO_INITIALIZER_GENERAL
* with CyrusSaslAllocatorsAndMutexes and CyrusSaslClientContext as dependents, or
* initialize the library before calling mongo::runGlobalInitializersOrDie().
*/
MONGO_INITIALIZER_WITH_PREREQUISITES(CyrusSaslClientContext,
("NativeSaslClientContext",
"CyrusSaslAllocatorsAndMutexes"))
(InitializerContext* context) {
static sasl_callback_t saslClientGlobalCallbacks[] =
{ { SASL_CB_LOG, SaslCallbackFn(saslClientLogSwallow), NULL /* context */ },
{ SASL_CB_LIST_END } };
// If the client application has previously called sasl_client_init(), the callbacks passed
// in here are ignored.
//
// TODO: Call sasl_client_done() at shutdown when we have a story for orderly shutdown.
int result = sasl_client_init(saslClientGlobalCallbacks);
if (result != SASL_OK) {
return Status(ErrorCodes::UnknownError,
mongoutils::str::stream() <<
"Could not initialize sasl client components (" <<
sasl_errstring(result, NULL, NULL) <<
")");
}
SaslClientSession::create = createCyrusSaslClientSession;
return Status::OK();
}
/**
* Callback registered on the sasl_conn_t underlying a CyrusSaslClientSession to allow the Cyrus SASL
* library to query for the authentication id and other simple string configuration parameters.
*
* Note that in Mongo, the authentication and authorization ids (authid and authzid) are always
* the same. These correspond to SASL_CB_AUTHNAME and SASL_CB_USER.
*/
int saslClientGetSimple(void* context,
int id,
const char** result,
unsigned* resultLen) throw () {
CyrusSaslClientSession* session = static_cast<CyrusSaslClientSession*>(context);
if (!session || !result)
return SASL_BADPARAM;
CyrusSaslClientSession::Parameter requiredParameterId;
switch (id) {
case SASL_CB_AUTHNAME:
case SASL_CB_USER:
requiredParameterId = CyrusSaslClientSession::parameterUser;
break;
default:
return SASL_FAIL;
}
if (!session->hasParameter(requiredParameterId))
return SASL_FAIL;
StringData value = session->getParameter(requiredParameterId);
*result = value.rawData();
if (resultLen)
*resultLen = static_cast<unsigned>(value.size());
return SASL_OK;
}
/**
* Callback registered on the sasl_conn_t underlying a CyrusSaslClientSession to allow
* the Cyrus SASL library to query for the password data.
*/
int saslClientGetPassword(sasl_conn_t* conn,
void* context,
int id,
sasl_secret_t** outSecret) throw () {
CyrusSaslClientSession* session = static_cast<CyrusSaslClientSession*>(context);
if (!session || !outSecret)
return SASL_BADPARAM;
sasl_secret_t* secret = session->getPasswordAsSecret();
if (secret == NULL) {
sasl_seterror(conn, 0, "No password data provided");
return SASL_FAIL;
}
*outSecret = secret;
return SASL_OK;
}
} // namespace
CyrusSaslClientSession::CyrusSaslClientSession() :
SaslClientSession(),
_saslConnection(NULL),
_step(0),
_done(false) {
const sasl_callback_t callbackTemplate[maxCallbacks] = {
{ SASL_CB_AUTHNAME, SaslCallbackFn(saslClientGetSimple), this },
{ SASL_CB_USER, SaslCallbackFn(saslClientGetSimple), this },
{ SASL_CB_PASS, SaslCallbackFn(saslClientGetPassword), this },
{ SASL_CB_LIST_END }
};
std::copy(callbackTemplate, callbackTemplate + maxCallbacks, _callbacks);
}
CyrusSaslClientSession::~CyrusSaslClientSession() {
sasl_dispose(&_saslConnection);
}
void CyrusSaslClientSession::setParameter(Parameter id, const StringData& value) {
fassert(18665, id >= 0 && id < numParameters);
if (id == parameterPassword) {
// The parameterPassword is stored as a sasl_secret_t, while other
// parameters are stored directly. This facilitates memory ownership management for
// getPasswordAsSecret().
_secret.reset(new char[sizeof(sasl_secret_t) + value.size() + 1]);
sasl_secret_t* secret =
static_cast<sasl_secret_t*>(static_cast<void*>(_secret.get()));
secret->len = value.size();
value.copyTo(static_cast<char*>(static_cast<void*>(&secret->data[0])), false);
}
SaslClientSession::setParameter(id, value);
}
sasl_secret_t* CyrusSaslClientSession::getPasswordAsSecret() {
// See comment in setParameter() about the special storage of parameterPassword.
return static_cast<sasl_secret_t*>(
static_cast<void*>(_secret.get()));
}
Status CyrusSaslClientSession::initialize() {
if (_saslConnection != NULL)
return Status(ErrorCodes::AlreadyInitialized,
"Cannot reinitialize CyrusSaslClientSession.");
int result = sasl_client_new(getParameter(parameterServiceName).toString().c_str(),
getParameter(parameterServiceHostname).toString().c_str(),
NULL,
NULL,
_callbacks,
0,
&_saslConnection);
if (SASL_OK != result) {
return Status(ErrorCodes::UnknownError,
mongoutils::str::stream() << sasl_errstring(result, NULL, NULL));
}
return Status::OK();
}
Status CyrusSaslClientSession::step(const StringData& inputData, std::string* outputData) {
const char* output = NULL;
unsigned outputSize = 0xFFFFFFFF;
int result;
if (_step == 0) {
const char* actualMechanism;
result = sasl_client_start(_saslConnection,
getParameter(parameterMechanism).toString().c_str(),
NULL,
&output,
&outputSize,
&actualMechanism);
}
else {
result = sasl_client_step(_saslConnection,
inputData.rawData(),
static_cast<unsigned>(inputData.size()),
NULL,
&output,
&outputSize);
}
++_step;
switch (result) {
case SASL_OK:
_done = true;
// Fall through
case SASL_CONTINUE:
*outputData = std::string(output, outputSize);
return Status::OK();
case SASL_NOMECH:
return Status(ErrorCodes::BadValue, sasl_errdetail(_saslConnection));
case SASL_BADAUTH:
return Status(ErrorCodes::AuthenticationFailed, sasl_errdetail(_saslConnection));
default:
return Status(ErrorCodes::ProtocolError, sasl_errdetail(_saslConnection));
}
}
} // namespace
|