| /* |
| // 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 "bmcweb_config.h" |
| |
| #include <app.hpp> |
| #include <dbus_utility.hpp> |
| #include <query.hpp> |
| #include <registries/privilege_registry.hpp> |
| #include <sdbusplus/asio/property.hpp> |
| #include <utils/sw_utils.hpp> |
| |
| namespace redfish |
| { |
| |
| // Match signals added on software path |
| static std::unique_ptr<sdbusplus::bus::match::match> fwUpdateMatcher; |
| static std::unique_ptr<sdbusplus::bus::match::match> fwUpdateErrorMatcher; |
| // Only allow one update at a time |
| static bool fwUpdateInProgress = false; |
| // Timer for software available |
| static std::unique_ptr<boost::asio::steady_timer> fwAvailableTimer; |
| |
| inline static void cleanUp() |
| { |
| fwUpdateInProgress = false; |
| fwUpdateMatcher = nullptr; |
| fwUpdateErrorMatcher = nullptr; |
| } |
| inline 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 errorCode) { |
| if (errorCode) |
| { |
| BMCWEB_LOG_DEBUG << "error_code = " << errorCode; |
| BMCWEB_LOG_DEBUG << "error msg = " << errorCode.message(); |
| } |
| }, |
| service, objPath, "org.freedesktop.DBus.Properties", "Set", |
| "xyz.openbmc_project.Software.Activation", "RequestedActivation", |
| dbus::utility::DbusVariantType( |
| "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(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| sdbusplus::message::message& m, |
| task::Payload&& payload) |
| { |
| dbus::utility::DBusInteracesMap 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") |
| { |
| // Retrieve service and activate |
| crow::connections::systemBus->async_method_call( |
| [objPath, asyncResp, payload(std::move(payload))]( |
| const boost::system::error_code errorCode, |
| const std::vector< |
| std::pair<std::string, std::vector<std::string>>>& |
| objInfo) mutable { |
| if (errorCode) |
| { |
| BMCWEB_LOG_DEBUG << "error_code = " << errorCode; |
| BMCWEB_LOG_DEBUG << "error msg = " << errorCode.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) |
| { |
| std::shared_ptr<task::TaskData> task = |
| task::TaskData::createTask( |
| [](boost::system::error_code ec, |
| sdbusplus::message::message& msg, |
| const std::shared_ptr<task::TaskData>& |
| taskData) { |
| if (ec) |
| { |
| return task::completed; |
| } |
| |
| std::string iface; |
| dbus::utility::DBusPropertiesMap values; |
| |
| std::string index = std::to_string(taskData->index); |
| msg.read(iface, values); |
| |
| if (iface == "xyz.openbmc_project.Software.Activation") |
| { |
| std::string* state = nullptr; |
| for (const auto& property : values) |
| { |
| if (property.first == "Activation") |
| { |
| const std::string* state = |
| std::get_if<std::string>( |
| &property.second); |
| if (state == nullptr) |
| { |
| taskData->messages.emplace_back( |
| messages::internalError()); |
| return task::completed; |
| } |
| } |
| } |
| |
| if (state == nullptr) |
| { |
| return !task::completed; |
| } |
| |
| if (boost::ends_with(*state, "Invalid") || |
| boost::ends_with(*state, "Failed")) |
| { |
| taskData->state = "Exception"; |
| taskData->status = "Warning"; |
| taskData->messages.emplace_back( |
| messages::taskAborted(index)); |
| return task::completed; |
| } |
| |
| if (boost::ends_with(*state, "Staged")) |
| { |
| taskData->state = "Stopping"; |
| taskData->messages.emplace_back( |
| messages::taskPaused(index)); |
| |
| // its staged, set a long timer to |
| // allow them time to complete the |
| // update (probably cycle the |
| // system) if this expires then |
| // task will be cancelled |
| taskData->extendTimer(std::chrono::hours(5)); |
| return !task::completed; |
| } |
| |
| if (boost::ends_with(*state, "Active")) |
| { |
| taskData->messages.emplace_back( |
| messages::taskCompletedOK(index)); |
| taskData->state = "Completed"; |
| return task::completed; |
| } |
| } |
| else if ( |
| iface == |
| "xyz.openbmc_project.Software.ActivationProgress") |
| { |
| |
| const uint8_t* progress = nullptr; |
| for (const auto& property : values) |
| { |
| if (property.first == "Progress") |
| { |
| const std::string* progress = |
| std::get_if<std::string>( |
| &property.second); |
| if (progress == nullptr) |
| { |
| taskData->messages.emplace_back( |
| messages::internalError()); |
| return task::completed; |
| } |
| } |
| } |
| |
| if (progress == nullptr) |
| { |
| return !task::completed; |
| } |
| taskData->percentComplete = |
| static_cast<int>(*progress); |
| taskData->messages.emplace_back( |
| messages::taskProgressChanged( |
| index, static_cast<size_t>(*progress))); |
| |
| // if we're getting status updates it's |
| // still alive, update timer |
| taskData->extendTimer(std::chrono::minutes(5)); |
| } |
| |
| // as firmware update often results in a |
| // reboot, the task may never "complete" |
| // unless it is an error |
| |
| return !task::completed; |
| }, |
| "type='signal',interface='org.freedesktop.DBus.Properties'," |
| "member='PropertiesChanged',path='" + |
| objPath.str + "'"); |
| task->startTimer(std::chrono::minutes(5)); |
| task->populateResp(asyncResp->res); |
| task->payload.emplace(std::move(payload)); |
| } |
| fwUpdateInProgress = false; |
| }, |
| "xyz.openbmc_project.ObjectMapper", |
| "/xyz/openbmc_project/object_mapper", |
| "xyz.openbmc_project.ObjectMapper", "GetObject", objPath.str, |
| std::array<const char*, 1>{ |
| "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( |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| const crow::Request& req, const std::string& url, |
| int timeoutTimeSeconds = 10) |
| { |
| // Only allow one FW update at a time |
| if (fwUpdateInProgress) |
| { |
| if (asyncResp) |
| { |
| messages::serviceTemporarilyUnavailable(asyncResp->res, "30"); |
| } |
| return; |
| } |
| |
| fwAvailableTimer = |
| std::make_unique<boost::asio::steady_timer>(*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); |
| } |
| }); |
| task::Payload payload(req); |
| auto callback = |
| [asyncResp, payload](sdbusplus::message::message& m) mutable { |
| BMCWEB_LOG_DEBUG << "Match fired"; |
| softwareInterfaceAdded(asyncResp, m, std::move(payload)); |
| }; |
| |
| fwUpdateInProgress = true; |
| |
| fwUpdateMatcher = std::make_unique<sdbusplus::bus::match::match>( |
| *crow::connections::systemBus, |
| "interface='org.freedesktop.DBus.ObjectManager',type='signal'," |
| "member='InterfacesAdded',path='/xyz/openbmc_project/software'", |
| callback); |
| |
| fwUpdateErrorMatcher = std::make_unique<sdbusplus::bus::match::match>( |
| *crow::connections::systemBus, |
| "interface='org.freedesktop.DBus.ObjectManager',type='signal'," |
| "member='InterfacesAdded'," |
| "path='/xyz/openbmc_project/logging'", |
| [asyncResp, url](sdbusplus::message::message& m) { |
| std::vector<std::pair<std::string, dbus::utility::DBusPropertiesMap>> |
| interfacesProperties; |
| sdbusplus::message::object_path objPath; |
| m.read(objPath, interfacesProperties); |
| BMCWEB_LOG_DEBUG << "obj path = " << objPath.str; |
| for (const std::pair<std::string, dbus::utility::DBusPropertiesMap>& |
| interface : interfacesProperties) |
| { |
| if (interface.first == "xyz.openbmc_project.Logging.Entry") |
| { |
| for (const std::pair<std::string, |
| dbus::utility::DbusVariantType>& value : |
| interface.second) |
| { |
| if (value.first != "Message") |
| { |
| continue; |
| } |
| const std::string* type = |
| std::get_if<std::string>(&value.second); |
| if (type == nullptr) |
| { |
| // if this was our message, timeout will cover it |
| return; |
| } |
| fwAvailableTimer = nullptr; |
| if (*type == |
| "xyz.openbmc_project.Software.Image.Error.UnTarFailure") |
| { |
| redfish::messages::invalidUpload(asyncResp->res, url, |
| "Invalid archive"); |
| } |
| else if (*type == |
| "xyz.openbmc_project.Software.Image.Error." |
| "ManifestFileFailure") |
| { |
| redfish::messages::invalidUpload(asyncResp->res, url, |
| "Invalid manifest"); |
| } |
| else if ( |
| *type == |
| "xyz.openbmc_project.Software.Image.Error.ImageFailure") |
| { |
| redfish::messages::invalidUpload( |
| asyncResp->res, url, "Invalid image format"); |
| } |
| else if ( |
| *type == |
| "xyz.openbmc_project.Software.Version.Error.AlreadyExists") |
| { |
| redfish::messages::invalidUpload( |
| asyncResp->res, url, |
| "Image version already exists"); |
| |
| redfish::messages::resourceAlreadyExists( |
| asyncResp->res, |
| "UpdateService.v1_5_0.UpdateService", "Version", |
| "uploaded version"); |
| } |
| else if ( |
| *type == |
| "xyz.openbmc_project.Software.Image.Error.BusyFailure") |
| { |
| redfish::messages::resourceExhaustion(asyncResp->res, |
| url); |
| } |
| else |
| { |
| redfish::messages::internalError(asyncResp->res); |
| } |
| } |
| } |
| } |
| }); |
| } |
| |
| /** |
| * UpdateServiceActionsSimpleUpdate class supports handle POST method for |
| * SimpleUpdate action. |
| */ |
| inline void requestRoutesUpdateServiceActionsSimpleUpdate(App& app) |
| { |
| BMCWEB_ROUTE( |
| app, "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate/") |
| .privileges(redfish::privileges::postUpdateService) |
| .methods(boost::beast::http::verb::post)( |
| [&app](const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
| if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| { |
| return; |
| } |
| |
| std::optional<std::string> transferProtocol; |
| std::string imageURI; |
| |
| 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 protocol |
| // 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::readJsonAction(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 <IP or Hostname>/<file> 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 10 minutes to complete |
| monitorForSoftwareAvailable( |
| asyncResp, req, |
| "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate", |
| 600); |
| |
| // TFTP can take up to 10 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"; |
| }); |
| } |
| |
| inline void |
| handleUpdateServicePost(App& app, const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) |
| { |
| if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| { |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "doPost..."; |
| |
| // Setup callback for when new software detected |
| monitorForSoftwareAvailable(asyncResp, req, "/redfish/v1/UpdateService"); |
| |
| 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!!"; |
| } |
| |
| inline void requestRoutesUpdateService(App& app) |
| { |
| BMCWEB_ROUTE(app, "/redfish/v1/UpdateService/") |
| .privileges(redfish::privileges::getUpdateService) |
| .methods(boost::beast::http::verb::get)( |
| [&app](const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
| if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| { |
| return; |
| } |
| asyncResp->res.jsonValue["@odata.type"] = |
| "#UpdateService.v1_5_0.UpdateService"; |
| asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService"; |
| asyncResp->res.jsonValue["Id"] = "UpdateService"; |
| asyncResp->res.jsonValue["Description"] = "Service for Software Update"; |
| asyncResp->res.jsonValue["Name"] = "Update Service"; |
| |
| #ifdef BMCWEB_ENABLE_REDFISH_UPDATESERVICE_OLD_POST_URL |
| // See note about later on in this file about why this is neccesary |
| // This is "Wrong" per the standard, but is done temporarily to |
| // avoid noise in failing tests as people transition to having this |
| // option disabled |
| asyncResp->res.addHeader(boost::beast::http::field::allow, |
| "GET, PATCH, HEAD"); |
| #endif |
| |
| asyncResp->res.jsonValue["HttpPushUri"] = |
| "/redfish/v1/UpdateService/update"; |
| |
| // UpdateService cannot be disabled |
| asyncResp->res.jsonValue["ServiceEnabled"] = true; |
| asyncResp->res.jsonValue["FirmwareInventory"]["@odata.id"] = |
| "/redfish/v1/UpdateService/FirmwareInventory"; |
| // Get the MaxImageSizeBytes |
| asyncResp->res.jsonValue["MaxImageSizeBytes"] = |
| bmcwebHttpReqBodyLimitMb * 1024 * 1024; |
| |
| #ifdef BMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE |
| // Update Actions object. |
| nlohmann::json& updateSvcSimpleUpdate = |
| asyncResp->res.jsonValue["Actions"]["#UpdateService.SimpleUpdate"]; |
| updateSvcSimpleUpdate["target"] = |
| "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"; |
| updateSvcSimpleUpdate["TransferProtocol@Redfish.AllowableValues"] = { |
| "TFTP"}; |
| #endif |
| // Get the current ApplyTime value |
| sdbusplus::asio::getProperty<std::string>( |
| *crow::connections::systemBus, "xyz.openbmc_project.Settings", |
| "/xyz/openbmc_project/software/apply_time", |
| "xyz.openbmc_project.Software.ApplyTime", "RequestedApplyTime", |
| [asyncResp](const boost::system::error_code ec, |
| const std::string& applyTime) { |
| if (ec) |
| { |
| BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| |
| // Store the ApplyTime Value |
| if (applyTime == "xyz.openbmc_project.Software.ApplyTime." |
| "RequestedApplyTimes.Immediate") |
| { |
| asyncResp->res.jsonValue["HttpPushUriOptions"] |
| ["HttpPushUriApplyTime"]["ApplyTime"] = |
| "Immediate"; |
| } |
| else if (applyTime == "xyz.openbmc_project.Software.ApplyTime." |
| "RequestedApplyTimes.OnReset") |
| { |
| asyncResp->res.jsonValue["HttpPushUriOptions"] |
| ["HttpPushUriApplyTime"]["ApplyTime"] = |
| "OnReset"; |
| } |
| }); |
| }); |
| BMCWEB_ROUTE(app, "/redfish/v1/UpdateService/") |
| .privileges(redfish::privileges::patchUpdateService) |
| .methods(boost::beast::http::verb::patch)( |
| [&app](const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
| if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| { |
| return; |
| } |
| BMCWEB_LOG_DEBUG << "doPatch..."; |
| |
| std::optional<nlohmann::json> pushUriOptions; |
| if (!json_util::readJsonPatch(req, asyncResp->res, "HttpPushUriOptions", |
| pushUriOptions)) |
| { |
| return; |
| } |
| |
| if (pushUriOptions) |
| { |
| std::optional<nlohmann::json> pushUriApplyTime; |
| if (!json_util::readJson(*pushUriOptions, asyncResp->res, |
| "HttpPushUriApplyTime", pushUriApplyTime)) |
| { |
| return; |
| } |
| |
| if (pushUriApplyTime) |
| { |
| std::optional<std::string> applyTime; |
| if (!json_util::readJson(*pushUriApplyTime, asyncResp->res, |
| "ApplyTime", applyTime)) |
| { |
| return; |
| } |
| |
| if (applyTime) |
| { |
| std::string applyTimeNewVal; |
| if (applyTime == "Immediate") |
| { |
| applyTimeNewVal = |
| "xyz.openbmc_project.Software.ApplyTime.RequestedApplyTimes.Immediate"; |
| } |
| else if (applyTime == "OnReset") |
| { |
| applyTimeNewVal = |
| "xyz.openbmc_project.Software.ApplyTime.RequestedApplyTimes.OnReset"; |
| } |
| else |
| { |
| BMCWEB_LOG_INFO |
| << "ApplyTime value is not in the list of acceptable values"; |
| messages::propertyValueNotInList( |
| asyncResp->res, *applyTime, "ApplyTime"); |
| return; |
| } |
| |
| // 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", |
| dbus::utility::DbusVariantType{applyTimeNewVal}); |
| } |
| } |
| } |
| }); |
| |
| // The "old" behavior of the update service URI causes redfish-service validator |
| // failures when the Allow header is supported, given that in the spec, |
| // UpdateService does not allow POST. in openbmc, we unfortunately reused that |
| // resource as our HttpPushUri as well. A number of services, including the |
| // openbmc tests, and documentation have hardcoded that erroneous API, instead |
| // of relying on HttpPushUri as the spec requires. This option will exist |
| // temporarily to allow the old behavior until Q4 2022, at which time it will be |
| // removed. |
| #ifdef BMCWEB_ENABLE_REDFISH_UPDATESERVICE_OLD_POST_URL |
| BMCWEB_ROUTE(app, "/redfish/v1/UpdateService/") |
| .privileges(redfish::privileges::postUpdateService) |
| .methods(boost::beast::http::verb::post)( |
| [&app](const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
| asyncResp->res.addHeader( |
| boost::beast::http::field::warning, |
| "299 - \"POST to /redfish/v1/UpdateService is deprecated. Use " |
| "the value contained within HttpPushUri.\""); |
| handleUpdateServicePost(app, req, asyncResp); |
| }); |
| #endif |
| BMCWEB_ROUTE(app, "/redfish/v1/UpdateService/update/") |
| .privileges(redfish::privileges::postUpdateService) |
| .methods(boost::beast::http::verb::post)( |
| std::bind_front(handleUpdateServicePost, std::ref(app))); |
| } |
| |
| inline void requestRoutesSoftwareInventoryCollection(App& app) |
| { |
| BMCWEB_ROUTE(app, "/redfish/v1/UpdateService/FirmwareInventory/") |
| .privileges(redfish::privileges::getSoftwareInventoryCollection) |
| .methods(boost::beast::http::verb::get)( |
| [&app](const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) { |
| if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| { |
| return; |
| } |
| asyncResp->res.jsonValue["@odata.type"] = |
| "#SoftwareInventoryCollection.SoftwareInventoryCollection"; |
| asyncResp->res.jsonValue["@odata.id"] = |
| "/redfish/v1/UpdateService/FirmwareInventory"; |
| asyncResp->res.jsonValue["Name"] = "Software Inventory Collection"; |
| |
| crow::connections::systemBus->async_method_call( |
| [asyncResp]( |
| const boost::system::error_code ec, |
| const dbus::utility::MapperGetSubTreeResponse& subtree) { |
| if (ec) |
| { |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); |
| asyncResp->res.jsonValue["Members@odata.count"] = 0; |
| |
| for (const auto& obj : subtree) |
| { |
| sdbusplus::message::object_path path(obj.first); |
| std::string swId = path.filename(); |
| if (swId.empty()) |
| { |
| messages::internalError(asyncResp->res); |
| BMCWEB_LOG_DEBUG << "Can't parse firmware ID!!"; |
| return; |
| } |
| |
| nlohmann::json& members = asyncResp->res.jsonValue["Members"]; |
| nlohmann::json::object_t member; |
| member["@odata.id"] = |
| "/redfish/v1/UpdateService/FirmwareInventory/" + swId; |
| members.push_back(std::move(member)); |
| asyncResp->res.jsonValue["Members@odata.count"] = |
| members.size(); |
| } |
| }, |
| // Note that only firmware levels associated with a device |
| // are stored under /xyz/openbmc_project/software therefore |
| // to ensure only real FirmwareInventory items are returned, |
| // this full object path must be used here as input to |
| // mapper |
| "xyz.openbmc_project.ObjectMapper", |
| "/xyz/openbmc_project/object_mapper", |
| "xyz.openbmc_project.ObjectMapper", "GetSubTree", |
| "/xyz/openbmc_project/software", static_cast<int32_t>(0), |
| std::array<const char*, 1>{"xyz.openbmc_project.Software.Version"}); |
| }); |
| } |
| /* Fill related item links (i.e. bmc, bios) in for inventory */ |
| inline static void |
| getRelatedItems(const std::shared_ptr<bmcweb::AsyncResp>& aResp, |
| const std::string& purpose) |
| { |
| if (purpose == sw_util::bmcPurpose) |
| { |
| nlohmann::json& relatedItem = aResp->res.jsonValue["RelatedItem"]; |
| nlohmann::json::object_t item; |
| item["@odata.id"] = "/redfish/v1/Managers/bmc"; |
| relatedItem.push_back(std::move(item)); |
| aResp->res.jsonValue["RelatedItem@odata.count"] = relatedItem.size(); |
| } |
| else if (purpose == sw_util::biosPurpose) |
| { |
| nlohmann::json& relatedItem = aResp->res.jsonValue["RelatedItem"]; |
| nlohmann::json::object_t item; |
| item["@odata.id"] = "/redfish/v1/Systems/system/Bios"; |
| relatedItem.push_back(std::move(item)); |
| aResp->res.jsonValue["RelatedItem@odata.count"] = relatedItem.size(); |
| } |
| else |
| { |
| BMCWEB_LOG_ERROR << "Unknown software purpose " << purpose; |
| } |
| } |
| |
| inline void |
| getSoftwareVersion(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| const std::string& service, const std::string& path, |
| const std::string& swId) |
| { |
| crow::connections::systemBus->async_method_call( |
| [asyncResp, |
| swId](const boost::system::error_code errorCode, |
| const dbus::utility::DBusPropertiesMap& propertiesList) { |
| if (errorCode) |
| { |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| const std::string* swInvPurpose = nullptr; |
| const std::string* version = nullptr; |
| for (const auto& property : propertiesList) |
| { |
| if (property.first == "Purpose") |
| { |
| swInvPurpose = std::get_if<std::string>(&property.second); |
| } |
| else if (property.first == "Version") |
| { |
| version = std::get_if<std::string>(&property.second); |
| } |
| } |
| |
| if (swInvPurpose == nullptr) |
| { |
| BMCWEB_LOG_DEBUG << "Can't find property \"Purpose\"!"; |
| messages::internalError(asyncResp->res); |
| return; |
| } |
| |
| BMCWEB_LOG_DEBUG << "swInvPurpose = " << *swInvPurpose; |
| |
| if (version == nullptr) |
| { |
| BMCWEB_LOG_DEBUG << "Can't find property \"Version\"!"; |
| |
| messages::internalError(asyncResp->res); |
| |
| 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); |
| }, |
| service, path, "org.freedesktop.DBus.Properties", "GetAll", |
| "xyz.openbmc_project.Software.Version"); |
| } |
| |
| inline void requestRoutesSoftwareInventory(App& app) |
| { |
| BMCWEB_ROUTE(app, "/redfish/v1/UpdateService/FirmwareInventory/<str>/") |
| .privileges(redfish::privileges::getSoftwareInventory) |
| .methods(boost::beast::http::verb::get)( |
| [&app](const crow::Request& req, |
| const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| const std::string& param) { |
| if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| { |
| return; |
| } |
| std::shared_ptr<std::string> swId = |
| std::make_shared<std::string>(param); |
| |
| asyncResp->res.jsonValue["@odata.id"] = |
| "/redfish/v1/UpdateService/FirmwareInventory/" + *swId; |
| |
| crow::connections::systemBus->async_method_call( |
| [asyncResp, |
| swId](const boost::system::error_code ec, |
| const dbus::utility::MapperGetSubTreeResponse& 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< |
| std::string, std::vector<std::string>>>>& |
| obj : subtree) |
| { |
| if (!boost::ends_with(obj.first, *swId)) |
| { |
| continue; |
| } |
| |
| if (obj.second.empty()) |
| { |
| continue; |
| } |
| |
| found = true; |
| sw_util::getSwStatus(asyncResp, swId, obj.second[0].first); |
| getSoftwareVersion(asyncResp, obj.second[0].first, obj.first, |
| *swId); |
| } |
| if (!found) |
| { |
| BMCWEB_LOG_ERROR << "Input swID " << *swId << " not found!"; |
| messages::resourceMissingAtURI( |
| asyncResp->res, crow::utility::urlFromPieces( |
| "redfish", "v1", "UpdateService", |
| "FirmwareInventory", *swId)); |
| return; |
| } |
| asyncResp->res.jsonValue["@odata.type"] = |
| "#SoftwareInventory.v1_1_0.SoftwareInventory"; |
| asyncResp->res.jsonValue["Name"] = "Software Inventory"; |
| asyncResp->res.jsonValue["Status"]["HealthRollup"] = "OK"; |
| |
| asyncResp->res.jsonValue["Updateable"] = false; |
| sw_util::getSwUpdatableStatus(asyncResp, swId); |
| }, |
| "xyz.openbmc_project.ObjectMapper", |
| "/xyz/openbmc_project/object_mapper", |
| "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", |
| static_cast<int32_t>(0), |
| std::array<const char*, 1>{"xyz.openbmc_project.Software.Version"}); |
| }); |
| } |
| |
| } // namespace redfish |