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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548 | // Copyright (C) 2016-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 <dhcpsrv/parsers/simple_parser4.h>
#include <cc/data.h>
#include <iostream><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
using namespace isc::data;
namespace isc {
namespace dhcp {
/// @brief This sets of arrays define the default values and
/// values inherited (derived) between various scopes.
///
/// Each of those is documented in @file simple_parser4.cc. This
/// is different than most other comments in Kea code. The reason
/// for placing those in .cc rather than .h file is that it
/// is expected to be one centralized place to look at for
/// the default values. This is expected to be looked at also by
/// people who are not skilled in C or C++, so they may be
/// confused with the differences between declaration and definition.
/// As such, there's one file to look at that hopefully is readable
/// without any C or C++ skills.
///
/// @{
/// @brief This table defines all global parameters in DHCPv4.
///
/// Boolean, integer, real and string types are for scalar parameters,
/// list and map types for entries.
/// Order follows global_param rule in bison grammar.
const SimpleKeywords SimpleParser4::GLOBAL4_PARAMETERS = {
{ "valid-lifetime", Element::integer },
{ "min-valid-lifetime", Element::integer },
{ "max-valid-lifetime", Element::integer },
{ "renew-timer", Element::integer },
{ "rebind-timer", Element::integer },
{ "decline-probation-period", Element::integer },
{ "subnet4", Element::list },
{ "shared-networks", Element::list },
{ "interfaces-config", Element::map },
{ "lease-database", Element::map },
{ "hosts-database", Element::map },
{ "hosts-databases", Element::list },
{ "host-reservation-identifiers", Element::list },
{ "client-classes", Element::list },
{ "option-def", Element::list },
{ "option-data", Element::list },
{ "hooks-libraries", Element::list },
{ "expired-leases-processing", Element::map },
{ "dhcp4o6-port", Element::integer },
{ "control-sockets", Element::list },
{ "dhcp-queue-control", Element::map },
{ "dhcp-ddns", Element::map },
{ "echo-client-id", Element::boolean },
{ "match-client-id", Element::boolean },
{ "authoritative", Element::boolean },
{ "next-server", Element::string },
{ "server-hostname", Element::string },
{ "boot-file-name", Element::string },
{ "user-context", Element::map },
{ "comment", Element::string },
{ "sanity-checks", Element::map },
{ "reservations", Element::list },
{ "config-control", Element::map },
{ "server-tag", Element::string },
{ "reservations-global", Element::boolean },
{ "reservations-in-subnet", Element::boolean },
{ "reservations-out-of-pool", Element::boolean },
{ "calculate-tee-times", Element::boolean },
{ "t1-percent", Element::real },
{ "t2-percent", Element::real },
{ "loggers", Element::list },
{ "hostname-char-set", Element::string },
{ "hostname-char-replacement", Element::string },
{ "ddns-send-updates", Element::boolean },
{ "ddns-override-no-update", Element::boolean },
{ "ddns-override-client-update", Element::boolean },
{ "ddns-replace-client-name", Element::string },
{ "ddns-generated-prefix", Element::string },
{ "ddns-qualifying-suffix", Element::string },
{ "store-extended-info", Element::boolean },
{ "statistic-default-sample-count", Element::integer },
{ "statistic-default-sample-age", Element::integer },
{ "multi-threading", Element::map },
{ "cache-threshold", Element::real },
{ "cache-max-age", Element::integer },
{ "early-global-reservations-lookup", Element::boolean },
{ "ip-reservations-unique", Element::boolean },
{ "reservations-lookup-first", Element::boolean },
{ "ddns-update-on-renew", Element::boolean },
{ "compatibility", Element::map },
{ "parked-packet-limit", Element::integer },
{ "allocator", Element::string },
{ "offer-lifetime", Element::integer },
{ "ddns-ttl-percent", Element::real },
{ "ddns-conflict-resolution-mode", Element::string },
{ "stash-agent-options", Element::boolean },
};
/// @brief This table defines default global values for DHCPv4
///
/// Some of the global parameters defined in the global scope (i.e. directly
/// in Dhcp4) are optional. If not defined, the following values will be
/// used.
const SimpleDefaults SimpleParser4::GLOBAL4_DEFAULTS = {
{ "valid-lifetime", Element::integer, "7200" },
{ "decline-probation-period", Element::integer, "86400" }, // 24h
{ "dhcp4o6-port", Element::integer, "0" },
{ "echo-client-id", Element::boolean, "true" },
{ "match-client-id", Element::boolean, "true" },
{ "authoritative", Element::boolean, "false" },
{ "next-server", Element::string, "0.0.0.0" },
{ "server-hostname", Element::string, "" },
{ "boot-file-name", Element::string, "" },
{ "server-tag", Element::string, "" },
{ "reservations-global", Element::boolean, "false" },
{ "reservations-in-subnet", Element::boolean, "true" },
{ "reservations-out-of-pool", Element::boolean, "false" },
{ "calculate-tee-times", Element::boolean, "false" },
{ "t1-percent", Element::real, ".50" },
{ "t2-percent", Element::real, ".875" },
{ "ddns-send-updates", Element::boolean, "true" },
{ "ddns-override-no-update", Element::boolean, "false" },
{ "ddns-override-client-update", Element::boolean, "false" },
{ "ddns-replace-client-name", Element::string, "never" },
{ "ddns-generated-prefix", Element::string, "myhost" },
{ "ddns-qualifying-suffix", Element::string, "" },
{ "hostname-char-set", Element::string, "[^A-Za-z0-9.-]" },
{ "hostname-char-replacement", Element::string, "" },
{ "store-extended-info", Element::boolean, "false" },
{ "statistic-default-sample-count", Element::integer, "20" },
{ "statistic-default-sample-age", Element::integer, "0" },
{ "early-global-reservations-lookup", Element::boolean, "false" },
{ "ip-reservations-unique", Element::boolean, "true" },
{ "reservations-lookup-first", Element::boolean, "false" },
{ "ddns-update-on-renew", Element::boolean, "false" },
{ "parked-packet-limit", Element::integer, "256" },
{ "allocator", Element::string, "iterative" },
{ "ddns-conflict-resolution-mode", Element::string, "check-with-dhcid" },
{ "stash-agent-options", Element::boolean, "false" },
};
/// @brief This table defines all option definition parameters.
///
/// Boolean, integer, real and string types are for scalar parameters,
/// list and map types for entries.
/// Order follows option_def_param rules in bison grammar.
const SimpleKeywords SimpleParser4::OPTION4_DEF_PARAMETERS = {
{ "name", Element::string },
{ "code", Element::integer },
{ "type", Element::string },
{ "record-types", Element::string },
{ "space", Element::string },
{ "encapsulate", Element::string },
{ "array", Element::boolean, },
{ "user-context", Element::map },
{ "comment", Element::string },
{ "metadata", Element::map }
};
/// @brief This table defines default values for option definitions in DHCPv4.
///
/// Dhcp4 may contain an array called option-def that enumerates new option
/// definitions. This array lists default values for those option definitions.
const SimpleDefaults SimpleParser4::OPTION4_DEF_DEFAULTS = {
{ "record-types", Element::string, ""},
{ "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
{ "array", Element::boolean, "false"},
{ "encapsulate", Element::string, "" }
};
/// @brief This table defines all option parameters.
///
/// Boolean, integer, real and string types are for scalar parameters,
/// list and map types for entries.
/// Order follows option_param rules in bison grammar.
const SimpleKeywords SimpleParser4::OPTION4_PARAMETERS = {
{ "name", Element::string },
{ "data", Element::string },
{ "code", Element::integer },
{ "space", Element::string },
{ "csv-format", Element::boolean },
{ "always-send", Element::boolean },
{ "never-send", Element::boolean },
{ "user-context", Element::map },
{ "comment", Element::string },
{ "client-classes", Element::list },
{ "metadata", Element::map }
};
/// @brief This table defines default values for options in DHCPv4.
///
/// Dhcp4 usually contains option values (option-data) defined in global,
/// subnet, class or host reservations scopes. This array lists default values
/// for those option-data declarations.
const SimpleDefaults SimpleParser4::OPTION4_DEFAULTS = {
{ "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
{ "csv-format", Element::boolean, "true"},
{ "always-send", Element::boolean, "false"},
{ "never-send", Element::boolean, "false"}
};
/// @brief This table defines all subnet parameters for DHCPv4.
///
/// Boolean, integer, real and string types are for scalar parameters,
/// list and map types for entries.
/// Order follows subnet4_param rule in bison grammar.
const SimpleKeywords SimpleParser4::SUBNET4_PARAMETERS = {
{ "valid-lifetime", Element::integer },
{ "min-valid-lifetime", Element::integer },
{ "max-valid-lifetime", Element::integer },
{ "renew-timer", Element::integer },
{ "rebind-timer", Element::integer },
{ "option-data", Element::list },
{ "pools", Element::list },
{ "subnet", Element::string },
{ "interface", Element::string },
{ "id", Element::integer },
{ "client-class", Element::string },
{ "require-client-classes", Element::list },
{ "evaluate-additional-classes", Element::list },
{ "reservations", Element::list },
{ "reservations-global", Element::boolean },
{ "reservations-in-subnet", Element::boolean },
{ "reservations-out-of-pool", Element::boolean },
{ "relay", Element::map },
{ "match-client-id", Element::boolean },
{ "authoritative", Element::boolean },
{ "next-server", Element::string },
{ "server-hostname", Element::string },
{ "boot-file-name", Element::string },
{ "4o6-interface", Element::string },
{ "4o6-interface-id", Element::string },
{ "4o6-subnet", Element::string },
{ "user-context", Element::map },
{ "comment", Element::string },
{ "calculate-tee-times", Element::boolean },
{ "t1-percent", Element::real },
{ "t2-percent", Element::real },
{ "ddns-send-updates", Element::boolean },
{ "ddns-override-no-update", Element::boolean },
{ "ddns-override-client-update", Element::boolean },
{ "ddns-replace-client-name", Element::string },
{ "ddns-generated-prefix", Element::string },
{ "ddns-qualifying-suffix", Element::string },
{ "hostname-char-set", Element::string },
{ "hostname-char-replacement", Element::string },
{ "store-extended-info", Element::boolean },
{ "metadata", Element::map },
{ "cache-threshold", Element::real },
{ "cache-max-age", Element::integer },
{ "ddns-update-on-renew", Element::boolean },
{ "allocator", Element::string },
{ "offer-lifetime", Element::integer },
{ "ddns-ttl-percent", Element::real },
{ "ddns-conflict-resolution-mode", Element::string },
};
/// @brief This table defines default values for each IPv4 subnet.
///
/// Note: When updating this array, please also update SHARED_SUBNET4_DEFAULTS
/// below. In most cases, those two should be kept in sync, except cases
/// where a parameter can be derived from shared-networks, but is not
/// defined on global level. Currently there in only one such parameter:
/// interface.
const SimpleDefaults SimpleParser4::SUBNET4_DEFAULTS = {
{ "interface", Element::string, "" },
{ "client-class", Element::string, "" },
{ "4o6-interface", Element::string, "" },
{ "4o6-interface-id", Element::string, "" },
{ "4o6-subnet", Element::string, "" },
};
/// @brief This table defines default values for each IPv4 subnet that is
/// part of a shared network
///
/// This is mostly the same as @ref SUBNET4_DEFAULTS, except one parameter
/// that can be derived from shared-network, but cannot from global scope.
/// This is: interface.
const SimpleDefaults SimpleParser4::SHARED_SUBNET4_DEFAULTS = {
{ "4o6-interface", Element::string, "" },
{ "4o6-interface-id", Element::string, "" },
{ "4o6-subnet", Element::string, "" },
};
/// @brief This table defines default values for each IPv4 shared network.
const SimpleDefaults SimpleParser4::SHARED_NETWORK4_DEFAULTS = {
{ "client-class", Element::string, "" },
{ "interface", Element::string, "" }
};
/// @brief List of parameters that can be inherited to subnet4 scope.
///
/// Some parameters may be defined on both global (directly in Dhcp4) and
/// subnet (Dhcp4/subnet4/...) scope. If not defined in the subnet scope,
/// the value is being inherited (derived) from the global scope. This
/// array lists all of such parameters.
///
/// This list is also used for inheriting from global to shared networks
/// and from shared networks to subnets within it.
const ParamsList SimpleParser4::INHERIT_TO_SUBNET4 = {
"rebind-timer",
"relay",
"renew-timer",
"valid-lifetime",
"min-valid-lifetime",
"max-valid-lifetime",
"calculate-tee-times",
"t1-percent",
"t2-percent",
"store-extended-info",
"cache-threshold",
"cache-max-age",
"allocator",
"offer-lifetime",
};
/// @brief This table defines all pool parameters.
///
/// Boolean, integer, real and string types are for scalar parameters,
/// list and map types for entries.
/// Order follows pool_param rules in bison grammar.
const SimpleKeywords SimpleParser4::POOL4_PARAMETERS = {
{ "pool", Element::string },
{ "pool-id", Element::integer },
{ "option-data", Element::list },
{ "client-class", Element::string },
{ "require-client-classes", Element::list },
{ "evaluate-additional-classes", Element::list },
{ "user-context", Element::map },
{ "comment", Element::string },
{ "metadata", Element::map }
};
/// @brief This table defines all shared network parameters for DHCPv4.
///
/// Boolean, integer, real and string types are for scalar parameters,
/// list and map types for entries.
/// Order follows shared_network_param rule in bison grammar.
const SimpleKeywords SimpleParser4::SHARED_NETWORK4_PARAMETERS = {
{ "name", Element::string },
{ "subnet4", Element::list },
{ "interface", Element::string },
{ "renew-timer", Element::integer },
{ "rebind-timer", Element::integer },
{ "option-data", Element::list },
{ "match-client-id", Element::boolean },
{ "authoritative", Element::boolean },
{ "next-server", Element::string },
{ "server-hostname", Element::string },
{ "boot-file-name", Element::string },
{ "relay", Element::map },
{ "reservations-global", Element::boolean },
{ "reservations-in-subnet", Element::boolean },
{ "reservations-out-of-pool", Element::boolean },
{ "client-class", Element::string },
{ "require-client-classes", Element::list },
{ "evaluate-additional-classes", Element::list },
{ "valid-lifetime", Element::integer },
{ "min-valid-lifetime", Element::integer },
{ "max-valid-lifetime", Element::integer },
{ "user-context", Element::map },
{ "comment", Element::string },
{ "calculate-tee-times", Element::boolean },
{ "t1-percent", Element::real },
{ "t2-percent", Element::real },
{ "ddns-send-updates", Element::boolean },
{ "ddns-override-no-update", Element::boolean },
{ "ddns-override-client-update", Element::boolean },
{ "ddns-replace-client-name", Element::string },
{ "ddns-generated-prefix", Element::string },
{ "ddns-qualifying-suffix", Element::string },
{ "hostname-char-set", Element::string },
{ "hostname-char-replacement", Element::string },
{ "store-extended-info", Element::boolean },
{ "metadata", Element::map },
{ "cache-threshold", Element::real },
{ "cache-max-age", Element::integer },
{ "ddns-update-on-renew", Element::boolean },
{ "allocator", Element::string },
{ "offer-lifetime", Element::integer },
{ "ddns-ttl-percent", Element::real },
{ "ddns-conflict-resolution-mode", Element::string },
};
/// @brief This table defines default values for interfaces for DHCPv4.
const SimpleDefaults SimpleParser4::IFACE4_DEFAULTS = {
{ "re-detect", Element::boolean, "true" }
};
/// @brief This table defines default values for dhcp-queue-control in DHCPv4.
const SimpleDefaults SimpleParser4::DHCP_QUEUE_CONTROL4_DEFAULTS = {
{ "enable-queue", Element::boolean, "false"},
{ "queue-type", Element::string, "kea-ring4"},
{ "capacity", Element::integer, "64"}
};
/// @brief This table defines default values for multi-threading in DHCPv4.
const SimpleDefaults SimpleParser4::DHCP_MULTI_THREADING4_DEFAULTS = {
{ "enable-multi-threading", Element::boolean, "true" },
{ "thread-pool-size", Element::integer, "0" },
{ "packet-queue-size", Element::integer, "64" }
};
/// @brief This defines default values for sanity checking for DHCPv4.
const SimpleDefaults SimpleParser4::SANITY_CHECKS4_DEFAULTS = {
{ "lease-checks", Element::string, "warn" }
};
/// @}
/// ---------------------------------------------------------------------------
/// --- end of default values -------------------------------------------------
/// ---------------------------------------------------------------------------
size_t SimpleParser4::setAllDefaults(ElementPtr global) {
size_t cnt = 0;
// Set global defaults first.
cnt = setDefaults(global, GLOBAL4_DEFAULTS);
// Now set option definition defaults for each specified option definition
ConstElementPtr option_defs = global->get("option-def");
if (option_defs) {
for (auto const& option_def : option_defs->listValue()) {
cnt += SimpleParser::setDefaults(option_def, OPTION4_DEF_DEFAULTS);
}
}
// Set the defaults for option data
ConstElementPtr options = global->get("option-data");
if (options) {
cnt += setListDefaults(options, OPTION4_DEFAULTS);
}
// Now set the defaults for defined subnets
ConstElementPtr subnets = global->get("subnet4");
if (subnets) {
cnt += setListDefaults(subnets, SUBNET4_DEFAULTS);
}
// Set the defaults for interfaces config
ConstElementPtr ifaces_cfg = global->get("interfaces-config");
if (ifaces_cfg) {
ElementPtr mutable_cfg = boost::const_pointer_cast<Element>(ifaces_cfg);
cnt += setDefaults(mutable_cfg, IFACE4_DEFAULTS);
}
// Set defaults for shared networks
ConstElementPtr shared = global->get("shared-networks");
if (shared) {
for (auto const& net : shared->listValue()) {
cnt += setDefaults(net, SHARED_NETWORK4_DEFAULTS);
ConstElementPtr subs = net->get("subnet4");
if (subs) {
cnt += setListDefaults(subs, SHARED_SUBNET4_DEFAULTS);
}
}
}
// Set the defaults for dhcp-queue-control. If the element isn't
// there we'll add it.
ConstElementPtr queue_control = global->get("dhcp-queue-control");
ElementPtr mutable_cfg;
if (queue_control) {
mutable_cfg = boost::const_pointer_cast<Element>(queue_control);
} else {
mutable_cfg = Element::createMap();
global->set("dhcp-queue-control", mutable_cfg);
}
cnt += setDefaults(mutable_cfg, DHCP_QUEUE_CONTROL4_DEFAULTS);
// Set the defaults for multi-threading. If the element isn't there
// we'll add it.
ConstElementPtr multi_threading = global->get("multi-threading");
if (multi_threading) {
mutable_cfg = boost::const_pointer_cast<Element>(multi_threading);
} else {
mutable_cfg = Element::createMap();
global->set("multi-threading", mutable_cfg);
}
cnt += setDefaults(mutable_cfg, DHCP_MULTI_THREADING4_DEFAULTS);
// Set the defaults for sanity-checks. If the element isn't
// there we'll add it.
ConstElementPtr sanity_checks = global->get("sanity-checks");
if (sanity_checks) {
mutable_cfg = boost::const_pointer_cast<Element>(sanity_checks);
} else {
mutable_cfg = Element::createMap();
global->set("sanity-checks", mutable_cfg);
}
cnt += setDefaults(mutable_cfg, SANITY_CHECKS4_DEFAULTS);
return (cnt);
}
size_t SimpleParser4::deriveParameters(ElementPtr global) {
size_t cnt = 0;
// Now derive global parameters into subnets.
ConstElementPtr subnets = global->get("subnet4");
if (subnets) {
for (auto const& single_subnet : subnets->listValue()) {
cnt += SimpleParser::deriveParams(global, single_subnet,
INHERIT_TO_SUBNET4);
}
}
// Deriving parameters for shared networks is a bit more involved.
// First, the shared-network level derives from global, and then
// subnets within derive from it.
ConstElementPtr shared = global->get("shared-networks");
if (shared) {
for (auto const& net : shared->listValue()) {
// First try to inherit the parameters from shared network,
// if defined there.
// Then try to inherit them from global.
cnt += SimpleParser::deriveParams(global, net,
INHERIT_TO_SUBNET4);
// Now we need to go thrugh all the subnets in this net.
subnets = net->get("subnet4");
if (subnets) {
for (auto const& single_subnet : subnets->listValue()) {
cnt += SimpleParser::deriveParams(net, single_subnet,
INHERIT_TO_SUBNET4);
}
}
}
}
return (cnt);
}
} // namespace dhcp
} // namespace isc
|