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