diff options
author | lloyd <[email protected]> | 2014-01-10 03:41:59 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2014-01-10 03:41:59 +0000 |
commit | 6894dca64c04936d07048c0e8cbf7e25858548c3 (patch) | |
tree | 5d572bfde9fe667dab14e3f04b5285a85d8acd95 /src/lib/modes/aead/ocb | |
parent | 9efa3be92442afb3d0b69890a36c7f122df18eda (diff) |
Move lib into src
Diffstat (limited to 'src/lib/modes/aead/ocb')
-rw-r--r-- | src/lib/modes/aead/ocb/info.txt | 6 | ||||
-rw-r--r-- | src/lib/modes/aead/ocb/ocb.cpp | 432 | ||||
-rw-r--r-- | src/lib/modes/aead/ocb/ocb.h | 124 |
3 files changed, 562 insertions, 0 deletions
diff --git a/src/lib/modes/aead/ocb/info.txt b/src/lib/modes/aead/ocb/info.txt new file mode 100644 index 000000000..be4cefdd0 --- /dev/null +++ b/src/lib/modes/aead/ocb/info.txt @@ -0,0 +1,6 @@ +define AEAD_OCB 20131128 + +<requires> +block +cmac +</requires> diff --git a/src/lib/modes/aead/ocb/ocb.cpp b/src/lib/modes/aead/ocb/ocb.cpp new file mode 100644 index 000000000..fd66bb2e9 --- /dev/null +++ b/src/lib/modes/aead/ocb/ocb.cpp @@ -0,0 +1,432 @@ +/* +* 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> + +namespace Botan { + +namespace { + +const size_t BS = 16; // intrinsic to OCB definition + +} + +// 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>& compute_offsets(secure_vector<byte>& offset, + size_t block_index, + size_t blocks) const + { + m_offset_buf.resize(blocks*BS); + + for(size_t i = 0; i != blocks; ++i) + { // could be done in parallel + offset ^= get(ctz(block_index + 1 + i)); + copy_mem(&m_offset_buf[BS*i], &offset[0], BS); + } + + return m_offset_buf; + } + + private: + 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); + } + + 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; + mutable secure_vector<byte> m_offset_buf; + }; + +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(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_checksum(m_cipher->parallel_bytes()), + m_offset(BS), + m_ad_hash(BS), + m_tag_size(tag_size) + { + 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 != 8 && m_tag_size != 12 && m_tag_size != 16) + 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 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)); + } + +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::update_nonce(const byte nonce[], size_t nonce_len) + { + 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[0] = ((tag_size() * 8) % 128) << 1; + 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; + } + +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_L, "A key was set"); + + m_offset = 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_blocks = m_checksum.size() / BS; + + while(blocks) + { + const size_t proc_blocks = std::min(blocks, par_blocks); + const size_t proc_bytes = proc_blocks * BS; + + const auto& offsets = L.compute_offsets(m_offset, m_block_index, proc_blocks); + + xor_buf(&m_checksum[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 -= proc_blocks; + m_block_index += proc_blocks; + } + } + +void OCB_Encryption::update(secure_vector<byte>& buffer, size_t offset) + { + BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane"); + const size_t sz = buffer.size() - offset; + byte* buf = &buffer[offset]; + + BOTAN_ASSERT(sz % BS == 0, "Input length is an even number of blocks"); + + encrypt(buf, sz / BS); + } + +void OCB_Encryption::finish(secure_vector<byte>& buffer, size_t offset) + { + BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane"); + const size_t sz = buffer.size() - offset; + byte* buf = &buffer[offset]; + + if(sz) + { + const size_t final_full_blocks = sz / BS; + const size_t remainder_bytes = sz - (final_full_blocks * BS); + + encrypt(buf, final_full_blocks); + + if(remainder_bytes) + { + BOTAN_ASSERT(remainder_bytes < BS, "Only a partial block left"); + byte* remainder = &buf[sz - 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); + } + } + + secure_vector<byte> checksum(BS); + + // fold checksum + for(size_t i = 0; i != m_checksum.size(); ++i) + checksum[i % checksum.size()] ^= m_checksum[i]; + + // now compute the tag + secure_vector<byte> mac = m_offset; + mac ^= checksum; + mac ^= m_L->dollar(); + + m_cipher->encrypt(mac); + + mac ^= m_ad_hash; + + buffer += std::make_pair(&mac[0], tag_size()); + + 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; + + while(blocks) + { + const size_t proc_blocks = std::min(blocks, par_blocks); + const size_t proc_bytes = proc_blocks * BS; + + const auto& offsets = L.compute_offsets(m_offset, m_block_index, proc_blocks); + + 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(&m_checksum[0], &buffer[0], proc_bytes); + + buffer += proc_bytes; + blocks -= proc_blocks; + m_block_index += proc_blocks; + } + } + +void OCB_Decryption::update(secure_vector<byte>& buffer, size_t offset) + { + BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane"); + const size_t sz = buffer.size() - offset; + byte* buf = &buffer[offset]; + + BOTAN_ASSERT(sz % BS == 0, "Input length is an even number of blocks"); + + decrypt(buf, sz / BS); + } + +void OCB_Decryption::finish(secure_vector<byte>& buffer, size_t offset) + { + BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane"); + const size_t sz = buffer.size() - offset; + byte* buf = &buffer[offset]; + + BOTAN_ASSERT(sz >= tag_size(), "We have the tag"); + + const size_t remaining = sz - tag_size(); + + if(remaining) + { + const size_t final_full_blocks = remaining / BS; + const size_t final_bytes = remaining - (final_full_blocks * BS); + + decrypt(&buf[0], final_full_blocks); + + if(final_bytes) + { + BOTAN_ASSERT(final_bytes < BS, "Only a partial block left"); + + byte* remainder = &buf[remaining - final_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], final_bytes); + + xor_buf(&m_checksum[0], &remainder[0], final_bytes); + m_checksum[final_bytes] ^= 0x80; + } + } + + secure_vector<byte> checksum(BS); + + // fold checksum + for(size_t i = 0; i != m_checksum.size(); ++i) + checksum[i % checksum.size()] ^= m_checksum[i]; + + // compute the mac + secure_vector<byte> mac = m_offset; + mac ^= checksum; + mac ^= m_L->dollar(); + + m_cipher->encrypt(mac); + + mac ^= m_ad_hash; + + // reset state + zeroise(m_checksum); + zeroise(m_offset); + m_block_index = 0; + + // compare mac + const byte* included_tag = &buf[remaining]; + + if(!same_mem(&mac[0], included_tag, tag_size())) + throw Integrity_Failure("OCB tag check failed"); + + // remove tag from end of message + buffer.resize(remaining + offset); + } + +} diff --git a/src/lib/modes/aead/ocb/ocb.h b/src/lib/modes/aead/ocb/ocb.h new file mode 100644 index 000000000..e7d042de3 --- /dev/null +++ b/src/lib/modes/aead/ocb/ocb.h @@ -0,0 +1,124 @@ +/* +* OCB Mode +* (C) 2013 Jack Lloyd +* +* Distributed under the terms of the Botan license +*/ + +#ifndef BOTAN_AEAD_OCB_H__ +#define BOTAN_AEAD_OCB_H__ + +#include <botan/aead.h> +#include <botan/block_cipher.h> +#include <botan/buf_filt.h> +#include <memory> + +namespace Botan { + +class L_computer; + +/** +* 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-03 +* @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; + + size_t tag_size() const { return m_tag_size; } + + void clear(); + + ~OCB_Mode(); + protected: + /** + * @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; + + // fixme make these private + std::unique_ptr<BlockCipher> m_cipher; + std::unique_ptr<L_computer> m_L; + + size_t m_block_index = 0; + + secure_vector<byte> m_checksum; + secure_vector<byte> m_offset; + secure_vector<byte> m_ad_hash; + private: + secure_vector<byte> update_nonce(const byte nonce[], size_t nonce_len); + + size_t m_tag_size = 0; + secure_vector<byte> m_last_nonce; + secure_vector<byte> m_stretch; + }; + +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 output_length(size_t input_length) const override + { return input_length + tag_size(); } + + size_t minimum_final_size() const override { return 0; } + + void update(secure_vector<byte>& blocks, size_t offset = 0) override; + + void finish(secure_vector<byte>& final_block, size_t offset = 0) 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 output_length(size_t input_length) const override + { + BOTAN_ASSERT(input_length > tag_size(), "Sufficient input"); + return input_length - tag_size(); + } + + size_t minimum_final_size() const override { return tag_size(); } + + void update(secure_vector<byte>& blocks, size_t offset = 0) override; + + void finish(secure_vector<byte>& final_block, size_t offset = 0) override; + private: + void decrypt(byte input[], size_t blocks); + }; + +} + +#endif |