Kea 3.1.0
simple_parser4.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 { "valid-lifetime", Element::integer },
38 { "min-valid-lifetime", Element::integer },
39 { "max-valid-lifetime", Element::integer },
40 { "renew-timer", Element::integer },
41 { "rebind-timer", Element::integer },
42 { "decline-probation-period", Element::integer },
43 { "subnet4", Element::list },
44 { "shared-networks", Element::list },
45 { "interfaces-config", Element::map },
46 { "lease-database", Element::map },
47 { "hosts-database", Element::map },
48 { "hosts-databases", Element::list },
49 { "host-reservation-identifiers", Element::list },
50 { "client-classes", Element::list },
51 { "option-def", Element::list },
52 { "option-data", Element::list },
53 { "hooks-libraries", Element::list },
54 { "expired-leases-processing", Element::map },
55 { "dhcp4o6-port", Element::integer },
56 { "control-sockets", Element::list },
57 { "dhcp-queue-control", Element::map },
58 { "dhcp-ddns", Element::map },
59 { "echo-client-id", Element::boolean },
60 { "match-client-id", Element::boolean },
61 { "authoritative", Element::boolean },
62 { "next-server", Element::string },
63 { "server-hostname", Element::string },
64 { "boot-file-name", Element::string },
65 { "user-context", Element::map },
66 { "comment", Element::string },
67 { "sanity-checks", Element::map },
68 { "reservations", Element::list },
69 { "config-control", Element::map },
70 { "server-tag", Element::string },
71 { "reservations-global", Element::boolean },
72 { "reservations-in-subnet", Element::boolean },
73 { "reservations-out-of-pool", Element::boolean },
74 { "calculate-tee-times", Element::boolean },
75 { "t1-percent", Element::real },
76 { "t2-percent", Element::real },
77 { "loggers", Element::list },
78 { "hostname-char-set", Element::string },
79 { "hostname-char-replacement", Element::string },
80 { "ddns-send-updates", Element::boolean },
81 { "ddns-override-no-update", Element::boolean },
82 { "ddns-override-client-update", Element::boolean },
83 { "ddns-replace-client-name", Element::string },
84 { "ddns-generated-prefix", Element::string },
85 { "ddns-qualifying-suffix", Element::string },
86 { "store-extended-info", Element::boolean },
87 { "statistic-default-sample-count", Element::integer },
88 { "statistic-default-sample-age", Element::integer },
89 { "multi-threading", Element::map },
90 { "cache-threshold", Element::real },
91 { "cache-max-age", Element::integer },
92 { "early-global-reservations-lookup", Element::boolean },
93 { "ip-reservations-unique", Element::boolean },
94 { "reservations-lookup-first", Element::boolean },
95 { "ddns-update-on-renew", Element::boolean },
96 { "compatibility", Element::map },
97 { "parked-packet-limit", Element::integer },
98 { "allocator", Element::string },
99 { "offer-lifetime", Element::integer },
100 { "ddns-ttl-percent", Element::real },
101 { "ddns-conflict-resolution-mode", Element::string },
102 { "stash-agent-options", Element::boolean },
103 { "ddns-ttl", Element::integer },
104 { "ddns-ttl-min", Element::integer },
105 { "ddns-ttl-max", Element::integer },
106};
107
114 { "valid-lifetime", Element::integer, "7200" },
115 { "decline-probation-period", Element::integer, "86400" }, // 24h
116 { "dhcp4o6-port", Element::integer, "0" },
117 { "echo-client-id", Element::boolean, "true" },
118 { "match-client-id", Element::boolean, "true" },
119 { "authoritative", Element::boolean, "false" },
120 { "next-server", Element::string, "0.0.0.0" },
121 { "server-hostname", Element::string, "" },
122 { "boot-file-name", Element::string, "" },
123 { "server-tag", Element::string, "" },
124 { "reservations-global", Element::boolean, "false" },
125 { "reservations-in-subnet", Element::boolean, "true" },
126 { "reservations-out-of-pool", Element::boolean, "false" },
127 { "calculate-tee-times", Element::boolean, "false" },
128 { "t1-percent", Element::real, ".50" },
129 { "t2-percent", Element::real, ".875" },
130 { "ddns-send-updates", Element::boolean, "true" },
131 { "ddns-override-no-update", Element::boolean, "false" },
132 { "ddns-override-client-update", Element::boolean, "false" },
133 { "ddns-replace-client-name", Element::string, "never" },
134 { "ddns-generated-prefix", Element::string, "myhost" },
135 { "ddns-qualifying-suffix", Element::string, "" },
136 { "hostname-char-set", Element::string, "[^A-Za-z0-9.-]" },
137 { "hostname-char-replacement", Element::string, "" },
138 { "store-extended-info", Element::boolean, "false" },
139 { "statistic-default-sample-count", Element::integer, "20" },
140 { "statistic-default-sample-age", Element::integer, "0" },
141 { "early-global-reservations-lookup", Element::boolean, "false" },
142 { "ip-reservations-unique", Element::boolean, "true" },
143 { "reservations-lookup-first", Element::boolean, "false" },
144 { "ddns-update-on-renew", Element::boolean, "false" },
145 { "parked-packet-limit", Element::integer, "256" },
146 { "allocator", Element::string, "iterative" },
147 { "ddns-conflict-resolution-mode", Element::string, "check-with-dhcid" },
148 { "stash-agent-options", Element::boolean, "false" },
149 { "cache-threshold", Element::real, "0.25" },
150};
151
153 { "host-reservation-identifiers", Element::list },
154 /* not yet supported
155 { "interfaces-config.interfaces", Element::list },
156 */
157};
158
160 { "host-reservation-identifiers", Element::string },
161 /* not yet supported
162 { "interfaces-config.interfaces", Element::string },
163 */
164};
165
172 { "name", Element::string },
173 { "code", Element::integer },
174 { "type", Element::string },
175 { "record-types", Element::string },
176 { "space", Element::string },
177 { "encapsulate", Element::string },
178 { "array", Element::boolean, },
179 { "user-context", Element::map },
180 { "comment", Element::string },
181 { "metadata", Element::map }
182};
183
189 { "record-types", Element::string, ""},
190 { "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
191 { "array", Element::boolean, "false"},
192 { "encapsulate", Element::string, "" }
193};
194
201 { "name", Element::string },
202 { "data", Element::string },
203 { "code", Element::integer },
204 { "space", Element::string },
205 { "csv-format", Element::boolean },
206 { "always-send", Element::boolean },
207 { "never-send", Element::boolean },
208 { "user-context", Element::map },
209 { "comment", Element::string },
210 { "client-classes", Element::list },
211 { "metadata", Element::map }
212};
213
220 { "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
221 { "csv-format", Element::boolean, "true"},
222 { "always-send", Element::boolean, "false"},
223 { "never-send", Element::boolean, "false"}
224};
225
232 { "valid-lifetime", Element::integer },
233 { "min-valid-lifetime", Element::integer },
234 { "max-valid-lifetime", Element::integer },
235 { "renew-timer", Element::integer },
236 { "rebind-timer", Element::integer },
237 { "option-data", Element::list },
238 { "pools", Element::list },
239 { "subnet", Element::string },
240 { "interface", Element::string },
241 { "id", Element::integer },
242 { "client-class", Element::string },
243 { "client-classes", Element::list },
244 { "require-client-classes", Element::list },
245 { "evaluate-additional-classes", Element::list },
246 { "reservations", Element::list },
247 { "reservations-global", Element::boolean },
248 { "reservations-in-subnet", Element::boolean },
249 { "reservations-out-of-pool", Element::boolean },
250 { "relay", Element::map },
251 { "match-client-id", Element::boolean },
252 { "authoritative", Element::boolean },
253 { "next-server", Element::string },
254 { "server-hostname", Element::string },
255 { "boot-file-name", Element::string },
256 { "4o6-interface", Element::string },
257 { "4o6-interface-id", Element::string },
258 { "4o6-subnet", Element::string },
259 { "user-context", Element::map },
260 { "comment", Element::string },
261 { "calculate-tee-times", Element::boolean },
262 { "t1-percent", Element::real },
263 { "t2-percent", Element::real },
264 { "ddns-send-updates", Element::boolean },
265 { "ddns-override-no-update", Element::boolean },
266 { "ddns-override-client-update", Element::boolean },
267 { "ddns-replace-client-name", Element::string },
268 { "ddns-generated-prefix", Element::string },
269 { "ddns-qualifying-suffix", Element::string },
270 { "hostname-char-set", Element::string },
271 { "hostname-char-replacement", Element::string },
272 { "store-extended-info", Element::boolean },
273 { "metadata", Element::map },
274 { "cache-threshold", Element::real },
275 { "cache-max-age", Element::integer },
276 { "ddns-update-on-renew", Element::boolean },
277 { "allocator", Element::string },
278 { "offer-lifetime", Element::integer },
279 { "ddns-ttl-percent", Element::real },
280 { "ddns-conflict-resolution-mode", Element::string },
281 { "ddns-ttl", Element::integer },
282 { "ddns-ttl-min", Element::integer },
283 { "ddns-ttl-max", Element::integer },
284};
285
294 { "interface", Element::string, "" },
295 { "4o6-interface", Element::string, "" },
296 { "4o6-interface-id", Element::string, "" },
297 { "4o6-subnet", Element::string, "" },
298};
299
307 { "4o6-interface", Element::string, "" },
308 { "4o6-interface-id", Element::string, "" },
309 { "4o6-subnet", Element::string, "" },
310};
311
314 { "interface", Element::string, "" }
315};
316
327 "rebind-timer",
328 "relay",
329 "renew-timer",
330 "valid-lifetime",
331 "min-valid-lifetime",
332 "max-valid-lifetime",
333 "calculate-tee-times",
334 "t1-percent",
335 "t2-percent",
336 "store-extended-info",
337 "cache-threshold",
338 "cache-max-age",
339 "allocator",
340 "offer-lifetime",
341};
342
349 { "pool", Element::string },
350 { "pool-id", Element::integer },
351 { "option-data", Element::list },
352 { "client-class", Element::string },
353 { "client-classes", Element::list },
354 { "require-client-classes", Element::list },
355 { "evaluate-additional-classes", Element::list },
356 { "user-context", Element::map },
357 { "comment", Element::string },
358 { "ddns-send-updates", Element::boolean },
359 { "ddns-override-no-update", Element::boolean },
360 { "ddns-override-client-update", Element::boolean },
361 { "ddns-replace-client-name", Element::string },
362 { "ddns-generated-prefix", Element::string },
363 { "ddns-qualifying-suffix", Element::string },
364 { "hostname-char-set", Element::string },
365 { "hostname-char-replacement", Element::string },
366 { "ddns-update-on-renew", Element::boolean },
367 { "ddns-ttl-percent", Element::real },
368 { "ddns-conflict-resolution-mode", Element::string },
369 { "ddns-ttl", Element::integer },
370 { "ddns-ttl-min", Element::integer },
371 { "ddns-ttl-max", Element::integer },
372 { "metadata", Element::map }
373};
374
381 { "name", Element::string },
382 { "subnet4", Element::list },
383 { "interface", Element::string },
384 { "renew-timer", Element::integer },
385 { "rebind-timer", Element::integer },
386 { "option-data", Element::list },
387 { "match-client-id", Element::boolean },
388 { "authoritative", Element::boolean },
389 { "next-server", Element::string },
390 { "server-hostname", Element::string },
391 { "boot-file-name", Element::string },
392 { "relay", Element::map },
393 { "reservations-global", Element::boolean },
394 { "reservations-in-subnet", Element::boolean },
395 { "reservations-out-of-pool", Element::boolean },
396 { "client-class", Element::string },
397 { "client-classes", Element::list },
398 { "require-client-classes", Element::list },
399 { "evaluate-additional-classes", Element::list },
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 { "offer-lifetime", Element::integer },
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-ring4"},
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, GLOBAL4_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, OPTION4_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, OPTION4_DEFAULTS);
476 }
477
478 // Now set the defaults for defined subnets
479 ConstElementPtr subnets = global->get("subnet4");
480 if (subnets) {
481 cnt += setListDefaults(subnets, SUBNET4_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, IFACE4_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("subnet4");
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_CONTROL4_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_THREADING4_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_CHECKS4_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("subnet4");
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("subnet4");
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 DHCP_MULTI_THREADING4_DEFAULTS
This table defines default values for multi-threading in DHCPv4.
static const isc::data::SimpleDefaults SUBNET4_DEFAULTS
This table defines default values for each IPv4 subnet.
static const isc::data::SimpleKeywords SUBNET4_PARAMETERS
This table defines all subnet parameters for DHCPv4.
static const isc::data::SimpleKeywords GLOBAL4_PARAMETERS
This table defines all global parameters in DHCPv4.
static const isc::data::SimpleDefaults GLOBAL4_DEFAULTS
This table defines default global values for DHCPv4.
static const isc::data::ParamsList INHERIT_TO_SUBNET4
List of parameters that can be inherited from the global to subnet4 scope.
static const isc::data::SimpleDefaults IFACE4_DEFAULTS
This table defines default values for interfaces for DHCPv4.
static const isc::data::SimpleKeywords OPTION4_DEF_PARAMETERS
This table defines all option definition parameters.
static const isc::data::SimpleDefaults SHARED_NETWORK4_DEFAULTS
This table defines default values for each IPv4 shared network.
static const isc::data::SimpleKeywords OPTION4_PARAMETERS
This table defines all option parameters.
static const isc::data::SimpleKeywords POOL4_PARAMETERS
This table defines all pool parameters.
static const isc::data::SimpleKeywords GLOBAL4_LIST_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 DHCPv4 configuration.
static const isc::data::SimpleDefaults SHARED_SUBNET4_DEFAULTS
This table defines default values for each IPv4 subnet that is part of a shared network.
static const isc::data::SimpleDefaults OPTION4_DEFAULTS
This table defines default values for options in DHCPv4.
static const isc::data::SimpleKeywords SHARED_NETWORK4_PARAMETERS
This table defines all shared network parameters for DHCPv4.
static const isc::data::SimpleDefaults SANITY_CHECKS4_DEFAULTS
This defines default values for sanity checking for DHCPv4.
static const isc::data::SimpleDefaults DHCP_QUEUE_CONTROL4_DEFAULTS
This table defines default values for dhcp-queue-control in DHCPv4.
static const isc::data::SimpleDefaults OPTION4_DEF_DEFAULTS
This table defines default values for option definitions in DHCPv4.
static const isc::data::SimpleKeywords GLOBAL4_LIST_PARAMETER_TYPES
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.