Add OCB mode, currently encrypt only, and an AEAD interface

10 files changed, 633 insertions, 0 deletions

diff --git a/checks/bench.cpp b/checks/bench.cpp
index 5faba00db..4e6f15fb6 100644
--- a/checks/bench.cpp
+++ b/checks/bench.cpp
@@ -76,6 +76,7 @@ const std::string algos[] = {
    "AES-128/CBC/CTS",
    "AES-128/CTR-BE",
    "AES-128/EAX",
+   "AES-128/OCB",
    "AES-128/OFB",
    "AES-128/XTS",
    "AES-128/CFB(128)",
diff --git a/checks/ocb.cpp b/checks/ocb.cpp
new file mode 100644
index 000000000..b45b6d2b8
--- /dev/null
+++ b/checks/ocb.cpp
@@ -0,0 +1,148 @@
+
+#include "validate.h"
+
+#include <botan/pipe.h>
+#include <botan/ocb.h>
+#include <botan/hex.h>
+#include <botan/sha2_32.h>
+#include <botan/aes.h>
+#include <iostream>
+//#include <botan/selftest.h>
+
+using namespace Botan;
+
+// something like this should be in the library
+std::vector<byte> ocb_encrypt(const SymmetricKey& key,
+                              const std::vector<byte>& nonce,
+                              const byte pt[], size_t pt_len,
+                              const byte ad[], size_t ad_len)
+   {
+   //std::unique_ptr<AEAD_Mode> ocb = get_aead("AES-128/OCB", ENCRYPTION);
+
+   OCB_Encryption* ocb = new OCB_Encryption(new AES_128);
+
+   ocb->set_key(key);
+   ocb->set_nonce(&nonce[0], nonce.size());
+   ocb->set_associated_data(ad, ad_len);
+
+   Pipe pipe(ocb);
+   pipe.process_msg(pt, pt_len);
+   return unlock(pipe.read_all());
+   }
+
+std::vector<byte> ocb_decrypt(const SymmetricKey& key,
+                              const std::vector<byte>& nonce,
+                              const byte pt[], size_t pt_len,
+                              const byte ad[], size_t ad_len)
+   {
+   throw std::runtime_error("Not implemented");
+
+#if 0
+   OCB_Decryption* ocb = new OCB_Decryption(new AES_128);
+
+   ocb->set_key(key);
+   ocb->set_nonce(&nonce[0], nonce.size());
+   ocb->set_associated_data(ad, ad_len);
+
+   Pipe pipe(ocb);
+   pipe.process_msg(pt, pt_len);
+   return pipe.read_all_unlocked();
+#endif
+   }
+
+template<typename Alloc, typename Alloc2>
+std::vector<byte> ocb_encrypt(const SymmetricKey& key,
+                              const std::vector<byte>& nonce,
+                              const std::vector<byte, Alloc>& pt,
+                              const std::vector<byte, Alloc2>& ad)
+   {
+   return ocb_encrypt(key, nonce, &pt[0], pt.size(), &ad[0], ad.size());
+   }
+
+
+void test_ocb_long()
+   {
+   SymmetricKey key("00000000000000000000000000000000");
+
+   const std::vector<byte> empty;
+   std::vector<byte> N(12);
+   std::vector<byte> C;
+
+   for(size_t i = 0; i != 128; ++i)
+      {
+      const std::vector<byte> S(i);
+      N[11] = i;
+
+      const std::vector<byte> C1 = ocb_encrypt(key, N, S, S);
+      const std::vector<byte> C2 = ocb_encrypt(key, N, S, empty);
+      const std::vector<byte> C3 = ocb_encrypt(key, N, empty, S);
+
+      //std::cout << "C_" << i << " = " << hex_encode(C1) << " " << hex_encode(C2) << " " << hex_encode(C3) << "\n";
+
+      C += C1;
+      C += C2;
+      C += C3;
+
+      SHA_256 sha256;
+      sha256.update(C);
+      //std::cout << "SHA-256(C_" << i << ") = " << hex_encode(sha256.final()) << "\n";
+      }
+
+   // SHA-256 hash of C would be useful
+
+   SHA_256 sha256;
+   sha256.update(C);
+   const std::string C_hash = hex_encode(sha256.final());
+   const std::string expected_C_hash = "C4E5158067F49356042296B13B050DE00A120EA846073E5E0DACFD0C9F43CC65";
+
+   if(C_hash != expected_C_hash)
+      {
+      std::cout << "OCB-128 long test, C hashes differ\n";
+      std::cout << C_hash << " !=\n" << expected_C_hash << "\n";
+      }
+
+   //std::cout << "SHA-256(C) = " << C_hash << "\n";
+
+   N[11] = 0;
+   const std::vector<byte> cipher = ocb_encrypt(key, N, empty, C);
+
+   const std::string expected = "B2B41CBF9B05037DA7F16C24A35C1C94";
+
+   const std::string cipher_hex = hex_encode(cipher);
+
+   if(cipher_hex != expected)
+      std::cout << "OCB AES-128 long test mistmatch " << cipher_hex << " != " << expected << "\n";
+   else
+      std::cout << "OCB AES-128 long test OK\n";
+   }
+
+void test_ocb()
+   {
+   SymmetricKey key("000102030405060708090A0B0C0D0E0F");
+
+   std::vector<byte> nonce = hex_decode("000102030405060708090A0B");
+
+   std::vector<byte> pt = hex_decode("000102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F2021222324252627");
+   std::vector<byte> ad = hex_decode("000102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F2021222324252627");
+
+   const std::string expected = "BEA5E8798DBE7110031C144DA0B26122CEAAB9B05DF771A657149D53773463CB68C65778B058A635659C623211DEEA0DE30D2C381879F4C8";
+
+   std::vector<byte> ctext = ocb_encrypt(key, nonce, pt, ad);
+
+   std::string ctext_hex = hex_encode(ctext);
+
+   if(ctext_hex != expected)
+      std::cout << "OCB/AES-128 encrypt test failure\n" << ctext_hex << " !=\n" << expected << "\n";
+   else
+      std::cout << "OCB/AES-128 encrypt OK\n";
+
+#if 0
+   std::vector<byte> dec = ocb_decrypt(key, nonce, ctext, ad);
+
+   std::cout << hex_encode(dec) << "\n";
+#endif
+
+   test_ocb_long();
+   }
+
+
diff --git a/checks/validate.cpp b/checks/validate.cpp
index 48bc6bd87..55af920cd 100644
--- a/checks/validate.cpp
+++ b/checks/validate.cpp
@@ -416,6 +416,8 @@ u32bit do_validation_tests(const std::string& filename,
       errors++;
       }
 
+   test_ocb();
+
    return errors;
    }
 
diff --git a/checks/validate.h b/checks/validate.h
index b88837d4b..539154d53 100644
--- a/checks/validate.h
+++ b/checks/validate.h
@@ -30,4 +30,6 @@ void do_x509_tests(RandomNumberGenerator&);
 
 size_t do_tls_tests(RandomNumberGenerator& rng);
 
+void test_ocb();
+
 #endif
diff --git a/src/engine/core_engine/core_modes.cpp b/src/engine/core_engine/core_modes.cpp
index 21a5863e2..039a60c78 100644
--- a/src/engine/core_engine/core_modes.cpp
+++ b/src/engine/core_engine/core_modes.cpp
@@ -40,6 +40,10 @@
   #include <botan/eax.h>
 #endif
 
+#if defined(BOTAN_HAS_OCB)
+  #include <botan/ocb.h>
+#endif
+
 #if defined(BOTAN_HAS_XTS)
   #include <botan/xts.h>
 #endif
@@ -127,6 +131,18 @@ Keyed_Filter* get_cipher_mode(const BlockCipher* block_cipher,
 #endif
       }
 
+#if defined(BOTAN_HAS_OCB)
+   if(mode == "OCB")
+      {
+      if(direction == ENCRYPTION)
+         return new OCB_Encryption(block_cipher->clone(), 16);
+      /*
+      else
+         return new OCB_Decryption(block_cipher->clone(), 16);
+      */
+      }
+#endif
+
 #if defined(BOTAN_HAS_XTS)
    if(mode == "XTS")
       {
diff --git a/src/filters/modes/aead/aead.h b/src/filters/modes/aead/aead.h
new file mode 100644
index 000000000..868008e5d
--- /dev/null
+++ b/src/filters/modes/aead/aead.h
@@ -0,0 +1,38 @@
+/*
+* Interface for AEAD modes
+* (C) 2013 Jack Lloyd
+*
+* Distributed under the terms of the Botan license
+*/
+
+#ifndef BOTAN_AEAD_H__
+#define BOTAN_AEAD_H__
+
+#include <botan/key_filt.h>
+
+namespace Botan {
+
+class AEAD_Mode : public Keyed_Filter
+   {
+   public:
+      /**
+      * Set associated data that is not included in the ciphertext but
+      * that should be authenticated. Must be called after set_key
+      * and before end_msg.
+      *
+      * @param ad the associated data
+      * @param ad_len length of add in bytes
+      */
+      virtual void set_associated_data(const byte ad[], size_t ad_len) = 0;
+
+      virtual void set_nonce(const byte nonce[], size_t nonce_len) = 0;
+
+      void set_iv(const InitializationVector& iv) override
+         {
+         set_nonce(iv.begin(), iv.length());
+         }
+   };
+
+}
+
+#endif
diff --git a/src/filters/modes/aead/info.txt b/src/filters/modes/aead/info.txt
new file mode 100644
index 000000000..b43aab2f6
--- /dev/null
+++ b/src/filters/modes/aead/info.txt
@@ -0,0 +1 @@
+define AEAD
diff --git a/src/filters/modes/ocb/info.txt b/src/filters/modes/ocb/info.txt
new file mode 100644
index 000000000..a98d7d54e
--- /dev/null
+++ b/src/filters/modes/ocb/info.txt
@@ -0,0 +1,7 @@
+define OCB
+
+<requires>
+block
+aead
+cmac
+</requires>
diff --git a/src/filters/modes/ocb/ocb.cpp b/src/filters/modes/ocb/ocb.cpp
new file mode 100644
index 000000000..05b1019b5
--- /dev/null
+++ b/src/filters/modes/ocb/ocb.cpp
@@ -0,0 +1,291 @@
+/*
+* OCB Mode
+* (C) 2013 Jack Lloyd
+*
+* Distributed under the terms of the Botan license
+*/
+
+#include <botan/ocb.h>
+#include <botan/cmac.h>
+#include <botan/internal/xor_buf.h>
+#include <botan/internal/bit_ops.h>
+#include <algorithm>
+
+#include <iostream>
+
+namespace Botan {
+
+namespace ShouldNotBeHere {
+
+inline void xor_mem(byte out[], const byte in[], size_t length)
+   {
+   for(size_t i = 0; i != length; ++i)
+      out[i] ^= in[i];
+   }
+
+inline void xor_mem(byte out[], const byte in[], const byte in2[], size_t length)
+   {
+   for(size_t i = 0; i != length; ++i)
+      out[i] = in[i] ^ in2[i];
+   }
+
+
+template<typename T, typename Alloc, typename Alloc2>
+std::vector<T, Alloc>&
+operator^=(std::vector<T, Alloc>& out,
+           const std::vector<T, Alloc2>& in)
+   {
+   if(out.size() < in.size())
+      out.resize(in.size());
+
+   xor_mem(&out[0], &in[0], in.size());
+   return out;
+   }
+
+
+}
+
+using namespace ShouldNotBeHere;
+
+
+// Has to be in Botan namespace so unique_ptr can reference it
+class L_computer
+   {
+   public:
+      L_computer(const BlockCipher& cipher);
+
+      const secure_vector<byte>& star() const { return m_L_star; }
+
+      const secure_vector<byte>& dollar() const { return m_L_dollar; }
+
+      // this should apply ctz (and cache it)
+      const secure_vector<byte>& operator()(size_t i) const;
+   private:
+      secure_vector<byte> poly_double(const secure_vector<byte>& in) const
+         {
+         return CMAC::poly_double(in, 0x87);
+         }
+
+      secure_vector<byte> m_L_dollar, m_L_star;
+      mutable std::vector<secure_vector<byte>> m_L;
+   };
+
+L_computer::L_computer(const BlockCipher& cipher)
+   {
+   m_L_star.resize(16);
+   cipher.encrypt(m_L_star);
+   m_L_dollar = poly_double(star());
+   m_L.push_back(poly_double(dollar()));
+   }
+
+const secure_vector<byte>& L_computer::operator()(size_t i) const
+   {
+   while(m_L.size() <= i)
+      m_L.push_back(poly_double(m_L.back()));
+
+   return m_L.at(i);
+   }
+
+namespace {
+
+/*
+* OCB's HASH
+*/
+secure_vector<byte> ocb_hash(const L_computer& L,
+                             const BlockCipher& cipher,
+                             const byte ad[], size_t ad_len)
+   {
+   secure_vector<byte> sum(16);
+   secure_vector<byte> offset(16);
+
+   secure_vector<byte> buf(16);
+
+   const size_t ad_blocks = (ad_len / 16);
+   const size_t ad_remainder = (ad_len % 16);
+
+   for(size_t i = 0; i != ad_blocks; ++i)
+      {
+      // this loop could run in parallel
+      offset ^= L(ctz(i+1));
+
+      buf = offset;
+      xor_mem(&buf[0], &ad[16*i], 16);
+
+      cipher.encrypt(buf);
+
+      sum ^= buf;
+      }
+
+   if(ad_remainder)
+      {
+      offset ^= L.star();
+
+      buf = offset;
+      xor_mem(&buf[0], &ad[16*ad_blocks], ad_remainder);
+      buf[ad_len % 16] ^= 0x80;
+
+      cipher.encrypt(buf);
+
+      sum ^= buf;
+      }
+
+   return sum;
+   }
+
+}
+
+OCB_Mode::OCB_Mode(BlockCipher* cipher, size_t tag_size) :
+   Buffered_Filter(16, 0),
+   m_cipher(cipher), m_tag_size(tag_size),
+   m_ad_hash(16), m_offset(16), m_checksum(16)
+   {
+   if(m_cipher->block_size() != 16)
+      throw std::invalid_argument("OCB requires a 128 bit cipher so cannot be used with " +
+                                  m_cipher->name());
+   }
+
+OCB_Mode::~OCB_Mode() { /* for unique_ptr destructor */ }
+
+bool OCB_Mode::valid_keylength(size_t n) const
+   {
+   return m_cipher->valid_keylength(n);
+   }
+
+std::string OCB_Mode::name() const
+   {
+   return m_cipher->name() + "/OCB"; // include tag size
+   }
+
+void OCB_Mode::set_key(const SymmetricKey& key)
+   {
+   m_cipher->set_key(key);
+   m_L.reset(new L_computer(*m_cipher));
+   }
+
+void OCB_Mode::set_nonce(const byte nonce[], size_t nonce_len)
+   {
+   if(nonce_len > 15) // OCB supports 127 bits, we support 120
+      throw Invalid_IV_Length(name(), nonce_len);
+
+   byte bottom;
+   secure_vector<byte> stretch;
+
+   if(1) // need to recompute stretch (save iv to compare)
+      {
+      secure_vector<byte> buf(16);
+
+      const size_t offset = 16 - nonce_len;
+
+      copy_mem(&buf[offset], nonce, nonce_len);
+      buf[offset-1] = 1;
+
+      bottom = buf[15] & 0x3F;
+      buf[15] &= 0xC0;
+
+      m_cipher->encrypt(buf);
+
+      for(size_t i = 0; i != 8; ++i)
+         buf.push_back(buf[i] ^ buf[i+1]);
+
+      stretch = buf;
+      }
+
+   // now set the offset from stretch and bottom
+
+   const size_t shift_bytes = bottom / 8;
+   const size_t shift_bits  = bottom % 8;
+
+   for(size_t i = 0; i != 16; ++i)
+      {
+      m_offset[i]  = (stretch[i+shift_bytes] << shift_bits);
+      m_offset[i] |= (stretch[i+shift_bytes+1] >> (8-shift_bits));
+      }
+   }
+
+void OCB_Mode::start_msg()
+   {
+   //BOTAN_ASSERT(m_nonce_state.fresh_nonce(), "Nonce state is fresh");
+   }
+
+void OCB_Mode::set_associated_data(const byte ad[], size_t ad_len)
+   {
+   m_ad_hash = ocb_hash(*m_L, *m_cipher, &ad[0], ad_len);
+   }
+
+void OCB_Mode::write(const byte input[], size_t length)
+   {
+   Buffered_Filter::write(input, length);
+   }
+
+void OCB_Mode::end_msg()
+   {
+   Buffered_Filter::end_msg();
+   }
+
+void OCB_Encryption::buffered_block(const byte input[], size_t input_length)
+   {
+   BOTAN_ASSERT(input_length % 16 == 0, "Input length is an even number of blocks");
+
+   const size_t blocks = input_length / 16;
+
+   const L_computer& L = *m_L;
+
+   secure_vector<byte> ctext_buf(16);
+
+   for(size_t i = 0; i != blocks; ++i)
+      {
+      // could run in parallel
+
+      xor_mem(&m_checksum[0], &input[16*i], 16);
+
+      m_offset ^= L(ctz(++m_block_index));
+
+      ctext_buf = m_offset;
+      xor_mem(&ctext_buf[0], &input[16*i], 16);
+      m_cipher->encrypt(ctext_buf);
+      ctext_buf ^= m_offset;
+
+      send(ctext_buf);
+      }
+   }
+
+void OCB_Encryption::buffered_final(const byte input[], size_t input_length)
+   {
+   /*
+   todo - might have multiple blocks here if buffering up multiple
+   blocks for bitslice mode, run those first by calling buffered_write
+   directly
+   */
+
+   if(input_length)
+      {
+      BOTAN_ASSERT(input_length < 16, "Only a partial block left");
+
+      xor_mem(&m_checksum[0], &input[0], input_length);
+      m_checksum[input_length] ^= 0x80;
+
+      m_offset ^= m_L->star(); // Offset_*
+
+      secure_vector<byte> buf(16);
+      m_cipher->encrypt(m_offset, buf);
+      xor_mem(&buf[0], &input[0], input_length);
+
+      send(buf, input_length); // final ciphertext
+      }
+
+   // now compute the tag
+   secure_vector<byte> mac = m_offset;
+   mac ^= m_checksum;
+   mac ^= m_L->dollar();
+
+   m_cipher->encrypt(mac);
+
+   mac ^= m_ad_hash;
+
+   send(mac);
+
+   zeroise(m_checksum);
+   zeroise(m_offset);
+   }
+
+}
diff --git a/src/filters/modes/ocb/ocb.h b/src/filters/modes/ocb/ocb.h
new file mode 100644
index 000000000..2c0795fe1
--- /dev/null
+++ b/src/filters/modes/ocb/ocb.h
@@ -0,0 +1,127 @@
+/*
+* OCB Mode
+* (C) 2013 Jack Lloyd
+*
+* Distributed under the terms of the Botan license
+*/
+
+#ifndef BOTAN_OCB_H__
+#define BOTAN_OCB_H__
+
+#include <botan/aead.h>
+#include <botan/block_cipher.h>
+#include <botan/buf_filt.h>
+#include <memory>
+
+namespace Botan {
+
+/**
+* OCB Mode (base class for OCB_Encryption and OCB_Decryption). Note
+* that OCB is patented, but is freely licensed in some circumstances.
+*
+* @see "The OCB Authenticated-Encryption Algorithm" internet draft
+        http://tools.ietf.org/html/draft-irtf-cfrg-ocb-00
+* @see Free Licenses http://www.cs.ucdavis.edu/~rogaway/ocb/license.htm
+* @see OCB home page http://www.cs.ucdavis.edu/~rogaway/ocb
+
+*/
+class BOTAN_DLL OCB_Mode : public AEAD_Mode,
+                           private Buffered_Filter
+   {
+   public:
+      /**
+      * @param cipher the 128-bit block cipher to use
+      * @param tag_size is how big the auth tag will be
+      */
+      OCB_Mode(BlockCipher* cipher, size_t tag_size = 16);
+
+      ~OCB_Mode();
+
+      void set_key(const SymmetricKey& key) override;
+      void set_nonce(const byte nonce[], size_t nonce_len) override;
+
+      void set_associated_data(const byte ad[], size_t ad_len) override;
+
+      bool valid_keylength(size_t n) const override;
+
+      std::string name() const override;
+
+   protected:
+      // fixme make these private
+      std::unique_ptr<BlockCipher> m_cipher;
+      std::unique_ptr<class L_computer> m_L;
+      size_t m_tag_size = 0;
+      size_t m_block_index = 0;
+
+      secure_vector<byte> m_ad_hash;
+      secure_vector<byte> m_offset;
+      secure_vector<byte> m_checksum;
+
+   private:
+      void write(const byte input[], size_t input_length) override;
+      void start_msg() override;
+      void end_msg() override;
+   };
+
+class BOTAN_DLL OCB_Encryption : public OCB_Mode
+   {
+   public:
+      /**
+      * @param cipher the 128-bit block cipher to use
+      * @param tag_size is how big the auth tag will be
+      */
+      OCB_Encryption(BlockCipher* cipher, size_t tag_size = 16) :
+         OCB_Mode(cipher, tag_size) {}
+
+   private:
+      void buffered_block(const byte input[], size_t input_length) override;
+      void buffered_final(const byte input[], size_t input_length) override;
+   };
+
+#if 0
+/**
+* OCB Decryption
+*/
+class BOTAN_DLL OCB_Decryption : public AEAD_Mode,
+                                 private Buffered_Filter
+   {
+   public:
+      /**
+      * @param cipher the cipher to use
+      * @param tag_size is how big the auth tag will be
+      */
+      OCB_Decryption(BlockCipher* cipher, size_t tag_size = 16);
+
+      ~OCB_Decryption();
+
+      void set_key(const SymmetricKey& key) override;
+      void set_nonce(const byte nonce[], size_t nonce_len) override;
+
+      void set_associated_data(const byte ad[], size_t ad_len) override;
+
+      bool valid_keylength(size_t n) const override;
+
+      std::string name() const override;
+
+   private:
+      void buffered_block(const byte input[], size_t input_length) override;
+      void buffered_final(const byte input[], size_t input_length) override;
+
+      void write(const byte input[], size_t input_length) override;
+      void start_msg() override;
+      void end_msg() override;
+
+      std::unique_ptr<BlockCipher> m_cipher;
+      std::unique_ptr<class L_computer> m_L;
+      size_t m_tag_size = 0;
+      size_t m_block_index = 0;
+
+      secure_vector<byte> m_ad_hash;
+      secure_vector<byte> m_offset;
+      secure_vector<byte> m_checksum;
+   };
+#endif
+
+}
+
+#endif