Kea 2.6.0
d2_client_mgr.h
Go to the documentation of this file.
1// Copyright (C) 2014-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#ifndef D2_CLIENT_MGR_H
8#define D2_CLIENT_MGR_H
9
14#include <asiolink/io_address.h>
15#include <dhcp_ddns/ncr_io.h>
17#include <dhcpsrv/srv_config.h>
19#include <util/str.h>
20
21#include <boost/algorithm/string.hpp>
22#include <boost/shared_ptr.hpp>
23#include <boost/noncopyable.hpp>
24
25#include <stdint.h>
26#include <string>
27#include <vector>
28#include <sstream>
29
30namespace isc {
31namespace dhcp {
32
43typedef
44std::function<void(const dhcp_ddns::NameChangeSender::Result result,
46
81 boost::noncopyable {
82public:
88
91
96 void setD2ClientConfig(D2ClientConfigPtr& new_config);
97
101 bool ddnsEnabled();
102
107
156 void analyzeFqdn(const bool client_s, const bool client_n, bool& server_s,
157 bool& server_n, const DdnsParams& ddns_params) const;
158
178 std::string generateFqdn(const asiolink::IOAddress& address,
179 const DdnsParams& ddns_params,
180 const bool trailing_dot = true) const;
181
200 std::string qualifyName(const std::string& partial_name,
201 const DdnsParams& ddns_params,
202 const bool trailing_dot) const;
203
216 template <class T>
217 void adjustFqdnFlags(const T& fqdn, T& fqdn_resp,
218 const DdnsParams& ddns_params);
219
237 template <class T>
238 void getUpdateDirections(const T& fqdn_resp, bool& forward, bool& reverse);
239
267 template <class T>
268 void adjustDomainName(const T& fqdn, T& fqdn_resp,
269 const DdnsParams& ddns_params);
270
291 void startSender(D2ClientErrorHandler error_handler,
292 const isc::asiolink::IOServicePtr& io_service);
293
309 void startSender(D2ClientErrorHandler error_handler);
310
315 bool amSending() const;
316
325 void stopSender();
326
339
351 Result result,
353
355 size_t getQueueSize() const;
356
358 size_t getQueueMaxSize() const;
359
371 const dhcp_ddns::NameChangeRequestPtr& peekAt(const size_t index) const;
372
377 void clearQueue();
378
385 void runReadyIO();
386
396 void suspendUpdates();
397
399 void stop();
400
401protected:
412 virtual void operator ()(const dhcp_ddns::NameChangeSender::Result result,
414
425 int getSelectFd();
426
434
435private:
436
438 D2ClientConfigPtr d2_client_config_;
439
441 dhcp_ddns::NameChangeSenderPtr name_change_sender_;
442
445 boost::shared_ptr<asiolink::IOService> private_io_service_;
446
449 D2ClientErrorHandler client_error_handler_;
450
452 int registered_select_fd_;
453};
454
455template <class T>
456void
457D2ClientMgr::adjustFqdnFlags(const T& fqdn, T& fqdn_resp, const DdnsParams& ddns_params) {
458 bool server_s = false;
459 bool server_n = false;
460 analyzeFqdn(fqdn.getFlag(T::FLAG_S), fqdn.getFlag(T::FLAG_N),
461 server_s, server_n, ddns_params);
462
463 // Reset the flags to zero to avoid triggering N and S both 1 check.
464 fqdn_resp.resetFlags();
465
466 // Set S and N flags.
467 fqdn_resp.setFlag(T::FLAG_S, server_s);
468 fqdn_resp.setFlag(T::FLAG_N, server_n);
469
470 // Set O flag true if server S overrides client S.
471 fqdn_resp.setFlag(T::FLAG_O, (fqdn.getFlag(T::FLAG_S) != server_s));
472}
473
474template <class T>
475void
477 bool& forward, bool& reverse) {
478 forward = fqdn_resp.getFlag(T::FLAG_S);
479 reverse = !(fqdn_resp.getFlag(T::FLAG_N));
480}
481
482template <class T>
483void
484D2ClientMgr::adjustDomainName(const T& fqdn, T& fqdn_resp, const DdnsParams& ddns_params) {
485 // If we're configured to replace it or the supplied name is blank
486 // set the response name to blank.
489 fqdn.getDomainName().empty()) {
490 fqdn_resp.setDomainName("", T::PARTIAL);
491 } else {
492 // Sanitize the name the client sent us, if we're configured to do so.
493 std::string client_name = fqdn.getDomainName();
494
496 if (sanitizer) {
497 // We need the raw text form, so we can replace escaped chars
498 dns::Name tmp(client_name);
499 std::string raw_name = tmp.toRawText();
500
501 // We do not know if the sanitizer's regexp preserves dots, so
502 // we'll scrub it label by label. Yeah, lucky us.
503 // Using boost::split is simpler than using dns::Name::split() as
504 // that returns Names which have trailing dots etc.
505 std::vector<std::string> labels;
506 boost::algorithm::split(labels, raw_name, boost::is_any_of("."));
507 std::stringstream ss;
508 bool first = true;
509 for (auto const& label : labels) {
510 if (!first) {
511 ss << ".";
512 } else {
513 first = false;
514 }
515
516 ss << sanitizer->scrub(label);
517 }
518
519 client_name = ss.str();
520 }
521
522 // If the supplied name is partial, qualify it by adding the suffix.
523 if (fqdn.getDomainNameType() == T::PARTIAL) {
524 fqdn_resp.setDomainName(qualifyName(client_name, ddns_params, true), T::FULL);
525 } else {
526 fqdn_resp.setDomainName(client_name, T::FULL);
527 }
528 }
529}
530
531
533typedef boost::shared_ptr<D2ClientMgr> D2ClientMgrPtr;
534
535
536} // namespace isc
537} // namespace dhcp
538
539#endif
ReplaceClientNameMode
Defines the client name replacement modes.
Definition: d2_client_cfg.h:76
D2ClientMgr isolates Kea from the details of being a D2 client.
Definition: d2_client_mgr.h:81
void invokeClientErrorHandler(const dhcp_ddns::NameChangeSender::Result result, dhcp_ddns::NameChangeRequestPtr &ncr)
Calls the client's error handler.
std::string generateFqdn(const asiolink::IOAddress &address, const DdnsParams &ddns_params, const bool trailing_dot=true) const
Builds a FQDN based on the configuration and given IP address.
void analyzeFqdn(const bool client_s, const bool client_n, bool &server_s, bool &server_n, const DdnsParams &ddns_params) const
Determines server flags based on configuration and client flags.
bool ddnsEnabled()
Convenience method for checking if DHCP-DDNS is enabled.
const D2ClientConfigPtr & getD2ClientConfig() const
Fetches the DHCP-DDNS configuration pointer.
void getUpdateDirections(const T &fqdn_resp, bool &forward, bool &reverse)
Get directional update flags based on server FQDN flags.
void stop()
Stop the sender.
void suspendUpdates()
Suspends sending requests.
int getRegisteredSelectFd()
Fetches the select-fd that is currently registered.
void adjustDomainName(const T &fqdn, T &fqdn_resp, const DdnsParams &ddns_params)
Set server FQDN name based on configuration and a given FQDN.
void sendRequest(dhcp_ddns::NameChangeRequestPtr &ncr)
Send the given NameChangeRequests to kea-dhcp-ddns.
size_t getQueueSize() const
Returns the number of NCRs queued for transmission.
void clearQueue()
Removes all NCRs queued for transmission.
void stopSender()
Disables sending NameChangeRequests to kea-dhcp-ddns.
void setD2ClientConfig(D2ClientConfigPtr &new_config)
Updates the DHCP-DDNS client configuration to the given value.
bool amSending() const
Returns true if the sender is in send mode, false otherwise.
int getSelectFd()
Fetches the sender's select-fd.
void runReadyIO()
Processes sender IO events.
void adjustFqdnFlags(const T &fqdn, T &fqdn_resp, const DdnsParams &ddns_params)
Set server FQDN flags based on configuration and a given FQDN.
~D2ClientMgr()
Destructor.
D2ClientMgr()
Constructor.
size_t getQueueMaxSize() const
Returns the maximum number of NCRs allowed in the queue.
virtual void operator()(const dhcp_ddns::NameChangeSender::Result result, dhcp_ddns::NameChangeRequestPtr &ncr)
Function operator implementing the NCR sender callback.
const dhcp_ddns::NameChangeRequestPtr & peekAt(const size_t index) const
Returns the nth NCR queued for transmission.
std::string qualifyName(const std::string &partial_name, const DdnsParams &ddns_params, const bool trailing_dot) const
Adds a qualifying suffix to a given domain name.
void startSender(D2ClientErrorHandler error_handler, const isc::asiolink::IOServicePtr &io_service)
Enables sending NameChangeRequests to kea-dhcp-ddns.
Convenience container for conveying DDNS behavioral parameters It is intended to be created per Packe...
Definition: srv_config.h:48
D2ClientConfig::ReplaceClientNameMode getReplaceClientNameMode() const
Returns how Kea should handle the domain-name supplied by the client.
Definition: srv_config.cc:997
isc::util::str::StringSanitizerPtr getHostnameSanitizer() const
Returns a regular expression string sanitizer.
Definition: srv_config.cc:1042
Abstract class for defining application layer send callbacks.
Definition: ncr_io.h:490
Abstract interface for sending NameChangeRequests.
Definition: ncr_io.h:468
Result
Defines the outcome of an asynchronous NCR send.
Definition: ncr_io.h:478
The Name class encapsulates DNS names.
Definition: name.h:219
std::string toRawText(bool omit_final_dot=false) const
Convert the LabelSequence to a string without escape sequences.
Definition: name.cc:509
Defines the D2ClientConfig class.
boost::shared_ptr< NameChangeSender > NameChangeSenderPtr
Defines a smart pointer to an instance of a sender.
Definition: ncr_io.h:857
boost::shared_ptr< NameChangeRequest > NameChangeRequestPtr
Defines a pointer to a NameChangeRequest.
Definition: ncr_msg.h:241
boost::shared_ptr< D2ClientConfig > D2ClientConfigPtr
Defines a pointer for D2ClientConfig instances.
boost::shared_ptr< D2ClientMgr > D2ClientMgrPtr
Defines a pointer for D2ClientMgr instances.
std::function< void(const dhcp_ddns::NameChangeSender::Result result, dhcp_ddns::NameChangeRequestPtr &ncr)> D2ClientErrorHandler
Defines the type for D2 IO error handler.
Definition: d2_client_mgr.h:45
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.
This file defines abstract classes for exchanging NameChangeRequests.