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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233 | // Copyright (C) 2015-2024 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/.
#include <config.h>
#include <cc/dhcp_config_error.h>
#include <config/http_command_config.h>
#include <http/basic_auth_config.h>
#include <limits><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace isc;
using namespace isc::asiolink;
using namespace isc::config;
using namespace isc::data;
using namespace isc::dhcp;
using namespace isc::http;
using namespace std;
namespace isc {
namespace config {
IOAddress HttpCommandConfig::DEFAULT_SOCKET_ADDRESS = IOAddress("127.0.0.1");
uint16_t HttpCommandConfig::DEFAULT_SOCKET_PORT = 8000;
string HttpCommandConfig::DEFAULT_AUTHENTICATION_REALM = "";
HttpCommandConfig::HttpCommandConfig(ConstElementPtr config)
: socket_type_("http"), socket_address_(DEFAULT_SOCKET_ADDRESS),
socket_port_(DEFAULT_SOCKET_PORT), auth_config_(),
trust_anchor_(""), cert_file_(""), key_file_(""), cert_required_(true),
emulate_agent_response_(true) {
if (config->getType() != Element::map) {
isc_throw(DhcpConfigError, "expected map type ("
<< config->getPosition() << ")");
}
// Get socket type.
ConstElementPtr socket_type = config->get("socket-type");
if (socket_type) {
if (socket_type->getType() != Element::string) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'socket-type' ("
<< socket_type->getPosition() << ")");
}
socket_type_ = socket_type->stringValue();
if ((socket_type_ != "http") && (socket_type_ != "https")) {
isc_throw(DhcpConfigError, "unsupported 'socket-type' '"
<< socket_type_ << "' not 'http' or 'https'");
}
}
// Reject UNIX only socket-name.
if (config->contains("socket-name")) {
isc_throw(DhcpConfigError,
"parameter 'socket-name' is not supported by HTTP "
"control sockets");
}
// Get socket address.
ConstElementPtr socket_address = config->get("socket-address");
if (socket_address) {
if (socket_address->getType() != Element::string) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'socket-address' ("
<< socket_address->getPosition() << ")");
}
try {
socket_address_ = IOAddress(socket_address->stringValue());
} catch (const std::exception& ex) {
isc_throw(DhcpConfigError, "failed to convert '"
<< socket_address->stringValue()
<< "' to address: " << ex.what()
<< " (" << socket_address->getPosition() << ")");
}
}
// Get socket port.
ConstElementPtr socket_port = config->get("socket-port");
if (socket_port) {
if (socket_port->getType() != Element::integer) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'socket-port' ("
<< socket_port->getPosition() << ")");
}
int64_t value = socket_port->intValue();
if ((value < numeric_limits<uint16_t>::min()) ||
(value > numeric_limits<uint16_t>::max())) {
isc_throw(DhcpConfigError,
"out of range value " << value
<< " specified for parameter 'socket-port' ("
<< socket_port->getPosition() << ")");
}
socket_port_ = static_cast<uint16_t>(value);
}
// Get HTTP authentication.
ConstElementPtr auth_config = config->get("authentication");
if (auth_config) {
ElementPtr mutable_auth_config =
boost::const_pointer_cast<Element>(auth_config);
if (auth_config->getType() != Element::map) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'authentication' ("
<< auth_config->getPosition() << ")");
}
// Default type is basic.
ConstElementPtr type = auth_config->get("type");
if (!type) {
mutable_auth_config->set("type", Element::create(string("basic")));
}
// Set default realm when not present.
ConstElementPtr realm = auth_config->get("realm");
if (!realm) {
mutable_auth_config->set("realm",
Element::create(DEFAULT_AUTHENTICATION_REALM));
}
BasicHttpAuthConfigPtr auth(new BasicHttpAuthConfig());
auth->parse(auth_config);
auth_config_ = auth;
}
// Get trust anchor.
ConstElementPtr trust_anchor = config->get("trust-anchor");
if (trust_anchor) {
if (trust_anchor->getType() != Element::string) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'trust-anchor' ("
<< trust_anchor->getPosition() << ")");
}
trust_anchor_ = trust_anchor->stringValue();
}
// Get cert file.
ConstElementPtr cert_file = config->get("cert-file");
if (cert_file) {
if (cert_file->getType() != Element::string) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'cert-file' ("
<< cert_file->getPosition() << ")");
}
cert_file_ = cert_file->stringValue();
}
// Get key file.
ConstElementPtr key_file = config->get("key-file");
if (key_file) {
if (key_file->getType() != Element::string) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'key-file' ("
<< key_file->getPosition() << ")");
}
key_file_ = key_file->stringValue();
}
// Get cert required.
ConstElementPtr cert_required = config->get("cert-required");
if (cert_required) {
if (cert_required->getType() != Element::boolean) {
isc_throw(DhcpConfigError,
"invalid type specified for parameter 'cert-required' ("
<< cert_required->getPosition() << ")");
}
cert_required_ = cert_required->boolValue();
}
// Check the TLS setup.
checkTlsSetup(socket_type_ == "https");
// Get user context.
ConstElementPtr user_context = config->get("user-context");
if (user_context) {
setContext(user_context);
}
}
void
HttpCommandConfig::checkTlsSetup(bool require_tls) const {
bool have_ca = !trust_anchor_.empty();
bool have_cert = !cert_file_.empty();
bool have_key = !key_file_.empty();
if (!have_ca && !have_cert && !have_key) {
if (require_tls) {
isc_throw(DhcpConfigError,
"no TLS setup for a HTTPS control socket");
}
return;
}
// TLS is used: all 3 parameters are required.
if (!have_ca) {
isc_throw(DhcpConfigError,
"trust-anchor parameter is missing or empty:"
" all or none of TLS parameters must be set");
}
if (!have_cert) {
isc_throw(DhcpConfigError, "cert-file parameter is missing or empty:"
" all or none of TLS parameters must be set");
}
if (!have_key) {
isc_throw(DhcpConfigError, "key-file parameter is missing or empty:"
" all or none of TLS parameters must be set");
}
}
ElementPtr
HttpCommandConfig::toElement() const {
ElementPtr result = Element::createMap();
// Set user-context.
contextToElement(result);
// Set socket type.
result->set("socket-type", Element::create(socket_type_));
// Set socket address.
result->set("socket-address", Element::create(socket_address_.toText()));
// Set socket port.
result->set("socket-port",
Element::create(static_cast<uint32_t>(socket_port_)));
/// Set authentication.
if (auth_config_) {
result->set("authentication", auth_config_->toElement());
}
// Set TLS setup when enabled.
if (!trust_anchor_.empty()) {
result->set("trust-anchor", Element::create(trust_anchor_));
result->set("cert-file", Element::create(cert_file_));
result->set("key-file", Element::create(key_file_));
result->set("cert-required", Element::create(cert_required_));
}
return (result);
}
} // end of isc::config
} // end of isc
|