/* // Copyright (c) 2018 Intel Corporation // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. */ #pragma once #include "node.hpp" #include #include #include namespace redfish { // Match signals added on software path static std::unique_ptr fwUpdateMatcher; // Only allow one update at a time static bool fwUpdateInProgress = false; // Timer for software available static std::unique_ptr fwAvailableTimer; static void cleanUp() { fwUpdateInProgress = false; fwUpdateMatcher = nullptr; } static void activateImage(const std::string &objPath, const std::string &service) { BMCWEB_LOG_DEBUG << "Activate image for " << objPath << " " << service; crow::connections::systemBus->async_method_call( [](const boost::system::error_code error_code) { if (error_code) { BMCWEB_LOG_DEBUG << "error_code = " << error_code; BMCWEB_LOG_DEBUG << "error msg = " << error_code.message(); } }, service, objPath, "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.Software.Activation", "RequestedActivation", std::variant( "xyz.openbmc_project.Software.Activation.RequestedActivations." "Active")); } // Note that asyncResp can be either a valid pointer or nullptr. If nullptr // then no asyncResp updates will occur static void softwareInterfaceAdded(std::shared_ptr asyncResp, sdbusplus::message::message &m) { std::vector>>>> interfacesProperties; sdbusplus::message::object_path objPath; m.read(objPath, interfacesProperties); BMCWEB_LOG_DEBUG << "obj path = " << objPath.str; for (auto &interface : interfacesProperties) { BMCWEB_LOG_DEBUG << "interface = " << interface.first; if (interface.first == "xyz.openbmc_project.Software.Activation") { // Found our interface, disable callbacks fwUpdateMatcher = nullptr; // Retrieve service and activate crow::connections::systemBus->async_method_call( [objPath, asyncResp]( const boost::system::error_code error_code, const std::vector>> &objInfo) { if (error_code) { BMCWEB_LOG_DEBUG << "error_code = " << error_code; BMCWEB_LOG_DEBUG << "error msg = " << error_code.message(); if (asyncResp) { messages::internalError(asyncResp->res); } cleanUp(); return; } // Ensure we only got one service back if (objInfo.size() != 1) { BMCWEB_LOG_ERROR << "Invalid Object Size " << objInfo.size(); if (asyncResp) { messages::internalError(asyncResp->res); } cleanUp(); return; } // cancel timer only when // xyz.openbmc_project.Software.Activation interface // is added fwAvailableTimer = nullptr; activateImage(objPath.str, objInfo[0].first); if (asyncResp) { redfish::messages::success(asyncResp->res); } fwUpdateInProgress = false; }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetObject", objPath.str, std::array{ "xyz.openbmc_project.Software.Activation"}); } } } // Note that asyncResp can be either a valid pointer or nullptr. If nullptr // then no asyncResp updates will occur static void monitorForSoftwareAvailable(std::shared_ptr asyncResp, const crow::Request &req, int timeoutTimeSeconds = 5) { // Only allow one FW update at a time if (fwUpdateInProgress != false) { if (asyncResp) { asyncResp->res.addHeader("Retry-After", "30"); messages::serviceTemporarilyUnavailable(asyncResp->res, "30"); } return; } fwAvailableTimer = std::make_unique(*req.ioService); fwAvailableTimer->expires_after(std::chrono::seconds(timeoutTimeSeconds)); fwAvailableTimer->async_wait( [asyncResp](const boost::system::error_code &ec) { cleanUp(); if (ec == boost::asio::error::operation_aborted) { // expected, we were canceled before the timer completed. return; } BMCWEB_LOG_ERROR << "Timed out waiting for firmware object being created"; BMCWEB_LOG_ERROR << "FW image may has already been uploaded to server"; if (ec) { BMCWEB_LOG_ERROR << "Async_wait failed" << ec; return; } if (asyncResp) { redfish::messages::internalError(asyncResp->res); } }); auto callback = [asyncResp](sdbusplus::message::message &m) { BMCWEB_LOG_DEBUG << "Match fired"; softwareInterfaceAdded(asyncResp, m); }; fwUpdateInProgress = true; fwUpdateMatcher = std::make_unique( *crow::connections::systemBus, "interface='org.freedesktop.DBus.ObjectManager',type='signal'," "member='InterfacesAdded',path='/xyz/openbmc_project/software'", callback); } /** * UpdateServiceActionsSimpleUpdate class supports handle POST method for * SimpleUpdate action. */ class UpdateServiceActionsSimpleUpdate : public Node { public: UpdateServiceActionsSimpleUpdate(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate/") { entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; } private: void doPost(crow::Response &res, const crow::Request &req, const std::vector ¶ms) override { std::optional transferProtocol; std::string imageURI; std::shared_ptr asyncResp = std::make_shared(res); BMCWEB_LOG_DEBUG << "Enter UpdateService.SimpleUpdate doPost"; // User can pass in both TransferProtocol and ImageURI parameters or // they can pass in just the ImageURI with the transfer protocl embedded // within it. // 1) TransferProtocol:TFTP ImageURI:1.1.1.1/myfile.bin // 2) ImageURI:tftp://1.1.1.1/myfile.bin if (!json_util::readJson(req, asyncResp->res, "TransferProtocol", transferProtocol, "ImageURI", imageURI)) { BMCWEB_LOG_DEBUG << "Missing TransferProtocol or ImageURI parameter"; return; } if (!transferProtocol) { // Must be option 2 // Verify ImageURI has transfer protocol in it size_t separator = imageURI.find(":"); if ((separator == std::string::npos) || ((separator + 1) > imageURI.size())) { messages::actionParameterValueTypeError( asyncResp->res, imageURI, "ImageURI", "UpdateService.SimpleUpdate"); BMCWEB_LOG_ERROR << "ImageURI missing transfer protocol: " << imageURI; return; } transferProtocol = imageURI.substr(0, separator); // Ensure protocol is upper case for a common comparison path below boost::to_upper(*transferProtocol); BMCWEB_LOG_DEBUG << "Encoded transfer protocol " << *transferProtocol; // Adjust imageURI to not have the protocol on it for parsing // below // ex. tftp://1.1.1.1/myfile.bin -> 1.1.1.1/myfile.bin imageURI = imageURI.substr(separator + 3); BMCWEB_LOG_DEBUG << "Adjusted imageUri " << imageURI; } // OpenBMC currently only supports TFTP if (*transferProtocol != "TFTP") { messages::actionParameterNotSupported(asyncResp->res, "TransferProtocol", "UpdateService.SimpleUpdate"); BMCWEB_LOG_ERROR << "Request incorrect protocol parameter: " << *transferProtocol; return; } // Format should be / for imageURI size_t separator = imageURI.find("/"); if ((separator == std::string::npos) || ((separator + 1) > imageURI.size())) { messages::actionParameterValueTypeError( asyncResp->res, imageURI, "ImageURI", "UpdateService.SimpleUpdate"); BMCWEB_LOG_ERROR << "Invalid ImageURI: " << imageURI; return; } std::string tftpServer = imageURI.substr(0, separator); std::string fwFile = imageURI.substr(separator + 1); BMCWEB_LOG_DEBUG << "Server: " << tftpServer + " File: " << fwFile; // Setup callback for when new software detected // Give TFTP 2 minutes to complete monitorForSoftwareAvailable(nullptr, req, 120); // TFTP can take up to 2 minutes depending on image size and // connection speed. Return to caller as soon as the TFTP operation // has been started. The callback above will ensure the activate // is started once the download has completed redfish::messages::success(asyncResp->res); // Call TFTP service crow::connections::systemBus->async_method_call( [](const boost::system::error_code ec) { if (ec) { // messages::internalError(asyncResp->res); cleanUp(); BMCWEB_LOG_DEBUG << "error_code = " << ec; BMCWEB_LOG_DEBUG << "error msg = " << ec.message(); } else { BMCWEB_LOG_DEBUG << "Call to DownloaViaTFTP Success"; } }, "xyz.openbmc_project.Software.Download", "/xyz/openbmc_project/software", "xyz.openbmc_project.Common.TFTP", "DownloadViaTFTP", fwFile, tftpServer); BMCWEB_LOG_DEBUG << "Exit UpdateService.SimpleUpdate doPost"; } }; class UpdateService : public Node { public: UpdateService(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/") { entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; } private: void doGet(crow::Response &res, const crow::Request &req, const std::vector ¶ms) override { res.jsonValue["@odata.type"] = "#UpdateService.v1_2_0.UpdateService"; res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService"; res.jsonValue["@odata.context"] = "/redfish/v1/$metadata#UpdateService.UpdateService"; res.jsonValue["Id"] = "UpdateService"; res.jsonValue["Description"] = "Service for Software Update"; res.jsonValue["Name"] = "Update Service"; res.jsonValue["HttpPushUri"] = "/redfish/v1/UpdateService"; // UpdateService cannot be disabled res.jsonValue["ServiceEnabled"] = true; res.jsonValue["FirmwareInventory"] = { {"@odata.id", "/redfish/v1/UpdateService/FirmwareInventory"}}; #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE // Update Actions object. nlohmann::json &updateSvcSimpleUpdate = res.jsonValue["Actions"]["#UpdateService.SimpleUpdate"]; updateSvcSimpleUpdate["target"] = "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"; updateSvcSimpleUpdate["TransferProtocol@Redfish.AllowableValues"] = { "TFTP"}; #endif res.end(); } void doPatch(crow::Response &res, const crow::Request &req, const std::vector ¶ms) override { BMCWEB_LOG_DEBUG << "doPatch..."; std::shared_ptr asyncResp = std::make_shared(res); std::string applyTime; if (!json_util::readJson(req, res, "ApplyTime", applyTime)) { return; } if ((applyTime == "Immediate") || (applyTime == "OnReset")) { std::string applyTimeNewVal; if (applyTime == "Immediate") { applyTimeNewVal = "xyz.openbmc_project.Software.ApplyTime." "RequestedApplyTimes.Immediate"; } else { applyTimeNewVal = "xyz.openbmc_project.Software.ApplyTime." "RequestedApplyTimes.OnReset"; } // Set the requested image apply time value crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "D-Bus responses error: " << ec; messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); }, "xyz.openbmc_project.Settings", "/xyz/openbmc_project/software/apply_time", "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.Software.ApplyTime", "RequestedApplyTime", std::variant{applyTimeNewVal}); } else { BMCWEB_LOG_INFO << "ApplyTime value is not in the list of " "acceptable values"; messages::propertyValueNotInList(asyncResp->res, applyTime, "ApplyTime"); } } void doPost(crow::Response &res, const crow::Request &req, const std::vector ¶ms) override { BMCWEB_LOG_DEBUG << "doPost..."; std::shared_ptr asyncResp = std::make_shared(res); // Setup callback for when new software detected monitorForSoftwareAvailable(asyncResp, req); std::string filepath( "/tmp/images/" + boost::uuids::to_string(boost::uuids::random_generator()())); BMCWEB_LOG_DEBUG << "Writing file to " << filepath; std::ofstream out(filepath, std::ofstream::out | std::ofstream::binary | std::ofstream::trunc); out << req.body; out.close(); BMCWEB_LOG_DEBUG << "file upload complete!!"; } }; class SoftwareInventoryCollection : public Node { public: template SoftwareInventoryCollection(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/FirmwareInventory/") { entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; } private: void doGet(crow::Response &res, const crow::Request &req, const std::vector ¶ms) override { std::shared_ptr asyncResp = std::make_shared(res); res.jsonValue["@odata.type"] = "#SoftwareInventoryCollection.SoftwareInventoryCollection"; res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService/FirmwareInventory"; res.jsonValue["@odata.context"] = "/redfish/v1/" "$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection"; res.jsonValue["Name"] = "Software Inventory Collection"; crow::connections::systemBus->async_method_call( [asyncResp]( const boost::system::error_code ec, const std::vector>>>> &subtree) { if (ec) { messages::internalError(asyncResp->res); return; } asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); asyncResp->res.jsonValue["Members@odata.count"] = 0; for (auto &obj : subtree) { // if can't parse fw id then return std::size_t idPos; if ((idPos = obj.first.rfind("/")) == std::string::npos) { messages::internalError(asyncResp->res); BMCWEB_LOG_DEBUG << "Can't parse firmware ID!!"; return; } std::string swId = obj.first.substr(idPos + 1); nlohmann::json &members = asyncResp->res.jsonValue["Members"]; members.push_back( {{"@odata.id", "/redfish/v1/UpdateService/" "FirmwareInventory/" + swId}}); asyncResp->res.jsonValue["Members@odata.count"] = members.size(); } }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", static_cast(0), std::array{ "xyz.openbmc_project.Software.Version"}); } }; class SoftwareInventory : public Node { public: template SoftwareInventory(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/FirmwareInventory//", std::string()) { entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; } private: /* Fill related item links (i.e. bmc, bios) in for inventory */ static void getRelatedItems(std::shared_ptr aResp, const std::string &purpose) { if (purpose == fw_util::bmcPurpose) { nlohmann::json &members = aResp->res.jsonValue["RelatedItem"]; members.push_back({{"@odata.id", "/redfish/v1/Managers/bmc"}}); aResp->res.jsonValue["Members@odata.count"] = members.size(); } else if (purpose == fw_util::biosPurpose) { // TODO(geissonator) Need BIOS schema support added for this // to be valid // nlohmann::json &members = aResp->res.jsonValue["RelatedItem"]; // members.push_back( // {{"@odata.id", "/redfish/v1/Systems/system/BIOS"}}); // aResp->res.jsonValue["Members@odata.count"] = members.size(); } else { BMCWEB_LOG_ERROR << "Unknown software purpose " << purpose; } } void doGet(crow::Response &res, const crow::Request &req, const std::vector ¶ms) override { std::shared_ptr asyncResp = std::make_shared(res); if (params.size() != 1) { messages::internalError(res); res.end(); return; } std::shared_ptr swId = std::make_shared(params[0]); res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService/FirmwareInventory/" + *swId; crow::connections::systemBus->async_method_call( [asyncResp, swId]( const boost::system::error_code ec, const std::vector>>>> &subtree) { BMCWEB_LOG_DEBUG << "doGet callback..."; if (ec) { messages::internalError(asyncResp->res); return; } // Ensure we find our input swId, otherwise return an error bool found = false; for (const std::pair< std::string, std::vector< std::pair>>> &obj : subtree) { if (boost::ends_with(obj.first, *swId) != true) { continue; } if (obj.second.size() < 1) { continue; } found = true; fw_util::getFwStatus(asyncResp, swId, obj.second[0].first); crow::connections::systemBus->async_method_call( [asyncResp, swId](const boost::system::error_code error_code, const boost::container::flat_map< std::string, VariantType> &propertiesList) { if (error_code) { messages::internalError(asyncResp->res); return; } boost::container::flat_map< std::string, VariantType>::const_iterator it = propertiesList.find("Purpose"); if (it == propertiesList.end()) { BMCWEB_LOG_DEBUG << "Can't find property \"Purpose\"!"; messages::propertyMissing(asyncResp->res, "Purpose"); return; } const std::string *swInvPurpose = std::get_if(&it->second); if (swInvPurpose == nullptr) { BMCWEB_LOG_DEBUG << "wrong types for property\"Purpose\"!"; messages::propertyValueTypeError(asyncResp->res, "", "Purpose"); return; } BMCWEB_LOG_DEBUG << "swInvPurpose = " << *swInvPurpose; it = propertiesList.find("Version"); if (it == propertiesList.end()) { BMCWEB_LOG_DEBUG << "Can't find property \"Version\"!"; messages::propertyMissing(asyncResp->res, "Version"); return; } BMCWEB_LOG_DEBUG << "Version found!"; const std::string *version = std::get_if(&it->second); if (version == nullptr) { BMCWEB_LOG_DEBUG << "Can't find property \"Version\"!"; messages::propertyValueTypeError(asyncResp->res, "", "Version"); return; } asyncResp->res.jsonValue["Version"] = *version; asyncResp->res.jsonValue["Id"] = *swId; // swInvPurpose is of format: // xyz.openbmc_project.Software.Version.VersionPurpose.ABC // Translate this to "ABC image" size_t endDesc = swInvPurpose->rfind("."); if (endDesc == std::string::npos) { messages::internalError(asyncResp->res); return; } endDesc++; if (endDesc >= swInvPurpose->size()) { messages::internalError(asyncResp->res); return; } std::string formatDesc = swInvPurpose->substr(endDesc); asyncResp->res.jsonValue["Description"] = formatDesc + " image"; getRelatedItems(asyncResp, *swInvPurpose); }, obj.second[0].first, obj.first, "org.freedesktop.DBus.Properties", "GetAll", "xyz.openbmc_project.Software.Version"); } if (!found) { BMCWEB_LOG_ERROR << "Input swID " + *swId + " not found!"; messages::resourceMissingAtURI( asyncResp->res, "/redfish/v1/UpdateService/FirmwareInventory/" + *swId); return; } asyncResp->res.jsonValue["@odata.type"] = "#SoftwareInventory.v1_1_0.SoftwareInventory"; asyncResp->res.jsonValue["@odata.context"] = "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory"; asyncResp->res.jsonValue["Name"] = "Software Inventory"; asyncResp->res.jsonValue["Updateable"] = false; asyncResp->res.jsonValue["Status"]["Health"] = "OK"; asyncResp->res.jsonValue["Status"]["HealthRollup"] = "OK"; }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", static_cast(0), std::array{ "xyz.openbmc_project.Software.Version"}); } }; } // namespace redfish