cryptolink.h

Go to the documentation of this file.

// Copyright (C) 2011-2022 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,   
    MD5 = 1,            
    SHA1 = 2,           
    SHA256 = 3,         
    SHA224 = 4,         
    SHA384 = 5,         
    SHA512 = 6          
 
};
 
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;
 
// Internal note: we can use this class later to initialize and manage
// dynamic (PKCS#11) libs
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& getRNG();
 
private:
    void initialize(CryptoLink& c);
 
    // To prevent people constructing their own, we make the constructor
    // private too.
    CryptoLink() {
        initialize(*this);
    }
    ~CryptoLink();
 
    CryptoLinkImplPtr impl_;
 
    RNGPtr rng_;
};
 
} // namespace cryptolink
} // namespace isc
 
#endif // ISC_CRYPTO_H