tsigkey.h

Go to the documentation of this file.

// Copyright (C) 2010-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 TSIGKEY_H
#define TSIGKEY_H
 
#include <cryptolink/cryptolink.h>
 
#include <cstdint>
 
namespace isc {
namespace dns {
 
class Name;

class TSIGKey {
public:


    TSIGKey(const Name& key_name, const Name& algorithm_name,
            const void* secret, size_t secret_len, size_t digestbits = 0);

    explicit TSIGKey(const std::string& str);

    TSIGKey(const TSIGKey& source);

    TSIGKey& operator=(const TSIGKey& source);

    virtual ~TSIGKey();



    const Name& getKeyName() const;

    const Name& getAlgorithmName() const;

    isc::cryptolink::HashAlgorithm getAlgorithm() const;

    size_t getDigestbits() const;

    size_t getSecretLength() const;

    const void* getSecret() const;

    std::string toText() const;


    static const Name& HMACMD5_NAME();    // HMAC-MD5 (RFC2845)
    static const Name& HMACMD5_SHORT_NAME();
    static const Name& HMACSHA1_NAME();   // HMAC-SHA1 (RFC4635)
    static const Name& HMACSHA256_NAME(); // HMAC-SHA256 (RFC4635)
    static const Name& HMACSHA224_NAME(); // HMAC-SHA256 (RFC4635)
    static const Name& HMACSHA384_NAME(); // HMAC-SHA256 (RFC4635)
    static const Name& HMACSHA512_NAME(); // HMAC-SHA256 (RFC4635)
    static const Name& GSSTSIG_NAME();    // GSS-TSIG (RFC3645)
 
private:
    struct TSIGKeyImpl;
    boost::shared_ptr<TSIGKeyImpl> impl_;
};

class TSIGKeyRing {
public:
    enum Result : uint16_t {
        SUCCESS = 0,    // The operation is successful.
        EXIST = 1,      // A key is already stored in TSIGKeyRing.
        NOTFOUND = 2    // The specified key is not found in TSIGKeyRing.
    };

    struct FindResult {
        FindResult(Result param_code, const TSIGKey* param_key) :
            code(param_code), key(param_key) {
        }
        const Result code;
        const TSIGKey* const key;
    };


private:
    TSIGKeyRing(const TSIGKeyRing& source);
    TSIGKeyRing& operator=(const TSIGKeyRing& source);
public:
    TSIGKeyRing();

    ~TSIGKeyRing();

    unsigned int size() const;

    Result add(const TSIGKey& key);

    Result remove(const Name& key_name);

    FindResult find(const Name& key_name) const;

    FindResult find(const Name& key_name, const Name& algorithm_name) const;
 
private:
    struct TSIGKeyRingImpl;
    boost::shared_ptr<TSIGKeyRingImpl> impl_;
};
}
}
 
#endif  // TSIGKEY_H