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 "bmcweb_config.h" 19 20 #include "app.hpp" 21 #include "async_resp.hpp" 22 #include "http_request.hpp" 23 #include "persistent_data.hpp" 24 #include "query.hpp" 25 #include "registries/privilege_registry.hpp" 26 #include "utils/systemd_utils.hpp" 27 28 #include <nlohmann/json.hpp> 29 30 namespace redfish 31 { 32 33 inline void 34 handleServiceRootHead(App& app, const crow::Request& req, 35 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 36 { 37 if (!redfish::setUpRedfishRoute(app, req, asyncResp)) 38 { 39 return; 40 } 41 42 asyncResp->res.addHeader( 43 boost::beast::http::field::link, 44 "</redfish/v1/JsonSchemas/ServiceRoot/ServiceRoot.json>; rel=describedby"); 45 } 46 47 inline void handleServiceRootGetImpl( 48 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 49 { 50 std::string uuid = persistent_data::getConfig().systemUuid; 51 asyncResp->res.jsonValue["@odata.type"] = 52 "#ServiceRoot.v1_11_0.ServiceRoot"; 53 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1"; 54 asyncResp->res.jsonValue["Id"] = "RootService"; 55 asyncResp->res.jsonValue["Name"] = "Root Service"; 56 asyncResp->res.jsonValue["RedfishVersion"] = "1.9.0"; 57 asyncResp->res.jsonValue["Links"]["Sessions"]["@odata.id"] = 58 "/redfish/v1/SessionService/Sessions"; 59 asyncResp->res.jsonValue["AccountService"]["@odata.id"] = 60 "/redfish/v1/AccountService"; 61 asyncResp->res.jsonValue["Chassis"]["@odata.id"] = "/redfish/v1/Chassis"; 62 asyncResp->res.jsonValue["JsonSchemas"]["@odata.id"] = 63 "/redfish/v1/JsonSchemas"; 64 asyncResp->res.jsonValue["Managers"]["@odata.id"] = "/redfish/v1/Managers"; 65 asyncResp->res.jsonValue["SessionService"]["@odata.id"] = 66 "/redfish/v1/SessionService"; 67 asyncResp->res.jsonValue["Systems"]["@odata.id"] = "/redfish/v1/Systems"; 68 asyncResp->res.jsonValue["Registries"]["@odata.id"] = 69 "/redfish/v1/Registries"; 70 asyncResp->res.jsonValue["UpdateService"]["@odata.id"] = 71 "/redfish/v1/UpdateService"; 72 asyncResp->res.jsonValue["UUID"] = uuid; 73 asyncResp->res.jsonValue["CertificateService"]["@odata.id"] = 74 "/redfish/v1/CertificateService"; 75 asyncResp->res.jsonValue["Tasks"]["@odata.id"] = "/redfish/v1/TaskService"; 76 asyncResp->res.jsonValue["EventService"]["@odata.id"] = 77 "/redfish/v1/EventService"; 78 asyncResp->res.jsonValue["TelemetryService"]["@odata.id"] = 79 "/redfish/v1/TelemetryService"; 80 asyncResp->res.jsonValue["Cables"]["@odata.id"] = "/redfish/v1/Cables"; 81 82 nlohmann::json& protocolFeatures = 83 asyncResp->res.jsonValue["ProtocolFeaturesSupported"]; 84 protocolFeatures["ExcerptQuery"] = false; 85 86 protocolFeatures["ExpandQuery"]["ExpandAll"] = 87 bmcwebInsecureEnableQueryParams; 88 // This is the maximum level defined in ServiceRoot.v1_13_0.json 89 if (bmcwebInsecureEnableQueryParams) 90 { 91 protocolFeatures["ExpandQuery"]["MaxLevels"] = 6; 92 } 93 protocolFeatures["ExpandQuery"]["Levels"] = bmcwebInsecureEnableQueryParams; 94 protocolFeatures["ExpandQuery"]["Links"] = bmcwebInsecureEnableQueryParams; 95 protocolFeatures["ExpandQuery"]["NoLinks"] = 96 bmcwebInsecureEnableQueryParams; 97 protocolFeatures["FilterQuery"] = false; 98 protocolFeatures["OnlyMemberQuery"] = true; 99 protocolFeatures["SelectQuery"] = true; 100 protocolFeatures["DeepOperations"]["DeepPOST"] = false; 101 protocolFeatures["DeepOperations"]["DeepPATCH"] = false; 102 } 103 inline void 104 handleServiceRootGet(App& app, const crow::Request& req, 105 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) 106 { 107 handleServiceRootHead(app, req, asyncResp); 108 handleServiceRootGetImpl(asyncResp); 109 } 110 111 inline void requestRoutesServiceRoot(App& app) 112 { 113 BMCWEB_ROUTE(app, "/redfish/v1/") 114 .privileges(redfish::privileges::headServiceRoot) 115 .methods(boost::beast::http::verb::head)( 116 std::bind_front(handleServiceRootHead, std::ref(app))); 117 BMCWEB_ROUTE(app, "/redfish/v1/") 118 .privileges(redfish::privileges::getServiceRoot) 119 .methods(boost::beast::http::verb::get)( 120 std::bind_front(handleServiceRootGet, std::ref(app))); 121 } 122 123 } // namespace redfish 124