Add new top-level algorithm which provides basic functionality: name

query, clearing, and cloning. Applies to ciphers, hashes, MACs, and
PBKDFs. May extend to KDFs later as well.

A single combined hierarchy in particular will make the algo_factory
much simpler.

1 files changed, 156 insertions, 0 deletions

diff --git a/src/algo_base/symkey.h b/src/algo_base/symkey.h
new file mode 100644
index 000000000..6735b2b87
--- /dev/null
+++ b/src/algo_base/symkey.h
@@ -0,0 +1,156 @@
+/*
+* OctetString
+* (C) 1999-2007 Jack Lloyd
+*
+* Distributed under the terms of the Botan license
+*/
+
+#ifndef BOTAN_SYMKEY_H__
+#define BOTAN_SYMKEY_H__
+
+#include <botan/secmem.h>
+#include <string>
+
+namespace Botan {
+
+/**
+* Octet String
+*/
+class BOTAN_DLL OctetString
+   {
+   public:
+      /**
+      * @return size of this octet string in bytes
+      */
+      size_t length() const { return bits.size(); }
+
+      /**
+      * @return this object as a SecureVector<byte>
+      */
+      SecureVector<byte> bits_of() const { return bits; }
+
+      /**
+      * @return start of this string
+      */
+      const byte* begin() const { return &bits[0]; }
+
+      /**
+      * @return end of this string
+      */
+      const byte* end() const   { return &bits[bits.size()]; }
+
+      /**
+      * @return this encoded as hex
+      */
+      std::string as_string() const;
+
+      /**
+      * XOR the contents of another octet string into this one
+      * @param other octet string
+      * @return reference to this
+      */
+      OctetString& operator^=(const OctetString& other);
+
+      /**
+      * Force to have odd parity
+      */
+      void set_odd_parity();
+
+      /**
+      * Change the contents of this octet string
+      * @param hex_string a hex encoded bytestring
+      */
+      void change(const std::string& hex_string);
+
+      /**
+      * Change the contents of this octet string
+      * @param in the input
+      * @param length of in in bytes
+      */
+      void change(const byte in[], size_t length);
+
+      /**
+      * Change the contents of this octet string
+      * @param in the input
+      */
+      void change(const MemoryRegion<byte>& in) { bits = in; }
+
+      /**
+      * Create a new random OctetString
+      * @param rng is a random number generator
+      * @param len is the desired length in bytes
+      */
+      OctetString(class RandomNumberGenerator& rng, size_t len);
+
+      /**
+      * Create a new OctetString
+      * @param str is a hex encoded string
+      */
+      OctetString(const std::string& str = "") { change(str); }
+
+      /**
+      * Create a new OctetString
+      * @param in is an array
+      * @param len is the length of in in bytes
+      */
+      OctetString(const byte in[], size_t len) { change(in, len); }
+
+      /**
+      * Create a new OctetString
+      * @param in a bytestring
+      */
+      OctetString(const MemoryRegion<byte>& in) { change(in); }
+   private:
+      SecureVector<byte> bits;
+   };
+
+/**
+* Compare two strings
+* @param x an octet string
+* @param y an octet string
+* @return if x is equal to y
+*/
+BOTAN_DLL bool operator==(const OctetString& x,
+                          const OctetString& y);
+
+/**
+* Compare two strings
+* @param x an octet string
+* @param y an octet string
+* @return if x is not equal to y
+*/
+BOTAN_DLL bool operator!=(const OctetString& x,
+                          const OctetString& y);
+
+/**
+* Concatenate two strings
+* @param x an octet string
+* @param y an octet string
+* @return x concatenated with y
+*/
+BOTAN_DLL OctetString operator+(const OctetString& x,
+                                const OctetString& y);
+
+/**
+* XOR two strings
+* @param x an octet string
+* @param y an octet string
+* @return x XORed with y
+*/
+BOTAN_DLL OctetString operator^(const OctetString& x,
+                                const OctetString& y);
+
+
+/**
+* Alternate name for octet string showing intent to use as a key
+*/
+typedef OctetString SymmetricKey;
+
+/**
+* Alternate name for octet string showing intent to use as an IV
+*/
+typedef OctetString InitializationVector;
+
+}
+
+#endif