#pragma once #include "aggregation_utils.hpp" #include "dbus_utility.hpp" #include "error_messages.hpp" #include "http_client.hpp" #include "http_connection.hpp" #include #include namespace redfish { enum class Result { LocalHandle, NoLocalHandle }; // clang-format off // These are all of the properties as of version 2022.2 of the Redfish Resource // and Schema Guide whose Type is "string (URI)" and the name does not end in a // case-insensitive form of "uri". That version of the schema is associated // with version 1.16.0 of the Redfish Specification. Going forward, new URI // properties should end in URI so this list should not need to be maintained as // the spec is updated. NOTE: These have been pre-sorted in order to be // compatible with binary search constexpr std::array nonUriProperties{ "@Redfish.ActionInfo", // "@odata.context", // We can't fix /redfish/v1/$metadata URIs "@odata.id", // "Destination", // Only used by EventService and won't be a Redfish URI // "HostName", // Isn't actually a Redfish URI "Image", "MetricProperty", // "OriginOfCondition", // Is URI when in request, but is object in response "TaskMonitor", "target", // normal string, but target URI for POST to invoke an action }; // clang-format on // Determines if the passed property contains a URI. Those property names // either end with a case-insensitive version of "uri" or are specifically // defined in the above array. inline bool isPropertyUri(const std::string_view propertyName) { return boost::iends_with(propertyName, "uri") || std::binary_search(nonUriProperties.begin(), nonUriProperties.end(), propertyName); } static void addPrefixToItem(nlohmann::json& item, std::string_view prefix) { std::string* strValue = item.get_ptr(); if (strValue == nullptr) { BMCWEB_LOG_CRITICAL << "Field wasn't a string????"; return; } // Make sure the value is a properly formatted URI auto parsed = boost::urls::parse_relative_ref(*strValue); if (!parsed) { BMCWEB_LOG_CRITICAL << "Couldn't parse URI from resource " << *strValue; return; } boost::urls::url_view thisUrl = *parsed; // We don't need to aggregate JsonSchemas due to potential issues such as // version mismatches between aggregator and satellite BMCs. For now // assume that the aggregator has all the schemas and versions that the // aggregated server has. if (crow::utility::readUrlSegments(thisUrl, "redfish", "v1", "JsonSchemas", crow::utility::OrMorePaths())) { BMCWEB_LOG_DEBUG << "Skipping JsonSchemas URI prefix fixing"; return; } // The first two segments should be "/redfish/v1". We need to check that // before we can search topCollections if (!crow::utility::readUrlSegments(thisUrl, "redfish", "v1", crow::utility::OrMorePaths())) { return; } // Check array adding a segment each time until collection is identified // Add prefix to segment after the collection const boost::urls::segments_view urlSegments = thisUrl.segments(); bool addedPrefix = false; boost::urls::url url("/"); boost::urls::segments_view::iterator it = urlSegments.begin(); const boost::urls::segments_view::const_iterator end = urlSegments.end(); // Skip past the leading "/redfish/v1" it++; it++; for (; it != end; it++) { // Trailing "/" will result in an empty segment. In that case we need // to return so we don't apply a prefix to top level collections such // as "/redfish/v1/Chassis/" if ((*it).empty()) { return; } if (std::binary_search(topCollections.begin(), topCollections.end(), url.buffer())) { std::string collectionItem(prefix); collectionItem += "_" + (*it); url.segments().push_back(collectionItem); it++; addedPrefix = true; break; } url.segments().push_back(*it); } // Finish constructing the URL here (if needed) to avoid additional checks for (; it != end; it++) { url.segments().push_back(*it); } if (addedPrefix) { url.segments().insert(url.segments().begin(), {"redfish", "v1"}); item = url; } } // Search the json for all URIs and add the supplied prefix if the URI is for // an aggregated resource. static void addPrefixes(nlohmann::json& json, std::string_view prefix) { nlohmann::json::object_t* object = json.get_ptr(); if (object != nullptr) { for (std::pair& item : *object) { if (isPropertyUri(item.first)) { addPrefixToItem(item.second, prefix); continue; } // Recusively parse the rest of the json addPrefixes(item.second, prefix); } return; } nlohmann::json::array_t* array = json.get_ptr(); if (array != nullptr) { for (nlohmann::json& item : *array) { addPrefixes(item, prefix); } } } class RedfishAggregator { private: const std::string retryPolicyName = "RedfishAggregation"; const std::string retryPolicyAction = "TerminateAfterRetries"; const uint32_t retryAttempts = 1; const uint32_t retryTimeoutInterval = 0; const std::string id = "Aggregator"; RedfishAggregator() { getSatelliteConfigs(constructorCallback); // Setup the retry policy to be used by Redfish Aggregation crow::HttpClient::getInstance().setRetryConfig( retryAttempts, retryTimeoutInterval, aggregationRetryHandler, retryPolicyName); crow::HttpClient::getInstance().setRetryPolicy(retryPolicyAction, retryPolicyName); } static inline boost::system::error_code aggregationRetryHandler(unsigned int respCode) { // Allow all response codes because we want to surface any satellite // issue to the client BMCWEB_LOG_DEBUG << "Received " << respCode << " response from satellite"; return boost::system::errc::make_error_code( boost::system::errc::success); } // Dummy callback used by the Constructor so that it can report the number // of satellite configs when the class is first created static void constructorCallback( const std::unordered_map& satelliteInfo) { BMCWEB_LOG_DEBUG << "There were " << std::to_string(satelliteInfo.size()) << " satellite configs found at startup"; } // Polls D-Bus to get all available satellite config information // Expects a handler which interacts with the returned configs static void getSatelliteConfigs( const std::function&)>& handler) { BMCWEB_LOG_DEBUG << "Gathering satellite configs"; crow::connections::systemBus->async_method_call( [handler](const boost::system::error_code ec, const dbus::utility::ManagedObjectType& objects) { if (ec) { BMCWEB_LOG_ERROR << "DBUS response error " << ec.value() << ", " << ec.message(); return; } // Maps a chosen alias representing a satellite BMC to a url // containing the information required to create a http // connection to the satellite std::unordered_map satelliteInfo; findSatelliteConfigs(objects, satelliteInfo); if (!satelliteInfo.empty()) { BMCWEB_LOG_DEBUG << "Redfish Aggregation enabled with " << std::to_string(satelliteInfo.size()) << " satellite BMCs"; } else { BMCWEB_LOG_DEBUG << "No satellite BMCs detected. Redfish Aggregation not enabled"; } handler(satelliteInfo); }, "xyz.openbmc_project.EntityManager", "/xyz/openbmc_project/inventory", "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); } // Search D-Bus objects for satellite config objects and add their // information if valid static void findSatelliteConfigs( const dbus::utility::ManagedObjectType& objects, std::unordered_map& satelliteInfo) { for (const auto& objectPath : objects) { for (const auto& interface : objectPath.second) { if (interface.first == "xyz.openbmc_project.Configuration.SatelliteController") { BMCWEB_LOG_DEBUG << "Found Satellite Controller at " << objectPath.first.str; if (!satelliteInfo.empty()) { BMCWEB_LOG_ERROR << "Redfish Aggregation only supports one satellite!"; BMCWEB_LOG_DEBUG << "Clearing all satellite data"; satelliteInfo.clear(); return; } // For now assume there will only be one satellite config. // Assign it the name/prefix "5B247A" addSatelliteConfig("5B247A", interface.second, satelliteInfo); } } } } // Parse the properties of a satellite config object and add the // configuration if the properties are valid static void addSatelliteConfig( const std::string& name, const dbus::utility::DBusPropertiesMap& properties, std::unordered_map& satelliteInfo) { boost::urls::url url; for (const auto& prop : properties) { if (prop.first == "Hostname") { const std::string* propVal = std::get_if(&prop.second); if (propVal == nullptr) { BMCWEB_LOG_ERROR << "Invalid Hostname value"; return; } url.set_host(*propVal); } else if (prop.first == "Port") { const uint64_t* propVal = std::get_if(&prop.second); if (propVal == nullptr) { BMCWEB_LOG_ERROR << "Invalid Port value"; return; } if (*propVal > std::numeric_limits::max()) { BMCWEB_LOG_ERROR << "Port value out of range"; return; } url.set_port(std::to_string(static_cast(*propVal))); } else if (prop.first == "AuthType") { const std::string* propVal = std::get_if(&prop.second); if (propVal == nullptr) { BMCWEB_LOG_ERROR << "Invalid AuthType value"; return; } // For now assume authentication not required to communicate // with the satellite BMC if (*propVal != "None") { BMCWEB_LOG_ERROR << "Unsupported AuthType value: " << *propVal << ", only \"none\" is supported"; return; } url.set_scheme("http"); } } // Finished reading properties // Make sure all required config information was made available if (url.host().empty()) { BMCWEB_LOG_ERROR << "Satellite config " << name << " missing Host"; return; } if (!url.has_port()) { BMCWEB_LOG_ERROR << "Satellite config " << name << " missing Port"; return; } if (!url.has_scheme()) { BMCWEB_LOG_ERROR << "Satellite config " << name << " missing AuthType"; return; } std::string resultString; auto result = satelliteInfo.insert_or_assign(name, std::move(url)); if (result.second) { resultString = "Added new satellite config "; } else { resultString = "Updated existing satellite config "; } BMCWEB_LOG_DEBUG << resultString << name << " at " << result.first->second.scheme() << "://" << result.first->second.encoded_host_and_port(); } enum AggregationType { Collection, Resource, }; static void startAggregation(AggregationType isCollection, const crow::Request& thisReq, const std::shared_ptr& asyncResp) { if ((isCollection == AggregationType::Collection) && (thisReq.method() != boost::beast::http::verb::get)) { BMCWEB_LOG_DEBUG << "Only aggregate GET requests to top level collections"; return; } // Create a copy of thisReq so we we can still locally process the req std::error_code ec; auto localReq = std::make_shared(thisReq.req, ec); if (ec) { BMCWEB_LOG_ERROR << "Failed to create copy of request"; if (isCollection != AggregationType::Collection) { messages::internalError(asyncResp->res); } return; } getSatelliteConfigs(std::bind_front(aggregateAndHandle, isCollection, localReq, asyncResp)); } static void findSatellite( const crow::Request& req, const std::shared_ptr& asyncResp, const std::unordered_map& satelliteInfo, std::string_view memberName) { // Determine if the resource ID begins with a known prefix for (const auto& satellite : satelliteInfo) { std::string targetPrefix = satellite.first; targetPrefix += "_"; if (memberName.starts_with(targetPrefix)) { BMCWEB_LOG_DEBUG << "\"" << satellite.first << "\" is a known prefix"; // Remove the known prefix from the request's URI and // then forward to the associated satellite BMC getInstance().forwardRequest(req, asyncResp, satellite.first, satelliteInfo); return; } } // We didn't recognize the prefix and need to return a 404 std::string nameStr = req.urlView.segments().back(); messages::resourceNotFound(asyncResp->res, "", nameStr); } // Intended to handle an incoming request based on if Redfish Aggregation // is enabled. Forwards request to satellite BMC if it exists. static void aggregateAndHandle( AggregationType isCollection, const std::shared_ptr& sharedReq, const std::shared_ptr& asyncResp, const std::unordered_map& satelliteInfo) { if (sharedReq == nullptr) { return; } // No satellite configs means we don't need to keep attempting to // aggregate if (satelliteInfo.empty()) { // For collections we'll also handle the request locally so we // don't need to write an error code if (isCollection == AggregationType::Resource) { std::string nameStr = sharedReq->urlView.segments().back(); messages::resourceNotFound(asyncResp->res, "", nameStr); } return; } const crow::Request& thisReq = *sharedReq; BMCWEB_LOG_DEBUG << "Aggregation is enabled, begin processing of " << thisReq.target(); // We previously determined the request is for a collection. No need to // check again if (isCollection == AggregationType::Collection) { BMCWEB_LOG_DEBUG << "Aggregating a collection"; // We need to use a specific response handler and send the // request to all known satellites getInstance().forwardCollectionRequests(thisReq, asyncResp, satelliteInfo); return; } const boost::urls::segments_view urlSegments = thisReq.urlView.segments(); boost::urls::url currentUrl("/"); boost::urls::segments_view::iterator it = urlSegments.begin(); const boost::urls::segments_view::const_iterator end = urlSegments.end(); // Skip past the leading "/redfish/v1" it++; it++; for (; it != end; it++) { if (std::binary_search(topCollections.begin(), topCollections.end(), currentUrl.buffer())) { // We've matched a resource collection so this current segment // must contain an aggregation prefix findSatellite(thisReq, asyncResp, satelliteInfo, *it); return; } currentUrl.segments().push_back(*it); } // We shouldn't reach this point since we should've hit one of the // previous exits messages::internalError(asyncResp->res); } // Attempt to forward a request to the satellite BMC associated with the // prefix. void forwardRequest( const crow::Request& thisReq, const std::shared_ptr& asyncResp, const std::string& prefix, const std::unordered_map& satelliteInfo) { const auto& sat = satelliteInfo.find(prefix); if (sat == satelliteInfo.end()) { // Realistically this shouldn't get called since we perform an // earlier check to make sure the prefix exists BMCWEB_LOG_ERROR << "Unrecognized satellite prefix \"" << prefix << "\""; return; } // We need to strip the prefix from the request's path std::string targetURI(thisReq.target()); size_t pos = targetURI.find(prefix + "_"); if (pos == std::string::npos) { // If this fails then something went wrong BMCWEB_LOG_ERROR << "Error removing prefix \"" << prefix << "_\" from request URI"; messages::internalError(asyncResp->res); return; } targetURI.erase(pos, prefix.size() + 1); std::function cb = std::bind_front(processResponse, prefix, asyncResp); std::string data = thisReq.req.body(); crow::HttpClient::getInstance().sendDataWithCallback( data, id, std::string(sat->second.host()), sat->second.port_number(), targetURI, false /*useSSL*/, thisReq.fields, thisReq.method(), retryPolicyName, cb); } // Forward a request for a collection URI to each known satellite BMC void forwardCollectionRequests( const crow::Request& thisReq, const std::shared_ptr& asyncResp, const std::unordered_map& satelliteInfo) { for (const auto& sat : satelliteInfo) { std::function cb = std::bind_front( processCollectionResponse, sat.first, asyncResp); std::string targetURI(thisReq.target()); std::string data = thisReq.req.body(); crow::HttpClient::getInstance().sendDataWithCallback( data, id, std::string(sat.second.host()), sat.second.port_number(), targetURI, false /*useSSL*/, thisReq.fields, thisReq.method(), retryPolicyName, cb); } } public: RedfishAggregator(const RedfishAggregator&) = delete; RedfishAggregator& operator=(const RedfishAggregator&) = delete; RedfishAggregator(RedfishAggregator&&) = delete; RedfishAggregator& operator=(RedfishAggregator&&) = delete; ~RedfishAggregator() = default; static RedfishAggregator& getInstance() { static RedfishAggregator handler; return handler; } // Processes the response returned by a satellite BMC and loads its // contents into asyncResp static void processResponse(std::string_view prefix, const std::shared_ptr& asyncResp, crow::Response& resp) { // We want to attempt prefix fixing regardless of response code // The resp will not have a json component // We need to create a json from resp's stringResponse if (resp.getHeaderValue("Content-Type") == "application/json") { nlohmann::json jsonVal = nlohmann::json::parse(resp.body(), nullptr, false); if (jsonVal.is_discarded()) { BMCWEB_LOG_ERROR << "Error parsing satellite response as JSON"; messages::operationFailed(asyncResp->res); return; } BMCWEB_LOG_DEBUG << "Successfully parsed satellite response"; addPrefixes(jsonVal, prefix); BMCWEB_LOG_DEBUG << "Added prefix to parsed satellite response"; asyncResp->res.result(resp.result()); asyncResp->res.jsonValue = std::move(jsonVal); BMCWEB_LOG_DEBUG << "Finished writing asyncResp"; } else { if (!resp.body().empty()) { // We received a valid response without the correct // Content-Type so return an Operation Failed error BMCWEB_LOG_ERROR << "Satellite response must be of type \"application/json\""; messages::operationFailed(asyncResp->res); } } } // Processes the collection response returned by a satellite BMC and merges // its "@odata.id" values static void processCollectionResponse( const std::string& prefix, const std::shared_ptr& asyncResp, crow::Response& resp) { if (resp.resultInt() != 200) { BMCWEB_LOG_DEBUG << "Collection resource does not exist in satellite BMC \"" << prefix << "\""; // Return the error if we haven't had any successes if (asyncResp->res.resultInt() != 200) { asyncResp->res.stringResponse = std::move(resp.stringResponse); } return; } // The resp will not have a json component // We need to create a json from resp's stringResponse if (resp.getHeaderValue("Content-Type") == "application/json") { nlohmann::json jsonVal = nlohmann::json::parse(resp.body(), nullptr, false); if (jsonVal.is_discarded()) { BMCWEB_LOG_ERROR << "Error parsing satellite response as JSON"; // Notify the user if doing so won't overwrite a valid response if ((asyncResp->res.resultInt() != 200) && (asyncResp->res.resultInt() != 502)) { messages::operationFailed(asyncResp->res); } return; } BMCWEB_LOG_DEBUG << "Successfully parsed satellite response"; // Now we need to add the prefix to the URIs contained in the // response. addPrefixes(jsonVal, prefix); BMCWEB_LOG_DEBUG << "Added prefix to parsed satellite response"; // If this resource collection does not exist on the aggregating bmc // and has not already been added from processing the response from // a different satellite then we need to completely overwrite // asyncResp if (asyncResp->res.resultInt() != 200) { // We only want to aggregate collections that contain a // "Members" array if ((!jsonVal.contains("Members")) && (!jsonVal["Members"].is_array())) { BMCWEB_LOG_DEBUG << "Skipping aggregating unsupported resource"; return; } BMCWEB_LOG_DEBUG << "Collection does not exist, overwriting asyncResp"; asyncResp->res.result(resp.result()); asyncResp->res.jsonValue = std::move(jsonVal); BMCWEB_LOG_DEBUG << "Finished overwriting asyncResp"; } else { // We only want to aggregate collections that contain a // "Members" array if ((!asyncResp->res.jsonValue.contains("Members")) && (!asyncResp->res.jsonValue["Members"].is_array())) { BMCWEB_LOG_DEBUG << "Skipping aggregating unsupported resource"; return; } BMCWEB_LOG_DEBUG << "Adding aggregated resources from \"" << prefix << "\" to collection"; // TODO: This is a potential race condition with multiple // satellites and the aggregating bmc attempting to write to // update this array. May need to cascade calls to the next // satellite at the end of this function. // This is presumably not a concern when there is only a single // satellite since the aggregating bmc should have completed // before the response is received from the satellite. auto& members = asyncResp->res.jsonValue["Members"]; auto& satMembers = jsonVal["Members"]; for (auto& satMem : satMembers) { members.push_back(std::move(satMem)); } asyncResp->res.jsonValue["Members@odata.count"] = members.size(); // TODO: Do we need to sort() after updating the array? } } else { BMCWEB_LOG_ERROR << "Received unparsable response from \"" << prefix << "\""; // We received as response that was not a json // Notify the user only if we did not receive any valid responses, // if the resource collection does not already exist on the // aggregating BMC, and if we did not already set this warning due // to a failure from a different satellite if ((asyncResp->res.resultInt() != 200) && (asyncResp->res.resultInt() != 502)) { messages::operationFailed(asyncResp->res); } } } // End processCollectionResponse() // Entry point to Redfish Aggregation // Returns Result stating whether or not we still need to locally handle the // request static Result beginAggregation(const crow::Request& thisReq, const std::shared_ptr& asyncResp) { using crow::utility::OrMorePaths; using crow::utility::readUrlSegments; const boost::urls::url_view url = thisReq.urlView; // We don't need to aggregate JsonSchemas due to potential issues such // as version mismatches between aggregator and satellite BMCs. For // now assume that the aggregator has all the schemas and versions that // the aggregated server has. if (crow::utility::readUrlSegments(url, "redfish", "v1", "JsonSchemas", crow::utility::OrMorePaths())) { return Result::LocalHandle; } // The first two segments should be "/redfish/v1". We need to check // that before we can search topCollections if (!crow::utility::readUrlSegments(url, "redfish", "v1", crow::utility::OrMorePaths())) { return Result::LocalHandle; } // Parse the URI to see if it begins with a known top level collection // such as: // /redfish/v1/Chassis // /redfish/v1/UpdateService/FirmwareInventory const boost::urls::segments_view urlSegments = url.segments(); std::string collectionItem; boost::urls::url currentUrl("/"); boost::urls::segments_view::iterator it = urlSegments.begin(); const boost::urls::segments_view::const_iterator end = urlSegments.end(); // Skip past the leading "/redfish/v1" it++; it++; for (; it != end; it++) { collectionItem = *it; if (std::binary_search(topCollections.begin(), topCollections.end(), currentUrl.buffer())) { // We've matched a resource collection so this current segment // might contain an aggregation prefix if (collectionItem.starts_with("5B247A")) { BMCWEB_LOG_DEBUG << "Need to forward a request"; // Extract the prefix from the request's URI, retrieve the // associated satellite config information, and then forward // the request to that satellite. startAggregation(AggregationType::Resource, thisReq, asyncResp); return Result::NoLocalHandle; } // Handle collection URI with a trailing backslash // e.g. /redfish/v1/Chassis/ it++; if ((it == end) && collectionItem.empty()) { startAggregation(AggregationType::Collection, thisReq, asyncResp); } // We didn't recognize the prefix or it's a collection with a // trailing "/". In both cases we still want to locally handle // the request return Result::LocalHandle; } currentUrl.segments().push_back(collectionItem); } // If we made it here then currentUrl could contain a top level // collection URI without a trailing "/", e.g. /redfish/v1/Chassis if (std::binary_search(topCollections.begin(), topCollections.end(), currentUrl.buffer())) { startAggregation(AggregationType::Collection, thisReq, asyncResp); return Result::LocalHandle; } BMCWEB_LOG_DEBUG << "Aggregation not required"; return Result::LocalHandle; } }; } // namespace redfish