Arduino Cryptography Library
GCM.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_GCM_h
24 #define CRYPTO_GCM_h
25 
26 #include "AuthenticatedCipher.h"
27 #include "BlockCipher.h"
28 #include "GHASH.h"
29 
31 {
32 public:
33  virtual ~GCMCommon();
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  GCMCommon();
54  void setBlockCipher(BlockCipher *cipher) { blockCipher = cipher; }
55 
56 private:
57  BlockCipher *blockCipher;
58  GHASH ghash;
59  struct {
60  uint8_t counter[16];
61  uint8_t stream[16];
62  uint8_t nonce[16];
63  uint64_t authSize;
64  uint64_t dataSize;
65  bool dataStarted;
66  uint8_t posn;
67  } state;
68 };
69 
70 template <typename T>
71 class GCM : public GCMCommon
72 {
73 public:
74  GCM() { setBlockCipher(&cipher); }
75 
76 private:
77  T cipher;
78 };
79 
80 #endif
Abstract base class for authenticated ciphers.
Abstract base class for block ciphers.
Definition: BlockCipher.h:30
Concrete base class to assist with implementing GCM for 128-bit block ciphers.
Definition: GCM.h:31
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: GCM.cpp:142
void clear()
Clears all security-sensitive state from this cipher.
Definition: GCM.cpp:253
virtual ~GCMCommon()
Destroys this cipher object after clearing sensitive information.
Definition: GCM.cpp:56
size_t keySize() const
Default size of the key for this cipher, in bytes.
Definition: GCM.cpp:61
GCMCommon()
Constructs a new cipher in GCM mode.
Definition: GCM.cpp:44
bool setIV(const uint8_t *iv, size_t len)
Sets the initialization vector to use for future encryption and decryption operations.
Definition: GCM.cpp:83
size_t ivSize() const
Size of the initialization vector for this cipher, in bytes.
Definition: GCM.cpp:66
size_t tagSize() const
Returns the size of the authentication tag.
Definition: GCM.cpp:72
bool setKey(const uint8_t *key, size_t len)
Sets the key to use for future encryption and decryption operations.
Definition: GCM.cpp:77
void computeTag(void *tag, size_t len)
Finalizes the encryption process and computes the authentication tag.
Definition: GCM.cpp:222
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: GCM.cpp:179
bool checkTag(const void *tag, size_t len)
Finalizes the decryption process and checks the authentication tag.
Definition: GCM.cpp:242
void setBlockCipher(BlockCipher *cipher)
Sets the block cipher to use for this GCM object.
Definition: GCM.h:54
void addAuthData(const void *data, size_t len)
Adds extra data that will be authenticated but not encrypted.
Definition: GCM.cpp:214
Implementation of the Galois Counter Mode (GCM).
Definition: GCM.h:72
GCM()
Constructs a new GCM object for the block cipher T.
Definition: GCM.h:74
Implementation of the GHASH message authenticator.
Definition: GHASH.h:30