Kea 3.0.0
simple_parser6.cc
Go to the documentation of this file.
1// Copyright (C) 2016-2025 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#include <config.h>
8
9#include <cc/data.h>
11
12using namespace isc::data;
13
14namespace isc {
15namespace dhcp {
30
37 { "data-directory", Element::string },
38 { "preferred-lifetime", Element::integer },
39 { "min-preferred-lifetime", Element::integer },
40 { "max-preferred-lifetime", Element::integer },
41 { "valid-lifetime", Element::integer },
42 { "min-valid-lifetime", Element::integer },
43 { "max-valid-lifetime", Element::integer },
44 { "renew-timer", Element::integer },
45 { "rebind-timer", Element::integer },
46 { "decline-probation-period", Element::integer },
47 { "subnet6", Element::list },
48 { "shared-networks", Element::list },
49 { "interfaces-config", Element::map },
50 { "lease-database", Element::map },
51 { "hosts-database", Element::map },
52 { "hosts-databases", Element::list },
53 { "mac-sources", Element::list },
54 { "relay-supplied-options", Element::list },
55 { "host-reservation-identifiers", Element::list },
56 { "client-classes", Element::list },
57 { "option-def", Element::list },
58 { "option-data", Element::list },
59 { "hooks-libraries", Element::list },
60 { "expired-leases-processing", Element::map },
61 { "server-id", Element::map },
62 { "dhcp4o6-port", Element::integer },
63 { "control-sockets", Element::list },
64 { "dhcp-queue-control", Element::map },
65 { "dhcp-ddns", Element::map },
66 { "user-context", Element::map },
67 { "comment", Element::string },
68 { "sanity-checks", Element::map },
69 { "reservations", Element::list },
70 { "config-control", Element::map },
71 { "server-tag", Element::string },
72 { "reservations-global", Element::boolean },
73 { "reservations-in-subnet", Element::boolean },
74 { "reservations-out-of-pool", Element::boolean },
75 { "calculate-tee-times", Element::boolean },
76 { "t1-percent", Element::real },
77 { "t2-percent", Element::real },
78 { "loggers", Element::list },
79 { "hostname-char-set", Element::string },
80 { "hostname-char-replacement", Element::string },
81 { "ddns-send-updates", Element::boolean },
82 { "ddns-override-no-update", Element::boolean },
83 { "ddns-override-client-update", Element::boolean },
84 { "ddns-replace-client-name", Element::string },
85 { "ddns-generated-prefix", Element::string },
86 { "ddns-qualifying-suffix", Element::string },
87 { "store-extended-info", Element::boolean },
88 { "statistic-default-sample-count", Element::integer },
89 { "statistic-default-sample-age", Element::integer },
90 { "multi-threading", Element::map },
91 { "cache-threshold", Element::real },
92 { "cache-max-age", Element::integer },
93 { "early-global-reservations-lookup", Element::boolean },
94 { "ip-reservations-unique", Element::boolean },
95 { "reservations-lookup-first", Element::boolean },
96 { "ddns-update-on-renew", Element::boolean },
97 { "compatibility", Element::map },
98 { "parked-packet-limit", Element::integer },
99 { "allocator", Element::string },
100 { "pd-allocator", Element::string },
101 { "ddns-ttl-percent", Element::real },
102 { "ddns-conflict-resolution-mode", Element::string },
103 { "ddns-ttl", Element::integer },
104 { "ddns-ttl-min", Element::integer },
105 { "ddns-ttl-max", Element::integer },
106};
107
114 // preferred-lifetime is unspecified and defaults to 0.625 of valid-lifetime.
115 { "valid-lifetime", Element::integer, "7200" },
116 { "decline-probation-period", Element::integer, "86400" }, // 24h
117 { "dhcp4o6-port", Element::integer, "0" },
118 { "server-tag", Element::string, "" },
119 { "reservations-global", Element::boolean, "false" },
120 { "reservations-in-subnet", Element::boolean, "true" },
121 { "reservations-out-of-pool", Element::boolean, "false" },
122 { "calculate-tee-times", Element::boolean, "true" },
123 { "t1-percent", Element::real, ".50" },
124 { "t2-percent", Element::real, ".80" },
125 { "ddns-send-updates", Element::boolean, "true" },
126 { "ddns-override-no-update", Element::boolean, "false" },
127 { "ddns-override-client-update", Element::boolean, "false" },
128 { "ddns-replace-client-name", Element::string, "never" },
129 { "ddns-generated-prefix", Element::string, "myhost" },
130 { "ddns-qualifying-suffix", Element::string, "" },
131 { "hostname-char-set", Element::string, "[^A-Za-z0-9.-]" },
132 { "hostname-char-replacement", Element::string, "" },
133 { "store-extended-info", Element::boolean, "false" },
134 { "statistic-default-sample-count", Element::integer, "20" },
135 { "statistic-default-sample-age", Element::integer, "0" },
136 { "early-global-reservations-lookup", Element::boolean, "false" },
137 { "ip-reservations-unique", Element::boolean, "true" },
138 { "reservations-lookup-first", Element::boolean, "false" },
139 { "ddns-update-on-renew", Element::boolean, "false" },
140 { "parked-packet-limit", Element::integer, "256" },
141 { "allocator", Element::string, "iterative" },
142 { "pd-allocator", Element::string, "iterative" },
143 { "ddns-conflict-resolution-mode", Element::string, "check-with-dhcid" },
144 { "cache-threshold", Element::real, "0.25" },
145};
146
153 { "name", Element::string },
154 { "code", Element::integer },
155 { "type", Element::string },
156 { "record-types", Element::string },
157 { "space", Element::string },
158 { "encapsulate", Element::string },
159 { "array", Element::boolean, },
160 { "user-context", Element::map },
161 { "comment", Element::string },
162 { "metadata", Element::map }
163};
164
170 { "record-types", Element::string, ""},
171 { "space", Element::string, "dhcp6"}, // DHCP6_OPTION_SPACE
172 { "array", Element::boolean, "false"},
173 { "encapsulate", Element::string, "" }
174};
175
182 { "name", Element::string },
183 { "data", Element::string },
184 { "code", Element::integer },
185 { "space", Element::string },
186 { "csv-format", Element::boolean },
187 { "always-send", Element::boolean },
188 { "never-send", Element::boolean },
189 { "user-context", Element::map },
190 { "comment", Element::string },
191 { "client-classes", Element::list },
192 { "metadata", Element::map }
193};
194
201 { "space", Element::string, "dhcp6"}, // DHCP6_OPTION_SPACE
202 { "csv-format", Element::boolean, "true"},
203 { "always-send", Element::boolean, "false"},
204 { "never-send", Element::boolean, "false"}
205};
206
213 { "preferred-lifetime", Element::integer },
214 { "min-preferred-lifetime", Element::integer },
215 { "max-preferred-lifetime", Element::integer },
216 { "valid-lifetime", Element::integer },
217 { "min-valid-lifetime", Element::integer },
218 { "max-valid-lifetime", Element::integer },
219 { "renew-timer", Element::integer },
220 { "rebind-timer", Element::integer },
221 { "option-data", Element::list },
222 { "pools", Element::list },
223 { "pd-pools", Element::list },
224 { "subnet", Element::string },
225 { "interface", Element::string },
226 { "interface-id", Element::string },
227 { "id", Element::integer },
228 { "rapid-commit", Element::boolean },
229 { "client-class", Element::string },
230 { "client-classes", Element::list },
231 { "require-client-classes", Element::list },
232 { "evaluate-additional-classes", Element::list },
233 { "reservations", Element::list },
234 { "reservations-global", Element::boolean },
235 { "reservations-in-subnet", Element::boolean },
236 { "reservations-out-of-pool", Element::boolean },
237 { "relay", Element::map },
238 { "user-context", Element::map },
239 { "comment", Element::string },
240 { "calculate-tee-times", Element::boolean },
241 { "t1-percent", Element::real },
242 { "t2-percent", Element::real },
243 { "ddns-send-updates", Element::boolean },
244 { "ddns-override-no-update", Element::boolean },
245 { "ddns-override-client-update", Element::boolean },
246 { "ddns-replace-client-name", Element::string },
247 { "ddns-generated-prefix", Element::string },
248 { "ddns-qualifying-suffix", Element::string },
249 { "hostname-char-set", Element::string },
250 { "hostname-char-replacement", Element::string },
251 { "store-extended-info", Element::boolean },
252 { "metadata", Element::map },
253 { "cache-threshold", Element::real },
254 { "cache-max-age", Element::integer },
255 { "ddns-update-on-renew", Element::boolean },
256 { "allocator", Element::string },
257 { "pd-allocator", Element::string },
258 { "ddns-ttl-percent", Element::real },
259 { "ddns-conflict-resolution-mode", Element::string },
260 { "ddns-ttl", Element::integer },
261 { "ddns-ttl-min", Element::integer },
262 { "ddns-ttl-max", Element::integer },
263};
264
272 { "interface", Element::string, "" },
273 { "rapid-commit", Element::boolean, "false" }, // rapid-commit disabled by default
274 { "interface-id", Element::string, "" }
275};
276
283};
284
287 { "interface", Element::string, "" },
288 { "interface-id", Element::string, "" },
289 { "rapid-commit", Element::boolean, "false" } // rapid-commit disabled by default
290};
291
302 "preferred-lifetime",
303 "min-preferred-lifetime",
304 "max-preferred-lifetime",
305 "rebind-timer",
306 "relay",
307 "renew-timer",
308 "valid-lifetime",
309 "min-valid-lifetime",
310 "max-valid-lifetime",
311 "calculate-tee-times",
312 "t1-percent",
313 "t2-percent",
314 "store-extended-info",
315 "cache-threshold",
316 "cache-max-age",
317 "allocator",
318 "pd-allocator"
319};
320
327 { "pool", Element::string },
328 { "pool-id", Element::integer },
329 { "option-data", Element::list },
330 { "client-class", Element::string },
331 { "client-classes", Element::list },
332 { "require-client-classes", Element::list },
333 { "evaluate-additional-classes", Element::list },
334 { "user-context", Element::map },
335 { "comment", Element::string },
336 { "ddns-send-updates", Element::boolean },
337 { "ddns-override-no-update", Element::boolean },
338 { "ddns-override-client-update", Element::boolean },
339 { "ddns-replace-client-name", Element::string },
340 { "ddns-generated-prefix", Element::string },
341 { "ddns-qualifying-suffix", Element::string },
342 { "hostname-char-set", Element::string },
343 { "hostname-char-replacement", Element::string },
344 { "ddns-update-on-renew", Element::boolean },
345 { "ddns-ttl-percent", Element::real },
346 { "ddns-conflict-resolution-mode", Element::string },
347 { "ddns-ttl", Element::integer },
348 { "ddns-ttl-min", Element::integer },
349 { "ddns-ttl-max", Element::integer },
350 { "metadata", Element::map }
351};
352
359 { "prefix", Element::string },
360 { "prefix-len", Element::integer },
361 { "delegated-len", Element::integer },
362 { "pool-id", Element::integer },
363 { "option-data", Element::list },
364 { "client-class", Element::string },
365 { "client-classes", Element::list },
366 { "require-client-classes", Element::list },
367 { "evaluate-additional-classes", Element::list },
368 { "excluded-prefix", Element::string },
369 { "excluded-prefix-len", Element::integer },
370 { "user-context", Element::map },
371 { "comment", Element::string },
372 { "metadata", Element::map }
373};
374
381 { "name", Element::string },
382 { "subnet6", Element::list },
383 { "interface", Element::string },
384 { "interface-id", Element::string },
385 { "renew-timer", Element::integer },
386 { "rebind-timer", Element::integer },
387 { "option-data", Element::list },
388 { "relay", Element::map },
389 { "reservations-global", Element::boolean },
390 { "reservations-in-subnet", Element::boolean },
391 { "reservations-out-of-pool", Element::boolean },
392 { "client-class", Element::string },
393 { "client-classes", Element::list },
394 { "require-client-classes", Element::list },
395 { "evaluate-additional-classes", Element::list },
396 { "preferred-lifetime", Element::integer },
397 { "min-preferred-lifetime", Element::integer },
398 { "max-preferred-lifetime", Element::integer },
399 { "rapid-commit", Element::boolean },
400 { "valid-lifetime", Element::integer },
401 { "min-valid-lifetime", Element::integer },
402 { "max-valid-lifetime", Element::integer },
403 { "user-context", Element::map },
404 { "comment", Element::string },
405 { "calculate-tee-times", Element::boolean },
406 { "t1-percent", Element::real },
407 { "t2-percent", Element::real },
408 { "ddns-send-updates", Element::boolean },
409 { "ddns-override-no-update", Element::boolean },
410 { "ddns-override-client-update", Element::boolean },
411 { "ddns-replace-client-name", Element::string },
412 { "ddns-generated-prefix", Element::string },
413 { "ddns-qualifying-suffix", Element::string },
414 { "hostname-char-set", Element::string },
415 { "hostname-char-replacement", Element::string },
416 { "store-extended-info", Element::boolean },
417 { "metadata", Element::map },
418 { "cache-threshold", Element::real },
419 { "cache-max-age", Element::integer },
420 { "ddns-update-on-renew", Element::boolean },
421 { "allocator", Element::string },
422 { "pd-allocator", Element::string },
423 { "ddns-ttl-percent", Element::real },
424 { "ddns-conflict-resolution-mode", Element::string },
425 { "ddns-ttl", Element::integer },
426 { "ddns-ttl-min", Element::integer },
427 { "ddns-ttl-max", Element::integer },
428};
429
432 { "re-detect", Element::boolean, "true" }
433};
434
437 { "enable-queue", Element::boolean, "false"},
438 { "queue-type", Element::string, "kea-ring6"},
439 { "capacity", Element::integer, "64"}
440};
441
444 { "enable-multi-threading", Element::boolean, "true" },
445 { "thread-pool-size", Element::integer, "0" },
446 { "packet-queue-size", Element::integer, "64" }
447};
448
451 { "lease-checks", Element::string, "warn" }
452};
453
455
459
461 size_t cnt = 0;
462
463 // Set global defaults first.
464 cnt = setDefaults(global, GLOBAL6_DEFAULTS);
465
466 // Now set the defaults for each specified option definition
467 ConstElementPtr option_defs = global->get("option-def");
468 if (option_defs) {
469 cnt += setListDefaults(option_defs, OPTION6_DEF_DEFAULTS);
470 }
471
472 // Set the defaults for option data
473 ConstElementPtr options = global->get("option-data");
474 if (options) {
475 cnt += setListDefaults(options, OPTION6_DEFAULTS);
476 }
477
478 // Now set the defaults for defined subnets
479 ConstElementPtr subnets = global->get("subnet6");
480 if (subnets) {
481 cnt += setListDefaults(subnets, SUBNET6_DEFAULTS);
482 }
483
484 // Set the defaults for interfaces config
485 ConstElementPtr ifaces_cfg = global->get("interfaces-config");
486 if (ifaces_cfg) {
487 ElementPtr mutable_cfg = boost::const_pointer_cast<Element>(ifaces_cfg);
488 cnt += setDefaults(mutable_cfg, IFACE6_DEFAULTS);
489 }
490
491 // Set defaults for shared networks
492 ConstElementPtr shared = global->get("shared-networks");
493 if (shared) {
494 for (auto const& net : shared->listValue()) {
495
497
498 ConstElementPtr subs = net->get("subnet6");
499 if (subs) {
501 }
502 }
503 }
504
505 // Set the defaults for dhcp-queue-control. If the element isn't there
506 // we'll add it.
507 ConstElementPtr queue_control = global->get("dhcp-queue-control");
508 ElementPtr mutable_cfg;
509 if (queue_control) {
510 mutable_cfg = boost::const_pointer_cast<Element>(queue_control);
511 } else {
512 mutable_cfg = Element::createMap();
513 global->set("dhcp-queue-control", mutable_cfg);
514 }
515
516 cnt += setDefaults(mutable_cfg, DHCP_QUEUE_CONTROL6_DEFAULTS);
517
518 // Set the defaults for multi-threading. If the element isn't there
519 // we'll add it.
520 ConstElementPtr multi_threading = global->get("multi-threading");
521 if (multi_threading) {
522 mutable_cfg = boost::const_pointer_cast<Element>(multi_threading);
523 } else {
524 mutable_cfg = Element::createMap();
525 global->set("multi-threading", mutable_cfg);
526 }
527
528 cnt += setDefaults(mutable_cfg, DHCP_MULTI_THREADING6_DEFAULTS);
529
530 // Set the defaults for sanity-checks. If the element isn't
531 // there we'll add it.
532 ConstElementPtr sanity_checks = global->get("sanity-checks");
533 if (sanity_checks) {
534 mutable_cfg = boost::const_pointer_cast<Element>(sanity_checks);
535 } else {
536 mutable_cfg = Element::createMap();
537 global->set("sanity-checks", mutable_cfg);
538 }
539
540 cnt += setDefaults(mutable_cfg, SANITY_CHECKS6_DEFAULTS);
541
542 return (cnt);
543}
544
546 size_t cnt = 0;
547
548 // Now derive global parameters into subnets.
549 ConstElementPtr subnets = global->get("subnet6");
550 if (subnets) {
551 for (auto const& single_subnet : subnets->listValue()) {
552 cnt += SimpleParser::deriveParams(global, single_subnet,
554 }
555 }
556
557 // Deriving parameters for shared networks is a bit more involved.
558 // First, the shared-network level derives from global, and then
559 // subnets within derive from it.
560 ConstElementPtr shared = global->get("shared-networks");
561 if (shared) {
562 for (auto const& net : shared->listValue()) {
563 // First try to inherit the parameters from shared network,
564 // if defined there.
565 // Then try to inherit them from global.
566 cnt += SimpleParser::deriveParams(global, net,
568
569 // Now we need to go thrugh all the subnets in this net.
570 subnets = net->get("subnet6");
571 if (subnets) {
572 for (auto const& single_subnet : subnets->listValue()) {
573 cnt += SimpleParser::deriveParams(net, single_subnet,
575 }
576 }
577 }
578 }
579
580 return (cnt);
581}
582
583} // namespace dhcp
584} // namespace isc
static ElementPtr createMap(const Position &pos=ZERO_POSITION())
Creates an empty MapElement type ElementPtr.
Definition data.cc:304
static size_t setListDefaults(isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
Sets the default values for all entries in a list.
static size_t deriveParams(isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
Derives (inherits) parameters from parent scope to a child.
static size_t setDefaults(isc::data::ElementPtr scope, const SimpleDefaults &default_values)
Sets the default values.
static const isc::data::SimpleDefaults SHARED_SUBNET6_DEFAULTS
This table defines default values for each IPv6 subnet that is part of a shared network.
static const isc::data::SimpleDefaults SUBNET6_DEFAULTS
This table defines default values for each IPv6 subnet.
static const isc::data::SimpleDefaults DHCP_QUEUE_CONTROL6_DEFAULTS
This table defines default values for dhcp-queue-control in DHCPv6.
static const isc::data::SimpleKeywords POOL6_PARAMETERS
This table defines all pool parameters.
static const isc::data::SimpleKeywords SHARED_NETWORK6_PARAMETERS
This table defines all shared network parameters for DHCPv6.
static const isc::data::SimpleDefaults GLOBAL6_DEFAULTS
This table defines default global values for DHCPv6.
static const isc::data::SimpleKeywords SUBNET6_PARAMETERS
This table defines all subnet parameters for DHCPv6.
static const isc::data::SimpleDefaults IFACE6_DEFAULTS
This table defines default values for interfaces for DHCPv6.
static const isc::data::SimpleDefaults OPTION6_DEF_DEFAULTS
This table defines default values for option definitions in DHCPv6.
static const isc::data::SimpleKeywords GLOBAL6_PARAMETERS
This table defines all global parameters in DHCPv6.
static const isc::data::SimpleDefaults OPTION6_DEFAULTS
This table defines default values for options in DHCPv6.
static const isc::data::SimpleDefaults SHARED_NETWORK6_DEFAULTS
This table defines default values for each IPv6 shared network.
static const isc::data::SimpleKeywords OPTION6_PARAMETERS
This table defines all option parameters.
static size_t deriveParameters(isc::data::ElementPtr global)
Derives (inherits) all parameters from global to more specific scopes.
static size_t setAllDefaults(isc::data::ElementPtr global)
Sets all defaults for DHCPv6 configuration.
static const isc::data::SimpleKeywords OPTION6_DEF_PARAMETERS
This table defines all option definition parameters.
static const isc::data::SimpleDefaults DHCP_MULTI_THREADING6_DEFAULTS
This table defines default values for multi-threading in DHCPv6.
static const isc::data::ParamsList INHERIT_TO_SUBNET6
List of parameters that can be inherited from the global to subnet6 scope.
static const isc::data::SimpleDefaults SANITY_CHECKS6_DEFAULTS
This defines default values for sanity checking for DHCPv6.
static const isc::data::SimpleKeywords PD_POOL6_PARAMETERS
This table defines all prefix delegation pool parameters.
std::vector< std::string > ParamsList
This defines a list of all parameters that are derived (or inherited) between contexts.
boost::shared_ptr< const Element > ConstElementPtr
Definition data.h:29
std::vector< SimpleDefault > SimpleDefaults
This specifies all default values in a given scope (e.g. a subnet).
boost::shared_ptr< Element > ElementPtr
Definition data.h:28
std::map< std::string, isc::data::Element::types > SimpleKeywords
This specifies all accepted keywords with their types.
Defines the logger used by the top-level component of kea-lfc.