xref: /openbmc/bmcweb/redfish-core/lib/roles.hpp (revision 81d523a7)
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 <app.hpp>
19 #include <dbus_utility.hpp>
20 #include <query.hpp>
21 #include <registries/privilege_registry.hpp>
22 #include <sdbusplus/asio/property.hpp>
23 
24 #include <variant>
25 namespace redfish
26 {
27 
28 inline std::string getRoleFromPrivileges(std::string_view priv)
29 {
30     if (priv == "priv-admin")
31     {
32         return "Administrator";
33     }
34     if (priv == "priv-user")
35     {
36         return "ReadOnly";
37     }
38     if (priv == "priv-operator")
39     {
40         return "Operator";
41     }
42     if (priv == "priv-noaccess")
43     {
44         return "NoAccess";
45     }
46     return "";
47 }
48 
49 inline bool getAssignedPrivFromRole(std::string_view role,
50                                     nlohmann::json& privArray)
51 {
52     if (role == "Administrator")
53     {
54         privArray = {"Login", "ConfigureManager", "ConfigureUsers",
55                      "ConfigureSelf", "ConfigureComponents"};
56     }
57     else if (role == "Operator")
58     {
59         privArray = {"Login", "ConfigureSelf", "ConfigureComponents"};
60     }
61     else if (role == "ReadOnly")
62     {
63         privArray = {"Login", "ConfigureSelf"};
64     }
65     else if (role == "NoAccess")
66     {
67         privArray = nlohmann::json::array();
68     }
69     else
70     {
71         return false;
72     }
73     return true;
74 }
75 
76 inline void requestRoutesRoles(App& app)
77 {
78     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Roles/<str>/")
79         .privileges(redfish::privileges::getRole)
80         .methods(boost::beast::http::verb::get)(
81             [&app](const crow::Request& req,
82                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
83                    const std::string& roleId) {
84         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
85         {
86             return;
87         }
88         nlohmann::json privArray = nlohmann::json::array();
89         if (!getAssignedPrivFromRole(roleId, privArray))
90         {
91             messages::resourceNotFound(asyncResp->res, "Role", roleId);
92 
93             return;
94         }
95 
96         asyncResp->res.jsonValue["@odata.type"] = "#Role.v1_2_2.Role";
97         asyncResp->res.jsonValue["Name"] = "User Role";
98         asyncResp->res.jsonValue["Description"] = roleId + " User Role";
99         asyncResp->res.jsonValue["OemPrivileges"] = nlohmann::json::array();
100         asyncResp->res.jsonValue["IsPredefined"] = true;
101         asyncResp->res.jsonValue["Id"] = roleId;
102         asyncResp->res.jsonValue["RoleId"] = roleId;
103         asyncResp->res.jsonValue["@odata.id"] =
104             "/redfish/v1/AccountService/Roles/" + roleId;
105         asyncResp->res.jsonValue["AssignedPrivileges"] = std::move(privArray);
106         });
107 }
108 
109 inline void requestRoutesRoleCollection(App& app)
110 {
111     BMCWEB_ROUTE(app, "/redfish/v1/AccountService/Roles/")
112         .privileges(redfish::privileges::getRoleCollection)
113         .methods(boost::beast::http::verb::get)(
114             [&app](const crow::Request& req,
115                    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
116         if (!redfish::setUpRedfishRoute(app, req, asyncResp))
117         {
118             return;
119         }
120 
121         asyncResp->res.jsonValue["@odata.id"] =
122             "/redfish/v1/AccountService/Roles";
123         asyncResp->res.jsonValue["@odata.type"] =
124             "#RoleCollection.RoleCollection";
125         asyncResp->res.jsonValue["Name"] = "Roles Collection";
126         asyncResp->res.jsonValue["Description"] = "BMC User Roles";
127 
128         sdbusplus::asio::getProperty<std::vector<std::string>>(
129             *crow::connections::systemBus, "xyz.openbmc_project.User.Manager",
130             "/xyz/openbmc_project/user", "xyz.openbmc_project.User.Manager",
131             "AllPrivileges",
132             [asyncResp](const boost::system::error_code ec,
133                         const std::vector<std::string>& privList) {
134             if (ec)
135             {
136                 messages::internalError(asyncResp->res);
137                 return;
138             }
139             nlohmann::json& memberArray = asyncResp->res.jsonValue["Members"];
140             memberArray = nlohmann::json::array();
141             for (const std::string& priv : privList)
142             {
143                 std::string role = getRoleFromPrivileges(priv);
144                 if (!role.empty())
145                 {
146                     nlohmann::json::object_t member;
147                     member["@odata.id"] =
148                         "/redfish/v1/AccountService/Roles/" + role;
149                     memberArray.push_back(std::move(member));
150                 }
151             }
152             asyncResp->res.jsonValue["Members@odata.count"] =
153                 memberArray.size();
154             });
155         });
156 }
157 
158 } // namespace redfish
159