vmac.h
Go to the documentation of this file.
// vmac.h - originally written and placed in the public domain by Wei Dai
/// \file vmac.h
/// \brief Classes for the VMAC message authentication code
/// \since Crypto++ 5.5
#ifndef CRYPTOPP_VMAC_H
#define CRYPTOPP_VMAC_H
#include "cryptlib.h"
#include "iterhash.h"
#include "seckey.h"
// Clang 3.3 integrated assembler crash on Linux. Clang 3.4 due to compiler
// error with .intel_syntax, http://llvm.org/bugs/show_bug.cgi?id=24232
#if CRYPTOPP_BOOL_X32 || defined(CRYPTOPP_DISABLE_MIXED_ASM)
# define CRYPTOPP_DISABLE_VMAC_ASM 1
#endif
NAMESPACE_BEGIN(CryptoPP)
/// \brief VMAC message authentication code base class
/// \since Crypto++ 5.5
class VMAC_Base : public IteratedHashBase<word64, MessageAuthenticationCode>
{
public:
std::string AlgorithmName() const {return std::string("VMAC(") + GetCipher().AlgorithmName() + ")-" + IntToString(DigestSize()*8);}
std::string AlgorithmProvider() const {return GetCipher().AlgorithmProvider();}
unsigned int IVSize() const {return GetCipher().BlockSize();}
unsigned int MinIVLength() const {return 1;}
void Resynchronize(const byte *nonce, int length=-1);
void GetNextIV(RandomNumberGenerator &rng, byte *IV);
unsigned int DigestSize() const {return m_is128 ? 16 : 8;};
void UncheckedSetKey(const byte *userKey, unsigned int keylength, const NameValuePairs &params);
void TruncatedFinal(byte *mac, size_t size);
unsigned int BlockSize() const {return m_L1KeyLength;}
ByteOrder GetByteOrder() const {return LITTLE_ENDIAN_ORDER;}
unsigned int OptimalDataAlignment() const;
protected:
virtual BlockCipher & AccessCipher() =0;
virtual int DefaultDigestSize() const =0;
const BlockCipher & GetCipher() const {return const_cast<VMAC_Base *>(this)->AccessCipher();}
void HashEndianCorrectedBlock(const word64 *data);
size_t HashMultipleBlocks(const word64 *input, size_t length);
void Init() {}
word64* StateBuf() {return NULLPTR;}
word64* DataBuf() {return (word64 *)(void*)m_data();}
void VHASH_Update_SSE2(const word64 *data, size_t blocksRemainingInWord64, int tagPart);
template <bool T_128BitTag>
void VHASH_Update_Template(const word64 *data, size_t blockRemainingInWord128);
void VHASH_Update(const word64 *data, size_t blocksRemainingInWord128);
CRYPTOPP_BLOCK_1(polyState, word64, (m_is128 ? 8 : 4))
CRYPTOPP_BLOCK_2(nhKey, word64, m_L1KeyLength/sizeof(word64) + 2*m_is128)
CRYPTOPP_BLOCK_3(data, byte, m_L1KeyLength)
CRYPTOPP_BLOCK_4(l3Key, word64, (m_is128 ? 4 : 2))
CRYPTOPP_BLOCK_5(nonce, byte, IVSize())
CRYPTOPP_BLOCK_6(pad, byte, IVSize())
CRYPTOPP_BLOCKS_END(6)
bool m_is128, m_padCached, m_isFirstBlock;
unsigned int m_L1KeyLength;
};
/// \brief VMAC message authentication code
/// \tparam T_BlockCipher block cipher
/// \tparam T_DigestBitSize digest size, in bits
/// \details VMAC is a block cipher-based message authentication code algorithm
/// using a universal hash proposed by Ted Krovetz and Wei Dai in April 2007. The
/// algorithm was designed for high performance backed by a formal analysis.
/// \details The implementation is based on Ted Krovetz's public domain vmac.c
/// and <a href="http://tools.ietf.org/html/draft-krovetz-vmac-01">draft-krovetz-vmac-01.txt</a>.
/// \sa <a href="http://www.cryptolounge.org/wiki/VMAC">VMAC</a>.
/// \since Crypto++ 5.5
template <class T_BlockCipher, int T_DigestBitSize = 128>
class VMAC : public SimpleKeyingInterfaceImpl<VMAC_Base, SameKeyLengthAs<T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE> >
{
public:
static std::string StaticAlgorithmName() {return std::string("VMAC(") + T_BlockCipher::StaticAlgorithmName() + ")-" + IntToString(T_DigestBitSize);}
private:
BlockCipher & AccessCipher() {return m_cipher;}
int DefaultDigestSize() const {return T_DigestBitSize/8;}
typename T_BlockCipher::Encryption m_cipher;
};
NAMESPACE_END
#endif
BlockCipher
Interface for one direction (encryption or decryption) of a block cipher.
Definition cryptlib.h:1288
IteratedHashBase< word64, MessageAuthenticationCode >::IteratedHashBase
IteratedHashBase()
Definition iterhash.h:46
MessageAuthenticationCode
Interface for message authentication codes.
Definition cryptlib.h:1304
NameValuePairs
Interface for retrieving values given their names.
Definition cryptlib.h:327
RandomNumberGenerator
Interface for random number generators.
Definition cryptlib.h:1440
SameKeyLengthAs
Provides key lengths based on another class's key length.
Definition seckey.h:218
SimpleKeyingInterface
Interface for algorithms that take byte strings as keys.
Definition cryptlib.h:647
SimpleKeyingInterface::UNIQUE_IV
@ UNIQUE_IV
The IV must be unique.
Definition cryptlib.h:726
SimpleKeyingInterfaceImpl
Provides a base implementation of SimpleKeyingInterface.
Definition seckey.h:258
VMAC_Base
VMAC message authentication code base class.
Definition vmac.h:25
VMAC_Base::BlockSize
unsigned int BlockSize() const
Provides the block size of the compression function.
Definition vmac.h:36
VMAC_Base::AlgorithmProvider
std::string AlgorithmProvider() const
Retrieve the provider of this algorithm.
Definition vmac.h:28
VMAC_Base::AlgorithmName
std::string AlgorithmName() const
Provides the name of this algorithm.
Definition vmac.h:27
VMAC_Base::IVSize
unsigned int IVSize() const
Returns length of the IV accepted by this object.
Definition vmac.h:29
VMAC_Base::DigestSize
unsigned int DigestSize() const
Provides the digest size of the hash.
Definition vmac.h:33
VMAC_Base::MinIVLength
unsigned int MinIVLength() const
Provides the minimum size of an IV.
Definition vmac.h:30
VMAC
VMAC message authentication code.
Definition vmac.h:79
word64
unsigned long long word64
64-bit unsigned datatype
Definition config_int.h:101
cryptlib.h
Abstract base classes that provide a uniform interface to this library.
ByteOrder
ByteOrder
Provides the byte ordering.
Definition cryptlib.h:148
LITTLE_ENDIAN_ORDER
@ LITTLE_ENDIAN_ORDER
byte order is little-endian
Definition cryptlib.h:150
iterhash.h
Base classes for iterated hashes.
IntToString
std::string IntToString(T value, unsigned int base=10)
Converts a value to a string.
Definition misc.h:929
CryptoPP
Crypto++ library namespace.
seckey.h
Classes and functions for implementing secret key algorithms.