Crypto++ 8.6 Free C++ class library of cryptographic schemes

vmac.h
Go to the documentation of this file.
1 // vmac.h - originally written and placed in the public domain by Wei Dai
2
3 /// \file vmac.h
4 /// \brief Classes for the VMAC message authentication code
5 /// \since Crypto++ 5.5
6
7 #ifndef CRYPTOPP_VMAC_H
8 #define CRYPTOPP_VMAC_H
9
10 #include "cryptlib.h"
11 #include "iterhash.h"
12 #include "seckey.h"
13
14 // Clang 3.3 integrated assembler crash on Linux. Clang 3.4 due to compiler
15 // error with .intel_syntax, http://llvm.org/bugs/show_bug.cgi?id=24232
16 #if CRYPTOPP_BOOL_X32 || defined(CRYPTOPP_DISABLE_MIXED_ASM)
17 # define CRYPTOPP_DISABLE_VMAC_ASM 1
18 #endif
19
20 NAMESPACE_BEGIN(CryptoPP)
21
22 /// \brief VMAC message authentication code base class
23 /// \since Crypto++ 5.5
24 class VMAC_Base : public IteratedHashBase<word64, MessageAuthenticationCode>
25 {
26 public:
27 std::string AlgorithmName() const {return std::string("VMAC(") + GetCipher().AlgorithmName() + ")-" + IntToString(DigestSize()*8);}
28 std::string AlgorithmProvider() const {return GetCipher().AlgorithmProvider();}
29 unsigned int IVSize() const {return GetCipher().BlockSize();}
30 unsigned int MinIVLength() const {return 1;}
31 void Resynchronize(const byte *nonce, int length=-1);
32 void GetNextIV(RandomNumberGenerator &rng, byte *IV);
33 unsigned int DigestSize() const {return m_is128 ? 16 : 8;};
34 void UncheckedSetKey(const byte *userKey, unsigned int keylength, const NameValuePairs &params);
35 void TruncatedFinal(byte *mac, size_t size);
36 unsigned int BlockSize() const {return m_L1KeyLength;}
37 ByteOrder GetByteOrder() const {return LITTLE_ENDIAN_ORDER;}
38 unsigned int OptimalDataAlignment() const;
39
40 protected:
41 virtual BlockCipher & AccessCipher() =0;
42 virtual int DefaultDigestSize() const =0;
43 const BlockCipher & GetCipher() const {return const_cast<VMAC_Base *>(this)->AccessCipher();}
44 void HashEndianCorrectedBlock(const word64 *data);
45 size_t HashMultipleBlocks(const word64 *input, size_t length);
46 void Init() {}
47 word64* StateBuf() {return NULLPTR;}
48 word64* DataBuf() {return (word64 *)(void*)m_data();}
49
50 void VHASH_Update_SSE2(const word64 *data, size_t blocksRemainingInWord64, int tagPart);
51 template <bool T_128BitTag>
52 void VHASH_Update_Template(const word64 *data, size_t blockRemainingInWord128);
53 void VHASH_Update(const word64 *data, size_t blocksRemainingInWord128);
54
55 CRYPTOPP_BLOCK_1(polyState, word64, (m_is128 ? 8 : 4))
56 CRYPTOPP_BLOCK_2(nhKey, word64, m_L1KeyLength/sizeof(word64) + 2*m_is128)
57 CRYPTOPP_BLOCK_3(data, byte, m_L1KeyLength)
58 CRYPTOPP_BLOCK_4(l3Key, word64, (m_is128 ? 4 : 2))
59 CRYPTOPP_BLOCK_5(nonce, byte, IVSize())
60 CRYPTOPP_BLOCK_6(pad, byte, IVSize())
61 CRYPTOPP_BLOCKS_END(6)
62
63 bool m_is128, m_padCached, m_isFirstBlock;
64 unsigned int m_L1KeyLength;
65 };
66
67 /// \brief VMAC message authentication code
68 /// \tparam T_BlockCipher block cipher
69 /// \tparam T_DigestBitSize digest size, in bits
70 /// \details VMAC is a block cipher-based message authentication code algorithm
71 /// using a universal hash proposed by Ted Krovetz and Wei Dai in April 2007. The
72 /// algorithm was designed for high performance backed by a formal analysis.
73 /// \details The implementation is based on Ted Krovetz's public domain vmac.c
74 /// and <a href="http://tools.ietf.org/html/draft-krovetz-vmac-01">draft-krovetz-vmac-01.txt</a>.
75 /// \sa <a href="http://www.cryptolounge.org/wiki/VMAC">VMAC</a>.
76 /// \since Crypto++ 5.5
77 template <class T_BlockCipher, int T_DigestBitSize = 128>
78 class VMAC : public SimpleKeyingInterfaceImpl<VMAC_Base, SameKeyLengthAs<T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE> >
79 {
80 public:
81 static std::string StaticAlgorithmName() {return std::string("VMAC(") + T_BlockCipher::StaticAlgorithmName() + ")-" + IntToString(T_DigestBitSize);}
82
83 private:
84 BlockCipher & AccessCipher() {return m_cipher;}
85 int DefaultDigestSize() const {return T_DigestBitSize/8;}
86 typename T_BlockCipher::Encryption m_cipher;
87 };
88
89 NAMESPACE_END
90
91 #endif
BlockCipher
Interface for one direction (encryption or decryption) of a block cipher.
Definition: cryptlib.h:1288
IteratedHashBase
Iterated hash base class.
Definition: iterhash.h:39
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
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:926
CryptoPP
Crypto++ library namespace.
Name::IV
const char * IV()
ConstByteArrayParameter, also accepts const byte * for backwards compatibility.
Definition: argnames.h:21
Name::DigestSize
const char * DigestSize()
int, in bytes
Definition: argnames.h:79
seckey.h
Classes and functions for implementing secret key algorithms.