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
|
/* Copyright 2012 10gen Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "mongo/client/sasl_client_authenticate.h"
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/bson/util/bson_extract.h"
#include "mongo/util/base64.h"
#include "mongo/util/gsasl_session.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/net/hostandport.h"
namespace mongo {
using namespace mongoutils;
const char* const saslStartCommandName = "saslStart";
const char* const saslContinueCommandName = "saslContinue";
const char* const saslCommandAutoAuthorizeFieldName = "autoAuthorize";
const char* const saslCommandCodeFieldName = "code";
const char* const saslCommandConversationIdFieldName = "conversationId";
const char* const saslCommandDoneFieldName = "done";
const char* const saslCommandErrmsgFieldName = "errmsg";
const char* const saslCommandMechanismFieldName = "mechanism";
const char* const saslCommandMechanismListFieldName = "supportedMechanisms";
const char* const saslCommandPasswordFieldName = "password";
const char* const saslCommandPayloadFieldName = "payload";
const char* const saslCommandPrincipalFieldName = "principal";
const char* const saslCommandServiceHostnameFieldName = "serviceHostname";
const char* const saslCommandServiceNameFieldName = "serviceName";
const char* const saslDefaultDBName = "admin";
const char* const saslDefaultServiceName = "mongodb";
const char* const saslClientLogFieldName = "clientLogLevel";
namespace {
// Default log level on the client for SASL log messages.
const int defaultSaslClientLogLevel = 4;
} // namespace
Status saslExtractPayload(const BSONObj& cmdObj, std::string* payload, BSONType* type) {
BSONElement payloadElement;
Status status = bsonExtractField(cmdObj, saslCommandPayloadFieldName, &payloadElement);
if (!status.isOK())
return status;
*type = payloadElement.type();
if (payloadElement.type() == BinData) {
const char* payloadData;
int payloadLen;
payloadData = payloadElement.binData(payloadLen);
if (payloadLen < 0)
return Status(ErrorCodes::InvalidLength, "Negative payload length");
*payload = std::string(payloadData, payloadData + payloadLen);
}
else if (payloadElement.type() == String) {
try {
*payload = base64::decode(payloadElement.str());
} catch (UserException& e) {
return Status(ErrorCodes::FailedToParse, e.what());
}
}
else {
return Status(ErrorCodes::TypeMismatch,
(str::stream() << "Wrong type for field; expected BinData or String for "
<< payloadElement));
}
return Status::OK();
}
namespace {
/**
* Configure "*session" as a client gsasl session for authenticating on the connection
* "*client", with the given "saslParameters". "gsasl" and "sessionHook" are passed through
* to GsaslSession::initializeClientSession, where they are documented.
*/
Status configureSession(Gsasl* gsasl,
DBClientWithCommands* client,
const BSONObj& saslParameters,
void* sessionHook,
GsaslSession* session) {
std::string mechanism;
Status status = bsonExtractStringField(saslParameters,
saslCommandMechanismFieldName,
&mechanism);
if (!status.isOK())
return status;
status = session->initializeClientSession(gsasl, mechanism, sessionHook);
if (!status.isOK())
return status;
std::string service;
status = bsonExtractStringFieldWithDefault(saslParameters,
saslCommandServiceNameFieldName,
saslDefaultServiceName,
&service);
if (!status.isOK())
return status;
session->setProperty(GSASL_SERVICE, service);
std::string hostname;
status = bsonExtractStringFieldWithDefault(saslParameters,
saslCommandServiceHostnameFieldName,
HostAndPort(client->getServerAddress()).host(),
&hostname);
if (!status.isOK())
return status;
session->setProperty(GSASL_HOSTNAME, hostname);
BSONElement element = saslParameters[saslCommandPrincipalFieldName];
if (element.type() == String) {
session->setProperty(GSASL_AUTHID, element.str());
}
else if (!element.eoo()) {
return Status(ErrorCodes::TypeMismatch,
str::stream() << "Expected string for " << element);
}
element = saslParameters[saslCommandPasswordFieldName];
if (element.type() == String) {
session->setProperty(GSASL_PASSWORD, element.str());
}
else if (!element.eoo()) {
return Status(ErrorCodes::TypeMismatch,
str::stream() << "Expected string for " << element);
}
return Status::OK();
}
int getSaslClientLogLevel(const BSONObj& saslParameters) {
int saslLogLevel = defaultSaslClientLogLevel;
BSONElement saslLogElement = saslParameters[saslClientLogFieldName];
if (saslLogElement.trueValue())
saslLogLevel = 1;
if (saslLogElement.isNumber())
saslLogLevel = saslLogElement.numberInt();
return saslLogLevel;
}
} // namespace
Status saslClientAuthenticate(Gsasl *gsasl,
DBClientWithCommands* client,
const BSONObj& saslParameters,
void* sessionHook) {
GsaslSession session;
int saslLogLevel = getSaslClientLogLevel(saslParameters);
Status status = configureSession(gsasl, client, saslParameters, sessionHook, &session);
if (!status.isOK())
return status;
BSONObj saslFirstCommandPrefix = BSON(
saslStartCommandName << 1 <<
saslCommandMechanismFieldName << session.getMechanism());
BSONObj saslFollowupCommandPrefix = BSON(saslContinueCommandName << 1);
BSONObj saslCommandPrefix = saslFirstCommandPrefix;
BSONObj inputObj = BSON(saslCommandPayloadFieldName << "");
bool isServerDone = false;
while (!session.isDone()) {
std::string payload;
BSONType type;
status = saslExtractPayload(inputObj, &payload, &type);
if (!status.isOK())
return status;
LOG(saslLogLevel) << "sasl client input: " << base64::encode(payload) << endl;
std::string responsePayload;
status = session.step(payload, &responsePayload);
if (!status.isOK())
return status;
LOG(saslLogLevel) << "sasl client output: " << base64::encode(responsePayload) << endl;
BSONObjBuilder commandBuilder;
commandBuilder.appendElements(saslCommandPrefix);
commandBuilder.appendBinData(saslCommandPayloadFieldName,
int(responsePayload.size()),
BinDataGeneral,
responsePayload.c_str());
BSONElement conversationId = inputObj[saslCommandConversationIdFieldName];
if (!conversationId.eoo())
commandBuilder.append(conversationId);
if (!client->runCommand(saslDefaultDBName, commandBuilder.obj(), inputObj)) {
return Status(ErrorCodes::UnknownError,
inputObj[saslCommandErrmsgFieldName].str());
}
int statusCodeInt = inputObj[saslCommandCodeFieldName].Int();
if (0 != statusCodeInt)
return Status(ErrorCodes::fromInt(statusCodeInt),
inputObj[saslCommandErrmsgFieldName].str());
isServerDone = inputObj[saslCommandDoneFieldName].trueValue();
saslCommandPrefix = saslFollowupCommandPrefix;
}
if (!isServerDone)
return Status(ErrorCodes::ProtocolError, "Client finished before server.");
return Status::OK();
}
} // namespace mongo
|
