gss_tsig_impl.h

Go to the documentation of this file.

// Copyright (C) 2021-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 GSS_TSIG_IMPL_H
#define GSS_TSIG_IMPL_H
 
#include <asiolink/interval_timer.h>
#include <gss_tsig/gss_tsig_cfg.h>
#include <gss_tsig/managed_key.h>
#include <hooks/hooks.h>
 
#include <chrono>
#include <memory>
 
#include <boost/multi_index/composite_key.hpp>
#include <boost/multi_index/ordered_index.hpp>
 
namespace isc {
namespace gss_tsig {

struct GssTsigKeyNameTag { };

struct GssTsigKeyServerTag { };

typedef boost::multi_index_container<
    // It holds pointers to GSS-TSIG key objects.
    ManagedKeyPtr,
    boost::multi_index::indexed_by<
        // First index is the by DNS name.
        boost::multi_index::hashed_unique<
            boost::multi_index::tag<GssTsigKeyNameTag>,
            boost::multi_index::const_mem_fun<ManagedKey, std::string,
                                              &ManagedKey::getKeyNameStr>
        >,
 
        // Second index is by DNS server (parent) ID with the inception
        // date to sort search results.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<GssTsigKeyServerTag>,
            boost::multi_index::composite_key<
                ManagedKey,
                // The DNS server (parent) ID.
                boost::multi_index::const_mem_fun<ManagedKey, std::string,
                                                  &ManagedKey::getParentID>,
                // The inception date.
                boost::multi_index::const_mem_fun<GssTsigKey,
                                                  std::chrono::system_clock::time_point,
                                                  &GssTsigKey::getInception>
                >
            >
    >
> ManagedKeyList;

class GssTsigImpl {
public:
    GssTsigImpl();

    virtual ~GssTsigImpl();

    void configure(isc::data::ConstElementPtr config);

    void finishConfigure(isc::d2::D2CfgContextPtr d2_config);

    isc::asiolink::IOServicePtr getIOService() {
        return (io_service_);
    }

    void setIOService(isc::asiolink::IOServicePtr io_service) {
        io_service_ = io_service;
    }

    DnsServerPtr getServer(const std::string& id) const;

    void start();

    void stop();

    void processAllServersKeys(bool rekey = false);

    void processServerKeys(DnsServerPtr server, bool rekey = false);

    void createKey(DnsServerPtr server,
                   std::chrono::time_point<std::chrono::system_clock> now);

    ManagedKeyPtr findKey(const d2::DnsServerInfoPtr& server_info,
                          bool& useGssTsig, bool& fallback);

    ManagedKeyPtr findKey(const std::string& name) const;

    void purgeKeys();

    void getHandler(isc::hooks::CalloutHandle& handle) const;

    void getAllHandler(isc::hooks::CalloutHandle& handle) const;

    void listHandler(isc::hooks::CalloutHandle& handle) const;

    void keyGetHandler(isc::hooks::CalloutHandle& handle) const;

    void keyExpireHandler(isc::hooks::CalloutHandle& handle);

    void keyDelHandler(isc::hooks::CalloutHandle& handle);

    void purgeHandler(isc::hooks::CalloutHandle& handle);

    void purgeAllHandler(isc::hooks::CalloutHandle& handle);

    void rekeyHandler(isc::hooks::CalloutHandle& handle);

    void rekeyAllHandler(isc::hooks::CalloutHandle& handle);

    void commandProcessed(isc::hooks::CalloutHandle& handle);
 
protected:
    GssTsigCfg cfg_;

    ManagedKeyList keys_;

    isc::asiolink::IOServicePtr io_service_;

    std::unique_ptr<std::string> krb5_client_ktname_prev_;

    std::unique_ptr<std::string> krb5ccname_prev_;

    isc::asiolink::IntervalTimerPtr purge_timer_;
};

typedef std::unique_ptr<GssTsigImpl> GssTsigImplPtr;
 
} // end of namespace isc::gss_tsig
} // end of namespace isc
 
#endif // GSS_TSIG_IMPL_H