xref: /openbmc/bmcweb/features/redfish/lib/update_service.hpp (revision dcf46d44f3619baae046d9b545b34c9f55d56de9) 
1 /*
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"
19 
20 #include <boost/container/flat_map.hpp>
21 #include <utils/fw_utils.hpp>
22 #include <variant>
23 
24 namespace redfish
25 {
26 
27 // Match signals added on software path
28 static std::unique_ptr<sdbusplus::bus::match::match> fwUpdateMatcher;
29 // Only allow one update at a time
30 static bool fwUpdateInProgress = false;
31 // Timer for software available
32 static std::unique_ptr<boost::asio::steady_timer> fwAvailableTimer;
33 
34 static void cleanUp()
35 {
36     fwUpdateInProgress = false;
37     fwUpdateMatcher = nullptr;
38 }
39 static 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 }
57 
58 // Note that asyncResp can be either a valid pointer or nullptr. If nullptr
59 // then no asyncResp updates will occur
60 static 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();
93                         if (asyncResp)
94                         {
95                             messages::internalError(asyncResp->res);
96                         }
97                         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();
105                         if (asyncResp)
106                         {
107                             messages::internalError(asyncResp->res);
108                         }
109                         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);
118                     if (asyncResp)
119                     {
120                         redfish::messages::success(asyncResp->res);
121                     }
122                     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 
133 // Note that asyncResp can be either a valid pointer or nullptr. If nullptr
134 // then no asyncResp updates will occur
135 static void monitorForSoftwareAvailable(std::shared_ptr<AsyncResp> asyncResp,
136                                         const crow::Request &req,
137                                         int timeoutTimeSeconds = 5)
138 {
139     // Only allow one FW update at a time
140     if (fwUpdateInProgress != false)
141     {
142         if (asyncResp)
143         {
144             messages::serviceTemporarilyUnavailable(asyncResp->res, "30");
145         }
146         return;
147     }
148 
149     fwAvailableTimer =
150         std::make_unique<boost::asio::steady_timer>(*req.ioService);
151 
152     fwAvailableTimer->expires_after(std::chrono::seconds(timeoutTimeSeconds));
153 
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             }
171             if (asyncResp)
172             {
173                 redfish::messages::internalError(asyncResp->res);
174             }
175         });
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 }
190 
191 /**
192  * UpdateServiceActionsSimpleUpdate class supports handle POST method for
193  * SimpleUpdate action.
194  */
195 class 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 
322 class UpdateService : public Node
323 {
324   public:
325     UpdateService(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/")
326     {
327         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"}}}};
334     }
335 
336   private:
337     void doGet(crow::Response &res, const crow::Request &req,
338                const std::vector<std::string> &params) override
339     {
340         std::shared_ptr<AsyncResp> aResp = std::make_shared<AsyncResp>(res);
341         res.jsonValue["@odata.type"] = "#UpdateService.v1_4_0.UpdateService";
342         res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService";
343         res.jsonValue["Id"] = "UpdateService";
344         res.jsonValue["Description"] = "Service for Software Update";
345         res.jsonValue["Name"] = "Update Service";
346         res.jsonValue["HttpPushUri"] = "/redfish/v1/UpdateService";
347         // UpdateService cannot be disabled
348         res.jsonValue["ServiceEnabled"] = true;
349         res.jsonValue["FirmwareInventory"] = {
350             {"@odata.id", "/redfish/v1/UpdateService/FirmwareInventory"}};
351 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
352         // Update Actions object.
353         nlohmann::json &updateSvcSimpleUpdate =
354             res.jsonValue["Actions"]["#UpdateService.SimpleUpdate"];
355         updateSvcSimpleUpdate["target"] =
356             "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate";
357         updateSvcSimpleUpdate["TransferProtocol@Redfish.AllowableValues"] = {
358             "TFTP"};
359 #endif
360         // Get the current ApplyTime value
361         crow::connections::systemBus->async_method_call(
362             [aResp](const boost::system::error_code ec,
363                     const std::variant<std::string> &applyTime) {
364                 if (ec)
365                 {
366                     BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
367                     messages::internalError(aResp->res);
368                     return;
369                 }
370 
371                 const std::string *s = std::get_if<std::string>(&applyTime);
372                 if (s == nullptr)
373                 {
374                     return;
375                 }
376                 // Store the ApplyTime Value
377                 if (*s == "xyz.openbmc_project.Software.ApplyTime."
378                           "RequestedApplyTimes.Immediate")
379                 {
380                     aResp->res.jsonValue["HttpPushUriOptions"]
381                                         ["HttpPushUriApplyTime"]["ApplyTime"] =
382                         "Immediate";
383                 }
384                 else if (*s == "xyz.openbmc_project.Software.ApplyTime."
385                                "RequestedApplyTimes.OnReset")
386                 {
387                     aResp->res.jsonValue["HttpPushUriOptions"]
388                                         ["HttpPushUriApplyTime"]["ApplyTime"] =
389                         "OnReset";
390                 }
391             },
392             "xyz.openbmc_project.Settings",
393             "/xyz/openbmc_project/software/apply_time",
394             "org.freedesktop.DBus.Properties", "Get",
395             "xyz.openbmc_project.Software.ApplyTime", "RequestedApplyTime");
396     }
397 
398     void doPatch(crow::Response &res, const crow::Request &req,
399                  const std::vector<std::string> &params) override
400     {
401         BMCWEB_LOG_DEBUG << "doPatch...";
402 
403         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
404 
405         std::optional<nlohmann::json> pushUriOptions;
406         if (!json_util::readJson(req, res, "HttpPushUriOptions",
407                                  pushUriOptions))
408         {
409             return;
410         }
411 
412         if (pushUriOptions)
413         {
414             std::optional<nlohmann::json> pushUriApplyTime;
415             if (!json_util::readJson(*pushUriOptions, res,
416                                      "HttpPushUriApplyTime", pushUriApplyTime))
417             {
418                 return;
419             }
420 
421             if (pushUriApplyTime)
422             {
423                 std::optional<std::string> applyTime;
424                 if (!json_util::readJson(*pushUriApplyTime, res, "ApplyTime",
425                                          applyTime))
426                 {
427                     return;
428                 }
429 
430                 if (applyTime)
431                 {
432                     std::string applyTimeNewVal;
433                     if (applyTime == "Immediate")
434                     {
435                         applyTimeNewVal =
436                             "xyz.openbmc_project.Software.ApplyTime."
437                             "RequestedApplyTimes.Immediate";
438                     }
439                     else if (applyTime == "OnReset")
440                     {
441                         applyTimeNewVal =
442                             "xyz.openbmc_project.Software.ApplyTime."
443                             "RequestedApplyTimes.OnReset";
444                     }
445                     else
446                     {
447                         BMCWEB_LOG_INFO
448                             << "ApplyTime value is not in the list of "
449                                "acceptable values";
450                         messages::propertyValueNotInList(
451                             asyncResp->res, *applyTime, "ApplyTime");
452                         return;
453                     }
454 
455                     // Set the requested image apply time value
456                     crow::connections::systemBus->async_method_call(
457                         [asyncResp](const boost::system::error_code ec) {
458                             if (ec)
459                             {
460                                 BMCWEB_LOG_ERROR << "D-Bus responses error: "
461                                                  << ec;
462                                 messages::internalError(asyncResp->res);
463                                 return;
464                             }
465                             messages::success(asyncResp->res);
466                         },
467                         "xyz.openbmc_project.Settings",
468                         "/xyz/openbmc_project/software/apply_time",
469                         "org.freedesktop.DBus.Properties", "Set",
470                         "xyz.openbmc_project.Software.ApplyTime",
471                         "RequestedApplyTime",
472                         std::variant<std::string>{applyTimeNewVal});
473                 }
474             }
475         }
476     }
477 
478     void doPost(crow::Response &res, const crow::Request &req,
479                 const std::vector<std::string> &params) override
480     {
481         BMCWEB_LOG_DEBUG << "doPost...";
482 
483         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
484 
485         // Setup callback for when new software detected
486         monitorForSoftwareAvailable(asyncResp, req);
487 
488         std::string filepath(
489             "/tmp/images/" +
490             boost::uuids::to_string(boost::uuids::random_generator()()));
491         BMCWEB_LOG_DEBUG << "Writing file to " << filepath;
492         std::ofstream out(filepath, std::ofstream::out | std::ofstream::binary |
493                                         std::ofstream::trunc);
494         out << req.body;
495         out.close();
496         BMCWEB_LOG_DEBUG << "file upload complete!!";
497     }
498 };
499 
500 class SoftwareInventoryCollection : public Node
501 {
502   public:
503     template <typename CrowApp>
504     SoftwareInventoryCollection(CrowApp &app) :
505         Node(app, "/redfish/v1/UpdateService/FirmwareInventory/")
506     {
507         entityPrivileges = {
508             {boost::beast::http::verb::get, {{"Login"}}},
509             {boost::beast::http::verb::head, {{"Login"}}},
510             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
511             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
512             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
513             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
514     }
515 
516   private:
517     void doGet(crow::Response &res, const crow::Request &req,
518                const std::vector<std::string> &params) override
519     {
520         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
521         res.jsonValue["@odata.type"] =
522             "#SoftwareInventoryCollection.SoftwareInventoryCollection";
523         res.jsonValue["@odata.id"] =
524             "/redfish/v1/UpdateService/FirmwareInventory";
525         res.jsonValue["Name"] = "Software Inventory Collection";
526 
527         crow::connections::systemBus->async_method_call(
528             [asyncResp](
529                 const boost::system::error_code ec,
530                 const std::vector<std::pair<
531                     std::string, std::vector<std::pair<
532                                      std::string, std::vector<std::string>>>>>
533                     &subtree) {
534                 if (ec)
535                 {
536                     messages::internalError(asyncResp->res);
537                     return;
538                 }
539                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
540                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
541 
542                 for (auto &obj : subtree)
543                 {
544                     // if can't parse fw id then return
545                     std::size_t idPos;
546                     if ((idPos = obj.first.rfind("/")) == std::string::npos)
547                     {
548                         messages::internalError(asyncResp->res);
549                         BMCWEB_LOG_DEBUG << "Can't parse firmware ID!!";
550                         return;
551                     }
552                     std::string swId = obj.first.substr(idPos + 1);
553 
554                     nlohmann::json &members =
555                         asyncResp->res.jsonValue["Members"];
556                     members.push_back(
557                         {{"@odata.id", "/redfish/v1/UpdateService/"
558                                        "FirmwareInventory/" +
559                                            swId}});
560                     asyncResp->res.jsonValue["Members@odata.count"] =
561                         members.size();
562                 }
563             },
564             // Note that only firmware levels associated with a device are
565             // stored under /xyz/openbmc_project/software therefore to ensure
566             // only real FirmwareInventory items are returned, this full object
567             // path must be used here as input to mapper
568             "xyz.openbmc_project.ObjectMapper",
569             "/xyz/openbmc_project/object_mapper",
570             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
571             "/xyz/openbmc_project/software", static_cast<int32_t>(0),
572             std::array<const char *, 1>{
573                 "xyz.openbmc_project.Software.Version"});
574     }
575 };
576 
577 class SoftwareInventory : public Node
578 {
579   public:
580     template <typename CrowApp>
581     SoftwareInventory(CrowApp &app) :
582         Node(app, "/redfish/v1/UpdateService/FirmwareInventory/<str>/",
583              std::string())
584     {
585         entityPrivileges = {
586             {boost::beast::http::verb::get, {{"Login"}}},
587             {boost::beast::http::verb::head, {{"Login"}}},
588             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
589             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
590             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
591             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
592     }
593 
594   private:
595     /* Fill related item links (i.e. bmc, bios) in for inventory */
596     static void getRelatedItems(std::shared_ptr<AsyncResp> aResp,
597                                 const std::string &purpose)
598     {
599         if (purpose == fw_util::bmcPurpose)
600         {
601             nlohmann::json &members = aResp->res.jsonValue["RelatedItem"];
602             members.push_back({{"@odata.id", "/redfish/v1/Managers/bmc"}});
603             aResp->res.jsonValue["Members@odata.count"] = members.size();
604         }
605         else if (purpose == fw_util::biosPurpose)
606         {
607             // TODO(geissonator) Need BIOS schema support added for this
608             //                   to be valid
609             // nlohmann::json &members = aResp->res.jsonValue["RelatedItem"];
610             // members.push_back(
611             //    {{"@odata.id", "/redfish/v1/Systems/system/BIOS"}});
612             // aResp->res.jsonValue["Members@odata.count"] = members.size();
613         }
614         else
615         {
616             BMCWEB_LOG_ERROR << "Unknown software purpose " << purpose;
617         }
618     }
619 
620     void doGet(crow::Response &res, const crow::Request &req,
621                const std::vector<std::string> &params) override
622     {
623         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
624 
625         if (params.size() != 1)
626         {
627             messages::internalError(res);
628             res.end();
629             return;
630         }
631 
632         std::shared_ptr<std::string> swId =
633             std::make_shared<std::string>(params[0]);
634 
635         res.jsonValue["@odata.id"] =
636             "/redfish/v1/UpdateService/FirmwareInventory/" + *swId;
637 
638         crow::connections::systemBus->async_method_call(
639             [asyncResp, swId](
640                 const boost::system::error_code ec,
641                 const std::vector<std::pair<
642                     std::string, std::vector<std::pair<
643                                      std::string, std::vector<std::string>>>>>
644                     &subtree) {
645                 BMCWEB_LOG_DEBUG << "doGet callback...";
646                 if (ec)
647                 {
648                     messages::internalError(asyncResp->res);
649                     return;
650                 }
651 
652                 // Ensure we find our input swId, otherwise return an error
653                 bool found = false;
654                 for (const std::pair<
655                          std::string,
656                          std::vector<
657                              std::pair<std::string, std::vector<std::string>>>>
658                          &obj : subtree)
659                 {
660                     if (boost::ends_with(obj.first, *swId) != true)
661                     {
662                         continue;
663                     }
664 
665                     if (obj.second.size() < 1)
666                     {
667                         continue;
668                     }
669 
670                     found = true;
671                     fw_util::getFwStatus(asyncResp, swId, obj.second[0].first);
672 
673                     crow::connections::systemBus->async_method_call(
674                         [asyncResp,
675                          swId](const boost::system::error_code error_code,
676                                const boost::container::flat_map<
677                                    std::string, VariantType> &propertiesList) {
678                             if (error_code)
679                             {
680                                 messages::internalError(asyncResp->res);
681                                 return;
682                             }
683                             boost::container::flat_map<
684                                 std::string, VariantType>::const_iterator it =
685                                 propertiesList.find("Purpose");
686                             if (it == propertiesList.end())
687                             {
688                                 BMCWEB_LOG_DEBUG
689                                     << "Can't find property \"Purpose\"!";
690                                 messages::propertyMissing(asyncResp->res,
691                                                           "Purpose");
692                                 return;
693                             }
694                             const std::string *swInvPurpose =
695                                 std::get_if<std::string>(&it->second);
696                             if (swInvPurpose == nullptr)
697                             {
698                                 BMCWEB_LOG_DEBUG
699                                     << "wrong types for property\"Purpose\"!";
700                                 messages::propertyValueTypeError(asyncResp->res,
701                                                                  "", "Purpose");
702                                 return;
703                             }
704 
705                             BMCWEB_LOG_DEBUG << "swInvPurpose = "
706                                              << *swInvPurpose;
707                             it = propertiesList.find("Version");
708                             if (it == propertiesList.end())
709                             {
710                                 BMCWEB_LOG_DEBUG
711                                     << "Can't find property \"Version\"!";
712                                 messages::propertyMissing(asyncResp->res,
713                                                           "Version");
714                                 return;
715                             }
716 
717                             BMCWEB_LOG_DEBUG << "Version found!";
718 
719                             const std::string *version =
720                                 std::get_if<std::string>(&it->second);
721 
722                             if (version == nullptr)
723                             {
724                                 BMCWEB_LOG_DEBUG
725                                     << "Can't find property \"Version\"!";
726 
727                                 messages::propertyValueTypeError(asyncResp->res,
728                                                                  "", "Version");
729                                 return;
730                             }
731                             asyncResp->res.jsonValue["Version"] = *version;
732                             asyncResp->res.jsonValue["Id"] = *swId;
733 
734                             // swInvPurpose is of format:
735                             // xyz.openbmc_project.Software.Version.VersionPurpose.ABC
736                             // Translate this to "ABC image"
737                             size_t endDesc = swInvPurpose->rfind(".");
738                             if (endDesc == std::string::npos)
739                             {
740                                 messages::internalError(asyncResp->res);
741                                 return;
742                             }
743                             endDesc++;
744                             if (endDesc >= swInvPurpose->size())
745                             {
746                                 messages::internalError(asyncResp->res);
747                                 return;
748                             }
749 
750                             std::string formatDesc =
751                                 swInvPurpose->substr(endDesc);
752                             asyncResp->res.jsonValue["Description"] =
753                                 formatDesc + " image";
754                             getRelatedItems(asyncResp, *swInvPurpose);
755                         },
756                         obj.second[0].first, obj.first,
757                         "org.freedesktop.DBus.Properties", "GetAll",
758                         "xyz.openbmc_project.Software.Version");
759                 }
760                 if (!found)
761                 {
762                     BMCWEB_LOG_ERROR << "Input swID " + *swId + " not found!";
763                     messages::resourceMissingAtURI(
764                         asyncResp->res,
765                         "/redfish/v1/UpdateService/FirmwareInventory/" + *swId);
766                     return;
767                 }
768                 asyncResp->res.jsonValue["@odata.type"] =
769                     "#SoftwareInventory.v1_1_0.SoftwareInventory";
770                 asyncResp->res.jsonValue["Name"] = "Software Inventory";
771                 asyncResp->res.jsonValue["Status"]["HealthRollup"] = "OK";
772 
773                 asyncResp->res.jsonValue["Updateable"] = false;
774                 fw_util::getFwUpdateableStatus(asyncResp, swId);
775             },
776             "xyz.openbmc_project.ObjectMapper",
777             "/xyz/openbmc_project/object_mapper",
778             "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/",
779             static_cast<int32_t>(0),
780             std::array<const char *, 1>{
781                 "xyz.openbmc_project.Software.Version"});
782     }
783 };
784 
785 } // namespace redfish
786