Kea 3.0.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
158 { "name", Element::string },
159 { "code", Element::integer },
160 { "type", Element::string },
161 { "record-types", Element::string },
162 { "space", Element::string },
163 { "encapsulate", Element::string },
164 { "array", Element::boolean, },
165 { "user-context", Element::map },
166 { "comment", Element::string },
167 { "metadata", Element::map }
168};
169
175 { "record-types", Element::string, ""},
176 { "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
177 { "array", Element::boolean, "false"},
178 { "encapsulate", Element::string, "" }
179};
180
187 { "name", Element::string },
188 { "data", Element::string },
189 { "code", Element::integer },
190 { "space", Element::string },
191 { "csv-format", Element::boolean },
192 { "always-send", Element::boolean },
193 { "never-send", Element::boolean },
194 { "user-context", Element::map },
195 { "comment", Element::string },
196 { "client-classes", Element::list },
197 { "metadata", Element::map }
198};
199
206 { "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
207 { "csv-format", Element::boolean, "true"},
208 { "always-send", Element::boolean, "false"},
209 { "never-send", Element::boolean, "false"}
210};
211
218 { "valid-lifetime", Element::integer },
219 { "min-valid-lifetime", Element::integer },
220 { "max-valid-lifetime", Element::integer },
221 { "renew-timer", Element::integer },
222 { "rebind-timer", Element::integer },
223 { "option-data", Element::list },
224 { "pools", Element::list },
225 { "subnet", Element::string },
226 { "interface", Element::string },
227 { "id", Element::integer },
228 { "client-class", Element::string },
229 { "client-classes", Element::list },
230 { "require-client-classes", Element::list },
231 { "evaluate-additional-classes", Element::list },
232 { "reservations", Element::list },
233 { "reservations-global", Element::boolean },
234 { "reservations-in-subnet", Element::boolean },
235 { "reservations-out-of-pool", Element::boolean },
236 { "relay", Element::map },
237 { "match-client-id", Element::boolean },
238 { "authoritative", Element::boolean },
239 { "next-server", Element::string },
240 { "server-hostname", Element::string },
241 { "boot-file-name", Element::string },
242 { "4o6-interface", Element::string },
243 { "4o6-interface-id", Element::string },
244 { "4o6-subnet", Element::string },
245 { "user-context", Element::map },
246 { "comment", Element::string },
247 { "calculate-tee-times", Element::boolean },
248 { "t1-percent", Element::real },
249 { "t2-percent", Element::real },
250 { "ddns-send-updates", Element::boolean },
251 { "ddns-override-no-update", Element::boolean },
252 { "ddns-override-client-update", Element::boolean },
253 { "ddns-replace-client-name", Element::string },
254 { "ddns-generated-prefix", Element::string },
255 { "ddns-qualifying-suffix", Element::string },
256 { "hostname-char-set", Element::string },
257 { "hostname-char-replacement", Element::string },
258 { "store-extended-info", Element::boolean },
259 { "metadata", Element::map },
260 { "cache-threshold", Element::real },
261 { "cache-max-age", Element::integer },
262 { "ddns-update-on-renew", Element::boolean },
263 { "allocator", Element::string },
264 { "offer-lifetime", Element::integer },
265 { "ddns-ttl-percent", Element::real },
266 { "ddns-conflict-resolution-mode", Element::string },
267 { "ddns-ttl", Element::integer },
268 { "ddns-ttl-min", Element::integer },
269 { "ddns-ttl-max", Element::integer },
270};
271
280 { "interface", Element::string, "" },
281 { "4o6-interface", Element::string, "" },
282 { "4o6-interface-id", Element::string, "" },
283 { "4o6-subnet", Element::string, "" },
284};
285
293 { "4o6-interface", Element::string, "" },
294 { "4o6-interface-id", Element::string, "" },
295 { "4o6-subnet", Element::string, "" },
296};
297
300 { "interface", Element::string, "" }
301};
302
313 "rebind-timer",
314 "relay",
315 "renew-timer",
316 "valid-lifetime",
317 "min-valid-lifetime",
318 "max-valid-lifetime",
319 "calculate-tee-times",
320 "t1-percent",
321 "t2-percent",
322 "store-extended-info",
323 "cache-threshold",
324 "cache-max-age",
325 "allocator",
326 "offer-lifetime",
327};
328
335 { "pool", Element::string },
336 { "pool-id", Element::integer },
337 { "option-data", Element::list },
338 { "client-class", Element::string },
339 { "client-classes", Element::list },
340 { "require-client-classes", Element::list },
341 { "evaluate-additional-classes", Element::list },
342 { "user-context", Element::map },
343 { "comment", Element::string },
344 { "ddns-send-updates", Element::boolean },
345 { "ddns-override-no-update", Element::boolean },
346 { "ddns-override-client-update", Element::boolean },
347 { "ddns-replace-client-name", Element::string },
348 { "ddns-generated-prefix", Element::string },
349 { "ddns-qualifying-suffix", Element::string },
350 { "hostname-char-set", Element::string },
351 { "hostname-char-replacement", Element::string },
352 { "ddns-update-on-renew", Element::boolean },
353 { "ddns-ttl-percent", Element::real },
354 { "ddns-conflict-resolution-mode", Element::string },
355 { "ddns-ttl", Element::integer },
356 { "ddns-ttl-min", Element::integer },
357 { "ddns-ttl-max", Element::integer },
358 { "metadata", Element::map }
359};
360
367 { "name", Element::string },
368 { "subnet4", Element::list },
369 { "interface", Element::string },
370 { "renew-timer", Element::integer },
371 { "rebind-timer", Element::integer },
372 { "option-data", Element::list },
373 { "match-client-id", Element::boolean },
374 { "authoritative", Element::boolean },
375 { "next-server", Element::string },
376 { "server-hostname", Element::string },
377 { "boot-file-name", Element::string },
378 { "relay", Element::map },
379 { "reservations-global", Element::boolean },
380 { "reservations-in-subnet", Element::boolean },
381 { "reservations-out-of-pool", Element::boolean },
382 { "client-class", Element::string },
383 { "client-classes", Element::list },
384 { "require-client-classes", Element::list },
385 { "evaluate-additional-classes", Element::list },
386 { "valid-lifetime", Element::integer },
387 { "min-valid-lifetime", Element::integer },
388 { "max-valid-lifetime", Element::integer },
389 { "user-context", Element::map },
390 { "comment", Element::string },
391 { "calculate-tee-times", Element::boolean },
392 { "t1-percent", Element::real },
393 { "t2-percent", Element::real },
394 { "ddns-send-updates", Element::boolean },
395 { "ddns-override-no-update", Element::boolean },
396 { "ddns-override-client-update", Element::boolean },
397 { "ddns-replace-client-name", Element::string },
398 { "ddns-generated-prefix", Element::string },
399 { "ddns-qualifying-suffix", Element::string },
400 { "hostname-char-set", Element::string },
401 { "hostname-char-replacement", Element::string },
402 { "store-extended-info", Element::boolean },
403 { "metadata", Element::map },
404 { "cache-threshold", Element::real },
405 { "cache-max-age", Element::integer },
406 { "ddns-update-on-renew", Element::boolean },
407 { "allocator", Element::string },
408 { "offer-lifetime", Element::integer },
409 { "ddns-ttl-percent", Element::real },
410 { "ddns-conflict-resolution-mode", Element::string },
411 { "ddns-ttl", Element::integer },
412 { "ddns-ttl-min", Element::integer },
413 { "ddns-ttl-max", Element::integer },
414};
415
418 { "re-detect", Element::boolean, "true" }
419};
420
423 { "enable-queue", Element::boolean, "false"},
424 { "queue-type", Element::string, "kea-ring4"},
425 { "capacity", Element::integer, "64"}
426};
427
430 { "enable-multi-threading", Element::boolean, "true" },
431 { "thread-pool-size", Element::integer, "0" },
432 { "packet-queue-size", Element::integer, "64" }
433};
434
437 { "lease-checks", Element::string, "warn" }
438};
439
441
445
447 size_t cnt = 0;
448
449 // Set global defaults first.
450 cnt = setDefaults(global, GLOBAL4_DEFAULTS);
451
452 // Now set the defaults for each specified option definition
453 ConstElementPtr option_defs = global->get("option-def");
454 if (option_defs) {
455 cnt += setListDefaults(option_defs, OPTION4_DEF_DEFAULTS);
456 }
457
458 // Set the defaults for option data
459 ConstElementPtr options = global->get("option-data");
460 if (options) {
461 cnt += setListDefaults(options, OPTION4_DEFAULTS);
462 }
463
464 // Now set the defaults for defined subnets
465 ConstElementPtr subnets = global->get("subnet4");
466 if (subnets) {
467 cnt += setListDefaults(subnets, SUBNET4_DEFAULTS);
468 }
469
470 // Set the defaults for interfaces config
471 ConstElementPtr ifaces_cfg = global->get("interfaces-config");
472 if (ifaces_cfg) {
473 ElementPtr mutable_cfg = boost::const_pointer_cast<Element>(ifaces_cfg);
474 cnt += setDefaults(mutable_cfg, IFACE4_DEFAULTS);
475 }
476
477 // Set defaults for shared networks
478 ConstElementPtr shared = global->get("shared-networks");
479 if (shared) {
480 for (auto const& net : shared->listValue()) {
481
483
484 ConstElementPtr subs = net->get("subnet4");
485 if (subs) {
487 }
488 }
489 }
490
491 // Set the defaults for dhcp-queue-control. If the element isn't there
492 // we'll add it.
493 ConstElementPtr queue_control = global->get("dhcp-queue-control");
494 ElementPtr mutable_cfg;
495 if (queue_control) {
496 mutable_cfg = boost::const_pointer_cast<Element>(queue_control);
497 } else {
498 mutable_cfg = Element::createMap();
499 global->set("dhcp-queue-control", mutable_cfg);
500 }
501
502 cnt += setDefaults(mutable_cfg, DHCP_QUEUE_CONTROL4_DEFAULTS);
503
504 // Set the defaults for multi-threading. If the element isn't there
505 // we'll add it.
506 ConstElementPtr multi_threading = global->get("multi-threading");
507 if (multi_threading) {
508 mutable_cfg = boost::const_pointer_cast<Element>(multi_threading);
509 } else {
510 mutable_cfg = Element::createMap();
511 global->set("multi-threading", mutable_cfg);
512 }
513
514 cnt += setDefaults(mutable_cfg, DHCP_MULTI_THREADING4_DEFAULTS);
515
516 // Set the defaults for sanity-checks. If the element isn't
517 // there we'll add it.
518 ConstElementPtr sanity_checks = global->get("sanity-checks");
519 if (sanity_checks) {
520 mutable_cfg = boost::const_pointer_cast<Element>(sanity_checks);
521 } else {
522 mutable_cfg = Element::createMap();
523 global->set("sanity-checks", mutable_cfg);
524 }
525
526 cnt += setDefaults(mutable_cfg, SANITY_CHECKS4_DEFAULTS);
527
528 return (cnt);
529}
530
532 size_t cnt = 0;
533
534 // Now derive global parameters into subnets.
535 ConstElementPtr subnets = global->get("subnet4");
536 if (subnets) {
537 for (auto const& single_subnet : subnets->listValue()) {
538 cnt += SimpleParser::deriveParams(global, single_subnet,
540 }
541 }
542
543 // Deriving parameters for shared networks is a bit more involved.
544 // First, the shared-network level derives from global, and then
545 // subnets within derive from it.
546 ConstElementPtr shared = global->get("shared-networks");
547 if (shared) {
548 for (auto const& net : shared->listValue()) {
549 // First try to inherit the parameters from shared network,
550 // if defined there.
551 // Then try to inherit them from global.
552 cnt += SimpleParser::deriveParams(global, net,
554
555 // Now we need to go thrugh all the subnets in this net.
556 subnets = net->get("subnet4");
557 if (subnets) {
558 for (auto const& single_subnet : subnets->listValue()) {
559 cnt += SimpleParser::deriveParams(net, single_subnet,
561 }
562 }
563 }
564 }
565
566 return (cnt);
567}
568
569} // namespace dhcp
570} // 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 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.
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.