Convert OCB to new AEAD interface

4 files changed, 544 insertions, 1 deletions

diff --git a/src/aead/gcm/gcm.cpp b/src/aead/gcm/gcm.cpp
index 0ff73b034..628dcc270 100644
--- a/src/aead/gcm/gcm.cpp
+++ b/src/aead/gcm/gcm.cpp
@@ -225,5 +225,4 @@ void GCM_Decryption::finish(secure_vector<byte>& buffer)
       throw Integrity_Failure("GCM tag check failed");
    }
 
-
 }
diff --git a/src/aead/ocb/info.txt b/src/aead/ocb/info.txt
new file mode 100644
index 000000000..8d6a93ed9
--- /dev/null
+++ b/src/aead/ocb/info.txt
@@ -0,0 +1,6 @@
+define AEAD_OCB
+
+<requires>
+block
+cmac
+</requires>
diff --git a/src/aead/ocb/ocb.cpp b/src/aead/ocb/ocb.cpp
new file mode 100644
index 000000000..5bd42766f
--- /dev/null
+++ b/src/aead/ocb/ocb.cpp
@@ -0,0 +1,423 @@
+/*
+* 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 <botan/hex.h>
+#include <iostream>
+
+namespace Botan {
+
+// Has to be in Botan namespace so unique_ptr can reference it
+class L_computer
+   {
+   public:
+      L_computer(const BlockCipher& cipher)
+         {
+         m_L_star.resize(cipher.block_size());
+         cipher.encrypt(m_L_star);
+         m_L_dollar = poly_double(star());
+         m_L.push_back(poly_double(dollar()));
+         }
+
+      const secure_vector<byte>& star() const { return m_L_star; }
+
+      const secure_vector<byte>& dollar() const { return m_L_dollar; }
+
+      const secure_vector<byte>& operator()(size_t i) const { return get(i); }
+
+      const secure_vector<byte>& get(size_t i) const
+         {
+         while(m_L.size() <= i)
+            m_L.push_back(poly_double(m_L.back()));
+
+         return m_L.at(i);
+         }
+
+   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;
+   };
+
+class Nonce_State
+   {
+   public:
+      Nonce_State(const BlockCipher& cipher) : m_cipher(cipher) {}
+
+      secure_vector<byte> update_nonce(const byte nonce[],
+                                       size_t nonce_len);
+   private:
+      const BlockCipher& m_cipher;
+      secure_vector<byte> m_last_nonce;
+      secure_vector<byte> m_stretch;
+   };
+
+secure_vector<byte>
+Nonce_State::update_nonce(const byte nonce[], size_t nonce_len)
+   {
+   const size_t BS = 16;
+
+   BOTAN_ASSERT(nonce_len < BS, "Nonce is less than 128 bits");
+
+   secure_vector<byte> nonce_buf(BS);
+
+   copy_mem(&nonce_buf[BS - nonce_len], nonce, nonce_len);
+   nonce_buf[BS - nonce_len - 1] = 1;
+
+   const byte bottom = nonce_buf[15] & 0x3F;
+   nonce_buf[15] &= 0xC0;
+
+   const bool need_new_stretch = (m_last_nonce != nonce_buf);
+
+   if(need_new_stretch)
+      {
+      m_last_nonce = nonce_buf;
+
+      m_cipher.encrypt(nonce_buf);
+
+      for(size_t i = 0; i != 8; ++i)
+         nonce_buf.push_back(nonce_buf[i] ^ nonce_buf[i+1]);
+
+      m_stretch = nonce_buf;
+      }
+
+   // now set the offset from stretch and bottom
+
+   const size_t shift_bytes = bottom / 8;
+   const size_t shift_bits  = bottom % 8;
+
+   secure_vector<byte> offset(BS);
+   for(size_t i = 0; i != BS; ++i)
+      {
+      offset[i]  = (m_stretch[i+shift_bytes] << shift_bits);
+      offset[i] |= (m_stretch[i+shift_bytes+1] >> (8-shift_bits));
+      }
+
+   return offset;
+   }
+
+namespace {
+
+/*
+* OCB's HASH
+*/
+secure_vector<byte> ocb_hash(const L_computer& L,
+                             const BlockCipher& cipher,
+                             const byte ad[], size_t ad_len)
+   {
+   const size_t BS = cipher.block_size();
+
+   secure_vector<byte> sum(BS);
+   secure_vector<byte> offset(BS);
+
+   secure_vector<byte> buf(BS);
+
+   const size_t ad_blocks = (ad_len / BS);
+   const size_t ad_remainder = (ad_len % BS);
+
+   for(size_t i = 0; i != ad_blocks; ++i)
+      {
+      // this loop could run in parallel
+      offset ^= L(ctz(i+1));
+
+      buf = offset;
+      xor_buf(&buf[0], &ad[BS*i], BS);
+
+      cipher.encrypt(buf);
+
+      sum ^= buf;
+      }
+
+   if(ad_remainder)
+      {
+      offset ^= L.star();
+
+      buf = offset;
+      xor_buf(&buf[0], &ad[BS*ad_blocks], ad_remainder);
+      buf[ad_len % BS] ^= 0x80;
+
+      cipher.encrypt(buf);
+
+      sum ^= buf;
+      }
+
+   return sum;
+   }
+
+}
+
+OCB_Mode::OCB_Mode(BlockCipher* cipher, size_t tag_size) :
+   m_cipher(cipher),
+   m_tag_size(tag_size),
+   m_ad_hash(BS), m_offset(BS), m_checksum(BS)
+   {
+   if(m_cipher->block_size() != BS)
+      throw std::invalid_argument("OCB requires a 128 bit cipher so cannot be used with " +
+                                  m_cipher->name());
+
+   if(m_tag_size != 16) // fixme: 64, 96 bits also supported
+      throw std::invalid_argument("OCB cannot produce a " + std::to_string(m_tag_size) +
+                                  " byte tag");
+
+   }
+
+OCB_Mode::~OCB_Mode() { /* for unique_ptr destructor */ }
+
+void OCB_Mode::clear()
+   {
+   m_cipher.reset();
+   m_L.reset();
+   zeroise(m_ad_hash);
+   zeroise(m_offset);
+   zeroise(m_checksum);
+   }
+
+bool OCB_Mode::valid_nonce_length(size_t length) const
+   {
+   return (length > 0 && length < 16);
+   }
+
+std::string OCB_Mode::name() const
+   {
+   return m_cipher->name() + "/OCB"; // include tag size
+   }
+
+size_t OCB_Mode::update_granularity() const
+   {
+   return 8 * m_cipher->parallel_bytes();
+   }
+
+Key_Length_Specification OCB_Mode::key_spec() const
+   {
+   return m_cipher->key_spec();
+   }
+
+void OCB_Mode::key_schedule(const byte key[], size_t length)
+   {
+   m_cipher->set_key(key, length);
+   m_L.reset(new L_computer(*m_cipher));
+   m_nonce_state.reset(new Nonce_State(*m_cipher));
+   }
+
+void OCB_Mode::set_associated_data(const byte ad[], size_t ad_len)
+   {
+   BOTAN_ASSERT(m_L, "A key was set");
+   m_ad_hash = ocb_hash(*m_L, *m_cipher, &ad[0], ad_len);
+   }
+
+secure_vector<byte> OCB_Mode::start(const byte nonce[], size_t nonce_len)
+   {
+   if(!valid_nonce_length(nonce_len))
+      throw Invalid_IV_Length(name(), nonce_len);
+
+   BOTAN_ASSERT(m_nonce_state, "A key was set");
+
+   m_offset = m_nonce_state->update_nonce(nonce, nonce_len);
+   zeroise(m_checksum);
+   m_block_index = 0;
+
+   return secure_vector<byte>();
+   }
+
+void OCB_Encryption::encrypt(byte buffer[], size_t blocks)
+   {
+   const L_computer& L = *m_L; // convenient name
+
+   const size_t par_bytes = m_cipher->parallel_bytes();
+
+   BOTAN_ASSERT(par_bytes % BS == 0, "Cipher is parallel in full blocks");
+
+   const size_t par_blocks = par_bytes / BS;
+
+   secure_vector<byte> csum_accum(par_bytes);
+   secure_vector<byte> offsets(par_bytes);
+
+   size_t blocks_left = blocks;
+
+   while(blocks_left)
+      {
+      const size_t proc_blocks = std::min(blocks_left, par_blocks);
+      const size_t proc_bytes = proc_blocks * BS;
+
+      for(size_t i = 0; i != proc_blocks; ++i)
+         { // could be done in parallel
+         m_offset ^= L(ctz(++m_block_index));
+         copy_mem(&offsets[BS*i], &m_offset[0], BS);
+         }
+
+      xor_buf(&csum_accum[0], &buffer[0], proc_bytes);
+
+      xor_buf(&buffer[0], &offsets[0], proc_bytes);
+
+      m_cipher->encrypt_n(&buffer[0], &buffer[0], proc_blocks);
+
+      xor_buf(&buffer[0], &offsets[0], proc_bytes);
+
+      buffer += proc_bytes;
+      blocks_left -= proc_blocks;
+      }
+
+   // fold into checksum
+   for(size_t i = 0; i != csum_accum.size(); ++i)
+      m_checksum[i % BS] ^= csum_accum[i];
+   }
+
+void OCB_Encryption::update(secure_vector<byte>& buffer)
+   {
+   BOTAN_ASSERT(buffer.size() % BS == 0, "Input length is an even number of blocks");
+
+   encrypt(&buffer[0], buffer.size() / BS);
+   }
+
+void OCB_Encryption::finish(secure_vector<byte>& buffer)
+   {
+   if(!buffer.empty())
+      {
+      const size_t final_full_blocks = buffer.size() / BS;
+      const size_t remainder_bytes = buffer.size() - (final_full_blocks * BS);
+
+      encrypt(&buffer[0], final_full_blocks);
+
+      if(remainder_bytes)
+         {
+         BOTAN_ASSERT(remainder_bytes < BS, "Only a partial block left");
+         byte* remainder = &buffer[buffer.size() - remainder_bytes];
+
+         xor_buf(&m_checksum[0], &remainder[0], remainder_bytes);
+         m_checksum[remainder_bytes] ^= 0x80;
+
+         m_offset ^= m_L->star(); // Offset_*
+
+         secure_vector<byte> buf(BS);
+         m_cipher->encrypt(m_offset, buf);
+         xor_buf(&remainder[0], &buf[0], remainder_bytes);
+         }
+      }
+
+   // 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;
+
+   buffer += mac;
+
+   zeroise(m_checksum);
+   zeroise(m_offset);
+   m_block_index = 0;
+   }
+
+void OCB_Decryption::decrypt(byte buffer[], size_t blocks)
+   {
+   const L_computer& L = *m_L; // convenient name
+
+   const size_t par_bytes = m_cipher->parallel_bytes();
+
+   BOTAN_ASSERT(par_bytes % BS == 0, "Cipher is parallel in full blocks");
+
+   const size_t par_blocks = par_bytes / BS;
+
+   secure_vector<byte> csum_accum(par_bytes);
+   secure_vector<byte> offsets(par_bytes);
+
+   size_t blocks_left = blocks;
+
+   while(blocks_left)
+      {
+      const size_t proc_blocks = std::min(blocks_left, par_blocks);
+      const size_t proc_bytes = proc_blocks * BS;
+
+      for(size_t i = 0; i != proc_blocks; ++i)
+         { // could be done in parallel
+         m_offset ^= L(ctz(++m_block_index));
+         copy_mem(&offsets[BS*i], &m_offset[0], BS);
+         }
+
+      xor_buf(&buffer[0], &offsets[0], proc_bytes);
+
+      m_cipher->decrypt_n(&buffer[0], &buffer[0], proc_blocks);
+
+      xor_buf(&buffer[0], &offsets[0], proc_bytes);
+
+      xor_buf(&csum_accum[0], &buffer[0], proc_bytes);
+
+      buffer += proc_bytes;
+      blocks_left -= proc_blocks;
+      }
+
+   // fold into checksum
+   for(size_t i = 0; i != csum_accum.size(); ++i)
+      m_checksum[i % BS] ^= csum_accum[i];
+   }
+
+void OCB_Decryption::update(secure_vector<byte>& buffer)
+   {
+   BOTAN_ASSERT(buffer.size() % BS == 0, "Input length is an even number of blocks");
+
+   decrypt(&buffer[0], buffer.size() / BS);
+   }
+
+void OCB_Decryption::finish(secure_vector<byte>& buffer)
+   {
+   BOTAN_ASSERT(buffer.size() >= tag_size(), "We have the tag");
+
+   if(const size_t remaining_ctext = buffer.size() - tag_size())
+      {
+      const size_t final_full_blocks = remaining_ctext / BS;
+      const size_t remainder_bytes = remaining_ctext - (final_full_blocks * BS);
+
+      decrypt(&buffer[0], final_full_blocks);
+
+      if(remainder_bytes)
+         {
+         BOTAN_ASSERT(remainder_bytes < BS, "Only a partial block left");
+
+         byte* remainder = &buffer[buffer.size() - remainder_bytes];
+
+         m_offset ^= m_L->star(); // Offset_*
+
+         secure_vector<byte> pad(BS);
+         m_cipher->encrypt(m_offset, pad); // P_*
+
+         xor_buf(&remainder[0], &pad[0], remainder_bytes);
+
+         xor_buf(&m_checksum[0], &remainder[0], remainder_bytes);
+         m_checksum[remainder_bytes] ^= 0x80;
+         }
+      }
+
+   const byte* included_tag = &buffer[buffer.size() - tag_size()];
+
+   secure_vector<byte> mac = m_offset;
+   mac ^= m_checksum;
+   mac ^= m_L->dollar();
+
+   m_cipher->encrypt(mac);
+
+   mac ^= m_ad_hash;
+
+   zeroise(m_checksum);
+   zeroise(m_offset);
+   m_block_index = 0;
+
+   if(!same_mem(&mac[0], included_tag, m_tag_size))
+      throw Integrity_Failure("OCB tag check failed");
+   }
+
+}
diff --git a/src/aead/ocb/ocb.h b/src/aead/ocb/ocb.h
new file mode 100644
index 000000000..9d10c2656
--- /dev/null
+++ b/src/aead/ocb/ocb.h
@@ -0,0 +1,115 @@
+/*
+* 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 {
+
+class L_computer;
+class Nonce_State;
+
+/**
+* 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
+   {
+   public:
+      secure_vector<byte> start(const byte nonce[], size_t nonce_len) override;
+
+      void set_associated_data(const byte ad[], size_t ad_len) override;
+
+      std::string name() const override;
+
+      size_t update_granularity() const;
+
+      Key_Length_Specification key_spec() const override;
+
+      bool valid_nonce_length(size_t) const override;
+
+      void clear();
+
+      ~OCB_Mode();
+   protected:
+      static const size_t BS = 16; // intrinsic to OCB definition
+
+      /**
+      * @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);
+
+      void key_schedule(const byte key[], size_t length) override;
+
+      size_t tag_size() const { return m_tag_size; }
+
+      // fixme make these private
+      std::unique_ptr<BlockCipher> m_cipher;
+      std::unique_ptr<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:
+      std::unique_ptr<Nonce_State> m_nonce_state;
+   };
+
+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) {}
+
+      size_t minimum_final_size() const override { return 0; }
+
+      void update(secure_vector<byte>& blocks) override;
+
+      void finish(secure_vector<byte>& final_block) override;
+   private:
+      void encrypt(byte input[], size_t blocks);
+   };
+
+class BOTAN_DLL OCB_Decryption : 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_Decryption(BlockCipher* cipher, size_t tag_size = 16) :
+         OCB_Mode(cipher, tag_size) {}
+
+      size_t minimum_final_size() const override { return tag_size(); }
+
+      void update(secure_vector<byte>& blocks) override;
+
+      void finish(secure_vector<byte>& final_block) override;
+   private:
+      void decrypt(byte input[], size_t blocks);
+   };
+
+}
+
+#endif