Kea 2.6.0
base_network_parser.cc
Go to the documentation of this file.
1// Copyright (C) 2019-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#include <util/triplet.h>
11#include <util/optional.h>
12#include <util/str.h>
13
14using namespace isc::data;
15using namespace isc::util;
16
17namespace isc {
18namespace dhcp {
19
20void
22 NetworkPtr& network) {
23 bool has_renew = network_data->contains("renew-timer");
24 bool has_rebind = network_data->contains("rebind-timer");
25 int64_t renew = -1;
26 int64_t rebind = -1;
27
28 if (has_renew) {
29 renew = getInteger(network_data, "renew-timer");
30 if (renew < 0) {
31 isc_throw(DhcpConfigError, "the value of renew-timer ("
32 << renew << ") must be a positive number");
33 }
34 network->setT1(renew);
35 }
36
37 if (has_rebind) {
38 rebind = getInteger(network_data, "rebind-timer");
39 if (rebind < 0) {
40 isc_throw(DhcpConfigError, "the value of rebind-timer ("
41 << rebind << ") must be a positive number");
42 }
43 network->setT2(rebind);
44 }
45
46 if (has_renew && has_rebind && (renew > rebind)) {
47 // The renew-timer value is too large and server logic
48 // later on will end up not sending it. Warn the user but
49 // allow the configuration to pass.
51 .arg(network->getLabel())
52 .arg(renew)
53 .arg(rebind);
54 }
55
56 network->setValid(parseIntTriplet(network_data, "valid-lifetime"));
57
58 if (network_data->contains("store-extended-info")) {
59 network->setStoreExtendedInfo(getBoolean(network_data,
60 "store-extended-info"));
61 }
62
63 if (network_data->contains("reservations-global")) {
64 network->setReservationsGlobal(getBoolean(network_data,
65 "reservations-global"));
66 }
67
68 if (network_data->contains("reservations-in-subnet")) {
69 network->setReservationsInSubnet(getBoolean(network_data,
70 "reservations-in-subnet"));
71 }
72
73 if (network_data->contains("reservations-out-of-pool")) {
74 network->setReservationsOutOfPool(getBoolean(network_data,
75 "reservations-out-of-pool"));
76 }
77}
78
79void
81 NetworkPtr& network) {
82 bool calculate_tee_times = network->getCalculateTeeTimes();
83 if (network_data->contains("calculate-tee-times")) {
84 calculate_tee_times = getBoolean(network_data, "calculate-tee-times");
85 network->setCalculateTeeTimes(calculate_tee_times);
86 }
87
88 Optional<double> t2_percent;
89 if (network_data->contains("t2-percent")) {
90 t2_percent = getDouble(network_data, "t2-percent");
91 }
92
93 Optional<double> t1_percent;
94 if (network_data->contains("t1-percent")) {
95 t1_percent = getDouble(network_data, "t1-percent");
96 }
97 if (calculate_tee_times) {
98 if (!t2_percent.unspecified() && ((t2_percent.get() <= 0.0) ||
99 (t2_percent.get() >= 1.0))) {
100 isc_throw(DhcpConfigError, "t2-percent: " << t2_percent.get()
101 << " is invalid, it must be greater than 0.0 and less than 1.0");
102 }
103
104 if (!t1_percent.unspecified() && ((t1_percent.get() <= 0.0) ||
105 (t1_percent.get() >= 1.0))) {
106 isc_throw(DhcpConfigError, "t1-percent: " << t1_percent.get()
107 << " is invalid it must be greater than 0.0 and less than 1.0");
108 }
109
110 if (!t1_percent.unspecified() && !t2_percent.unspecified() &&
111 (t1_percent.get() >= t2_percent.get())) {
112 isc_throw(DhcpConfigError, "t1-percent: " << t1_percent.get()
113 << " is invalid, it must be less than t2-percent: "
114 << t2_percent.get());
115 }
116 }
117
118 network->setT2Percent(t2_percent);
119 network->setT1Percent(t1_percent);
120}
121
122void
124 NetworkPtr& network) {
125 if (network_data->contains("cache-threshold")) {
126 double cache_threshold = getDouble(network_data, "cache-threshold");
127 if ((cache_threshold <= 0.0) || (cache_threshold >= 1.0)) {
128 isc_throw(DhcpConfigError, "cache-threshold: " << cache_threshold
129 << " is invalid, it must be greater than 0.0 and less than 1.0");
130 }
131 network->setCacheThreshold(cache_threshold);
132 }
133
134 if (network_data->contains("cache-max-age")) {
135 network->setCacheMaxAge(getInteger(network_data, "cache-max-age"));
136 }
137}
138
139void
141 NetworkPtr& network) {
142
143 if (network_data->contains("ddns-send-updates")) {
144 network->setDdnsSendUpdates(getBoolean(network_data, "ddns-send-updates"));
145 }
146
147 if (network_data->contains("ddns-override-no-update")) {
148 network->setDdnsOverrideNoUpdate(getBoolean(network_data, "ddns-override-no-update"));
149 }
150
151 if (network_data->contains("ddns-override-client-update")) {
152 network->setDdnsOverrideClientUpdate(getBoolean(network_data, "ddns-override-client-update"));
153 }
154
155 if (network_data->contains("ddns-replace-client-name")) {
156 network->setDdnsReplaceClientNameMode(getAndConvert<D2ClientConfig::ReplaceClientNameMode,
158 (network_data, "ddns-replace-client-name",
159 "ReplaceClientName mode"));
160 }
161
162 if (network_data->contains("ddns-generated-prefix")) {
163 network->setDdnsGeneratedPrefix(getString(network_data, "ddns-generated-prefix"));
164 }
165
166 if (network_data->contains("ddns-qualifying-suffix")) {
167 network->setDdnsQualifyingSuffix(getString(network_data, "ddns-qualifying-suffix"));
168 }
169
170 std::string hostname_char_set;
171 if (network_data->contains("hostname-char-set")) {
172 hostname_char_set = getString(network_data, "hostname-char-set");
173 network->setHostnameCharSet(hostname_char_set);
174 }
175
176 std::string hostname_char_replacement;
177 if (network_data->contains("hostname-char-replacement")) {
178 hostname_char_replacement = getString(network_data, "hostname-char-replacement");
179 network->setHostnameCharReplacement(hostname_char_replacement);
180 }
181
182 // We need to validate sanitizer values here so we can detect problems and
183 // cause a configuration. We don't retain the compilation because it's not
184 // something we can inherit.
185 if (!hostname_char_set.empty()) {
186 try {
187 str::StringSanitizerPtr sanitizer(new str::StringSanitizer(hostname_char_set,
188 hostname_char_replacement));
189 } catch (const std::exception& ex) {
190 isc_throw(BadValue, "hostname-char-set '" << hostname_char_set
191 << "' is not a valid regular expression");
192 }
193 }
194
195 if (network_data->contains("ddns-update-on-renew")) {
196 network->setDdnsUpdateOnRenew(getBoolean(network_data, "ddns-update-on-renew"));
197 }
198
199 if (network_data->contains("ddns-ttl-percent")) {
200 network->setDdnsTtlPercent(getDouble(network_data, "ddns-ttl-percent"));
201 }
202
203 // For backward compatibility, ddns-conflict-resolution-mode is optional.
204 if (network_data->contains("ddns-conflict-resolution-mode")) {
205 network->setDdnsConflictResolutionMode(getString(network_data,
206 "ddns-conflict-resolution-mode"));
207 }
208}
209
210void
212 NetworkPtr& network) {
213 if (network_data->contains("allocator")) {
214 auto allocator_type = getString(network_data, "allocator");
215 if ((allocator_type != "iterative") && (allocator_type != "random") &&
216 (allocator_type != "flq")) {
217 // Unsupported allocator type used.
218 isc_throw(DhcpConfigError, "supported allocators are: iterative, random and flq");
219 }
220 network->setAllocatorType(allocator_type);
221 }
222}
223
224void
226 Network6Ptr& network) {
227 if (network_data->contains("pd-allocator")) {
228 auto allocator_type = getString(network_data, "pd-allocator");
229 if ((allocator_type != "iterative") && (allocator_type != "random") &&
230 (allocator_type != "flq")) {
231 // Unsupported allocator type used.
232 isc_throw(DhcpConfigError, "supported allocators are: iterative, random and flq");
233 }
234 network->setPdAllocatorType(allocator_type);
235 }
236}
237
238void
240 Network4Ptr& network) {
241 if (network_data->contains("offer-lifetime")) {
242 auto value = getInteger(network_data, "offer-lifetime");
243 if (value < 0) {
244 isc_throw(DhcpConfigError, "the value of offer-lifetime '"
245 << value << "' must be a positive number ("
246 << getPosition("offer-lifetime", network_data) << ")");
247 }
248
249 network->setOfferLft(value);
250 }
251}
252
253
254} // end of namespace isc::dhcp
255} // end of namespace isc
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
target_type getAndConvert(isc::data::ConstElementPtr scope, const std::string &name, const std::string &type_name)
Returns a converted value from a scope.
static const data::Element::Position & getPosition(const std::string &name, const data::ConstElementPtr parent)
Utility method that returns position of an element.
static double getDouble(const ConstElementPtr &scope, const std::string &name)
Returns a floating point parameter from a scope.
static std::string getString(isc::data::ConstElementPtr scope, const std::string &name)
Returns a string parameter from a scope.
const isc::util::Triplet< uint32_t > parseIntTriplet(const data::ConstElementPtr &scope, const std::string &name)
Parses an integer triplet.
static bool getBoolean(isc::data::ConstElementPtr scope, const std::string &name)
Returns a boolean parameter from a scope.
static int64_t getInteger(isc::data::ConstElementPtr scope, const std::string &name)
Returns an integer parameter from a scope.
void parseCacheParams(const data::ConstElementPtr &network_data, NetworkPtr &network)
Parses parameters related to lease cache settings.
void parseAllocatorParams(const data::ConstElementPtr &network_data, NetworkPtr &network)
Parses parameters pertaining to allocator selection.
void parseDdnsParams(const data::ConstElementPtr &network_data, NetworkPtr &network)
Parses parameters pertaining to DDNS behavior.
void parseCommon(const data::ConstElementPtr &network_data, NetworkPtr &network)
Parses common parameters.
void parseTeePercents(const data::ConstElementPtr &network_data, NetworkPtr &network)
Parses parameters related to "percent" timers settings.
void parsePdAllocatorParams(const data::ConstElementPtr &network_data, Network6Ptr &network)
Parses parameters pertaining to prefix delegation allocator selection.
void parseOfferLft(const data::ConstElementPtr &network_data, Network4Ptr &network)
Parses offer-lifetime parameter (v4 only)
static ReplaceClientNameMode stringToReplaceClientNameMode(const std::string &mode_str)
Converts labels to ReplaceClientNameMode enum values.
ReplaceClientNameMode
Defines the client name replacement modes.
Definition: d2_client_cfg.h:76
To be removed. Please use ConfigError instead.
A template representing an optional value.
Definition: optional.h:36
T get() const
Retrieves the encapsulated value.
Definition: optional.h:114
void unspecified(bool unspecified)
Modifies the flag that indicates whether the value is specified or unspecified.
Definition: optional.h:136
Implements a regular expression based string scrubber.
Definition: str.h:222
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
#define LOG_WARN(LOGGER, MESSAGE)
Macro to conveniently test warn output and log it.
Definition: macros.h:26
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:29
isc::log::Logger dhcpsrv_logger("dhcpsrv")
DHCP server library Logger.
Definition: dhcpsrv_log.h:56
boost::shared_ptr< Network4 > Network4Ptr
Pointer to the Network4 object.
Definition: network.h:1413
const isc::log::MessageID DHCPSRV_CFGMGR_RENEW_GTR_REBIND
boost::shared_ptr< Network6 > Network6Ptr
Pointer to the Network6 object.
Definition: network.h:1418
boost::shared_ptr< Network > NetworkPtr
Pointer to the Network object.
Definition: network.h:73
std::unique_ptr< StringSanitizer > StringSanitizerPtr
Type representing the pointer to the StringSanitizer.
Definition: str.h:263
Defines the logger used by the top-level component of kea-lfc.