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 | // Copyright (C) 2019-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 <util/triplet.h>
#include <dhcpsrv/dhcpsrv_log.h>
#include <dhcpsrv/parsers/base_network_parser.h>
#include <util/optional.h>
#include <util/str.h>
using namespace isc::data;
using namespace isc::util;
namespace isc {
namespace dhcp {
void
BaseNetworkParser::parseCommon(const ConstElementPtr& network_data,
NetworkPtr& network) {
bool has_renew = network_data->contains("renew-timer");
bool has_rebind = network_data->contains("rebind-timer");
int64_t renew = -1;
int64_t rebind = -1;
if (has_renew) {
renew = getInteger(network_data, "renew-timer");
if (renew < 0) {
isc_throw(DhcpConfigError, "the value of renew-timer ("
<< renew << ") must be a positive number");
}
network->setT1(renew);
}
if (has_rebind) {
rebind = getInteger(network_data, "rebind-timer");
if (rebind < 0) {
isc_throw(DhcpConfigError, "the value of rebind-timer ("
<< rebind << ") must be a positive number");
}
network->setT2(rebind);
}
if (has_renew && has_rebind && (renew > rebind)) {
// The renew-timer value is too large and server logic
// later on will end up not sending it. Warn the user but
// allow the configuration to pass.
LOG_WARN(dhcpsrv_logger, DHCPSRV_CFGMGR_RENEW_GTR_REBIND)
.arg(network->getLabel())
.arg(renew)
.arg(rebind);
}
network->setValid(parseIntTriplet(network_data, "valid-lifetime"));
if (network_data->contains("store-extended-info")) {
network->setStoreExtendedInfo(getBoolean(network_data,
"store-extended-info"));
}
if (network_data->contains("reservations-global")) {
network->setReservationsGlobal(getBoolean(network_data,
"reservations-global"));
}
if (network_data->contains("reservations-in-subnet")) {
network->setReservationsInSubnet(getBoolean(network_data,
"reservations-in-subnet"));
}
if (network_data->contains("reservations-out-of-pool")) {
network->setReservationsOutOfPool(getBoolean(network_data,
"reservations-out-of-pool"));
}
}
void
BaseNetworkParser::parseTeePercents(const ConstElementPtr& network_data,
NetworkPtr& network) {
bool calculate_tee_times = network->getCalculateTeeTimes();
if (network_data->contains("calculate-tee-times")) {
calculate_tee_times = getBoolean(network_data, "calculate-tee-times");
network->setCalculateTeeTimes(calculate_tee_times);
}
Optional<double> t2_percent;
if (network_data->contains("t2-percent")) {
t2_percent = getDouble(network_data, "t2-percent");
}
Optional<double> t1_percent;
if (network_data->contains("t1-percent")) {
t1_percent = getDouble(network_data, "t1-percent");
}
if (calculate_tee_times) {
if (!t2_percent.unspecified() && ((t2_percent.get() <= 0.0) ||
(t2_percent.get() >= 1.0))) {
isc_throw(DhcpConfigError, "t2-percent: " << t2_percent.get()
<< " is invalid, it must be greater than 0.0 and less than 1.0");
}
if (!t1_percent.unspecified() && ((t1_percent.get() <= 0.0) ||
(t1_percent.get() >= 1.0))) {
isc_throw(DhcpConfigError, "t1-percent: " << t1_percent.get()
<< " is invalid it must be greater than 0.0 and less than 1.0");
}
if (!t1_percent.unspecified() && !t2_percent.unspecified() &&
(t1_percent.get() >= t2_percent.get())) {
isc_throw(DhcpConfigError, "t1-percent: " << t1_percent.get()
<< " is invalid, it must be less than t2-percent: "
<< t2_percent.get());
}
}
network->setT2Percent(t2_percent);
network->setT1Percent(t1_percent);
}
void
BaseNetworkParser::parseCacheParams(const ConstElementPtr& network_data,
NetworkPtr& network) {
if (network_data->contains("cache-threshold")) {
double cache_threshold = getDouble(network_data, "cache-threshold");
if ((cache_threshold <= 0.0) || (cache_threshold >= 1.0)) {
isc_throw(DhcpConfigError, "cache-threshold: " << cache_threshold
<< " is invalid, it must be greater than 0.0 and less than 1.0");
}
network->setCacheThreshold(cache_threshold);
}
if (network_data->contains("cache-max-age")) {
network->setCacheMaxAge(getInteger(network_data, "cache-max-age"));
}
}
void
BaseNetworkParser::parseDdnsParams(const data::ConstElementPtr& network_data,
NetworkPtr& network) {
if (network_data->contains("ddns-send-updates")) {
network->setDdnsSendUpdates(getBoolean(network_data, "ddns-send-updates"));
}
if (network_data->contains("ddns-override-no-update")) {
network->setDdnsOverrideNoUpdate(getBoolean(network_data, "ddns-override-no-update"));
}
if (network_data->contains("ddns-override-client-update")) {
network->setDdnsOverrideClientUpdate(getBoolean(network_data, "ddns-override-client-update"));
}
if (network_data->contains("ddns-replace-client-name")) {
network->setDdnsReplaceClientNameMode(getAndConvert<D2ClientConfig::ReplaceClientNameMode,
D2ClientConfig::stringToReplaceClientNameMode>
(network_data, "ddns-replace-client-name",
"ReplaceClientName mode"));
}
if (network_data->contains("ddns-generated-prefix")) {
network->setDdnsGeneratedPrefix(getString(network_data, "ddns-generated-prefix"));
}
if (network_data->contains("ddns-qualifying-suffix")) {
network->setDdnsQualifyingSuffix(getString(network_data, "ddns-qualifying-suffix"));
}
std::string hostname_char_set;
if (network_data->contains("hostname-char-set")) {
hostname_char_set = getString(network_data, "hostname-char-set");
network->setHostnameCharSet(hostname_char_set);
}
std::string hostname_char_replacement;
if (network_data->contains("hostname-char-replacement")) {
hostname_char_replacement = getString(network_data, "hostname-char-replacement");
network->setHostnameCharReplacement(hostname_char_replacement);
}
// We need to validate sanitizer values here so we can detect problems and
// cause a configuration. We don't retain the compilation because it's not
// something we can inherit.
if (!hostname_char_set.empty()) {
try {
str::StringSanitizerPtr sanitizer(new str::StringSanitizer(hostname_char_set,
hostname_char_replacement));
} catch (const std::exception& ex) {
isc_throw(BadValue, "hostname-char-set '" << hostname_char_set
<< "' is not a valid regular expression");
}
}
if (network_data->contains("ddns-update-on-renew")) {
network->setDdnsUpdateOnRenew(getBoolean(network_data, "ddns-update-on-renew"));
}
bool has_ddns_ttl = false;
uint32_t ddns_ttl = 0;<--- The scope of the variable 'ddns_ttl' can be reduced. [+]The scope of the variable 'ddns_ttl' 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:<--- Variable 'ddns_ttl' is assigned a value that is never used.
void f(int x)<--- Variable 'ddns_ttl' is assigned a value that is never used.
{<--- Variable 'ddns_ttl' is assigned a value that is never used.
int i = 0;<--- Variable 'ddns_ttl' is assigned a value that is never used.
if (x) {<--- Variable 'ddns_ttl' is assigned a value that is never used.
// it's safe to move 'int i = 0;' here<--- Variable 'ddns_ttl' is assigned a value that is never used.
for (int n = 0; n < 10; ++n) {<--- Variable 'ddns_ttl' is assigned a value that is never used.
// it is possible but not safe to move 'int i = 0;' here<--- Variable 'ddns_ttl' is assigned a value that is never used.
do_something(&i);<--- Variable 'ddns_ttl' is assigned a value that is never used.
}<--- Variable 'ddns_ttl' is assigned a value that is never used.
}<--- Variable 'ddns_ttl' is assigned a value that is never used.
}<--- Variable 'ddns_ttl' is assigned a value that is never used.
When you see this message it is always safe to reduce the variable scope 1 level. <--- Variable 'ddns_ttl' is assigned a value that is never used.
if (network_data->contains("ddns-ttl")) {
ddns_ttl = getInteger(network_data, "ddns-ttl");
network->setDdnsTtl(ddns_ttl);
has_ddns_ttl = true;
}
if (network_data->contains("ddns-ttl-percent")) {
if (has_ddns_ttl) {
isc_throw(BadValue, "cannot specify both ddns-ttl-percent and ddns-ttl");
}
network->setDdnsTtlPercent(getDouble(network_data, "ddns-ttl-percent"));
}
uint32_t ddns_ttl_min = 0;
if (network_data->contains("ddns-ttl-min")) {
if (has_ddns_ttl) {
isc_throw(BadValue, "cannot specify both ddns-ttl-min and ddns-ttl");
}
ddns_ttl_min = getInteger(network_data, "ddns-ttl-min");
network->setDdnsTtlMin(ddns_ttl_min);
}
if (network_data->contains("ddns-ttl-max")) {
if (has_ddns_ttl) {
isc_throw(BadValue, "cannot specify both ddns-ttl-max and ddns-ttl");
}
uint32_t ddns_ttl_max = getInteger(network_data, "ddns-ttl-max");
if (ddns_ttl_max < ddns_ttl_min) {
isc_throw(BadValue, "ddns-ttl-max: " << ddns_ttl_max
<< " must be greater than ddns-ttl-min: " << ddns_ttl_min);
}
network->setDdnsTtlMax(ddns_ttl_max);
}
// For backward compatibility, ddns-conflict-resolution-mode is optional.
if (network_data->contains("ddns-conflict-resolution-mode")) {
network->setDdnsConflictResolutionMode(getString(network_data,
"ddns-conflict-resolution-mode"));
}
}
void
BaseNetworkParser::parseAllocatorParams(const data::ConstElementPtr& network_data,
NetworkPtr& network) {
if (network_data->contains("allocator")) {
auto allocator_type = getString(network_data, "allocator");
if ((allocator_type != "iterative") && (allocator_type != "random") &&
(allocator_type != "flq")) {
// Unsupported allocator type used.
isc_throw(DhcpConfigError, "supported allocators are: iterative, random and flq");
}
network->setAllocatorType(allocator_type);
}
}
void
BaseNetworkParser::parsePdAllocatorParams(const data::ConstElementPtr& network_data,
Network6Ptr& network) {
if (network_data->contains("pd-allocator")) {
auto allocator_type = getString(network_data, "pd-allocator");
if ((allocator_type != "iterative") && (allocator_type != "random") &&
(allocator_type != "flq")) {
// Unsupported allocator type used.
isc_throw(DhcpConfigError, "supported allocators are: iterative, random and flq");
}
network->setPdAllocatorType(allocator_type);
}
}
void
BaseNetworkParser::parseOfferLft(const data::ConstElementPtr& network_data,
Network4Ptr& network) {
if (network_data->contains("offer-lifetime")) {
auto value = getInteger(network_data, "offer-lifetime");
if (value < 0) {
isc_throw(DhcpConfigError, "the value of offer-lifetime '"
<< value << "' must be a positive number ("
<< getPosition("offer-lifetime", network_data) << ")");
}
network->setOfferLft(value);
}
}
void
BaseNetworkParser::getAdditionalClassesElem(ConstElementPtr params,
ClassAdderFunc adder_func) {
// Try setting up additional client classes.
ConstElementPtr req_class_list = params->get("require-client-classes");
ConstElementPtr class_list = params->get("evaluate-additional-classes");
if (req_class_list) {
if (!class_list) {
LOG_WARN(dhcpsrv_logger, DHCPSRV_REQUIRE_CLIENT_CLASSES_DEPRECATED);
class_list = req_class_list;
} else {
isc_throw(isc::dhcp::DhcpConfigError,
"cannot specify both 'require-client-classes' and "
"'evaluate-additional-classes'. Use only the latter.");
}
}
if (class_list) {
const std::vector<data::ElementPtr>& classes = class_list->listValue();
for (auto const& cclass : classes) {
if ((cclass->getType() != Element::string) ||
cclass->stringValue().empty()) {
isc_throw(DhcpConfigError, "invalid class name (" << cclass->getPosition() << ")");
}
(adder_func)(cclass->stringValue());
}
}
}
void
BaseNetworkParser::getClientClassesElem(ConstElementPtr params,
ClassAdderFunc adder_func) {
// Try setting up client client classes.
ConstElementPtr class_elem = params->get("client-class");
ConstElementPtr class_list = params->get("client-classes");
if (class_elem) {
if (!class_list) {
LOG_WARN(dhcpsrv_logger, DHCPSRV_CLIENT_CLASS_DEPRECATED);
if (class_elem->getType() != Element::string) {
isc_throw(DhcpConfigError, "invalid class name (" << class_elem->getPosition() << ")");
}
if (!class_elem->stringValue().empty()) {
(adder_func)(class_elem->stringValue());
}
} else {
isc_throw(isc::dhcp::DhcpConfigError,
"cannot specify both 'client-class' and "
"'client-classes'. Use only the latter.");
}
}
if (class_list) {
for (auto const& cclass : class_list->listValue()) {
if ((cclass->getType() != Element::string) ||
cclass->stringValue().empty()) {
isc_throw(DhcpConfigError, "invalid class name (" << cclass->getPosition() << ")");
}
(adder_func)(cclass->stringValue());
}
}
}
} // end of namespace isc::dhcp
} // end of namespace isc
|