#include <lion.h>

Inheritance diagram for Botan::Lion:

Public Types
typedef SCAN_Name	Spec
Public Member Functions
size_t	block_size () const override
void	clear () override
BlockCipher *	clone () const override
void	decrypt (const byte in[], byte out[]) const
void	decrypt (byte block[]) const
template<typename Alloc >
void	decrypt (std::vector< byte, Alloc > &block) const
template<typename Alloc , typename Alloc2 >
void	decrypt (const std::vector< byte, Alloc > &in, std::vector< byte, Alloc2 > &out) const
void	decrypt_n (const byte in[], byte out[], size_t blocks) const override
void	encrypt (const byte in[], byte out[]) const
void	encrypt (byte block[]) const
template<typename Alloc >
void	encrypt (std::vector< byte, Alloc > &block) const
template<typename Alloc , typename Alloc2 >
void	encrypt (const std::vector< byte, Alloc > &in, std::vector< byte, Alloc2 > &out) const
void	encrypt_n (const byte in[], byte out[], size_t blocks) const override
Key_Length_Specification	key_spec () const override
	Lion (HashFunction hash, StreamCipher cipher, size_t block_size)
size_t	maximum_keylength () const
size_t	minimum_keylength () const
std::string	name () const override
size_t	parallel_bytes () const
virtual size_t	parallelism () const
void	set_key (const SymmetricKey &key)
template<typename Alloc >
void	set_key (const std::vector< byte, Alloc > &key)
void	set_key (const byte key[], size_t length)
bool	valid_keylength (size_t length) const

Detailed Description

Lion is a block cipher construction designed by Ross Anderson and Eli Biham, described in "Two Practical and Provably Secure Block Ciphers: BEAR and LION". It has a variable block size and is designed to encrypt very large blocks (up to a megabyte)

http://www.cl.cam.ac.uk/~rja14/Papers/bear-lion.pdf

Definition at line 25 of file lion.h.

Member Typedef Documentation

typedef SCAN_Name Botan::BlockCipher::Spec [inherited]

Definition at line 22 of file block_cipher.h.

Constructor & Destructor Documentation

Botan::Lion::Lion	(	HashFunction *	hash,
		StreamCipher *	cipher,
		size_t	block_size
	)

Parameters:

hash	the hash to use internally
cipher	the stream cipher to use internally
block_size	the size of the block to use

Definition at line 140 of file lion.cpp.

References name().

Referenced by clone().

                                                                      :
   m_block_size(std::max<size_t>(2*hash->output_length() + 1, block_size)),
   m_hash(hash),
   m_cipher(cipher)
   {
   if(2*left_size() + 1 > m_block_size)
      throw Invalid_Argument(name() + ": Chosen block size is too small");

   if(!m_cipher->valid_keylength(left_size()))
      throw Invalid_Argument(name() + ": This stream/hash combo is invalid");

   m_key1.resize(left_size());
   m_key2.resize(left_size());
   }

Member Function Documentation

size_t Botan::Lion::block_size ( ) const [inline, override, virtual]

Returns:: block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 31 of file lion.h.

Referenced by clone(), and name().

{ return m_block_size; }

void Botan::Lion::clear ( ) [override, virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 129 of file lion.cpp.

References Botan::zeroise().

   {
   zeroise(m_key1);
   zeroise(m_key2);
   m_hash->clear();
   m_cipher->clear();
   }

BlockCipher * Botan::Lion::clone ( ) const [override, virtual]

Returns:: new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 121 of file lion.cpp.

References block_size(), and Lion().

   {
   return new Lion(m_hash->clone(), m_cipher->clone(), block_size());
   }

void Botan::BlockCipher::decrypt	(	const byte	in[],
		byte	out[]
	)		const `[inline, inherited]`

Decrypt a block.

Parameters:

in	The ciphertext block to be decypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 59 of file block_cipher.h.

Referenced by Botan::Camellia_128::decrypt_n(), Botan::DESX::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::XTS_Decryption::finish(), and Botan::CTS_Decryption::finish().

         { decrypt_n(in, out, 1); }

void Botan::BlockCipher::decrypt ( byte block[] ) const [inline, inherited]

Decrypt a block.

Parameters:

block the ciphertext block to be decrypted Must be of length block_size(). Will hold the result when the function has finished.

Definition at line 76 of file block_cipher.h.

{ decrypt_n(block, block, 1); }

template<typename Alloc >

void Botan::BlockCipher::decrypt ( std::vector< byte, Alloc > & block ) const [inline, inherited]

Decrypt one or more blocks

Parameters:

block the input/output buffer (multiple of block_size())

Definition at line 93 of file block_cipher.h.

         {
         return decrypt_n(&block[0], &block[0], block.size() / block_size());
         }

template<typename Alloc , typename Alloc2 >

void Botan::BlockCipher::decrypt	(	const std::vector< byte, Alloc > &	in,
		std::vector< byte, Alloc2 > &	out
	)		const `[inline, inherited]`

Decrypt one or more blocks

Parameters:

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)

Definition at line 116 of file block_cipher.h.

         {
         return decrypt_n(&in[0], &out[0], in.size() / block_size());
         }

void Botan::Lion::decrypt_n	(	const byte	in[],
		byte	out[],
		size_t	blocks
	)		const `[override, virtual]`

Decrypt one or more blocks

Parameters:

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)
blocks	the number of blocks to process

Implements Botan::BlockCipher.

Definition at line 69 of file lion.cpp.

References Botan::xor_buf().

   {
   const size_t LEFT_SIZE = left_size();
   const size_t RIGHT_SIZE = right_size();

   secure_vector<byte> buffer_vec(LEFT_SIZE);
   byte* buffer = &buffer_vec[0];

   for(size_t i = 0; i != blocks; ++i)
      {
      xor_buf(buffer, in, &m_key2[0], LEFT_SIZE);
      m_cipher->set_key(buffer, LEFT_SIZE);
      m_cipher->cipher(in + LEFT_SIZE, out + LEFT_SIZE, RIGHT_SIZE);

      m_hash->update(out + LEFT_SIZE, RIGHT_SIZE);
      m_hash->final(buffer);
      xor_buf(out, in, buffer, LEFT_SIZE);

      xor_buf(buffer, out, &m_key1[0], LEFT_SIZE);
      m_cipher->set_key(buffer, LEFT_SIZE);
      m_cipher->cipher1(out + LEFT_SIZE, RIGHT_SIZE);

      in += m_block_size;
      out += m_block_size;
      }
   }

void Botan::BlockCipher::encrypt	(	const byte	in[],
		byte	out[]
	)		const `[inline, inherited]`

Encrypt a block.

Parameters:

in	The plaintext block to be encrypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 49 of file block_cipher.h.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::Camellia_128::encrypt_n(), Botan::DESX::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::CFB_Encryption::update(), Botan::CBC_Encryption::update(), and Botan::CFB_Decryption::update().

         { encrypt_n(in, out, 1); }

void Botan::BlockCipher::encrypt ( byte block[] ) const [inline, inherited]

Encrypt a block.

Parameters:

block the plaintext block to be encrypted Must be of length block_size(). Will hold the result when the function has finished.

Definition at line 68 of file block_cipher.h.

{ encrypt_n(block, block, 1); }

template<typename Alloc >

void Botan::BlockCipher::encrypt ( std::vector< byte, Alloc > & block ) const [inline, inherited]

Encrypt one or more blocks

Parameters:

block the input/output buffer (multiple of block_size())

Definition at line 83 of file block_cipher.h.

         {
         return encrypt_n(&block[0], &block[0], block.size() / block_size());
         }

template<typename Alloc , typename Alloc2 >

void Botan::BlockCipher::encrypt	(	const std::vector< byte, Alloc > &	in,
		std::vector< byte, Alloc2 > &	out
	)		const `[inline, inherited]`

Encrypt one or more blocks

Parameters:

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)

Definition at line 104 of file block_cipher.h.

         {
         return encrypt_n(&in[0], &out[0], in.size() / block_size());
         }

void Botan::Lion::encrypt_n	(	const byte	in[],
		byte	out[],
		size_t	blocks
	)		const `[override, virtual]`

Encrypt one or more blocks

Parameters:

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)
blocks	the number of blocks to process

Implements Botan::BlockCipher.

Definition at line 39 of file lion.cpp.

References Botan::xor_buf().

   {
   const size_t LEFT_SIZE = left_size();
   const size_t RIGHT_SIZE = right_size();

   secure_vector<byte> buffer_vec(LEFT_SIZE);
   byte* buffer = &buffer_vec[0];

   for(size_t i = 0; i != blocks; ++i)
      {
      xor_buf(buffer, in, &m_key1[0], LEFT_SIZE);
      m_cipher->set_key(buffer, LEFT_SIZE);
      m_cipher->cipher(in + LEFT_SIZE, out + LEFT_SIZE, RIGHT_SIZE);

      m_hash->update(out + LEFT_SIZE, RIGHT_SIZE);
      m_hash->final(buffer);
      xor_buf(out, in, buffer, LEFT_SIZE);

      xor_buf(buffer, out, &m_key2[0], LEFT_SIZE);
      m_cipher->set_key(buffer, LEFT_SIZE);
      m_cipher->cipher1(out + LEFT_SIZE, RIGHT_SIZE);

      in += m_block_size;
      out += m_block_size;
      }
   }

Key_Length_Specification Botan::Lion::key_spec ( ) const [inline, override, virtual]

Returns:: object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 33 of file lion.h.

References m_hash.

         {
         return Key_Length_Specification(2, 2*m_hash->output_length(), 2);
         }

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const [inline, inherited]

Returns:: minimum allowed key length

Definition at line 36 of file sym_algo.h.

References Botan::Key_Length_Specification::maximum_keylength().

         {
         return key_spec().maximum_keylength();
         }

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const [inline, inherited]

Returns:: maxmium allowed key length

Definition at line 44 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

std::string Botan::Lion::name ( ) const [override, virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 111 of file lion.cpp.

References block_size(), and Botan::ASN1::to_string().

Referenced by Lion().

   {
   return "Lion(" + m_hash->name() + "," +
                    m_cipher->name() + "," +
                    std::to_string(block_size()) + ")";
   }

size_t Botan::BlockCipher::parallel_bytes ( ) const [inline, inherited]

Returns:: prefererred parallelism of this cipher in bytes

Definition at line 37 of file block_cipher.h.

Referenced by Botan::XTS_Mode::update_granularity(), Botan::CBC_Mode::update_granularity(), and Botan::ECB_Mode::update_granularity().

         {
         return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
         }

virtual size_t Botan::BlockCipher::parallelism ( ) const [inline, virtual, inherited]

Returns:: native parallelism of this cipher in blocks

Reimplemented in Botan::AES_256_NI, Botan::AES_192_NI, Botan::AES_128_NI, Botan::IDEA_SSE2, Botan::Noekeon_SIMD, Botan::Serpent_SIMD, and Botan::XTEA_SIMD.

Definition at line 32 of file block_cipher.h.

{ return 1; }

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey & key ) [inline, inherited]

Set the symmetric key of this object.

Parameters:

key	the SymmetricKey to be set.

Definition at line 63 of file sym_algo.h.

References Botan::OctetString::begin(), and Botan::OctetString::length().

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_mac_set_key(), Botan::TLS::Session::decrypt(), Botan::TLS::Session::encrypt(), and Botan::pbkdf2().

         {
         set_key(key.begin(), key.length());
         }

template<typename Alloc >

void Botan::SymmetricAlgorithm::set_key ( const std::vector< byte, Alloc > & key ) [inline, inherited]

Definition at line 69 of file sym_algo.h.

         {
         set_key(&key[0], key.size());
         }

void Botan::SymmetricAlgorithm::set_key	(	const byte	key[],
		size_t	length
	)		`[inline, inherited]`

Set the symmetric key of this object.

Parameters:

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 79 of file sym_algo.h.

         {
         if(!valid_keylength(length))
            throw Invalid_Key_Length(name(), length);
         key_schedule(key, length);
         }

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length ) const [inline, inherited]

Check whether a given key length is valid for this algorithm.

Parameters:

length the key length to be checked.

Returns:: true if the key length is valid.

Definition at line 54 of file sym_algo.h.

Referenced by Botan::aont_package(), and Botan::aont_unpackage().

         {
         return key_spec().valid_keylength(length);
         }

The documentation for this class was generated from the following files:

src/lib/block/lion/lion.h
src/lib/block/lion/lion.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation