1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*
// 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 "privileges.hpp"
#include "token_authorization_middleware.hpp"
#include "webserver_common.hpp"
#include <error_messages.hpp>
#include <vector>
#include "http_request.h"
#include "http_response.h"
namespace redfish
{
/**
* AsyncResp
* Gathers data needed for response processing after async calls are done
*/
class AsyncResp
{
public:
AsyncResp(crow::Response& response) : res(response)
{
}
~AsyncResp()
{
res.end();
}
crow::Response& res;
};
/**
* @brief Abstract class used for implementing Redfish nodes.
*
*/
class Node
{
public:
template <typename... Params>
Node(CrowApp& app, std::string&& entityUrl, Params... paramsIn)
{
crow::DynamicRule& get = app.routeDynamic(entityUrl.c_str());
getRule = &get;
get.methods("GET"_method)([this](const crow::Request& req,
crow::Response& res,
Params... params) {
std::vector<std::string> paramVec = {params...};
doGet(res, req, paramVec);
});
crow::DynamicRule& patch = app.routeDynamic(entityUrl.c_str());
patchRule = &patch;
patch.methods("PATCH"_method)([this](const crow::Request& req,
crow::Response& res,
Params... params) {
std::vector<std::string> paramVec = {params...};
doPatch(res, req, paramVec);
});
crow::DynamicRule& post = app.routeDynamic(entityUrl.c_str());
postRule = &post;
post.methods("POST"_method)([this](const crow::Request& req,
crow::Response& res,
Params... params) {
std::vector<std::string> paramVec = {params...};
doPost(res, req, paramVec);
});
crow::DynamicRule& delete_ = app.routeDynamic(entityUrl.c_str());
deleteRule = &delete_;
delete_.methods("DELETE"_method)([this](const crow::Request& req,
crow::Response& res,
Params... params) {
std::vector<std::string> paramVec = {params...};
doDelete(res, req, paramVec);
});
}
void initPrivileges()
{
auto it = entityPrivileges.find(boost::beast::http::verb::get);
if (it != entityPrivileges.end())
{
if (getRule != nullptr)
{
getRule->requires(it->second);
}
}
it = entityPrivileges.find(boost::beast::http::verb::post);
if (it != entityPrivileges.end())
{
if (postRule != nullptr)
{
postRule->requires(it->second);
}
}
it = entityPrivileges.find(boost::beast::http::verb::patch);
if (it != entityPrivileges.end())
{
if (patchRule != nullptr)
{
patchRule->requires(it->second);
}
}
it = entityPrivileges.find(boost::beast::http::verb::delete_);
if (it != entityPrivileges.end())
{
if (deleteRule != nullptr)
{
deleteRule->requires(it->second);
}
}
}
virtual ~Node() = default;
OperationMap entityPrivileges;
crow::DynamicRule* getRule = nullptr;
crow::DynamicRule* postRule = nullptr;
crow::DynamicRule* patchRule = nullptr;
crow::DynamicRule* deleteRule = nullptr;
protected:
// Node is designed to be an abstract class, so doGet is pure virtual
virtual void doGet(crow::Response& res, const crow::Request& req,
const std::vector<std::string>& params)
{
res.result(boost::beast::http::status::method_not_allowed);
res.end();
}
virtual void doPatch(crow::Response& res, const crow::Request& req,
const std::vector<std::string>& params)
{
res.result(boost::beast::http::status::method_not_allowed);
res.end();
}
virtual void doPost(crow::Response& res, const crow::Request& req,
const std::vector<std::string>& params)
{
res.result(boost::beast::http::status::method_not_allowed);
res.end();
}
virtual void doDelete(crow::Response& res, const crow::Request& req,
const std::vector<std::string>& params)
{
res.result(boost::beast::http::status::method_not_allowed);
res.end();
}
/* @brief Would the operation be allowed if the user did not have the
* ConfigureSelf Privilege? Also honors session.isConfigureSelfOnly.
*
* @param req the request
*
* @returns True if allowed, false otherwise
*/
inline bool isAllowedWithoutConfigureSelf(const crow::Request& req)
{
const std::string& userRole = req.userRole;
BMCWEB_LOG_DEBUG << "isAllowedWithoutConfigureSelf for the role "
<< req.userRole;
Privileges effectiveUserPrivileges;
if (req.session && req.session->isConfigureSelfOnly)
{
// The session has no privileges because it is limited to
// configureSelfOnly and we are disregarding that privilege.
// Note that some operations do not require any privilege.
}
else
{
effectiveUserPrivileges = redfish::getUserPrivileges(userRole);
effectiveUserPrivileges.resetSinglePrivilege("ConfigureSelf");
}
const auto& requiredPrivilegesIt = entityPrivileges.find(req.method());
return (requiredPrivilegesIt != entityPrivileges.end()) &&
isOperationAllowedWithPrivileges(requiredPrivilegesIt->second,
effectiveUserPrivileges);
}
};
} // namespace redfish
|
