tsig.h

Go to the documentation of this file.

// Copyright (C) 2011-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/.
 
// IMPORTANT: the server side of this code MUST NOT be used until
// it was fixed, cf RFC 8945. Note that Kea uses only the client side.
 
#ifndef TSIG_H
#define TSIG_H
 
#include <dns/tsigerror.h>
#include <dns/tsigkey.h>
#include <dns/tsigrecord.h>
#include <exceptions/exceptions.h>
 
#include <cstdint>
 
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
namespace isc {
namespace dns {

class TSIGContextError : public isc::Exception {
public:
    TSIGContextError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

class TSIGContext : boost::noncopyable {
public:
    enum State : uint16_t {
        INIT,                   
        SENT_REQUEST,           
        RECEIVED_REQUEST,       
        SENT_RESPONSE,          
        VERIFIED_RESPONSE       
    };



    explicit TSIGContext(const TSIGKey& key);

    TSIGContext(const Name& key_name, const Name& algorithm_name,
                const TSIGKeyRing& keyring);

    virtual ~TSIGContext();

    virtual ConstTSIGRecordPtr
    sign(const uint16_t qid, const void* const data, const size_t data_len);

    virtual TSIGError
    verify(const TSIGRecord* const record, const void* const data, const size_t data_len);

    virtual bool lastHadSignature() const;

    virtual size_t getTSIGLength() const;

    virtual State getState() const;

    virtual TSIGError getError() const;



    static const uint16_t DEFAULT_FUDGE = 300;
 
protected:
    void update(const void* const data, size_t len);
 
private:
    struct TSIGContextImpl;
    boost::shared_ptr<TSIGContextImpl> impl_;
};
 
typedef boost::shared_ptr<TSIGContext> TSIGContextPtr;
typedef boost::shared_ptr<TSIGKey> TSIGKeyPtr;
 
}
}
 
#endif  // TSIG_H