d2_cfg_mgr.h

Go to the documentation of this file.

// Copyright (C) 2014-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef D2_CFG_MGR_H
#define D2_CFG_MGR_H
 
#include <asiolink/io_service.h>
#include <cc/data.h>
#include <config/http_command_config.h>
#include <exceptions/exceptions.h>
#include <d2srv/d2_config.h>
#include <hooks/hooks_config.h>
#include <process/d_cfg_mgr.h>
 
#include <stdint.h>
#include <string>
 
namespace isc {
namespace d2 {

extern const std::string DDNS_REV_ZONE_DEFAULT4;

extern const std::string DDNS_REV_ZONE_DEFAULT6;
 
class D2CfgContext;
typedef boost::shared_ptr<D2CfgContext> D2CfgContextPtr;

class D2CfgContext : public process::ConfigBase {
public:
    D2CfgContext();

    virtual ~D2CfgContext();

    virtual process::ConfigPtr clone() {
        return (process::ConfigPtr(new D2CfgContext(*this)));
    }

    D2ParamsPtr& getD2Params() {
        return (d2_params_);
    }

    DdnsDomainListMgrPtr getForwardMgr() {
        return (forward_mgr_);
    }

    void setForwardMgr(DdnsDomainListMgrPtr forward_mgr) {
        forward_mgr_ = forward_mgr;
    }

    DdnsDomainListMgrPtr getReverseMgr() {
        return (reverse_mgr_);
    }

    void setReverseMgr(DdnsDomainListMgrPtr reverse_mgr) {
        reverse_mgr_ = reverse_mgr;
    }

    TSIGKeyInfoMapPtr getKeys() {
        return (keys_);
    }

    void setKeys(const TSIGKeyInfoMapPtr& keys) {
        keys_ = keys;
    }

    const isc::data::ConstElementPtr getUnixControlSocketInfo() const {
        return (unix_control_socket_);
    }

    void setUnixControlSocketInfo(const isc::data::ConstElementPtr& control_socket) {
        unix_control_socket_ = control_socket;
    }

    const isc::data::ConstElementPtr getHttpControlSocketInfo() const {
        return (http_control_socket_);
    }

    void setHttpControlSocketInfo(const isc::data::ConstElementPtr& control_socket) {
        http_control_socket_ = control_socket;
    }

    isc::hooks::HooksConfig& getHooksConfig() {
        return (hooks_config_);
    }

    const isc::hooks::HooksConfig& getHooksConfig() const {
        return (hooks_config_);
    }

    virtual isc::data::ElementPtr toElement() const;
 
protected:
    D2CfgContext(const D2CfgContext& rhs);
 
private:
    D2CfgContext& operator=(const D2CfgContext& rhs);

    D2ParamsPtr d2_params_;

    DdnsDomainListMgrPtr forward_mgr_;

    DdnsDomainListMgrPtr reverse_mgr_;

    TSIGKeyInfoMapPtr keys_;

    isc::data::ConstElementPtr unix_control_socket_;

    isc::data::ConstElementPtr http_control_socket_;

    isc::hooks::HooksConfig hooks_config_;
};

typedef boost::shared_ptr<DdnsDomainListMgr> DdnsDomainListMgrPtr;

class D2CfgMgr : public process::DCfgMgrBase {
public:
    static const char* IPV4_REV_ZONE_SUFFIX;

    static const char* IPV6_REV_ZONE_SUFFIX;

    D2CfgMgr();

    virtual ~D2CfgMgr();

    D2CfgContextPtr getD2CfgContext() {
        return (boost::dynamic_pointer_cast<D2CfgContext>(getContext()));
    }

    bool forwardUpdatesEnabled();

    bool reverseUpdatesEnabled();

    bool matchForward(const std::string& fqdn, DdnsDomainPtr& domain);

    bool matchReverse(const std::string& ip_address,
                      DdnsDomainPtr& domain,
                      const std::string& reverse_zone = "");

    static std::string reverseIpAddress(const std::string& address,
                                        const std::string& reverse_zone = "");

    static std::string reverseV4Address(const isc::asiolink::IOAddress& ioaddr, const std::string& reverse_zone);

    static std::string reverseV6Address(const isc::asiolink::IOAddress& ioaddr, const std::string& reverse_zone);

    const D2ParamsPtr& getD2Params();

    const isc::data::ConstElementPtr getUnixControlSocketInfo();

    const isc::data::ConstElementPtr getHttpControlSocketInfo();

    virtual std::string getConfigSummary(const uint32_t selection) override;
 
    std::list<std::list<std::string>> jsonPathsToRedact() const final override;
 
protected:
    virtual isc::data::ConstElementPtr
    parse(isc::data::ConstElementPtr config, bool check_only) override;

    virtual void setCfgDefaults(isc::data::ElementPtr mutable_config) override;

    virtual process::ConfigPtr createNewContext() override;
};

typedef boost::shared_ptr<D2CfgMgr> D2CfgMgrPtr;
 
} // end of isc::d2 namespace
} // end of isc namespace
 
#endif // D2_CFG_MGR_H