Arduino Cryptography Library
EAX.h
1 /*
2  * Copyright (C) 2015 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef CRYPTO_EAX_h
24 #define CRYPTO_EAX_h
25 
26 #include "AuthenticatedCipher.h"
27 #include "BlockCipher.h"
28 #include "OMAC.h"
29 
31 {
32 public:
33  virtual ~EAXCommon();
34 
35  size_t keySize() const;
36  size_t ivSize() const;
37  size_t tagSize() const;
38 
39  bool setKey(const uint8_t *key, size_t len);
40  bool setIV(const uint8_t *iv, size_t len);
41 
42  void encrypt(uint8_t *output, const uint8_t *input, size_t len);
43  void decrypt(uint8_t *output, const uint8_t *input, size_t len);
44 
45  void addAuthData(const void *data, size_t len);
46 
47  void computeTag(void *tag, size_t len);
48  bool checkTag(const void *tag, size_t len);
49 
50  void clear();
51 
52 protected:
53  EAXCommon();
55  {
56  omac.setBlockCipher(cipher);
57  }
58 
59 private:
60  struct {
61  uint8_t counter[16];
62  uint8_t stream[16];
63  uint8_t tag[16];
64  uint8_t hash[16];
65  uint8_t encPosn;
66  uint8_t authMode;
67  } state;
68  OMAC omac;
69 
70  void closeAuthData();
71  void encryptCTR(uint8_t *output, const uint8_t *input, size_t len);
72  void closeTag();
73 };
74 
75 template <typename T>
76 class EAX : public EAXCommon
77 {
78 public:
79  EAX() { setBlockCipher(&cipher); }
80 
81 private:
82  T cipher;
83 };
84 
85 #endif
Abstract base class for authenticated ciphers.
Abstract base class for block ciphers.
Definition: BlockCipher.h:30
Concrete base class to assist with implementing EAX for 128-bit block ciphers.
Definition: EAX.h:31
size_t keySize() const
Default size of the key for this cipher, in bytes.
Definition: EAX.cpp:54
bool setIV(const uint8_t *iv, size_t len)
Sets the initialization vector to use for future encryption and decryption operations.
Definition: EAX.cpp:76
size_t tagSize() const
Returns the size of the authentication tag.
Definition: EAX.cpp:65
void decrypt(uint8_t *output, const uint8_t *input, size_t len)
Decrypts an input buffer and writes the plaintext to an output buffer.
Definition: EAX.cpp:108
bool checkTag(const void *tag, size_t len)
Finalizes the decryption process and checks the authentication tag.
Definition: EAX.cpp:130
void setBlockCipher(BlockCipher *cipher)
Sets the block cipher to use for this EAX object.
Definition: EAX.h:54
void encrypt(uint8_t *output, const uint8_t *input, size_t len)
Encrypts an input buffer and writes the ciphertext to an output buffer.
Definition: EAX.cpp:100
void computeTag(void *tag, size_t len)
Finalizes the encryption process and computes the authentication tag.
Definition: EAX.cpp:122
size_t ivSize() const
Size of the initialization vector for this cipher, in bytes.
Definition: EAX.cpp:59
void addAuthData(const void *data, size_t len)
Adds extra data that will be authenticated but not encrypted.
Definition: EAX.cpp:116
EAXCommon()
Constructs a new cipher in EAX mode.
Definition: EAX.cpp:43
bool setKey(const uint8_t *key, size_t len)
Sets the key to use for future encryption and decryption operations.
Definition: EAX.cpp:71
void clear()
Clears all security-sensitive state from this cipher.
Definition: EAX.cpp:141
Implementation of the EAX authenticated cipher.
Definition: EAX.h:77
EAX()
Constructs a new EAX object for the block cipher T.
Definition: EAX.h:79
Implementation of the OMAC message authenticator.
Definition: OMAC.h:29
void setBlockCipher(BlockCipher *cipher)
Sets the block cipher to use for this OMAC object.
Definition: OMAC.h:35