managed_key.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 MANAGED_KEY_H
#define MANAGED_KEY_H
 
#include <cc/cfg_to_element.h>
#include <gss_tsig/gss_tsig_key.h>
#include <gss_tsig/tkey_exchange.h>
 
#include <cstdint>
#include <mutex>
 
namespace isc {
namespace gss_tsig {

class ManagedKey : public GssTsigKey, public TKeyExchange::Callback,
                   public isc::data::CfgToElement {
public:
    enum Status : uint16_t {
        NOT_READY,        
        USABLE,           
        EXPIRED,          
        IN_ERROR          
    };

    static std::string statusToText(Status status);

    ManagedKey(const std::string& name);

    virtual ~ManagedKey() = default;

    std::string getKeyNameStr() const {
        return (getKeyName().toText());
    }

    std::string getParentID() const {
        return (parent_id_);
    }

    void setParentID(const std::string& parent_id) {
        parent_id_ = parent_id;
    }

    Status getStatus() const {
        return (status_);
    }

    void setStatus(Status status) {
        status_ = status;
    }

    TKeyExchange::Status getTKeyStatus() const {
        return (tkey_status_);
    }

    void setTKeyStatus(TKeyExchange::Status tkey_status) {
        tkey_status_ = tkey_status;
    }

    TKeyExchangePtr& getTKeyExchange() {
        return (tkey_ex_);
    }

    void operator()(TKeyExchange::Status tkey_status);

    static std::string genName(const std::string& server);

    isc::data::ElementPtr toElement() const;

    virtual dns::TSIGContextPtr createContext();
 
private:
    std::string parent_id_;

    Status status_;

    TKeyExchange::Status tkey_status_;

    TKeyExchangePtr tkey_ex_;
 
public:
    boost::scoped_ptr<std::mutex> mutex_;
};

typedef boost::shared_ptr<ManagedKey> ManagedKeyPtr;
 
} // end of namespace isc::gss_tsig
} // end of namespace isc
 
#endif // MANAGED_KEY_H