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_15_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 #ifdef BMCWEB_ENABLE_REDFISH_AGGREGATION
62     asyncResp->res.jsonValue["AggregationService"]["@odata.id"] =
63         "/redfish/v1/AggregationService";
64 #endif
65     asyncResp->res.jsonValue["Chassis"]["@odata.id"] = "/redfish/v1/Chassis";
66     asyncResp->res.jsonValue["JsonSchemas"]["@odata.id"] =
67         "/redfish/v1/JsonSchemas";
68     asyncResp->res.jsonValue["Managers"]["@odata.id"] = "/redfish/v1/Managers";
69     asyncResp->res.jsonValue["SessionService"]["@odata.id"] =
70         "/redfish/v1/SessionService";
71     asyncResp->res.jsonValue["Systems"]["@odata.id"] = "/redfish/v1/Systems";
72     asyncResp->res.jsonValue["Registries"]["@odata.id"] =
73         "/redfish/v1/Registries";
74     asyncResp->res.jsonValue["UpdateService"]["@odata.id"] =
75         "/redfish/v1/UpdateService";
76     asyncResp->res.jsonValue["UUID"] = uuid;
77     asyncResp->res.jsonValue["CertificateService"]["@odata.id"] =
78         "/redfish/v1/CertificateService";
79     asyncResp->res.jsonValue["Tasks"]["@odata.id"] = "/redfish/v1/TaskService";
80     asyncResp->res.jsonValue["EventService"]["@odata.id"] =
81         "/redfish/v1/EventService";
82     asyncResp->res.jsonValue["TelemetryService"]["@odata.id"] =
83         "/redfish/v1/TelemetryService";
84     asyncResp->res.jsonValue["Cables"]["@odata.id"] = "/redfish/v1/Cables";
85 
86     asyncResp->res.jsonValue["Links"]["ManagerProvidingService"]["@odata.id"] =
87         "/redfish/v1/Managers/bmc";
88 
89     nlohmann::json& protocolFeatures =
90         asyncResp->res.jsonValue["ProtocolFeaturesSupported"];
91     protocolFeatures["ExcerptQuery"] = false;
92 
93     protocolFeatures["ExpandQuery"]["ExpandAll"] =
94         bmcwebInsecureEnableQueryParams;
95     // This is the maximum level defined in ServiceRoot.v1_13_0.json
96     if (bmcwebInsecureEnableQueryParams)
97     {
98         protocolFeatures["ExpandQuery"]["MaxLevels"] = 6;
99     }
100     protocolFeatures["ExpandQuery"]["Levels"] = bmcwebInsecureEnableQueryParams;
101     protocolFeatures["ExpandQuery"]["Links"] = bmcwebInsecureEnableQueryParams;
102     protocolFeatures["ExpandQuery"]["NoLinks"] =
103         bmcwebInsecureEnableQueryParams;
104     protocolFeatures["FilterQuery"] = false;
105     protocolFeatures["OnlyMemberQuery"] = true;
106     protocolFeatures["SelectQuery"] = true;
107     protocolFeatures["DeepOperations"]["DeepPOST"] = false;
108     protocolFeatures["DeepOperations"]["DeepPATCH"] = false;
109 }
110 inline void
111     handleServiceRootGet(App& app, const crow::Request& req,
112                          const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
113 {
114     handleServiceRootHead(app, req, asyncResp);
115     handleServiceRootGetImpl(asyncResp);
116 }
117 
118 inline void requestRoutesServiceRoot(App& app)
119 {
120     BMCWEB_ROUTE(app, "/redfish/v1/")
121         .privileges(redfish::privileges::headServiceRoot)
122         .methods(boost::beast::http::verb::head)(
123             std::bind_front(handleServiceRootHead, std::ref(app)));
124     BMCWEB_ROUTE(app, "/redfish/v1/")
125         .privileges(redfish::privileges::getServiceRoot)
126         .methods(boost::beast::http::verb::get)(
127             std::bind_front(handleServiceRootGet, std::ref(app)));
128 }
129 
130 } // namespace redfish
131