Arduino Cryptography Library
Ascon128.h
1 /*
2  * Copyright (C) 2018 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_ASCON128_H
24 #define CRYPTO_ASCON128_H
25 
26 #include "AuthenticatedCipher.h"
27 
29 {
30 public:
31  Ascon128();
32  virtual ~Ascon128();
33 
34  size_t keySize() const;
35  size_t ivSize() const;
36  size_t tagSize() const;
37 
38  bool setKey(const uint8_t *key, size_t len);
39  bool setIV(const uint8_t *iv, size_t len);
40 
41  void encrypt(uint8_t *output, const uint8_t *input, size_t len);
42  void decrypt(uint8_t *output, const uint8_t *input, size_t len);
43 
44  void addAuthData(const void *data, size_t len);
45 
46  void computeTag(void *tag, size_t len);
47  bool checkTag(const void *tag, size_t len);
48 
49  void clear();
50 
51 private:
52  struct {
53  uint64_t K[2];
54  uint64_t S[5];
55  } state;
56  uint8_t posn;
57  uint8_t authMode;
58 
59  void permute(uint8_t first);
60  void endAuth();
61 };
62 
63 #endif
ASCON-128 authenticated cipher.
Definition: Ascon128.h:29
Ascon128()
Constructs a new Ascon128 authenticated cipher.
Definition: Ascon128.cpp:48
size_t keySize() const
Gets the size of the Ascon128 key in bytes.
Definition: Ascon128.cpp:72
size_t tagSize() const
Gets the size of the Ascon128 authentication tag in bytes.
Definition: Ascon128.cpp:95
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: Ascon128.cpp:171
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: Ascon128.cpp:142
bool setIV(const uint8_t *iv, size_t len)
Sets the initialization vector to use for future encryption and decryption operations.
Definition: Ascon128.cpp:112
void clear()
Clears all security-sensitive state from this cipher object.
Definition: Ascon128.cpp:280
bool checkTag(const void *tag, size_t len)
Finalizes the decryption process and checks the authentication tag.
Definition: Ascon128.cpp:250
virtual ~Ascon128()
Destroys this Ascon128 authenticated cipher.
Definition: Ascon128.cpp:62
void addAuthData(const void *data, size_t len)
Adds extra data that will be authenticated but not encrypted.
Definition: Ascon128.cpp:200
void computeTag(void *tag, size_t len)
Finalizes the encryption process and computes the authentication tag.
Definition: Ascon128.cpp:228
size_t ivSize() const
Gets the size of the Ascon128 initialization vector in bytes.
Definition: Ascon128.cpp:85
bool setKey(const uint8_t *key, size_t len)
Sets the key to use for future encryption and decryption operations.
Definition: Ascon128.cpp:100
Abstract base class for authenticated ciphers.