Arduino Cryptography Library
Cipher.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_CIPHER_h
24 #define CRYPTO_CIPHER_h
25 
26 #include <inttypes.h>
27 #include <stddef.h>
28 
29 class Cipher
30 {
31 public:
32  Cipher();
33  virtual ~Cipher();
34 
35  virtual size_t keySize() const = 0;
36  virtual size_t ivSize() const = 0;
37 
38  virtual bool setKey(const uint8_t *key, size_t len) = 0;
39  virtual bool setIV(const uint8_t *iv, size_t len) = 0;
40 
41  virtual void encrypt(uint8_t *output, const uint8_t *input, size_t len) = 0;
42  virtual void decrypt(uint8_t *output, const uint8_t *input, size_t len) = 0;
43 
44  virtual void clear() = 0;
45 };
46 
47 #endif
Abstract base class for stream ciphers.
Definition: Cipher.h:30
virtual bool setKey(const uint8_t *key, size_t len)=0
Sets the key to use for future encryption and decryption operations.
virtual bool setIV(const uint8_t *iv, size_t len)=0
Sets the initialization vector to use for future encryption and decryption operations.
virtual void clear()=0
Clears all security-sensitive state from this cipher.
virtual size_t keySize() const =0
Default size of the key for this cipher, in bytes.
Cipher()
Constructs a new cipher object.
Definition: Cipher.cpp:41
virtual ~Cipher()
Destroys this cipher object.
Definition: Cipher.cpp:53
virtual size_t ivSize() const =0
Size of the initialization vector for this cipher, in bytes.
virtual void decrypt(uint8_t *output, const uint8_t *input, size_t len)=0
Decrypts an input buffer and writes the plaintext to an output buffer.
virtual void encrypt(uint8_t *output, const uint8_t *input, size_t len)=0
Encrypts an input buffer and writes the ciphertext to an output buffer.