blob: fde05ab4e83448f4a685c617df49aad06ae31332 [file] [log] [blame]
Jennifer Lee729dae72018-04-24 15:59:34 -07001/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
16#pragma once
17
18#include "node.hpp"
Ed Tanous1abe55e2018-09-05 08:30:59 -070019
Jennifer Lee729dae72018-04-24 15:59:34 -070020#include <boost/container/flat_map.hpp>
Andrew Geissler87d84722019-02-28 14:28:39 -060021#include <utils/fw_utils.hpp>
Ed Tanousabf2add2019-01-22 16:40:12 -080022#include <variant>
Jennifer Lee729dae72018-04-24 15:59:34 -070023
Ed Tanous1abe55e2018-09-05 08:30:59 -070024namespace redfish
25{
Ed Tanous27826b52018-10-29 11:40:58 -070026
Andrew Geissler0e7de462019-03-04 19:11:54 -060027// Match signals added on software path
Jennifer Leeacb7cfb2018-06-07 16:08:15 -070028static std::unique_ptr<sdbusplus::bus::match::match> fwUpdateMatcher;
Andrew Geissler0e7de462019-03-04 19:11:54 -060029// Only allow one update at a time
30static bool fwUpdateInProgress = false;
Andrew Geissler86adcd62019-04-18 10:58:05 -050031// Timer for software available
Ed Tanous271584a2019-07-09 16:24:22 -070032static std::unique_ptr<boost::asio::steady_timer> fwAvailableTimer;
Andrew Geissler86adcd62019-04-18 10:58:05 -050033
34static void cleanUp()
35{
36 fwUpdateInProgress = false;
37 fwUpdateMatcher = nullptr;
38}
39static void activateImage(const std::string &objPath,
40 const std::string &service)
41{
42 BMCWEB_LOG_DEBUG << "Activate image for " << objPath << " " << service;
43 crow::connections::systemBus->async_method_call(
44 [](const boost::system::error_code error_code) {
45 if (error_code)
46 {
47 BMCWEB_LOG_DEBUG << "error_code = " << error_code;
48 BMCWEB_LOG_DEBUG << "error msg = " << error_code.message();
49 }
50 },
51 service, objPath, "org.freedesktop.DBus.Properties", "Set",
52 "xyz.openbmc_project.Software.Activation", "RequestedActivation",
53 std::variant<std::string>(
54 "xyz.openbmc_project.Software.Activation.RequestedActivations."
55 "Active"));
56}
Andrew Geissler0554c982019-04-23 14:40:12 -050057
58// Note that asyncResp can be either a valid pointer or nullptr. If nullptr
59// then no asyncResp updates will occur
Andrew Geissler86adcd62019-04-18 10:58:05 -050060static void softwareInterfaceAdded(std::shared_ptr<AsyncResp> asyncResp,
61 sdbusplus::message::message &m)
62{
63 std::vector<std::pair<
64 std::string,
65 std::vector<std::pair<std::string, std::variant<std::string>>>>>
66 interfacesProperties;
67
68 sdbusplus::message::object_path objPath;
69
70 m.read(objPath, interfacesProperties);
71
72 BMCWEB_LOG_DEBUG << "obj path = " << objPath.str;
73 for (auto &interface : interfacesProperties)
74 {
75 BMCWEB_LOG_DEBUG << "interface = " << interface.first;
76
77 if (interface.first == "xyz.openbmc_project.Software.Activation")
78 {
79 // Found our interface, disable callbacks
80 fwUpdateMatcher = nullptr;
81
82 // Retrieve service and activate
83 crow::connections::systemBus->async_method_call(
84 [objPath, asyncResp](
85 const boost::system::error_code error_code,
86 const std::vector<std::pair<
87 std::string, std::vector<std::string>>> &objInfo) {
88 if (error_code)
89 {
90 BMCWEB_LOG_DEBUG << "error_code = " << error_code;
91 BMCWEB_LOG_DEBUG << "error msg = "
92 << error_code.message();
Andrew Geissler0554c982019-04-23 14:40:12 -050093 if (asyncResp)
94 {
95 messages::internalError(asyncResp->res);
96 }
Andrew Geissler86adcd62019-04-18 10:58:05 -050097 cleanUp();
98 return;
99 }
100 // Ensure we only got one service back
101 if (objInfo.size() != 1)
102 {
103 BMCWEB_LOG_ERROR << "Invalid Object Size "
104 << objInfo.size();
Andrew Geissler0554c982019-04-23 14:40:12 -0500105 if (asyncResp)
106 {
107 messages::internalError(asyncResp->res);
108 }
Andrew Geissler86adcd62019-04-18 10:58:05 -0500109 cleanUp();
110 return;
111 }
112 // cancel timer only when
113 // xyz.openbmc_project.Software.Activation interface
114 // is added
115 fwAvailableTimer = nullptr;
116
117 activateImage(objPath.str, objInfo[0].first);
Andrew Geissler0554c982019-04-23 14:40:12 -0500118 if (asyncResp)
119 {
120 redfish::messages::success(asyncResp->res);
121 }
Andrew Geissler86adcd62019-04-18 10:58:05 -0500122 fwUpdateInProgress = false;
123 },
124 "xyz.openbmc_project.ObjectMapper",
125 "/xyz/openbmc_project/object_mapper",
126 "xyz.openbmc_project.ObjectMapper", "GetObject", objPath.str,
127 std::array<const char *, 1>{
128 "xyz.openbmc_project.Software.Activation"});
129 }
130 }
131}
132
Andrew Geissler0554c982019-04-23 14:40:12 -0500133// Note that asyncResp can be either a valid pointer or nullptr. If nullptr
134// then no asyncResp updates will occur
Andrew Geissler86adcd62019-04-18 10:58:05 -0500135static void monitorForSoftwareAvailable(std::shared_ptr<AsyncResp> asyncResp,
Andrew Geissler0554c982019-04-23 14:40:12 -0500136 const crow::Request &req,
137 int timeoutTimeSeconds = 5)
Andrew Geissler86adcd62019-04-18 10:58:05 -0500138{
139 // Only allow one FW update at a time
140 if (fwUpdateInProgress != false)
141 {
Andrew Geissler0554c982019-04-23 14:40:12 -0500142 if (asyncResp)
143 {
Andrew Geissler0554c982019-04-23 14:40:12 -0500144 messages::serviceTemporarilyUnavailable(asyncResp->res, "30");
145 }
Andrew Geissler86adcd62019-04-18 10:58:05 -0500146 return;
147 }
148
Andrew Geissler0554c982019-04-23 14:40:12 -0500149 fwAvailableTimer =
Ed Tanous271584a2019-07-09 16:24:22 -0700150 std::make_unique<boost::asio::steady_timer>(*req.ioService);
Andrew Geissler86adcd62019-04-18 10:58:05 -0500151
Ed Tanous271584a2019-07-09 16:24:22 -0700152 fwAvailableTimer->expires_after(std::chrono::seconds(timeoutTimeSeconds));
Andrew Geissler86adcd62019-04-18 10:58:05 -0500153
154 fwAvailableTimer->async_wait(
155 [asyncResp](const boost::system::error_code &ec) {
156 cleanUp();
157 if (ec == boost::asio::error::operation_aborted)
158 {
159 // expected, we were canceled before the timer completed.
160 return;
161 }
162 BMCWEB_LOG_ERROR
163 << "Timed out waiting for firmware object being created";
164 BMCWEB_LOG_ERROR
165 << "FW image may has already been uploaded to server";
166 if (ec)
167 {
168 BMCWEB_LOG_ERROR << "Async_wait failed" << ec;
169 return;
170 }
Andrew Geissler0554c982019-04-23 14:40:12 -0500171 if (asyncResp)
172 {
173 redfish::messages::internalError(asyncResp->res);
174 }
Andrew Geissler86adcd62019-04-18 10:58:05 -0500175 });
176
177 auto callback = [asyncResp](sdbusplus::message::message &m) {
178 BMCWEB_LOG_DEBUG << "Match fired";
179 softwareInterfaceAdded(asyncResp, m);
180 };
181
182 fwUpdateInProgress = true;
183
184 fwUpdateMatcher = std::make_unique<sdbusplus::bus::match::match>(
185 *crow::connections::systemBus,
186 "interface='org.freedesktop.DBus.ObjectManager',type='signal',"
187 "member='InterfacesAdded',path='/xyz/openbmc_project/software'",
188 callback);
189}
Jennifer Lee729dae72018-04-24 15:59:34 -0700190
Andrew Geissler0554c982019-04-23 14:40:12 -0500191/**
192 * UpdateServiceActionsSimpleUpdate class supports handle POST method for
193 * SimpleUpdate action.
194 */
195class UpdateServiceActionsSimpleUpdate : public Node
196{
197 public:
198 UpdateServiceActionsSimpleUpdate(CrowApp &app) :
199 Node(app,
200 "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate/")
201 {
202 entityPrivileges = {
203 {boost::beast::http::verb::get, {{"Login"}}},
204 {boost::beast::http::verb::head, {{"Login"}}},
205 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
206 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
207 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
208 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
209 }
210
211 private:
212 void doPost(crow::Response &res, const crow::Request &req,
213 const std::vector<std::string> &params) override
214 {
215 std::optional<std::string> transferProtocol;
216 std::string imageURI;
217 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
218
219 BMCWEB_LOG_DEBUG << "Enter UpdateService.SimpleUpdate doPost";
220
221 // User can pass in both TransferProtocol and ImageURI parameters or
222 // they can pass in just the ImageURI with the transfer protocl embedded
223 // within it.
224 // 1) TransferProtocol:TFTP ImageURI:1.1.1.1/myfile.bin
225 // 2) ImageURI:tftp://1.1.1.1/myfile.bin
226
227 if (!json_util::readJson(req, asyncResp->res, "TransferProtocol",
228 transferProtocol, "ImageURI", imageURI))
229 {
230 BMCWEB_LOG_DEBUG
231 << "Missing TransferProtocol or ImageURI parameter";
232 return;
233 }
234 if (!transferProtocol)
235 {
236 // Must be option 2
237 // Verify ImageURI has transfer protocol in it
238 size_t separator = imageURI.find(":");
239 if ((separator == std::string::npos) ||
240 ((separator + 1) > imageURI.size()))
241 {
242 messages::actionParameterValueTypeError(
243 asyncResp->res, imageURI, "ImageURI",
244 "UpdateService.SimpleUpdate");
245 BMCWEB_LOG_ERROR << "ImageURI missing transfer protocol: "
246 << imageURI;
247 return;
248 }
249 transferProtocol = imageURI.substr(0, separator);
250 // Ensure protocol is upper case for a common comparison path below
251 boost::to_upper(*transferProtocol);
252 BMCWEB_LOG_DEBUG << "Encoded transfer protocol "
253 << *transferProtocol;
254
255 // Adjust imageURI to not have the protocol on it for parsing
256 // below
257 // ex. tftp://1.1.1.1/myfile.bin -> 1.1.1.1/myfile.bin
258 imageURI = imageURI.substr(separator + 3);
259 BMCWEB_LOG_DEBUG << "Adjusted imageUri " << imageURI;
260 }
261
262 // OpenBMC currently only supports TFTP
263 if (*transferProtocol != "TFTP")
264 {
265 messages::actionParameterNotSupported(asyncResp->res,
266 "TransferProtocol",
267 "UpdateService.SimpleUpdate");
268 BMCWEB_LOG_ERROR << "Request incorrect protocol parameter: "
269 << *transferProtocol;
270 return;
271 }
272
273 // Format should be <IP or Hostname>/<file> for imageURI
274 size_t separator = imageURI.find("/");
275 if ((separator == std::string::npos) ||
276 ((separator + 1) > imageURI.size()))
277 {
278 messages::actionParameterValueTypeError(
279 asyncResp->res, imageURI, "ImageURI",
280 "UpdateService.SimpleUpdate");
281 BMCWEB_LOG_ERROR << "Invalid ImageURI: " << imageURI;
282 return;
283 }
284
285 std::string tftpServer = imageURI.substr(0, separator);
286 std::string fwFile = imageURI.substr(separator + 1);
287 BMCWEB_LOG_DEBUG << "Server: " << tftpServer + " File: " << fwFile;
288
289 // Setup callback for when new software detected
290 // Give TFTP 2 minutes to complete
291 monitorForSoftwareAvailable(nullptr, req, 120);
292
293 // TFTP can take up to 2 minutes depending on image size and
294 // connection speed. Return to caller as soon as the TFTP operation
295 // has been started. The callback above will ensure the activate
296 // is started once the download has completed
297 redfish::messages::success(asyncResp->res);
298
299 // Call TFTP service
300 crow::connections::systemBus->async_method_call(
301 [](const boost::system::error_code ec) {
302 if (ec)
303 {
304 // messages::internalError(asyncResp->res);
305 cleanUp();
306 BMCWEB_LOG_DEBUG << "error_code = " << ec;
307 BMCWEB_LOG_DEBUG << "error msg = " << ec.message();
308 }
309 else
310 {
311 BMCWEB_LOG_DEBUG << "Call to DownloaViaTFTP Success";
312 }
313 },
314 "xyz.openbmc_project.Software.Download",
315 "/xyz/openbmc_project/software", "xyz.openbmc_project.Common.TFTP",
316 "DownloadViaTFTP", fwFile, tftpServer);
317
318 BMCWEB_LOG_DEBUG << "Exit UpdateService.SimpleUpdate doPost";
319 }
320};
321
Ed Tanous1abe55e2018-09-05 08:30:59 -0700322class UpdateService : public Node
323{
324 public:
325 UpdateService(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/")
326 {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700327 entityPrivileges = {
328 {boost::beast::http::verb::get, {{"Login"}}},
329 {boost::beast::http::verb::head, {{"Login"}}},
330 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
331 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
332 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
333 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
Jennifer Leeacb7cfb2018-06-07 16:08:15 -0700334 }
Jennifer Leeacb7cfb2018-06-07 16:08:15 -0700335
Ed Tanous1abe55e2018-09-05 08:30:59 -0700336 private:
337 void doGet(crow::Response &res, const crow::Request &req,
338 const std::vector<std::string> &params) override
339 {
Ed Tanous0f74e642018-11-12 15:17:05 -0800340 res.jsonValue["@odata.type"] = "#UpdateService.v1_2_0.UpdateService";
341 res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService";
342 res.jsonValue["@odata.context"] =
343 "/redfish/v1/$metadata#UpdateService.UpdateService";
344 res.jsonValue["Id"] = "UpdateService";
345 res.jsonValue["Description"] = "Service for Software Update";
346 res.jsonValue["Name"] = "Update Service";
347 res.jsonValue["HttpPushUri"] = "/redfish/v1/UpdateService";
348 // UpdateService cannot be disabled
349 res.jsonValue["ServiceEnabled"] = true;
350 res.jsonValue["FirmwareInventory"] = {
351 {"@odata.id", "/redfish/v1/UpdateService/FirmwareInventory"}};
Andrew Geissler0554c982019-04-23 14:40:12 -0500352#ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
353 // Update Actions object.
354 nlohmann::json &updateSvcSimpleUpdate =
355 res.jsonValue["Actions"]["#UpdateService.SimpleUpdate"];
356 updateSvcSimpleUpdate["target"] =
357 "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate";
358 updateSvcSimpleUpdate["TransferProtocol@Redfish.AllowableValues"] = {
359 "TFTP"};
360#endif
Jennifer Leeacb7cfb2018-06-07 16:08:15 -0700361 res.end();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700362 }
Andrew Geissler0e7de462019-03-04 19:11:54 -0600363
Jayashankar Padathfa1a5a32019-05-28 23:54:37 +0530364 void doPatch(crow::Response &res, const crow::Request &req,
365 const std::vector<std::string> &params) override
366 {
367 BMCWEB_LOG_DEBUG << "doPatch...";
368
369 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
370 std::string applyTime;
371
372 if (!json_util::readJson(req, res, "ApplyTime", applyTime))
373 {
374 return;
375 }
376
377 if ((applyTime == "Immediate") || (applyTime == "OnReset"))
378 {
379 std::string applyTimeNewVal;
380 if (applyTime == "Immediate")
381 {
382 applyTimeNewVal = "xyz.openbmc_project.Software.ApplyTime."
383 "RequestedApplyTimes.Immediate";
384 }
385 else
386 {
387 applyTimeNewVal = "xyz.openbmc_project.Software.ApplyTime."
388 "RequestedApplyTimes.OnReset";
389 }
390
391 // Set the requested image apply time value
392 crow::connections::systemBus->async_method_call(
393 [asyncResp](const boost::system::error_code ec) {
394 if (ec)
395 {
396 BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
397 messages::internalError(asyncResp->res);
398 return;
399 }
400 messages::success(asyncResp->res);
401 },
402 "xyz.openbmc_project.Settings",
403 "/xyz/openbmc_project/software/apply_time",
404 "org.freedesktop.DBus.Properties", "Set",
405 "xyz.openbmc_project.Software.ApplyTime", "RequestedApplyTime",
406 std::variant<std::string>{applyTimeNewVal});
407 }
408 else
409 {
410 BMCWEB_LOG_INFO << "ApplyTime value is not in the list of "
411 "acceptable values";
412 messages::propertyValueNotInList(asyncResp->res, applyTime,
413 "ApplyTime");
414 }
415 }
416
Ed Tanous1abe55e2018-09-05 08:30:59 -0700417 void doPost(crow::Response &res, const crow::Request &req,
418 const std::vector<std::string> &params) override
419 {
420 BMCWEB_LOG_DEBUG << "doPost...";
Jennifer Leeacb7cfb2018-06-07 16:08:15 -0700421
Andrew Geissler0e7de462019-03-04 19:11:54 -0600422 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700423
Andrew Geissler86adcd62019-04-18 10:58:05 -0500424 // Setup callback for when new software detected
425 monitorForSoftwareAvailable(asyncResp, req);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700426
427 std::string filepath(
428 "/tmp/images/" +
429 boost::uuids::to_string(boost::uuids::random_generator()()));
430 BMCWEB_LOG_DEBUG << "Writing file to " << filepath;
431 std::ofstream out(filepath, std::ofstream::out | std::ofstream::binary |
432 std::ofstream::trunc);
433 out << req.body;
434 out.close();
435 BMCWEB_LOG_DEBUG << "file upload complete!!";
436 }
Jennifer Lee729dae72018-04-24 15:59:34 -0700437};
Ed Tanousc711bf82018-07-30 16:31:33 -0700438
Ed Tanous1abe55e2018-09-05 08:30:59 -0700439class SoftwareInventoryCollection : public Node
440{
441 public:
442 template <typename CrowApp>
443 SoftwareInventoryCollection(CrowApp &app) :
444 Node(app, "/redfish/v1/UpdateService/FirmwareInventory/")
445 {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700446 entityPrivileges = {
447 {boost::beast::http::verb::get, {{"Login"}}},
448 {boost::beast::http::verb::head, {{"Login"}}},
449 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
450 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
451 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
452 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
Jennifer Lee729dae72018-04-24 15:59:34 -0700453 }
Jennifer Lee729dae72018-04-24 15:59:34 -0700454
Ed Tanous1abe55e2018-09-05 08:30:59 -0700455 private:
456 void doGet(crow::Response &res, const crow::Request &req,
457 const std::vector<std::string> &params) override
458 {
459 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous0f74e642018-11-12 15:17:05 -0800460 res.jsonValue["@odata.type"] =
461 "#SoftwareInventoryCollection.SoftwareInventoryCollection";
462 res.jsonValue["@odata.id"] =
463 "/redfish/v1/UpdateService/FirmwareInventory";
464 res.jsonValue["@odata.context"] =
465 "/redfish/v1/"
466 "$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection";
467 res.jsonValue["Name"] = "Software Inventory Collection";
Ed Tanousc711bf82018-07-30 16:31:33 -0700468
Ed Tanous1abe55e2018-09-05 08:30:59 -0700469 crow::connections::systemBus->async_method_call(
470 [asyncResp](
471 const boost::system::error_code ec,
472 const std::vector<std::pair<
473 std::string, std::vector<std::pair<
474 std::string, std::vector<std::string>>>>>
475 &subtree) {
476 if (ec)
477 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700478 messages::internalError(asyncResp->res);
Ed Tanousc711bf82018-07-30 16:31:33 -0700479 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700480 }
481 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
482 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Jennifer Lee6c4eb9d2018-05-22 10:58:31 -0700483
Ed Tanous1abe55e2018-09-05 08:30:59 -0700484 for (auto &obj : subtree)
485 {
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700486 // if can't parse fw id then return
Ed Tanous27826b52018-10-29 11:40:58 -0700487 std::size_t idPos;
488 if ((idPos = obj.first.rfind("/")) == std::string::npos)
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700489 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700490 messages::internalError(asyncResp->res);
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700491 BMCWEB_LOG_DEBUG << "Can't parse firmware ID!!";
492 return;
493 }
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700494 std::string swId = obj.first.substr(idPos + 1);
495
Andrew Geisslere0dd8052019-06-18 16:05:10 -0500496 nlohmann::json &members =
497 asyncResp->res.jsonValue["Members"];
498 members.push_back(
499 {{"@odata.id", "/redfish/v1/UpdateService/"
500 "FirmwareInventory/" +
501 swId}});
502 asyncResp->res.jsonValue["Members@odata.count"] =
503 members.size();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700504 }
505 },
506 "xyz.openbmc_project.ObjectMapper",
507 "/xyz/openbmc_project/object_mapper",
Ed Tanous271584a2019-07-09 16:24:22 -0700508 "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/",
509 static_cast<int32_t>(0),
Ed Tanous1abe55e2018-09-05 08:30:59 -0700510 std::array<const char *, 1>{
511 "xyz.openbmc_project.Software.Version"});
512 }
Jennifer Lee729dae72018-04-24 15:59:34 -0700513};
514
Ed Tanous1abe55e2018-09-05 08:30:59 -0700515class SoftwareInventory : public Node
516{
517 public:
518 template <typename CrowApp>
519 SoftwareInventory(CrowApp &app) :
520 Node(app, "/redfish/v1/UpdateService/FirmwareInventory/<str>/",
521 std::string())
522 {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700523 entityPrivileges = {
524 {boost::beast::http::verb::get, {{"Login"}}},
525 {boost::beast::http::verb::head, {{"Login"}}},
526 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
527 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
528 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
529 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
530 }
531
532 private:
Andrew Geissler87d84722019-02-28 14:28:39 -0600533 /* Fill related item links (i.e. bmc, bios) in for inventory */
534 static void getRelatedItems(std::shared_ptr<AsyncResp> aResp,
535 const std::string &purpose)
536 {
537 if (purpose == fw_util::bmcPurpose)
538 {
539 nlohmann::json &members = aResp->res.jsonValue["RelatedItem"];
540 members.push_back({{"@odata.id", "/redfish/v1/Managers/bmc"}});
541 aResp->res.jsonValue["Members@odata.count"] = members.size();
542 }
543 else if (purpose == fw_util::biosPurpose)
544 {
545 // TODO(geissonator) Need BIOS schema support added for this
546 // to be valid
547 // nlohmann::json &members = aResp->res.jsonValue["RelatedItem"];
548 // members.push_back(
549 // {{"@odata.id", "/redfish/v1/Systems/system/BIOS"}});
550 // aResp->res.jsonValue["Members@odata.count"] = members.size();
551 }
552 else
553 {
554 BMCWEB_LOG_ERROR << "Unknown software purpose " << purpose;
555 }
556 }
557
Ed Tanous1abe55e2018-09-05 08:30:59 -0700558 void doGet(crow::Response &res, const crow::Request &req,
559 const std::vector<std::string> &params) override
560 {
561 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700562
563 if (params.size() != 1)
564 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700565 messages::internalError(res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700566 res.end();
567 return;
568 }
569
Ed Tanous3ae837c2018-08-07 14:41:19 -0700570 std::shared_ptr<std::string> swId =
Ed Tanous1abe55e2018-09-05 08:30:59 -0700571 std::make_shared<std::string>(params[0]);
572
573 res.jsonValue["@odata.id"] =
Ed Tanous3ae837c2018-08-07 14:41:19 -0700574 "/redfish/v1/UpdateService/FirmwareInventory/" + *swId;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700575
576 crow::connections::systemBus->async_method_call(
Ed Tanous3ae837c2018-08-07 14:41:19 -0700577 [asyncResp, swId](
Ed Tanous1abe55e2018-09-05 08:30:59 -0700578 const boost::system::error_code ec,
579 const std::vector<std::pair<
580 std::string, std::vector<std::pair<
581 std::string, std::vector<std::string>>>>>
582 &subtree) {
583 BMCWEB_LOG_DEBUG << "doGet callback...";
584 if (ec)
585 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700586 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700587 return;
588 }
589
Andrew Geissler69132282019-07-01 11:00:35 -0500590 // Ensure we find our input swId, otherwise return an error
591 bool found = false;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700592 for (const std::pair<
593 std::string,
594 std::vector<
595 std::pair<std::string, std::vector<std::string>>>>
596 &obj : subtree)
597 {
Ed Tanous3ae837c2018-08-07 14:41:19 -0700598 if (boost::ends_with(obj.first, *swId) != true)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700599 {
600 continue;
601 }
602
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700603 if (obj.second.size() < 1)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700604 {
605 continue;
606 }
607
Andrew Geissler69132282019-07-01 11:00:35 -0500608 found = true;
Andrew Geisslere0dd8052019-06-18 16:05:10 -0500609 fw_util::getFwStatus(asyncResp, swId, obj.second[0].first);
610
Ed Tanous1abe55e2018-09-05 08:30:59 -0700611 crow::connections::systemBus->async_method_call(
612 [asyncResp,
Ed Tanous3ae837c2018-08-07 14:41:19 -0700613 swId](const boost::system::error_code error_code,
614 const boost::container::flat_map<
615 std::string, VariantType> &propertiesList) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700616 if (error_code)
617 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700618 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700619 return;
620 }
621 boost::container::flat_map<
622 std::string, VariantType>::const_iterator it =
623 propertiesList.find("Purpose");
624 if (it == propertiesList.end())
625 {
626 BMCWEB_LOG_DEBUG
627 << "Can't find property \"Purpose\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700628 messages::propertyMissing(asyncResp->res,
629 "Purpose");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700630 return;
631 }
Ed Tanous3ae837c2018-08-07 14:41:19 -0700632 const std::string *swInvPurpose =
Ed Tanousabf2add2019-01-22 16:40:12 -0800633 std::get_if<std::string>(&it->second);
Ed Tanous3ae837c2018-08-07 14:41:19 -0700634 if (swInvPurpose == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700635 {
636 BMCWEB_LOG_DEBUG
637 << "wrong types for property\"Purpose\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700638 messages::propertyValueTypeError(asyncResp->res,
639 "", "Purpose");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700640 return;
641 }
642
Ed Tanous3ae837c2018-08-07 14:41:19 -0700643 BMCWEB_LOG_DEBUG << "swInvPurpose = "
644 << *swInvPurpose;
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700645 it = propertiesList.find("Version");
646 if (it == propertiesList.end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700647 {
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700648 BMCWEB_LOG_DEBUG
649 << "Can't find property \"Version\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700650 messages::propertyMissing(asyncResp->res,
651 "Version");
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700652 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700653 }
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700654
655 BMCWEB_LOG_DEBUG << "Version found!";
656
657 const std::string *version =
Ed Tanousabf2add2019-01-22 16:40:12 -0800658 std::get_if<std::string>(&it->second);
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700659
660 if (version == nullptr)
661 {
662 BMCWEB_LOG_DEBUG
663 << "Can't find property \"Version\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700664
665 messages::propertyValueTypeError(asyncResp->res,
666 "", "Version");
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700667 return;
668 }
669 asyncResp->res.jsonValue["Version"] = *version;
670 asyncResp->res.jsonValue["Id"] = *swId;
Andrew Geissler54daabe2019-02-13 13:54:15 -0600671
672 // swInvPurpose is of format:
673 // xyz.openbmc_project.Software.Version.VersionPurpose.ABC
James Feiste2e96772019-10-03 10:51:43 -0700674 // Translate this to "ABC image"
Andrew Geissler54daabe2019-02-13 13:54:15 -0600675 size_t endDesc = swInvPurpose->rfind(".");
676 if (endDesc == std::string::npos)
677 {
678 messages::internalError(asyncResp->res);
679 return;
680 }
681 endDesc++;
682 if (endDesc >= swInvPurpose->size())
683 {
684 messages::internalError(asyncResp->res);
685 return;
686 }
687
688 std::string formatDesc =
689 swInvPurpose->substr(endDesc);
690 asyncResp->res.jsonValue["Description"] =
James Feiste2e96772019-10-03 10:51:43 -0700691 formatDesc + " image";
Andrew Geissler87d84722019-02-28 14:28:39 -0600692 getRelatedItems(asyncResp, *swInvPurpose);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700693 },
694 obj.second[0].first, obj.first,
695 "org.freedesktop.DBus.Properties", "GetAll",
696 "xyz.openbmc_project.Software.Version");
697 }
Andrew Geissler69132282019-07-01 11:00:35 -0500698 if (!found)
699 {
700 BMCWEB_LOG_ERROR << "Input swID " + *swId + " not found!";
701 messages::resourceMissingAtURI(
702 asyncResp->res,
703 "/redfish/v1/UpdateService/FirmwareInventory/" + *swId);
704 return;
705 }
Ayushi Smriti4e68c452019-09-04 14:37:55 +0530706 asyncResp->res.jsonValue["@odata.type"] =
707 "#SoftwareInventory.v1_1_0.SoftwareInventory";
708 asyncResp->res.jsonValue["@odata.context"] =
709 "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory";
710 asyncResp->res.jsonValue["Name"] = "Software Inventory";
711 asyncResp->res.jsonValue["Updateable"] = false;
712 asyncResp->res.jsonValue["Status"]["Health"] = "OK";
713 asyncResp->res.jsonValue["Status"]["HealthRollup"] = "OK";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700714 },
715 "xyz.openbmc_project.ObjectMapper",
716 "/xyz/openbmc_project/object_mapper",
Ed Tanous271584a2019-07-09 16:24:22 -0700717 "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/",
718 static_cast<int32_t>(0),
Ed Tanous1abe55e2018-09-05 08:30:59 -0700719 std::array<const char *, 1>{
720 "xyz.openbmc_project.Software.Version"});
721 }
722};
723
724} // namespace redfish