xref: /openbmc/bmcweb/features/redfish/lib/roles.hpp (revision e0d918bc397350aa21af3dab9faa6e21748f6373)

/*
// Copyright (c) 2018 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/
#pragma once

#include "node.hpp"

namespace redfish {

class Roles : public Node {
 public:
  Roles(CrowApp& app)
      : Node(app, "/redfish/v1/AccountService/Roles/Administrator/") {
    Node::json["@odata.id"] = "/redfish/v1/AccountService/Roles/Administrator";
    Node::json["@odata.type"] = "#Role.v1_0_2.Role";
    Node::json["@odata.context"] = "/redfish/v1/$metadata#Role.Role";
    Node::json["Id"] = "Administrator";
    Node::json["Name"] = "User Role";
    Node::json["Description"] = "Administrator User Role";
    Node::json["IsPredefined"] = true;
    Node::json["AssignedPrivileges"] = {"Login", "ConfigureManager",
                                        "ConfigureUsers", "ConfigureSelf",
                                        "ConfigureComponents"};
    Node::json["OemPrivileges"] = nlohmann::json::array();
    entityPrivileges = {{boost::beast::http::verb::get, {{"Login"}}},
                        {boost::beast::http::verb::head, {{"Login"}}},
                        {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
                        {boost::beast::http::verb::put, {{"ConfigureManager"}}},
                        {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
                        {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
  }

 private:
  void doGet(crow::response& res, const crow::request& req,
             const std::vector<std::string>& params) override {
    res.json_value = Node::json;
    res.end();
  }
};

class RoleCollection : public Node {
 public:
  RoleCollection(CrowApp& app)
      : Node(app, "/redfish/v1/AccountService/Roles/") {
    Node::json["@odata.id"] = "/redfish/v1/AccountService/Roles";
    Node::json["@odata.type"] = "#RoleCollection.RoleCollection";
    Node::json["@odata.context"] =
        "/redfish/v1/$metadata#RoleCollection.RoleCollection";
    Node::json["Name"] = "Roles Collection";
    Node::json["Description"] = "BMC User Roles";
    Node::json["Members@odata.count"] = 1;
    Node::json["Members"] = {
        {{"@odata.id", "/redfish/v1/AccountService/Roles/Administrator"}}};

    entityPrivileges = {{boost::beast::http::verb::get, {{"Login"}}},
                        {boost::beast::http::verb::head, {{"Login"}}},
                        {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
                        {boost::beast::http::verb::put, {{"ConfigureManager"}}},
                        {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
                        {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
  }

 private:
  void doGet(crow::response& res, const crow::request& req,
             const std::vector<std::string>& params) override {
    res.json_value = Node::json;
    // This is a short term solution to work around a bug.  GetSubroutes
    // accidentally recognizes the Roles/Administrator route as a subroute
    // (because it's hardcoded to a single entity).  Remove this line when that
    // is resolved
    res.json_value.erase("Administrator");
    res.end();
  }
};

}  // namespace redfish