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
|
// Copyright (C) 2021-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef CMD__RESPONSE_CREATOR_H
#define CMD__RESPONSE_CREATOR_H
#include <http/response_creator.h>
#include <http/basic_auth_config.h>
#include <boost/shared_ptr.hpp>
#include <unordered_set>
namespace isc {
namespace config {
/// @brief Concrete implementation of the HTTP response creator used
/// for processing API commands
///
/// See the documentation of the @ref isc::http::HttpResponseCreator for
/// the basic information how HTTP response creators are utilized by
/// the libkea-http library to generate HTTP responses.
///
/// This creator expects that received requests are encapsulated in the
/// @ref isc::http::PostHttpRequestJson objects. The generated responses
/// are encapsulated in the HttpResponseJson objects.
///
/// This class uses @ref CommandMgr singleton to process commands
/// conveyed in the HTTP body. The JSON responses returned by the manager
/// are placed in the body of the generated HTTP responses.
class CmdResponseCreator : public http::HttpResponseCreator {
public:
/// @brief Constructor
///
/// @param emulate_agent_response if true, responses for normal
/// command outcomes are guaranteed to be wrapped in an Element::list.
/// This emulates how kea-ctrl-agent forms responses. Defaults to true.
CmdResponseCreator(bool emulate_agent_response = true)
: emulate_agent_response_(emulate_agent_response) {};
/// @brief Create a new request.
///
/// This method creates a bare instance of the @ref
/// isc::http::PostHttpRequestJson.
///
/// @return Pointer to the new instance of the @ref
/// isc::http::PostHttpRequestJson.
virtual http::HttpRequestPtr createNewHttpRequest() const;
/// @brief Creates stock HTTP response.
///
/// @param request Pointer to an object representing HTTP request.
/// @param status_code Status code of the response.
/// @return Pointer to an @ref isc::http::HttpResponseJson object
/// representing stock HTTP response.
virtual http::HttpResponsePtr
createStockHttpResponse(const http::HttpRequestPtr& request,
const http::HttpStatusCode& status_code) const;
/// @brief Indicates whether or not agent response emulation is enabled.
///
/// @return true if emulation is enabled.
bool emulateAgentResponse() {
return (emulate_agent_response_);
}
/// @brief Filter commands.
///
/// From RBAC code: if the access list is empty or the command
/// cannot be found just return.
///
/// @param request The HTTP request (for the HTTP version).
/// @param body The request body.
/// @param accept The accept access list.
http::HttpResponseJsonPtr
filterCommand(const http::HttpRequestPtr& request,
const data::ConstElementPtr& body,
const std::unordered_set<std::string>& accept);
/// @brief The server current authentication configuration.
///
/// Default to the empty HttpAuthConfigPtr.
///
/// @note: This is currently not used, except in unit-tests. For the time being,
/// we postponed writing the corresponding code in the HA, so http_auth_config_
/// is left to its empty default value.
static http::HttpAuthConfigPtr http_auth_config_;
/// @brief The server command accept list.
///
/// Default to the empty list which means to accept everything.
static std::unordered_set<std::string> command_accept_list_;
private:
/// @brief Creates un-finalized stock HTTP response.
///
/// The un-finalized response is the response that can't be sent over the
/// wire until @c finalize() is called, which commits the contents of the
/// message body.
///
/// @param request Pointer to an object representing HTTP request.
/// @param status_code Status code of the response.
/// @return Pointer to an @ref isc::http::HttpResponseJson object
/// representing stock HTTP response.
http::HttpResponsePtr
createStockHttpResponseInternal(const http::HttpRequestPtr& request,
const http::HttpStatusCode& status_code) const;
/// @brief Creates implementation specific HTTP response.
///
/// @param request Pointer to an object representing HTTP request.
/// @return Pointer to an object representing HTTP response.
virtual http::HttpResponsePtr
createDynamicHttpResponse(http::HttpRequestPtr request);
/// @brief Determines whether or not responses are enclosed in an Element::list.
/// Currently kea-ctrl-agent wraps all responses in a list, as it may have
/// response from more than one server. If this is true, we'll ensure
/// responses (other than error responses) are in a list.
bool emulate_agent_response_;
};
/// @brief Pointer to the @ref CmdResponseCreator.
typedef boost::shared_ptr<CmdResponseCreator> CmdResponseCreatorPtr;
} // end of namespace isc::config
} // end of namespace isc
#endif
|
