Kea 2.5.8
simple_parser4.cc
Go to the documentation of this file.
1// Copyright (C) 2016-2024 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
10#include <cc/data.h>
11#include <iostream>
12
13using namespace isc::data;
14
15namespace isc {
16namespace dhcp {
31
38 { "valid-lifetime", Element::integer },
39 { "min-valid-lifetime", Element::integer },
40 { "max-valid-lifetime", Element::integer },
41 { "renew-timer", Element::integer },
42 { "rebind-timer", Element::integer },
43 { "decline-probation-period", Element::integer },
44 { "subnet4", Element::list },
45 { "shared-networks", Element::list },
46 { "interfaces-config", Element::map },
47 { "lease-database", Element::map },
48 { "hosts-database", Element::map },
49 { "hosts-databases", Element::list },
50 { "host-reservation-identifiers", Element::list },
51 { "client-classes", Element::list },
52 { "option-def", Element::list },
53 { "option-data", Element::list },
54 { "hooks-libraries", Element::list },
55 { "expired-leases-processing", Element::map },
56 { "dhcp4o6-port", Element::integer },
57 { "control-socket", Element::map },
58 { "dhcp-queue-control", Element::map },
59 { "dhcp-ddns", Element::map },
60 { "echo-client-id", Element::boolean },
61 { "match-client-id", Element::boolean },
62 { "authoritative", Element::boolean },
63 { "next-server", Element::string },
64 { "server-hostname", Element::string },
65 { "boot-file-name", Element::string },
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 { "reservation-mode", Element::string },
73 { "reservations-global", Element::boolean },
74 { "reservations-in-subnet", Element::boolean },
75 { "reservations-out-of-pool", Element::boolean },
76 { "calculate-tee-times", Element::boolean },
77 { "t1-percent", Element::real },
78 { "t2-percent", Element::real },
79 { "loggers", Element::list },
80 { "hostname-char-set", Element::string },
81 { "hostname-char-replacement", Element::string },
82 { "ddns-send-updates", Element::boolean },
83 { "ddns-override-no-update", Element::boolean },
84 { "ddns-override-client-update", Element::boolean },
85 { "ddns-replace-client-name", Element::string },
86 { "ddns-generated-prefix", Element::string },
87 { "ddns-qualifying-suffix", Element::string },
88 { "store-extended-info", Element::boolean },
89 { "statistic-default-sample-count", Element::integer },
90 { "statistic-default-sample-age", Element::integer },
91 { "multi-threading", Element::map },
92 { "cache-threshold", Element::real },
93 { "cache-max-age", Element::integer },
94 { "early-global-reservations-lookup", Element::boolean },
95 { "ip-reservations-unique", Element::boolean },
96 { "reservations-lookup-first", Element::boolean },
97 { "ddns-update-on-renew", Element::boolean },
98 { "compatibility", Element::map },
99 { "parked-packet-limit", Element::integer },
100 { "allocator", Element::string },
101 { "offer-lifetime", Element::integer },
102 { "ddns-ttl-percent", Element::real },
103 { "ddns-conflict-resolution-mode", Element::string },
104};
105
112 { "valid-lifetime", Element::integer, "7200" },
113 { "decline-probation-period", Element::integer, "86400" }, // 24h
114 { "dhcp4o6-port", Element::integer, "0" },
115 { "echo-client-id", Element::boolean, "true" },
116 { "match-client-id", Element::boolean, "true" },
117 { "authoritative", Element::boolean, "false" },
118 { "next-server", Element::string, "0.0.0.0" },
119 { "server-hostname", Element::string, "" },
120 { "boot-file-name", Element::string, "" },
121 { "server-tag", Element::string, "" },
122 { "reservations-global", Element::boolean, "false" },
123 { "reservations-in-subnet", Element::boolean, "true" },
124 { "reservations-out-of-pool", Element::boolean, "false" },
125 { "calculate-tee-times", Element::boolean, "false" },
126 { "t1-percent", Element::real, ".50" },
127 { "t2-percent", Element::real, ".875" },
128 { "ddns-send-updates", Element::boolean, "true" },
129 { "ddns-override-no-update", Element::boolean, "false" },
130 { "ddns-override-client-update", Element::boolean, "false" },
131 { "ddns-replace-client-name", Element::string, "never" },
132 { "ddns-generated-prefix", Element::string, "myhost" },
133 { "ddns-qualifying-suffix", Element::string, "" },
134 { "hostname-char-set", Element::string, "[^A-Za-z0-9.-]" },
135 { "hostname-char-replacement", Element::string, "" },
136 { "store-extended-info", Element::boolean, "false" },
137 { "statistic-default-sample-count", Element::integer, "20" },
138 { "statistic-default-sample-age", Element::integer, "0" },
139 { "early-global-reservations-lookup", Element::boolean, "false" },
140 { "ip-reservations-unique", Element::boolean, "true" },
141 { "reservations-lookup-first", Element::boolean, "false" },
142 { "ddns-update-on-renew", Element::boolean, "false" },
143 { "parked-packet-limit", Element::integer, "256" },
144 { "allocator", Element::string, "iterative" },
145 { "ddns-conflict-resolution-mode", Element::string, "check-with-dhcid" },
146};
147
154 { "name", Element::string },
155 { "code", Element::integer },
156 { "type", Element::string },
157 { "record-types", Element::string },
158 { "space", Element::string },
159 { "encapsulate", Element::string },
160 { "array", Element::boolean, },
161 { "user-context", Element::map },
162 { "comment", Element::string },
163 { "metadata", Element::map }
164};
165
171 { "record-types", Element::string, ""},
172 { "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
173 { "array", Element::boolean, "false"},
174 { "encapsulate", Element::string, "" }
175};
176
183 { "name", Element::string },
184 { "data", Element::string },
185 { "code", Element::integer },
186 { "space", Element::string },
187 { "csv-format", Element::boolean },
188 { "always-send", Element::boolean },
189 { "never-send", Element::boolean },
190 { "user-context", Element::map },
191 { "comment", Element::string },
192 { "metadata", Element::map }
193};
194
201 { "space", Element::string, "dhcp4"}, // DHCP4_OPTION_SPACE
202 { "csv-format", Element::boolean, "true"},
203 { "always-send", Element::boolean, "false"},
204 { "never-send", Element::boolean, "false"}
205};
206
213 { "valid-lifetime", Element::integer },
214 { "min-valid-lifetime", Element::integer },
215 { "max-valid-lifetime", Element::integer },
216 { "renew-timer", Element::integer },
217 { "rebind-timer", Element::integer },
218 { "option-data", Element::list },
219 { "pools", Element::list },
220 { "subnet", Element::string },
221 { "interface", Element::string },
222 { "id", Element::integer },
223 { "client-class", Element::string },
224 { "require-client-classes", Element::list },
225 { "reservations", Element::list },
226 { "reservation-mode", Element::string },
227 { "reservations-global", Element::boolean },
228 { "reservations-in-subnet", Element::boolean },
229 { "reservations-out-of-pool", Element::boolean },
230 { "relay", Element::map },
231 { "match-client-id", Element::boolean },
232 { "authoritative", Element::boolean },
233 { "next-server", Element::string },
234 { "server-hostname", Element::string },
235 { "boot-file-name", Element::string },
236 { "4o6-interface", Element::string },
237 { "4o6-interface-id", Element::string },
238 { "4o6-subnet", Element::string },
239 { "user-context", Element::map },
240 { "comment", Element::string },
241 { "calculate-tee-times", Element::boolean },
242 { "t1-percent", Element::real },
243 { "t2-percent", Element::real },
244 { "ddns-send-updates", Element::boolean },
245 { "ddns-override-no-update", Element::boolean },
246 { "ddns-override-client-update", Element::boolean },
247 { "ddns-replace-client-name", Element::string },
248 { "ddns-generated-prefix", Element::string },
249 { "ddns-qualifying-suffix", Element::string },
250 { "hostname-char-set", Element::string },
251 { "hostname-char-replacement", Element::string },
252 { "store-extended-info", Element::boolean },
253 { "metadata", Element::map },
254 { "cache-threshold", Element::real },
255 { "cache-max-age", Element::integer },
256 { "ddns-update-on-renew", Element::boolean },
257 { "allocator", Element::string },
258 { "offer-lifetime", Element::integer },
259 { "ddns-ttl-percent", Element::real },
260 { "ddns-conflict-resolution-mode", Element::string },
261};
262
271 { "id", Element::integer, "0" }, // 0 means autogenerate
272 { "interface", Element::string, "" },
273 { "client-class", Element::string, "" },
274 { "4o6-interface", Element::string, "" },
275 { "4o6-interface-id", Element::string, "" },
276 { "4o6-subnet", Element::string, "" },
277};
278
286 { "id", Element::integer, "0" }, // 0 means autogenerate
287 { "4o6-interface", Element::string, "" },
288 { "4o6-interface-id", Element::string, "" },
289 { "4o6-subnet", Element::string, "" },
290};
291
294 { "client-class", Element::string, "" },
295 { "interface", Element::string, "" }
296};
297
308 "rebind-timer",
309 "relay",
310 "renew-timer",
311 "valid-lifetime",
312 "min-valid-lifetime",
313 "max-valid-lifetime",
314 "calculate-tee-times",
315 "t1-percent",
316 "t2-percent",
317 "store-extended-info",
318 "cache-threshold",
319 "cache-max-age",
320 "allocator",
321 "offer-lifetime",
322};
323
330 { "pool", Element::string },
331 { "pool-id", Element::integer },
332 { "option-data", Element::list },
333 { "client-class", Element::string },
334 { "require-client-classes", Element::list },
335 { "user-context", Element::map },
336 { "comment", Element::string },
337 { "metadata", Element::map }
338};
339
346 { "name", Element::string },
347 { "subnet4", Element::list },
348 { "interface", Element::string },
349 { "renew-timer", Element::integer },
350 { "rebind-timer", Element::integer },
351 { "option-data", Element::list },
352 { "match-client-id", Element::boolean },
353 { "authoritative", Element::boolean },
354 { "next-server", Element::string },
355 { "server-hostname", Element::string },
356 { "boot-file-name", Element::string },
357 { "relay", Element::map },
358 { "reservation-mode", Element::string },
359 { "reservations-global", Element::boolean },
360 { "reservations-in-subnet", Element::boolean },
361 { "reservations-out-of-pool", Element::boolean },
362 { "client-class", Element::string },
363 { "require-client-classes", Element::list },
364 { "valid-lifetime", Element::integer },
365 { "min-valid-lifetime", Element::integer },
366 { "max-valid-lifetime", Element::integer },
367 { "user-context", Element::map },
368 { "comment", Element::string },
369 { "calculate-tee-times", Element::boolean },
370 { "t1-percent", Element::real },
371 { "t2-percent", Element::real },
372 { "ddns-send-updates", Element::boolean },
373 { "ddns-override-no-update", Element::boolean },
374 { "ddns-override-client-update", Element::boolean },
375 { "ddns-replace-client-name", Element::string },
376 { "ddns-generated-prefix", Element::string },
377 { "ddns-qualifying-suffix", Element::string },
378 { "hostname-char-set", Element::string },
379 { "hostname-char-replacement", Element::string },
380 { "store-extended-info", Element::boolean },
381 { "metadata", Element::map },
382 { "cache-threshold", Element::real },
383 { "cache-max-age", Element::integer },
384 { "ddns-update-on-renew", Element::boolean },
385 { "allocator", Element::string },
386 { "offer-lifetime", Element::integer },
387 { "ddns-ttl-percent", Element::real },
388 { "ddns-conflict-resolution-mode", Element::string },
389};
390
393 { "re-detect", Element::boolean, "true" }
394};
395
398 { "enable-queue", Element::boolean, "false"},
399 { "queue-type", Element::string, "kea-ring4"},
400 { "capacity", Element::integer, "64"}
401};
402
405 { "enable-multi-threading", Element::boolean, "true" },
406 { "thread-pool-size", Element::integer, "0" },
407 { "packet-queue-size", Element::integer, "64" }
408};
409
412 { "lease-checks", Element::string, "warn" }
413};
414
416
420
422 size_t cnt = 0;
423
424 // Set global defaults first.
425 cnt = setDefaults(global, GLOBAL4_DEFAULTS);
426
427 // Now set option definition defaults for each specified option definition
428 ConstElementPtr option_defs = global->get("option-def");
429 if (option_defs) {
430 for (auto const& option_def : option_defs->listValue()) {
432 }
433 }
434
435 // Set the defaults for option data
436 ConstElementPtr options = global->get("option-data");
437 if (options) {
438 cnt += setListDefaults(options, OPTION4_DEFAULTS);
439 }
440
441 // Now set the defaults for defined subnets
442 ConstElementPtr subnets = global->get("subnet4");
443 if (subnets) {
444 cnt += setListDefaults(subnets, SUBNET4_DEFAULTS);
445 }
446
447 // Set the defaults for interfaces config
448 ConstElementPtr ifaces_cfg = global->get("interfaces-config");
449 if (ifaces_cfg) {
450 ElementPtr mutable_cfg = boost::const_pointer_cast<Element>(ifaces_cfg);
451 cnt += setDefaults(mutable_cfg, IFACE4_DEFAULTS);
452 }
453
454 // Set defaults for shared networks
455 ConstElementPtr shared = global->get("shared-networks");
456 if (shared) {
457 for (auto const& net : shared->listValue()) {
458
460
461 ConstElementPtr subs = net->get("subnet4");
462 if (subs) {
464 }
465 }
466 }
467
468 // Set the defaults for dhcp-queue-control. If the element isn't
469 // there we'll add it.
470 ConstElementPtr queue_control = global->get("dhcp-queue-control");
471 ElementPtr mutable_cfg;
472 if (queue_control) {
473 mutable_cfg = boost::const_pointer_cast<Element>(queue_control);
474 } else {
475 mutable_cfg = Element::createMap();
476 global->set("dhcp-queue-control", mutable_cfg);
477 }
478
479 cnt += setDefaults(mutable_cfg, DHCP_QUEUE_CONTROL4_DEFAULTS);
480
481 // Set the defaults for multi-threading. If the element isn't there
482 // we'll add it.
483 ConstElementPtr multi_threading = global->get("multi-threading");
484 if (multi_threading) {
485 mutable_cfg = boost::const_pointer_cast<Element>(multi_threading);
486 } else {
487 mutable_cfg = Element::createMap();
488 global->set("multi-threading", mutable_cfg);
489 }
490
491 cnt += setDefaults(mutable_cfg, DHCP_MULTI_THREADING4_DEFAULTS);
492
493 // Set the defaults for sanity-checks. If the element isn't
494 // there we'll add it.
495 ConstElementPtr sanity_checks = global->get("sanity-checks");
496 if (sanity_checks) {
497 mutable_cfg = boost::const_pointer_cast<Element>(sanity_checks);
498 } else {
499 mutable_cfg = Element::createMap();
500 global->set("sanity-checks", mutable_cfg);
501 }
502
503 cnt += setDefaults(mutable_cfg, SANITY_CHECKS4_DEFAULTS);
504
505 return (cnt);
506}
507
509 size_t cnt = 0;
510
511 // Now derive global parameters into subnets.
512 ConstElementPtr subnets = global->get("subnet4");
513 if (subnets) {
514 for (auto const& single_subnet : subnets->listValue()) {
515 cnt += SimpleParser::deriveParams(global, single_subnet,
517 }
518 }
519
520 // Deriving parameters for shared networks is a bit more involved.
521 // First, the shared-network level derives from global, and then
522 // subnets within derive from it.
523 ConstElementPtr shared = global->get("shared-networks");
524 if (shared) {
525 for (auto const& net : shared->listValue()) {
526 // First try to inherit the parameters from shared network,
527 // if defined there.
528 // Then try to inherit them from global.
529 cnt += SimpleParser::deriveParams(global, net,
531
532 // Now we need to go thrugh all the subnets in this net.
533 subnets = net->get("subnet4");
534 if (subnets) {
535 for (auto const& single_subnet : subnets->listValue()) {
536 cnt += SimpleParser::deriveParams(net, single_subnet,
538 }
539 }
540 }
541 }
542
543 return (cnt);
544}
545
546} // namespace dhcp
547} // 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 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.