iterhash.h

Go to the documentation of this file.

// iterhash.h - originally written and placed in the public domain by Wei Dai
 
 
#ifndef CRYPTOPP_ITERHASH_H
#define CRYPTOPP_ITERHASH_H
 
#include "cryptlib.h"
#include "secblock.h"
#include "misc.h"
#include "simple.h"
 
#if CRYPTOPP_MSC_VERSION
# pragma warning(push)
# pragma warning(disable: 4231 4275)
# if (CRYPTOPP_MSC_VERSION >= 1400)
#  pragma warning(disable: 6011 6386 28193)
# endif
#endif
 
NAMESPACE_BEGIN(CryptoPP)
 
 
class CRYPTOPP_DLL HashInputTooLong : public InvalidDataFormat
{
public:
        explicit HashInputTooLong(const std::string &alg)
                : InvalidDataFormat("IteratedHashBase: input data exceeds maximum allowed by hash function " + alg) {}
};
 
template <class T, class BASE>
class CRYPTOPP_NO_VTABLE IteratedHashBase : public BASE
{
public:
        typedef T HashWordType;
 
        virtual ~IteratedHashBase() {}
 
        IteratedHashBase() : m_countLo(0), m_countHi(0) {}
 
        unsigned int OptimalBlockSize() const {return this->BlockSize();}
 
        unsigned int OptimalDataAlignment() const {return GetAlignmentOf<T>();}
 
        void Update(const byte *input, size_t length);
 
        byte * CreateUpdateSpace(size_t &size);
 
        void Restart();
 
        void TruncatedFinal(byte *digest, size_t digestSize);
 
        virtual std::string AlgorithmProvider() const { return "C++"; }
 
protected:
        inline T GetBitCountHi() const
                {return (m_countLo >> (8*sizeof(T)-3)) + (m_countHi << 3);}
        inline T GetBitCountLo() const
                {return m_countLo << 3;}
 
        void PadLastBlock(unsigned int lastBlockSize, byte padFirst=0x80);
        virtual void Init() =0;
 
        virtual ByteOrder GetByteOrder() const =0;
        virtual void HashEndianCorrectedBlock(const HashWordType *data) =0;
        virtual size_t HashMultipleBlocks(const T *input, size_t length);
        void HashBlock(const HashWordType *input)
                {HashMultipleBlocks(input, this->BlockSize());}
 
        virtual T* DataBuf() =0;
        virtual T* StateBuf() =0;
 
private:
        T m_countLo, m_countHi;
};
 
template <class T_HashWordType, class T_Endianness, unsigned int T_BlockSize, class T_Base = HashTransformation>
class CRYPTOPP_NO_VTABLE IteratedHash : public IteratedHashBase<T_HashWordType, T_Base>
{
public:
        typedef T_Endianness ByteOrderClass;
        typedef T_HashWordType HashWordType;
 
        CRYPTOPP_CONSTANT(BLOCKSIZE = T_BlockSize);
        // BCB2006 workaround: can't use BLOCKSIZE here
        CRYPTOPP_COMPILE_ASSERT((T_BlockSize & (T_BlockSize - 1)) == 0);        // blockSize is a power of 2
 
        virtual ~IteratedHash() {}
 
        unsigned int BlockSize() const {return T_BlockSize;}
 
        ByteOrder GetByteOrder() const {return T_Endianness::ToEnum();}
 
        inline void CorrectEndianess(HashWordType *out, const HashWordType *in, size_t byteCount)
        {
                CRYPTOPP_ASSERT(in != NULLPTR);
                CRYPTOPP_ASSERT(out != NULLPTR);
                CRYPTOPP_ASSERT(IsAligned<T_HashWordType>(in));
                CRYPTOPP_ASSERT(IsAligned<T_HashWordType>(out));
 
                ConditionalByteReverse(T_Endianness::ToEnum(), out, in, byteCount);
        }
 
protected:
        enum { Blocks = T_BlockSize/sizeof(T_HashWordType) };
        T_HashWordType* DataBuf() {return this->m_data;}
        FixedSizeSecBlock<T_HashWordType, Blocks> m_data;
};
 
template <class T_HashWordType, class T_Endianness, unsigned int T_BlockSize, unsigned int T_StateSize, class T_Transform, unsigned int T_DigestSize = 0, bool T_StateAligned = false>
class CRYPTOPP_NO_VTABLE IteratedHashWithStaticTransform
        : public ClonableImpl<T_Transform, AlgorithmImpl<IteratedHash<T_HashWordType, T_Endianness, T_BlockSize>, T_Transform> >
{
public:
        CRYPTOPP_CONSTANT(DIGESTSIZE = T_DigestSize ? T_DigestSize : T_StateSize);
 
        virtual ~IteratedHashWithStaticTransform() {}
 
        unsigned int DigestSize() const {return DIGESTSIZE;}
 
protected:
        // https://github.com/weidai11/cryptopp/issues/147#issuecomment-766231864
        IteratedHashWithStaticTransform() {IteratedHashWithStaticTransform::Init();}
        void HashEndianCorrectedBlock(const T_HashWordType *data) {T_Transform::Transform(this->m_state, data);}
        void Init() {T_Transform::InitState(this->m_state);}
 
        enum { Blocks = T_BlockSize/sizeof(T_HashWordType) };
        T_HashWordType* StateBuf() {return this->m_state;}
        FixedSizeAlignedSecBlock<T_HashWordType, Blocks, T_StateAligned> m_state;
};
 
#if !defined(__GNUC__) && !defined(__clang__)
        CRYPTOPP_DLL_TEMPLATE_CLASS IteratedHashBase<word64, HashTransformation>;
        CRYPTOPP_STATIC_TEMPLATE_CLASS IteratedHashBase<word64, MessageAuthenticationCode>;
 
        CRYPTOPP_DLL_TEMPLATE_CLASS IteratedHashBase<word32, HashTransformation>;
        CRYPTOPP_STATIC_TEMPLATE_CLASS IteratedHashBase<word32, MessageAuthenticationCode>;
#endif
 
NAMESPACE_END
 
#if CRYPTOPP_MSC_VERSION
# pragma warning(pop)
#endif
 
#endif