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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453 | // Copyright (C) 2014-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 <asiolink/io_address.h>
#include <asiolink/addr_utilities.h>
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/parsers/host_reservation_parser.h>
#include <dhcpsrv/parsers/option_data_parser.h>
#include <boost/lexical_cast.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <algorithm><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <sys/socket.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <sstream><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <string><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace isc::asiolink;
using namespace isc::data;
namespace {
/// @brief Returns set of the supported parameters for DHCPv4.
///
/// This function returns the set of supported parameters for
/// host reservation in DHCPv4.
///
/// @param identifiers_only Indicates if the function should only
/// return supported host identifiers (if true) or all supported
/// parameters (if false).
const std::set<std::string>&
getSupportedParams4(const bool identifiers_only = false) {
// Holds set of host identifiers.
static std::set<std::string> identifiers_set;
// Holds set of all supported parameters, including identifiers.
static std::set<std::string> params_set;
// If this is first execution of this function, we need
// to initialize the set.
if (identifiers_set.empty()) {
identifiers_set.insert("hw-address");
identifiers_set.insert("duid");
identifiers_set.insert("circuit-id");
identifiers_set.insert("client-id");
identifiers_set.insert("flex-id");
}
// Copy identifiers and add all other parameters.
if (params_set.empty()) {
params_set = identifiers_set;
params_set.insert("hostname");
params_set.insert("ip-address");
params_set.insert("option-data");
params_set.insert("next-server");
params_set.insert("server-hostname");
params_set.insert("boot-file-name");
params_set.insert("client-classes");
params_set.insert("user-context");
}
return (identifiers_only ? identifiers_set : params_set);
}
/// @brief Returns set of the supported parameters for DHCPv6.
///
/// This function returns the set of supported parameters for
/// host reservation in DHCPv6.
///
/// @param identifiers_only Indicates if the function should only
/// return supported host identifiers (if true) or all supported
/// parameters (if false).
const std::set<std::string>&
getSupportedParams6(const bool identifiers_only = false) {
// Holds set of host identifiers.
static std::set<std::string> identifiers_set;
// Holds set of all supported parameters, including identifiers.
static std::set<std::string> params_set;
// If this is first execution of this function, we need
// to initialize the set.
if (identifiers_set.empty()) {
identifiers_set.insert("hw-address");
identifiers_set.insert("duid");
identifiers_set.insert("flex-id");
}
// Copy identifiers and add all other parameters.
if (params_set.empty()) {
params_set = identifiers_set;
params_set.insert("hostname");
params_set.insert("ip-addresses");
params_set.insert("prefixes");
params_set.insert("option-data");
params_set.insert("client-classes");
params_set.insert("user-context");
}
return (identifiers_only ? identifiers_set : params_set);
}
}
namespace isc {
namespace dhcp {
HostPtr
HostReservationParser::parse(const SubnetID& subnet_id,
isc::data::ConstElementPtr reservation_data,
bool encapsulate_options) {
return (parseInternal(subnet_id, reservation_data, encapsulate_options));
}
HostPtr
HostReservationParser::parseInternal(const SubnetID&,
isc::data::ConstElementPtr reservation_data,
bool) {
std::string identifier;<--- The scope of the variable 'identifier' can be reduced. [+]The scope of the variable 'identifier' can be reduced. Warning: Be careful when fixing this message, especially when there are inner loops. Here is an example where cppcheck will write that the scope for 'i' can be reduced:
void f(int x)
{
int i = 0;
if (x) {
// it's safe to move 'int i = 0;' here
for (int n = 0; n < 10; ++n) {
// it is possible but not safe to move 'int i = 0;' here
do_something(&i);
}
}
}
When you see this message it is always safe to reduce the variable scope 1 level.
std::string identifier_name;<--- The scope of the variable 'identifier_name' can be reduced. [+]The scope of the variable 'identifier_name' can be reduced. Warning: Be careful when fixing this message, especially when there are inner loops. Here is an example where cppcheck will write that the scope for 'i' can be reduced:
void f(int x)
{
int i = 0;
if (x) {
// it's safe to move 'int i = 0;' here
for (int n = 0; n < 10; ++n) {
// it is possible but not safe to move 'int i = 0;' here
do_something(&i);
}
}
}
When you see this message it is always safe to reduce the variable scope 1 level.
std::string hostname;<--- The scope of the variable 'hostname' can be reduced. [+]The scope of the variable 'hostname' can be reduced. Warning: Be careful when fixing this message, especially when there are inner loops. Here is an example where cppcheck will write that the scope for 'i' can be reduced:
void f(int x)
{
int i = 0;
if (x) {
// it's safe to move 'int i = 0;' here
for (int n = 0; n < 10; ++n) {
// it is possible but not safe to move 'int i = 0;' here
do_something(&i);
}
}
}
When you see this message it is always safe to reduce the variable scope 1 level.
ConstElementPtr user_context;
HostPtr host;
try {
// Gather those parameters that are common for both IPv4 and IPv6
// reservations.
for (auto const& element : reservation_data->mapValue()) {
// Check if we support this parameter.
if (!isSupportedParameter(element.first)) {
isc_throw(DhcpConfigError, "unsupported configuration"
" parameter '" << element.first << "'");
}
if (isIdentifierParameter(element.first)) {
if (!identifier.empty()) {
isc_throw(DhcpConfigError, "the '" << element.first
<< "' and '" << identifier_name
<< "' are mutually exclusive");
}
identifier = element.second->stringValue();
identifier_name = element.first;
} else if (element.first == "hostname") {
hostname = element.second->stringValue();
} else if (element.first == "user-context") {
user_context = element.second;
}
}
// Host identifier is a must.
if (identifier_name.empty()) {
// If there is no identifier specified, we have to display an
// error message and include the information what identifiers
// are supported.
std::ostringstream s;
for (auto const& param_name : getSupportedParameters(true)) {
if (s.tellp() != std::streampos(0)) {
s << ", ";
}
s << param_name;
}
isc_throw(DhcpConfigError, "one of the supported identifiers must"
" be specified for host reservation: "
<< s.str());
}
// Create a host object from the basic parameters we already parsed.
host.reset(new Host(identifier, identifier_name, SUBNET_ID_UNUSED,
SUBNET_ID_UNUSED, IOAddress("0.0.0.0"), hostname));
// Add user context
if (user_context) {
host->setContext(user_context);
}
} catch (const std::exception& ex) {
// Append line number where the error occurred.
isc_throw(DhcpConfigError, ex.what() << " ("
<< reservation_data->getPosition() << ")");
}
return (host);
}
bool
HostReservationParser::isIdentifierParameter(const std::string& param_name) const {
return (getSupportedParameters(true).count(param_name) > 0);
}
bool
HostReservationParser::isSupportedParameter(const std::string& param_name) const {
return (getSupportedParameters(false).count(param_name) > 0);
}
HostPtr
HostReservationParser4::parseInternal(const SubnetID& subnet_id,
isc::data::ConstElementPtr reservation_data,
bool encapsulate_options) {
HostPtr host = HostReservationParser::parseInternal(subnet_id, reservation_data,
encapsulate_options);
host->setIPv4SubnetID(subnet_id);
for (auto const& element : reservation_data->mapValue()) {
// For 'option-data' element we will use another parser which
// already returns errors with position appended, so don't
// surround it with try-catch.
if (element.first == "option-data") {
CfgOptionPtr cfg_option = host->getCfgOption4();
// This parser is converted to SimpleParser already. It
// parses the Element structure immediately, there's no need
// to go through build/commit phases.
OptionDataListParser parser(AF_INET);
parser.parse(cfg_option, element.second, encapsulate_options);
// Everything else should be surrounded with try-catch to append
// position.
} else {
try {
if (element.first == "ip-address") {
host->setIPv4Reservation(IOAddress(element.second->
stringValue()));
} else if (element.first == "next-server") {
host->setNextServer(IOAddress(element.second->stringValue()));
} else if (element.first == "server-hostname") {
host->setServerHostname(element.second->stringValue());
} else if (element.first == "boot-file-name") {
host->setBootFileName(element.second->stringValue());
} else if (element.first == "client-classes") {
for (auto const& class_element : element.second->listValue()) {
host->addClientClass4(class_element->stringValue());
}
}
} catch (const std::exception& ex) {
// Append line number where the error occurred.
isc_throw(DhcpConfigError, ex.what() << " ("
<< element.second->getPosition() << ")");
}
}
}
return (host);
}
const std::set<std::string>&
HostReservationParser4::getSupportedParameters(const bool identifiers_only) const {
return (getSupportedParams4(identifiers_only));
}
HostPtr
HostReservationParser6::parseInternal(const SubnetID& subnet_id,
isc::data::ConstElementPtr reservation_data,
bool encapsulate_options) {
HostPtr host = HostReservationParser::parseInternal(subnet_id, reservation_data,
encapsulate_options);
host->setIPv6SubnetID(subnet_id);
for (auto const& element : reservation_data->mapValue()) {
// Parse option values. Note that the configuration option parser
// returns errors with position information appended, so there is no
// need to surround it with try-clause (and rethrow with position
// appended).
if (element.first == "option-data") {
CfgOptionPtr cfg_option = host->getCfgOption6();
// This parser is converted to SimpleParser already. It
// parses the Element structure immediately, there's no need
// to go through build/commit phases.
OptionDataListParser parser(AF_INET6);
parser.parse(cfg_option, element.second, encapsulate_options);
} else if (element.first == "ip-addresses" || element.first == "prefixes") {
for (auto const& prefix_element : element.second->listValue()) {
try {
// For the IPv6 address the prefix length is 128 and the
// value specified in the list is a reserved address.
IPv6Resrv::Type resrv_type = IPv6Resrv::TYPE_NA;
std::string prefix = prefix_element->stringValue();
uint8_t prefix_len = 128;
// If we're dealing with prefixes, instead of addresses,
// we will have to extract the prefix length from the value
// specified in the following format: 2001:db8:2000::/64.
if (element.first == "prefixes") {
// The slash is mandatory for prefixes. If there is no
// slash, return an error.
size_t len_pos = prefix.find('/');
if (len_pos == std::string::npos) {
isc_throw(DhcpConfigError, "prefix reservation"
" requires prefix length be specified"
" in '" << prefix << "'");
// If there is nothing after the slash, we should also
// report an error.
} else if (len_pos >= prefix.length() - 1) {
isc_throw(DhcpConfigError, "prefix '" << prefix
<< "' requires length after '/'");
}
// Convert the prefix length from the string to the
// number. Note, that we don't use the uint8_t type
// as the lexical cast would expect a character, e.g.
// 'a', instead of prefix length, e.g. '64'.
try {
prefix_len = boost::lexical_cast<unsigned int>(prefix.substr(len_pos + 1));
} catch (const boost::bad_lexical_cast&) {
isc_throw(DhcpConfigError, "prefix length value '"
<< prefix.substr(len_pos + 1)
<< "' is invalid");
}
if ((prefix_len == 0) || (prefix_len > 128)) {
isc_throw(OutOfRange,
"'prefix-len' value must be in range of [1..128]");
}
// Remove the slash character and the prefix length
// from the parsed value.
prefix.erase(len_pos);
// Finally, set the reservation type.
resrv_type = IPv6Resrv::TYPE_PD;
if (prefix_len != 128) {
IOAddress addr(prefix);
IOAddress first_address = firstAddrInPrefix(addr, prefix_len);
if (first_address != addr) {
isc_throw(BadValue, "Prefix address: " << addr
<< " exceeds prefix/prefix-len pair: " << first_address
<< "/" << static_cast<uint32_t>(prefix_len));
}
}
}
// Create a reservation for an address or prefix.
host->addReservation(IPv6Resrv(resrv_type,
IOAddress(prefix),
prefix_len));
} catch (const std::exception& ex) {
// Append line number where the error occurred.
isc_throw(DhcpConfigError, ex.what() << " ("
<< prefix_element->getPosition() << ")");
}
}
} else if (element.first == "client-classes") {
try {
for (auto const& class_element : element.second->listValue()) {
host->addClientClass6(class_element->stringValue());
}
} catch (const std::exception& ex) {
// Append line number where the error occurred.
isc_throw(DhcpConfigError, ex.what() << " ("
<< element.second->getPosition() << ")");
}
}
}
return (host);
}
const std::set<std::string>&
HostReservationParser6::getSupportedParameters(const bool identifiers_only) const {
return (getSupportedParams6(identifiers_only));
}
HostReservationIdsParser::HostReservationIdsParser()
: staging_cfg_() {
}
void
HostReservationIdsParser::parse(isc::data::ConstElementPtr ids_list) {
parseInternal(ids_list);
}
void
HostReservationIdsParser::parseInternal(isc::data::ConstElementPtr ids_list) {
// Remove existing identifier types.
staging_cfg_->clearIdentifierTypes();
for (auto const& element : ids_list->listValue()) {
std::string id_name = element->stringValue();
try {
if (id_name != "auto") {
if (!isSupportedIdentifier(id_name)) {
isc_throw(isc::BadValue, "unsupported identifier '"
<< id_name << "'");
}
staging_cfg_->addIdentifierType(id_name);
} else {
// 'auto' is mutually exclusive with other values. If there
// are any values in the configuration already it means that
// some other values have already been specified.
if (!staging_cfg_->getIdentifierTypes().empty()) {
isc_throw(isc::BadValue, "if 'auto' keyword is used,"
" no other values can be specified within '"
"host-reservation-identifiers' list");
}
// Iterate over all identifier types and for those supported
// in a given context (DHCPv4 or DHCPv6) add the identifier type
// to the configuration.
for (unsigned int i = 0;
i <= static_cast<unsigned int>(Host::LAST_IDENTIFIER_TYPE);
++i) {
std::string supported_id_name =
Host::getIdentifierName(static_cast<Host::IdentifierType>(i));
if (isSupportedIdentifier(supported_id_name)) {
staging_cfg_->addIdentifierType(supported_id_name);
}
}
}
} catch (const std::exception& ex) {
// Append line number where the error occurred.
isc_throw(DhcpConfigError, ex.what() << " ("
<< element->getPosition() << ")");
}
}
// The parsed list must not be empty.
if (staging_cfg_->getIdentifierTypes().empty()) {
isc_throw(DhcpConfigError, "'host-reservation-identifiers' list must not"
" be empty (" << ids_list->getPosition() << ")");
}
}
HostReservationIdsParser4::HostReservationIdsParser4()
: HostReservationIdsParser() {
staging_cfg_ = CfgMgr::instance().getStagingCfg()->getCfgHostOperations4();
}
bool
HostReservationIdsParser4::isSupportedIdentifier(const std::string& id_name) const {
return (getSupportedParams4(true).count(id_name) > 0);
}
HostReservationIdsParser6::HostReservationIdsParser6()
: HostReservationIdsParser() {
staging_cfg_ = CfgMgr::instance().getStagingCfg()->getCfgHostOperations6();
}
bool
HostReservationIdsParser6::isSupportedIdentifier(const std::string& id_name) const {
return (getSupportedParams6(true).count(id_name) > 0);
}
} // end of namespace isc::dhcp
} // end of namespace isc
|