Arduino Cryptography Library
XOF.h
1 /*
2  * Copyright (C) 2016 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_XOF_h
24 #define CRYPTO_XOF_h
25 
26 #include <inttypes.h>
27 #include <stddef.h>
28 
29 class XOF
30 {
31 public:
32  XOF();
33  virtual ~XOF();
34 
35  virtual size_t blockSize() const = 0;
36 
37  virtual void reset() = 0;
38  virtual void update(const void *data, size_t len) = 0;
39 
40  virtual void extend(uint8_t *data, size_t len) = 0;
41  virtual void encrypt(uint8_t *output, const uint8_t *input, size_t len) = 0;
42 
43  inline void decrypt(uint8_t *output, const uint8_t *input, size_t len)
44  {
45  encrypt(output, input, len);
46  }
47 
48  virtual void clear() = 0;
49 };
50 
51 #endif
Abstract base class for Extendable-Output Functions (XOFs).
Definition: XOF.h:30
virtual void extend(uint8_t *data, size_t len)=0
Generates extendable output from this XOF.
void decrypt(uint8_t *output, const uint8_t *input, size_t len)
Decrypts an input buffer with extendable output from this XOF.
Definition: XOF.h:43
virtual void update(const void *data, size_t len)=0
Updates the XOF with more data.
virtual size_t blockSize() const =0
Size of the internal block used by the XOF algorithm, in bytes.
virtual ~XOF()
Destroys this XOF object.
Definition: XOF.cpp:134
virtual void reset()=0
Resets the XOF ready for a new session.
XOF()
Constructs a new XOF object.
Definition: XOF.cpp:122
virtual void encrypt(uint8_t *output, const uint8_t *input, size_t len)=0
Encrypts an input buffer with extendable output from this XOF.
virtual void clear()=0
Clears the hash state, removing all sensitive data, and then resets the XOF ready for a new session.