cryptolink.h

Go to the documentation of this file.

// Copyright (C) 2011-2024 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 ISC_CRYPTO_H
#define ISC_CRYPTO_H
 
#include <string>
#include <util/buffer.h>
#include <exceptions/exceptions.h>
 
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
#include <memory>
 
namespace isc {
namespace cryptolink {

enum HashAlgorithm {
    UNKNOWN_HASH = 0,   // This value can be used in conversion
                        // functions, to be returned when the
                        // input is unknown (but a value MUST be
                        // returned), for instance when the input
                        // is a Name or a string, and the return
                        // value is a HashAlgorithm.
    MD5 = 1,            // MD5
    SHA1 = 2,           // SHA-1
    SHA256 = 3,         // SHA-256
    SHA224 = 4,         // SHA-224
    SHA384 = 5,         // SHA-384
    SHA512 = 6          // SHA-512
};

class Hash;

class HMAC;

class RNG;

typedef boost::shared_ptr<RNG> RNGPtr;

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

class InitializationError : public CryptoLinkError {
public:
    InitializationError(const char* file, size_t line, const char* what) :
        CryptoLinkError(file, line, what) {}
};

class UnsupportedAlgorithm : public CryptoLinkError {
public:
    UnsupportedAlgorithm(const char* file, size_t line, const char* what) :
        CryptoLinkError(file, line, what) {}
};

class BadKey : public CryptoLinkError {
public:
    BadKey(const char* file, size_t line, const char* what) :
        CryptoLinkError(file, line, what) {}
};

class LibraryError : public CryptoLinkError {
public:
    LibraryError(const char* file, size_t line, const char* what) :
        CryptoLinkError(file, line, what) {}
};

class CryptoLinkImpl;

typedef boost::shared_ptr<CryptoLinkImpl> CryptoLinkImplPtr;

class RNGImpl;

class CryptoLink : private boost::noncopyable {
public:
    static CryptoLink& getCryptoLink();

    static std::string getVersion();

    Hash* createHash(const HashAlgorithm hash_algorithm);

    HMAC* createHMAC(const void* secret, size_t secret_len,
                     const HashAlgorithm hash_algorithm);

    virtual RNGPtr const& getRNG() const;
 
private:
    void initialize(CryptoLink& c);

    CryptoLink() {
        initialize(*this);
    }
    ~CryptoLink();

    CryptoLinkImplPtr impl_;

    RNGPtr rng_;
};
 
} // namespace cryptolink
} // namespace isc
 
#endif // ISC_CRYPTO_H