xref: /openbmc/bmcweb/features/redfish/lib/update_service.hpp (revision e0dd805760c55acb6fd161026b4b6d444b641eae) 
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::deadline_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             asyncResp->res.addHeader("Retry-After", "30");
145             messages::serviceTemporarilyUnavailable(asyncResp->res, "30");
146         }
147         return;
148     }
149 
150     fwAvailableTimer =
151         std::make_unique<boost::asio::deadline_timer>(*req.ioService);
152 
153     fwAvailableTimer->expires_from_now(
154         boost::posix_time::seconds(timeoutTimeSeconds));
155 
156     fwAvailableTimer->async_wait(
157         [asyncResp](const boost::system::error_code &ec) {
158             cleanUp();
159             if (ec == boost::asio::error::operation_aborted)
160             {
161                 // expected, we were canceled before the timer completed.
162                 return;
163             }
164             BMCWEB_LOG_ERROR
165                 << "Timed out waiting for firmware object being created";
166             BMCWEB_LOG_ERROR
167                 << "FW image may has already been uploaded to server";
168             if (ec)
169             {
170                 BMCWEB_LOG_ERROR << "Async_wait failed" << ec;
171                 return;
172             }
173             if (asyncResp)
174             {
175                 redfish::messages::internalError(asyncResp->res);
176             }
177         });
178 
179     auto callback = [asyncResp](sdbusplus::message::message &m) {
180         BMCWEB_LOG_DEBUG << "Match fired";
181         softwareInterfaceAdded(asyncResp, m);
182     };
183 
184     fwUpdateInProgress = true;
185 
186     fwUpdateMatcher = std::make_unique<sdbusplus::bus::match::match>(
187         *crow::connections::systemBus,
188         "interface='org.freedesktop.DBus.ObjectManager',type='signal',"
189         "member='InterfacesAdded',path='/xyz/openbmc_project/software'",
190         callback);
191 }
192 
193 /**
194  * UpdateServiceActionsSimpleUpdate class supports handle POST method for
195  * SimpleUpdate action.
196  */
197 class UpdateServiceActionsSimpleUpdate : public Node
198 {
199   public:
200     UpdateServiceActionsSimpleUpdate(CrowApp &app) :
201         Node(app,
202              "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate/")
203     {
204         entityPrivileges = {
205             {boost::beast::http::verb::get, {{"Login"}}},
206             {boost::beast::http::verb::head, {{"Login"}}},
207             {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
208             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
209             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
210             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
211     }
212 
213   private:
214     void doPost(crow::Response &res, const crow::Request &req,
215                 const std::vector<std::string> &params) override
216     {
217         std::optional<std::string> transferProtocol;
218         std::string imageURI;
219         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
220 
221         BMCWEB_LOG_DEBUG << "Enter UpdateService.SimpleUpdate doPost";
222 
223         // User can pass in both TransferProtocol and ImageURI parameters or
224         // they can pass in just the ImageURI with the transfer protocl embedded
225         // within it.
226         // 1) TransferProtocol:TFTP ImageURI:1.1.1.1/myfile.bin
227         // 2) ImageURI:tftp://1.1.1.1/myfile.bin
228 
229         if (!json_util::readJson(req, asyncResp->res, "TransferProtocol",
230                                  transferProtocol, "ImageURI", imageURI))
231         {
232             BMCWEB_LOG_DEBUG
233                 << "Missing TransferProtocol or ImageURI parameter";
234             return;
235         }
236         if (!transferProtocol)
237         {
238             // Must be option 2
239             // Verify ImageURI has transfer protocol in it
240             size_t separator = imageURI.find(":");
241             if ((separator == std::string::npos) ||
242                 ((separator + 1) > imageURI.size()))
243             {
244                 messages::actionParameterValueTypeError(
245                     asyncResp->res, imageURI, "ImageURI",
246                     "UpdateService.SimpleUpdate");
247                 BMCWEB_LOG_ERROR << "ImageURI missing transfer protocol: "
248                                  << imageURI;
249                 return;
250             }
251             transferProtocol = imageURI.substr(0, separator);
252             // Ensure protocol is upper case for a common comparison path below
253             boost::to_upper(*transferProtocol);
254             BMCWEB_LOG_DEBUG << "Encoded transfer protocol "
255                              << *transferProtocol;
256 
257             // Adjust imageURI to not have the protocol on it for parsing
258             // below
259             // ex. tftp://1.1.1.1/myfile.bin -> 1.1.1.1/myfile.bin
260             imageURI = imageURI.substr(separator + 3);
261             BMCWEB_LOG_DEBUG << "Adjusted imageUri " << imageURI;
262         }
263 
264         // OpenBMC currently only supports TFTP
265         if (*transferProtocol != "TFTP")
266         {
267             messages::actionParameterNotSupported(asyncResp->res,
268                                                   "TransferProtocol",
269                                                   "UpdateService.SimpleUpdate");
270             BMCWEB_LOG_ERROR << "Request incorrect protocol parameter: "
271                              << *transferProtocol;
272             return;
273         }
274 
275         // Format should be <IP or Hostname>/<file> for imageURI
276         size_t separator = imageURI.find("/");
277         if ((separator == std::string::npos) ||
278             ((separator + 1) > imageURI.size()))
279         {
280             messages::actionParameterValueTypeError(
281                 asyncResp->res, imageURI, "ImageURI",
282                 "UpdateService.SimpleUpdate");
283             BMCWEB_LOG_ERROR << "Invalid ImageURI: " << imageURI;
284             return;
285         }
286 
287         std::string tftpServer = imageURI.substr(0, separator);
288         std::string fwFile = imageURI.substr(separator + 1);
289         BMCWEB_LOG_DEBUG << "Server: " << tftpServer + " File: " << fwFile;
290 
291         // Setup callback for when new software detected
292         // Give TFTP 2 minutes to complete
293         monitorForSoftwareAvailable(nullptr, req, 120);
294 
295         // TFTP can take up to 2 minutes depending on image size and
296         // connection speed. Return to caller as soon as the TFTP operation
297         // has been started. The callback above will ensure the activate
298         // is started once the download has completed
299         redfish::messages::success(asyncResp->res);
300 
301         // Call TFTP service
302         crow::connections::systemBus->async_method_call(
303             [](const boost::system::error_code ec) {
304                 if (ec)
305                 {
306                     // messages::internalError(asyncResp->res);
307                     cleanUp();
308                     BMCWEB_LOG_DEBUG << "error_code = " << ec;
309                     BMCWEB_LOG_DEBUG << "error msg = " << ec.message();
310                 }
311                 else
312                 {
313                     BMCWEB_LOG_DEBUG << "Call to DownloaViaTFTP Success";
314                 }
315             },
316             "xyz.openbmc_project.Software.Download",
317             "/xyz/openbmc_project/software", "xyz.openbmc_project.Common.TFTP",
318             "DownloadViaTFTP", fwFile, tftpServer);
319 
320         BMCWEB_LOG_DEBUG << "Exit UpdateService.SimpleUpdate doPost";
321     }
322 };
323 
324 class UpdateService : public Node
325 {
326   public:
327     UpdateService(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/")
328     {
329         entityPrivileges = {
330             {boost::beast::http::verb::get, {{"Login"}}},
331             {boost::beast::http::verb::head, {{"Login"}}},
332             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
333             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
334             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
335             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
336     }
337 
338   private:
339     void doGet(crow::Response &res, const crow::Request &req,
340                const std::vector<std::string> &params) override
341     {
342         res.jsonValue["@odata.type"] = "#UpdateService.v1_2_0.UpdateService";
343         res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService";
344         res.jsonValue["@odata.context"] =
345             "/redfish/v1/$metadata#UpdateService.UpdateService";
346         res.jsonValue["Id"] = "UpdateService";
347         res.jsonValue["Description"] = "Service for Software Update";
348         res.jsonValue["Name"] = "Update Service";
349         res.jsonValue["HttpPushUri"] = "/redfish/v1/UpdateService";
350         // UpdateService cannot be disabled
351         res.jsonValue["ServiceEnabled"] = true;
352         res.jsonValue["FirmwareInventory"] = {
353             {"@odata.id", "/redfish/v1/UpdateService/FirmwareInventory"}};
354 #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE
355         // Update Actions object.
356         nlohmann::json &updateSvcSimpleUpdate =
357             res.jsonValue["Actions"]["#UpdateService.SimpleUpdate"];
358         updateSvcSimpleUpdate["target"] =
359             "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate";
360         updateSvcSimpleUpdate["TransferProtocol@Redfish.AllowableValues"] = {
361             "TFTP"};
362 #endif
363         res.end();
364     }
365 
366     void doPatch(crow::Response &res, const crow::Request &req,
367                  const std::vector<std::string> &params) override
368     {
369         BMCWEB_LOG_DEBUG << "doPatch...";
370 
371         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
372         std::string applyTime;
373 
374         if (!json_util::readJson(req, res, "ApplyTime", applyTime))
375         {
376             return;
377         }
378 
379         if ((applyTime == "Immediate") || (applyTime == "OnReset"))
380         {
381             std::string applyTimeNewVal;
382             if (applyTime == "Immediate")
383             {
384                 applyTimeNewVal = "xyz.openbmc_project.Software.ApplyTime."
385                                   "RequestedApplyTimes.Immediate";
386             }
387             else
388             {
389                 applyTimeNewVal = "xyz.openbmc_project.Software.ApplyTime."
390                                   "RequestedApplyTimes.OnReset";
391             }
392 
393             // Set the requested image apply time value
394             crow::connections::systemBus->async_method_call(
395                 [asyncResp](const boost::system::error_code ec) {
396                     if (ec)
397                     {
398                         BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec;
399                         messages::internalError(asyncResp->res);
400                         return;
401                     }
402                     messages::success(asyncResp->res);
403                 },
404                 "xyz.openbmc_project.Settings",
405                 "/xyz/openbmc_project/software/apply_time",
406                 "org.freedesktop.DBus.Properties", "Set",
407                 "xyz.openbmc_project.Software.ApplyTime", "RequestedApplyTime",
408                 std::variant<std::string>{applyTimeNewVal});
409         }
410         else
411         {
412             BMCWEB_LOG_INFO << "ApplyTime value is not in the list of "
413                                "acceptable values";
414             messages::propertyValueNotInList(asyncResp->res, applyTime,
415                                              "ApplyTime");
416         }
417     }
418 
419     void doPost(crow::Response &res, const crow::Request &req,
420                 const std::vector<std::string> &params) override
421     {
422         BMCWEB_LOG_DEBUG << "doPost...";
423 
424         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
425 
426         // Setup callback for when new software detected
427         monitorForSoftwareAvailable(asyncResp, req);
428 
429         std::string filepath(
430             "/tmp/images/" +
431             boost::uuids::to_string(boost::uuids::random_generator()()));
432         BMCWEB_LOG_DEBUG << "Writing file to " << filepath;
433         std::ofstream out(filepath, std::ofstream::out | std::ofstream::binary |
434                                         std::ofstream::trunc);
435         out << req.body;
436         out.close();
437         BMCWEB_LOG_DEBUG << "file upload complete!!";
438     }
439 };
440 
441 class SoftwareInventoryCollection : public Node
442 {
443   public:
444     template <typename CrowApp>
445     SoftwareInventoryCollection(CrowApp &app) :
446         Node(app, "/redfish/v1/UpdateService/FirmwareInventory/")
447     {
448         entityPrivileges = {
449             {boost::beast::http::verb::get, {{"Login"}}},
450             {boost::beast::http::verb::head, {{"Login"}}},
451             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
452             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
453             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
454             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
455     }
456 
457   private:
458     void doGet(crow::Response &res, const crow::Request &req,
459                const std::vector<std::string> &params) override
460     {
461         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
462         res.jsonValue["@odata.type"] =
463             "#SoftwareInventoryCollection.SoftwareInventoryCollection";
464         res.jsonValue["@odata.id"] =
465             "/redfish/v1/UpdateService/FirmwareInventory";
466         res.jsonValue["@odata.context"] =
467             "/redfish/v1/"
468             "$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection";
469         res.jsonValue["Name"] = "Software Inventory Collection";
470 
471         crow::connections::systemBus->async_method_call(
472             [asyncResp](
473                 const boost::system::error_code ec,
474                 const std::vector<std::pair<
475                     std::string, std::vector<std::pair<
476                                      std::string, std::vector<std::string>>>>>
477                     &subtree) {
478                 if (ec)
479                 {
480                     messages::internalError(asyncResp->res);
481                     return;
482                 }
483                 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
484                 asyncResp->res.jsonValue["Members@odata.count"] = 0;
485 
486                 for (auto &obj : subtree)
487                 {
488                     const std::vector<
489                         std::pair<std::string, std::vector<std::string>>>
490                         &connections = obj.second;
491 
492                     // if can't parse fw id then return
493                     std::size_t idPos;
494                     if ((idPos = obj.first.rfind("/")) == std::string::npos)
495                     {
496                         messages::internalError(asyncResp->res);
497                         BMCWEB_LOG_DEBUG << "Can't parse firmware ID!!";
498                         return;
499                     }
500                     std::string swId = obj.first.substr(idPos + 1);
501 
502                     nlohmann::json &members =
503                         asyncResp->res.jsonValue["Members"];
504                     members.push_back(
505                         {{"@odata.id", "/redfish/v1/UpdateService/"
506                                        "FirmwareInventory/" +
507                                            swId}});
508                     asyncResp->res.jsonValue["Members@odata.count"] =
509                         members.size();
510                 }
511             },
512             "xyz.openbmc_project.ObjectMapper",
513             "/xyz/openbmc_project/object_mapper",
514             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
515             "/xyz/openbmc_project/software", int32_t(1),
516             std::array<const char *, 1>{
517                 "xyz.openbmc_project.Software.Version"});
518     }
519 };
520 
521 class SoftwareInventory : public Node
522 {
523   public:
524     template <typename CrowApp>
525     SoftwareInventory(CrowApp &app) :
526         Node(app, "/redfish/v1/UpdateService/FirmwareInventory/<str>/",
527              std::string())
528     {
529         entityPrivileges = {
530             {boost::beast::http::verb::get, {{"Login"}}},
531             {boost::beast::http::verb::head, {{"Login"}}},
532             {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
533             {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
534             {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
535             {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
536     }
537 
538   private:
539     /* Fill related item links (i.e. bmc, bios) in for inventory */
540     static void getRelatedItems(std::shared_ptr<AsyncResp> aResp,
541                                 const std::string &purpose)
542     {
543         if (purpose == fw_util::bmcPurpose)
544         {
545             nlohmann::json &members = aResp->res.jsonValue["RelatedItem"];
546             members.push_back({{"@odata.id", "/redfish/v1/Managers/bmc"}});
547             aResp->res.jsonValue["Members@odata.count"] = members.size();
548         }
549         else if (purpose == fw_util::biosPurpose)
550         {
551             // TODO(geissonator) Need BIOS schema support added for this
552             //                   to be valid
553             // nlohmann::json &members = aResp->res.jsonValue["RelatedItem"];
554             // members.push_back(
555             //    {{"@odata.id", "/redfish/v1/Systems/system/BIOS"}});
556             // aResp->res.jsonValue["Members@odata.count"] = members.size();
557         }
558         else
559         {
560             BMCWEB_LOG_ERROR << "Unknown software purpose " << purpose;
561         }
562     }
563 
564     void doGet(crow::Response &res, const crow::Request &req,
565                const std::vector<std::string> &params) override
566     {
567         std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
568         res.jsonValue["@odata.type"] =
569             "#SoftwareInventory.v1_1_0.SoftwareInventory";
570         res.jsonValue["@odata.context"] =
571             "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory";
572         res.jsonValue["Name"] = "Software Inventory";
573         res.jsonValue["Updateable"] = false;
574         res.jsonValue["Status"]["Health"] = "OK";
575         res.jsonValue["Status"]["HealthRollup"] = "OK";
576 
577         if (params.size() != 1)
578         {
579             messages::internalError(res);
580             res.end();
581             return;
582         }
583 
584         std::shared_ptr<std::string> swId =
585             std::make_shared<std::string>(params[0]);
586 
587         res.jsonValue["@odata.id"] =
588             "/redfish/v1/UpdateService/FirmwareInventory/" + *swId;
589 
590         crow::connections::systemBus->async_method_call(
591             [asyncResp, swId](
592                 const boost::system::error_code ec,
593                 const std::vector<std::pair<
594                     std::string, std::vector<std::pair<
595                                      std::string, std::vector<std::string>>>>>
596                     &subtree) {
597                 BMCWEB_LOG_DEBUG << "doGet callback...";
598                 if (ec)
599                 {
600                     messages::internalError(asyncResp->res);
601                     return;
602                 }
603 
604                 for (const std::pair<
605                          std::string,
606                          std::vector<
607                              std::pair<std::string, std::vector<std::string>>>>
608                          &obj : subtree)
609                 {
610                     if (boost::ends_with(obj.first, *swId) != true)
611                     {
612                         continue;
613                     }
614 
615                     if (obj.second.size() < 1)
616                     {
617                         continue;
618                     }
619 
620                     fw_util::getFwStatus(asyncResp, swId, obj.second[0].first);
621 
622                     crow::connections::systemBus->async_method_call(
623                         [asyncResp,
624                          swId](const boost::system::error_code error_code,
625                                const boost::container::flat_map<
626                                    std::string, VariantType> &propertiesList) {
627                             if (error_code)
628                             {
629                                 messages::internalError(asyncResp->res);
630                                 return;
631                             }
632                             boost::container::flat_map<
633                                 std::string, VariantType>::const_iterator it =
634                                 propertiesList.find("Purpose");
635                             if (it == propertiesList.end())
636                             {
637                                 BMCWEB_LOG_DEBUG
638                                     << "Can't find property \"Purpose\"!";
639                                 messages::propertyMissing(asyncResp->res,
640                                                           "Purpose");
641                                 return;
642                             }
643                             const std::string *swInvPurpose =
644                                 std::get_if<std::string>(&it->second);
645                             if (swInvPurpose == nullptr)
646                             {
647                                 BMCWEB_LOG_DEBUG
648                                     << "wrong types for property\"Purpose\"!";
649                                 messages::propertyValueTypeError(asyncResp->res,
650                                                                  "", "Purpose");
651                                 return;
652                             }
653 
654                             BMCWEB_LOG_DEBUG << "swInvPurpose = "
655                                              << *swInvPurpose;
656                             it = propertiesList.find("Version");
657                             if (it == propertiesList.end())
658                             {
659                                 BMCWEB_LOG_DEBUG
660                                     << "Can't find property \"Version\"!";
661                                 messages::propertyMissing(asyncResp->res,
662                                                           "Version");
663                                 return;
664                             }
665 
666                             BMCWEB_LOG_DEBUG << "Version found!";
667 
668                             const std::string *version =
669                                 std::get_if<std::string>(&it->second);
670 
671                             if (version == nullptr)
672                             {
673                                 BMCWEB_LOG_DEBUG
674                                     << "Can't find property \"Version\"!";
675 
676                                 messages::propertyValueTypeError(asyncResp->res,
677                                                                  "", "Version");
678                                 return;
679                             }
680                             asyncResp->res.jsonValue["Version"] = *version;
681                             asyncResp->res.jsonValue["Id"] = *swId;
682 
683                             // swInvPurpose is of format:
684                             // xyz.openbmc_project.Software.Version.VersionPurpose.ABC
685                             // Translate this to "ABC update"
686                             size_t endDesc = swInvPurpose->rfind(".");
687                             if (endDesc == std::string::npos)
688                             {
689                                 messages::internalError(asyncResp->res);
690                                 return;
691                             }
692                             endDesc++;
693                             if (endDesc >= swInvPurpose->size())
694                             {
695                                 messages::internalError(asyncResp->res);
696                                 return;
697                             }
698 
699                             std::string formatDesc =
700                                 swInvPurpose->substr(endDesc);
701                             asyncResp->res.jsonValue["Description"] =
702                                 formatDesc + " update";
703                             getRelatedItems(asyncResp, *swInvPurpose);
704                         },
705                         obj.second[0].first, obj.first,
706                         "org.freedesktop.DBus.Properties", "GetAll",
707                         "xyz.openbmc_project.Software.Version");
708                 }
709             },
710             "xyz.openbmc_project.ObjectMapper",
711             "/xyz/openbmc_project/object_mapper",
712             "xyz.openbmc_project.ObjectMapper", "GetSubTree",
713             "/xyz/openbmc_project/software", int32_t(1),
714             std::array<const char *, 1>{
715                 "xyz.openbmc_project.Software.Version"});
716     }
717 };
718 
719 } // namespace redfish
720