Borawski.Lukasz | b6df6dc | 2018-01-24 10:20:45 +0100 | [diff] [blame] | 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 | |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 18 | #include "bmcweb_config.h" |
Ed Tanous | f4c99e7 | 2021-10-04 17:02:43 -0700 | [diff] [blame] | 19 | |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 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 | |
Nan Zhou | 9629907 | 2022-03-23 09:13:46 -0700 | [diff] [blame] | 28 | #include <nlohmann/json.hpp> |
Borawski.Lukasz | b6df6dc | 2018-01-24 10:20:45 +0100 | [diff] [blame] | 29 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 30 | namespace redfish |
| 31 | { |
Ed Tanous | 3ebd75f | 2018-03-05 18:20:01 -0800 | [diff] [blame] | 32 | |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 33 | inline void |
Ed Tanous | 5b22492 | 2022-06-22 19:00:59 -0700 | [diff] [blame] | 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) |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 49 | { |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 50 | std::string uuid = persistent_data::getConfig().systemUuid; |
Shantappa Teekappanavar | 9c929be | 2021-12-16 19:02:52 -0600 | [diff] [blame] | 51 | asyncResp->res.jsonValue["@odata.type"] = |
| 52 | "#ServiceRoot.v1_11_0.ServiceRoot"; |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 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"; |
Ed Tanous | 1476687 | 2022-03-15 10:44:42 -0700 | [diff] [blame] | 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"; |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 72 | asyncResp->res.jsonValue["UUID"] = uuid; |
Ed Tanous | 1476687 | 2022-03-15 10:44:42 -0700 | [diff] [blame] | 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"; |
Nan Zhou | 9629907 | 2022-03-23 09:13:46 -0700 | [diff] [blame] | 81 | |
| 82 | nlohmann::json& protocolFeatures = |
| 83 | asyncResp->res.jsonValue["ProtocolFeaturesSupported"]; |
| 84 | protocolFeatures["ExcerptQuery"] = false; |
Ed Tanous | 7cf436c | 2022-03-22 23:53:51 -0700 | [diff] [blame] | 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; |
Nan Zhou | 9629907 | 2022-03-23 09:13:46 -0700 | [diff] [blame] | 97 | protocolFeatures["FilterQuery"] = false; |
Nan Zhou | 0553fb5 | 2022-08-05 17:23:06 +0000 | [diff] [blame] | 98 | protocolFeatures["OnlyMemberQuery"] = true; |
Nan Zhou | 07ffa4e | 2022-08-09 22:46:25 +0000 | [diff] [blame] | 99 | protocolFeatures["SelectQuery"] = true; |
Nan Zhou | 9629907 | 2022-03-23 09:13:46 -0700 | [diff] [blame] | 100 | protocolFeatures["DeepOperations"]["DeepPOST"] = false; |
| 101 | protocolFeatures["DeepOperations"]["DeepPATCH"] = false; |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 102 | } |
Ed Tanous | 5b22492 | 2022-06-22 19:00:59 -0700 | [diff] [blame] | 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 | } |
John Edward Broadbent | 8338891 | 2021-06-29 10:46:46 -0700 | [diff] [blame] | 110 | |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 111 | inline void requestRoutesServiceRoot(App& app) |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 112 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 113 | BMCWEB_ROUTE(app, "/redfish/v1/") |
Ed Tanous | 5b22492 | 2022-06-22 19:00:59 -0700 | [diff] [blame] | 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/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 118 | .privileges(redfish::privileges::getServiceRoot) |
Ed Tanous | 7cf436c | 2022-03-22 23:53:51 -0700 | [diff] [blame] | 119 | .methods(boost::beast::http::verb::get)( |
Ed Tanous | 5b22492 | 2022-06-22 19:00:59 -0700 | [diff] [blame] | 120 | std::bind_front(handleServiceRootGet, std::ref(app))); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 121 | } |
Borawski.Lukasz | b6df6dc | 2018-01-24 10:20:45 +0100 | [diff] [blame] | 122 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 123 | } // namespace redfish |