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
319
320
321
322
323
324
|
/*
// Copyright (c) 2018 Intel Corporation
//
// 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.
*/
#pragma once
#include "error_messages.hpp"
#include "node.hpp"
#include "persistent_data.hpp"
#include <app.hpp>
namespace redfish
{
class SessionCollection;
class Sessions : public Node
{
public:
Sessions(App& app) :
Node(app, "/redfish/v1/SessionService/Sessions/<str>/", std::string())
{
entityPrivileges = {
{boost::beast::http::verb::get, {{"Login"}}},
{boost::beast::http::verb::head, {{"Login"}}},
{boost::beast::http::verb::patch, {{"ConfigureManager"}}},
{boost::beast::http::verb::put, {{"ConfigureManager"}}},
{boost::beast::http::verb::delete_,
{{"ConfigureManager"}, {"ConfigureSelf"}}},
{boost::beast::http::verb::post, {{"ConfigureManager"}}}};
}
private:
void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const crow::Request&,
const std::vector<std::string>& params) override
{
// Note that control also reaches here via doPost and doDelete.
auto session =
persistent_data::SessionStore::getInstance().getSessionByUid(
params[0]);
if (session == nullptr)
{
messages::resourceNotFound(asyncResp->res, "Session", params[0]);
return;
}
asyncResp->res.jsonValue["Id"] = session->uniqueId;
asyncResp->res.jsonValue["UserName"] = session->username;
asyncResp->res.jsonValue["@odata.id"] =
"/redfish/v1/SessionService/Sessions/" + session->uniqueId;
asyncResp->res.jsonValue["@odata.type"] = "#Session.v1_3_0.Session";
asyncResp->res.jsonValue["Name"] = "User Session";
asyncResp->res.jsonValue["Description"] = "Manager User Session";
asyncResp->res.jsonValue["ClientOriginIPAddress"] = session->clientIp;
#ifdef BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE
asyncResp->res.jsonValue["Oem"]["OpenBMC"]["@odata.type"] =
"#OemSession.v1_0_0.Session";
asyncResp->res.jsonValue["Oem"]["OpenBMC"]["ClientID"] =
session->clientId;
#endif
}
void doDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const crow::Request& req,
const std::vector<std::string>& params) override
{
// Need only 1 param which should be id of session to be deleted
if (params.size() != 1)
{
// This should be handled by crow and never happen
BMCWEB_LOG_ERROR << "Session DELETE has been called with invalid "
"number of params";
messages::generalError(asyncResp->res);
return;
}
auto session =
persistent_data::SessionStore::getInstance().getSessionByUid(
params[0]);
if (session == nullptr)
{
messages::resourceNotFound(asyncResp->res, "Session", params[0]);
return;
}
// Perform a proper ConfigureSelf authority check. If a
// session is being used to DELETE some other user's session,
// then the ConfigureSelf privilege does not apply. In that
// case, perform the authority check again without the user's
// ConfigureSelf privilege.
if (session->username != req.session->username)
{
if (!isAllowedWithoutConfigureSelf(req))
{
BMCWEB_LOG_WARNING << "DELETE Session denied access";
messages::insufficientPrivilege(asyncResp->res);
return;
}
}
// DELETE should return representation of object that will be removed
doGet(asyncResp, req, params);
persistent_data::SessionStore::getInstance().removeSession(session);
}
/**
* This allows SessionCollection to reuse this class' doGet method, to
* maintain consistency of returned data, as Collection's doPost should
* return data for created member which should match member's doGet
* result in 100%
*/
friend SessionCollection;
};
class SessionCollection : public Node
{
public:
SessionCollection(App& app) :
Node(app, "/redfish/v1/SessionService/Sessions/"), memberSession(app)
{
entityPrivileges = {
{boost::beast::http::verb::get, {{"Login"}}},
{boost::beast::http::verb::head, {{"Login"}}},
{boost::beast::http::verb::patch, {{"ConfigureManager"}}},
{boost::beast::http::verb::put, {{"ConfigureManager"}}},
{boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
{boost::beast::http::verb::post, {}}};
}
private:
void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const crow::Request&, const std::vector<std::string>&) override
{
std::vector<const std::string*> sessionIds =
persistent_data::SessionStore::getInstance().getUniqueIds(
false, persistent_data::PersistenceType::TIMEOUT);
asyncResp->res.jsonValue["Members@odata.count"] = sessionIds.size();
asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
for (const std::string* uid : sessionIds)
{
asyncResp->res.jsonValue["Members"].push_back(
{{"@odata.id", "/redfish/v1/SessionService/Sessions/" + *uid}});
}
asyncResp->res.jsonValue["Members@odata.count"] = sessionIds.size();
asyncResp->res.jsonValue["@odata.type"] =
"#SessionCollection.SessionCollection";
asyncResp->res.jsonValue["@odata.id"] =
"/redfish/v1/SessionService/Sessions/";
asyncResp->res.jsonValue["Name"] = "Session Collection";
asyncResp->res.jsonValue["Description"] = "Session Collection";
}
void doPost(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const crow::Request& req,
const std::vector<std::string>&) override
{
std::string username;
std::string password;
std::optional<nlohmann::json> oemObject;
std::string clientId;
if (!json_util::readJson(req, asyncResp->res, "UserName", username,
"Password", password, "Oem", oemObject))
{
return;
}
if (password.empty() || username.empty() ||
asyncResp->res.result() != boost::beast::http::status::ok)
{
if (username.empty())
{
messages::propertyMissing(asyncResp->res, "UserName");
}
if (password.empty())
{
messages::propertyMissing(asyncResp->res, "Password");
}
return;
}
int pamrc = pamAuthenticateUser(username, password);
bool isConfigureSelfOnly = pamrc == PAM_NEW_AUTHTOK_REQD;
if ((pamrc != PAM_SUCCESS) && !isConfigureSelfOnly)
{
messages::resourceAtUriUnauthorized(asyncResp->res,
std::string(req.url),
"Invalid username or password");
return;
}
#ifdef BMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE
if (oemObject)
{
std::optional<nlohmann::json> bmcOem;
if (!json_util::readJson(*oemObject, asyncResp->res, "OpenBMC",
bmcOem))
{
return;
}
if (!json_util::readJson(*bmcOem, asyncResp->res, "ClientID",
clientId))
{
BMCWEB_LOG_ERROR << "Could not read ClientId";
return;
}
}
#endif
// User is authenticated - create session
std::shared_ptr<persistent_data::UserSession> session =
persistent_data::SessionStore::getInstance().generateUserSession(
username, req.ipAddress.to_string(), clientId,
persistent_data::PersistenceType::TIMEOUT, isConfigureSelfOnly);
asyncResp->res.addHeader("X-Auth-Token", session->sessionToken);
asyncResp->res.addHeader("Location",
"/redfish/v1/SessionService/Sessions/" +
session->uniqueId);
asyncResp->res.result(boost::beast::http::status::created);
if (session->isConfigureSelfOnly)
{
messages::passwordChangeRequired(
asyncResp->res,
"/redfish/v1/AccountService/Accounts/" + session->username);
}
memberSession.doGet(asyncResp, req, {session->uniqueId});
}
/**
* Member session to ensure consistency between collection's doPost and
* member's doGet, as they should return 100% matching data
*/
Sessions memberSession;
};
class SessionService : public Node
{
public:
SessionService(App& app) : Node(app, "/redfish/v1/SessionService/")
{
entityPrivileges = {
{boost::beast::http::verb::get, {{"Login"}}},
{boost::beast::http::verb::head, {{"Login"}}},
{boost::beast::http::verb::patch, {{"ConfigureManager"}}},
{boost::beast::http::verb::put, {{"ConfigureManager"}}},
{boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
{boost::beast::http::verb::post, {{"ConfigureManager"}}}};
}
private:
void doGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const crow::Request&, const std::vector<std::string>&) override
{
asyncResp->res.jsonValue["@odata.type"] =
"#SessionService.v1_0_2.SessionService";
asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/SessionService/";
asyncResp->res.jsonValue["Name"] = "Session Service";
asyncResp->res.jsonValue["Id"] = "SessionService";
asyncResp->res.jsonValue["Description"] = "Session Service";
asyncResp->res.jsonValue["SessionTimeout"] =
persistent_data::SessionStore::getInstance().getTimeoutInSeconds();
asyncResp->res.jsonValue["ServiceEnabled"] = true;
asyncResp->res.jsonValue["Sessions"] = {
{"@odata.id", "/redfish/v1/SessionService/Sessions"}};
}
void doPatch(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const crow::Request& req,
const std::vector<std::string>&) override
{
std::optional<int64_t> sessionTimeout;
if (!json_util::readJson(req, asyncResp->res, "SessionTimeout",
sessionTimeout))
{
return;
}
if (sessionTimeout)
{
// The mininum & maximum allowed values for session timeout are 30
// seconds and 86400 seconds respectively as per the session service
// schema mentioned at
// https://redfish.dmtf.org/schemas/v1/SessionService.v1_1_7.json
if (*sessionTimeout <= 86400 && *sessionTimeout >= 30)
{
std::chrono::seconds sessionTimeoutInseconds(*sessionTimeout);
persistent_data::SessionStore::getInstance()
.updateSessionTimeout(sessionTimeoutInseconds);
messages::propertyValueModified(
asyncResp->res, "SessionTimeOut",
std::to_string(*sessionTimeout));
}
else
{
messages::propertyValueNotInList(
asyncResp->res, std::to_string(*sessionTimeout),
"SessionTimeOut");
}
}
}
};
} // namespace redfish
|