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
|
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors
#pragma once
#include "app.hpp"
#include "async_resp.hpp"
#include "error_messages.hpp"
#include "http_request.hpp"
#include "http_response.hpp"
#include "logging.hpp"
#include "ossl_random.hpp"
#include "query.hpp"
#include "redfish_aggregator.hpp"
#include "registries/privilege_registry.hpp"
#include "utility.hpp"
#include "utils/json_utils.hpp"
#include <boost/beast/http/field.hpp>
#include <boost/beast/http/verb.hpp>
#include <boost/system/result.hpp>
#include <boost/url/format.hpp>
#include <boost/url/parse.hpp>
#include <boost/url/url.hpp>
#include <nlohmann/json.hpp>
#include <cstddef>
#include <functional>
#include <memory>
#include <unordered_map>
#include <utility>
namespace redfish
{
inline void handleAggregationServiceHead(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationService/AggregationService.json>; rel=describedby");
}
inline void handleAggregationServiceGet(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationService/AggregationService.json>; rel=describedby");
nlohmann::json& json = asyncResp->res.jsonValue;
json["@odata.id"] = "/redfish/v1/AggregationService";
json["@odata.type"] = "#AggregationService.v1_0_1.AggregationService";
json["Id"] = "AggregationService";
json["Name"] = "Aggregation Service";
json["Description"] = "Aggregation Service";
json["ServiceEnabled"] = true;
json["AggregationSources"]["@odata.id"] =
"/redfish/v1/AggregationService/AggregationSources";
}
inline void requestRoutesAggregationService(App& app)
{
BMCWEB_ROUTE(app, "/redfish/v1/AggregationService/")
.privileges(redfish::privileges::headAggregationService)
.methods(boost::beast::http::verb::head)(
std::bind_front(handleAggregationServiceHead, std::ref(app)));
BMCWEB_ROUTE(app, "/redfish/v1/AggregationService/")
.privileges(redfish::privileges::getAggregationService)
.methods(boost::beast::http::verb::get)(
std::bind_front(handleAggregationServiceGet, std::ref(app)));
}
inline void populateAggregationSourceCollection(
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const boost::system::error_code& ec,
const std::unordered_map<std::string, boost::urls::url>& satelliteInfo)
{
// Something went wrong while querying dbus
if (ec)
{
messages::internalError(asyncResp->res);
return;
}
nlohmann::json::array_t members;
for (const auto& sat : satelliteInfo)
{
nlohmann::json::object_t member;
member["@odata.id"] = boost::urls::format(
"/redfish/v1/AggregationService/AggregationSources/{}", sat.first);
members.emplace_back(std::move(member));
}
asyncResp->res.jsonValue["Members@odata.count"] = members.size();
asyncResp->res.jsonValue["Members"] = std::move(members);
}
inline void handleAggregationSourceCollectionGet(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationSourceCollection/AggregationSourceCollection.json>; rel=describedby");
nlohmann::json& json = asyncResp->res.jsonValue;
json["@odata.id"] = "/redfish/v1/AggregationService/AggregationSources";
json["@odata.type"] =
"#AggregationSourceCollection.AggregationSourceCollection";
json["Name"] = "Aggregation Source Collection";
// Query D-Bus for satellite configs and add them to the Members array
RedfishAggregator::getInstance().getSatelliteConfigs(
std::bind_front(populateAggregationSourceCollection, asyncResp));
}
inline void handleAggregationSourceCollectionHead(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationService/AggregationSourceCollection.json>; rel=describedby");
}
inline void requestRoutesAggregationSourceCollection(App& app)
{
BMCWEB_ROUTE(app, "/redfish/v1/AggregationService/AggregationSources/")
.privileges(redfish::privileges::getAggregationSourceCollection)
.methods(boost::beast::http::verb::get)(std::bind_front(
handleAggregationSourceCollectionGet, std::ref(app)));
BMCWEB_ROUTE(app, "/redfish/v1/AggregationService/AggregationSources/")
.privileges(redfish::privileges::getAggregationSourceCollection)
.methods(boost::beast::http::verb::head)(std::bind_front(
handleAggregationSourceCollectionHead, std::ref(app)));
}
inline void populateAggregationSource(
const std::string& aggregationSourceId,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const boost::system::error_code& ec,
const std::unordered_map<std::string, boost::urls::url>& satelliteInfo)
{
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationSource/AggregationSource.json>; rel=describedby");
// Something went wrong while querying dbus
if (ec)
{
messages::internalError(asyncResp->res);
return;
}
const auto& sat = satelliteInfo.find(aggregationSourceId);
if (sat == satelliteInfo.end())
{
messages::resourceNotFound(asyncResp->res, "AggregationSource",
aggregationSourceId);
return;
}
asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
"/redfish/v1/AggregationService/AggregationSources/{}",
aggregationSourceId);
asyncResp->res.jsonValue["@odata.type"] =
"#AggregationSource.v1_3_1.AggregationSource";
asyncResp->res.jsonValue["Id"] = aggregationSourceId;
// TODO: We may want to change this whenever we support aggregating multiple
// satellite BMCs. Otherwise all AggregationSource resources will have the
// same "Name".
// TODO: We should use the "Name" from the satellite config whenever we add
// support for including it in the data returned in satelliteInfo.
asyncResp->res.jsonValue["Name"] = "Aggregation source";
std::string hostName(sat->second.encoded_origin());
asyncResp->res.jsonValue["HostName"] = std::move(hostName);
// The Redfish spec requires Password to be null in responses
asyncResp->res.jsonValue["Password"] = nullptr;
}
inline void handleAggregationSourceGet(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& aggregationSourceId)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
// Query D-Bus for satellite config corresponding to the specified
// AggregationSource
RedfishAggregator::getInstance().getSatelliteConfigs(std::bind_front(
populateAggregationSource, aggregationSourceId, asyncResp));
}
inline void handleAggregationSourceHead(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& aggregationSourceId)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationService/AggregationSource.json>; rel=describedby");
// Needed to prevent unused variable error
BMCWEB_LOG_DEBUG("Added link header to response from {}",
aggregationSourceId);
}
inline void handleAggregationSourceCollectionPost(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
std::string hostname;
if (!json_util::readJsonPatch(req, asyncResp->res, "HostName", hostname))
{
return;
}
boost::system::result<boost::urls::url> url =
boost::urls::parse_absolute_uri(hostname);
if (!url)
{
messages::propertyValueIncorrect(asyncResp->res, hostname, "HostName");
return;
}
url->normalize();
if (url->scheme() != "http" && url->scheme() != "https")
{
messages::propertyValueIncorrect(asyncResp->res, hostname, "HostName");
return;
}
crow::utility::setPortDefaults(*url);
std::string prefix = bmcweb::getRandomIdOfLength(8);
RedfishAggregator::getInstance().currentAggregationSources.emplace(
prefix, *url);
BMCWEB_LOG_DEBUG("Emplaced {} with url {}", prefix, url->buffer());
asyncResp->res.addHeader(
boost::beast::http::field::location,
boost::urls::format("/redfish/v1/AggregationSources/{}", prefix)
.buffer());
messages::created(asyncResp->res);
}
inline void handleAggregationSourceDelete(
App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& aggregationSourceId)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/AggregationService/AggregationSource.json>; rel=describedby");
size_t deleted =
RedfishAggregator::getInstance().currentAggregationSources.erase(
aggregationSourceId);
if (deleted == 0)
{
messages::resourceNotFound(asyncResp->res, "AggregationSource",
aggregationSourceId);
return;
}
messages::success(asyncResp->res);
}
inline void requestRoutesAggregationSource(App& app)
{
BMCWEB_ROUTE(app,
"/redfish/v1/AggregationService/AggregationSources/<str>/")
.privileges(redfish::privileges::getAggregationSource)
.methods(boost::beast::http::verb::get)(
std::bind_front(handleAggregationSourceGet, std::ref(app)));
BMCWEB_ROUTE(app,
"/redfish/v1/AggregationService/AggregationSources/<str>/")
.privileges(redfish::privileges::deleteAggregationSource)
.methods(boost::beast::http::verb::delete_)(
std::bind_front(handleAggregationSourceDelete, std::ref(app)));
BMCWEB_ROUTE(app,
"/redfish/v1/AggregationService/AggregationSources/<str>/")
.privileges(redfish::privileges::headAggregationSource)
.methods(boost::beast::http::verb::head)(
std::bind_front(handleAggregationSourceHead, std::ref(app)));
BMCWEB_ROUTE(app, "/redfish/v1/AggregationService/AggregationSources/")
.privileges(redfish::privileges::postAggregationSourceCollection)
.methods(boost::beast::http::verb::post)(std::bind_front(
handleAggregationSourceCollectionPost, std::ref(app)));
}
} // namespace redfish
|
