#include <cascade.h>

Inheritance diagram for Botan::Cascade_Cipher:

Public Types
typedef SCAN_Name	Spec
Public Member Functions
size_t	block_size () const
	Cascade_Cipher (BlockCipher cipher1, BlockCipher cipher2)
	Cascade_Cipher (const Cascade_Cipher &)
void	clear ()
BlockCipher *	clone () const
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
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
Key_Length_Specification	key_spec () const
size_t	maximum_keylength () const
size_t	minimum_keylength () const
std::string	name () const
Cascade_Cipher &	operator= (const Cascade_Cipher &)
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
Static Public Member Functions
static Cascade_Cipher *	make (const Spec &spec)

Detailed Description

Block Cipher Cascade

Definition at line 18 of file cascade.h.

Member Typedef Documentation

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

Definition at line 22 of file block_cipher.h.

Constructor & Destructor Documentation

Botan::Cascade_Cipher::Cascade_Cipher	(	BlockCipher *	cipher1,
		BlockCipher *	cipher2
	)

Create a cascade of two block ciphers

Parameters:

cipher1	the first cipher
cipher2	the second cipher

Definition at line 97 of file cascade.cpp.

References block_size(), Botan::BlockCipher::block_size(), and name().

Referenced by clone(), and make().

                                                               :
   m_cipher1(c1), m_cipher2(c2)
   {
   m_block = block_size_for_cascade(c1->block_size(), c2->block_size());

   if(block_size() % c1->block_size() || block_size() % c2->block_size())
      throw Internal_Error("Failure in " + name() + " constructor");
   }

Botan::Cascade_Cipher::Cascade_Cipher ( const Cascade_Cipher & )

Member Function Documentation

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

Returns:: block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 24 of file cascade.h.

Referenced by Cascade_Cipher(), decrypt_n(), and encrypt_n().

{ return m_block; }

void Botan::Cascade_Cipher::clear ( ) [virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 54 of file cascade.cpp.

   {
   m_cipher1->clear();
   m_cipher2->clear();
   }

BlockCipher * Botan::Cascade_Cipher::clone ( ) const [virtual]

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

Implements Botan::BlockCipher.

Definition at line 65 of file cascade.cpp.

References Cascade_Cipher().

   {
   return new Cascade_Cipher(m_cipher1->clone(),
                             m_cipher2->clone());
   }

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::Cascade_Cipher::decrypt_n	(	const byte	in[],
		byte	out[],
		size_t	blocks
	)		const `[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 36 of file cascade.cpp.

References block_size().

   {
   size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
   size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());

   m_cipher2->decrypt_n(in, out, c2_blocks);
   m_cipher1->decrypt_n(out, out, c1_blocks);
   }

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::DESX::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::CBC_Encryption::update(), Botan::CFB_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::Cascade_Cipher::encrypt_n	(	const byte	in[],
		byte	out[],
		size_t	blocks
	)		const `[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 26 of file cascade.cpp.

References block_size().

   {
   size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
   size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());

   m_cipher1->encrypt_n(in, out, c1_blocks);
   m_cipher2->encrypt_n(out, out, c2_blocks);
   }

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

Returns:: object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 26 of file cascade.h.

         {
         return Key_Length_Specification(m_cipher1->maximum_keylength() +
                                         m_cipher2->maximum_keylength());
         }

Cascade_Cipher * Botan::Cascade_Cipher::make ( const Spec & spec ) [static]

Definition at line 15 of file cascade.cpp.

References Botan::SCAN_Name::arg(), and Cascade_Cipher().

   {
   auto& block_cipher = Algo_Registry<BlockCipher>::global_registry();
   std::unique_ptr<BlockCipher> c1(block_cipher.make(spec.arg(0)));
   std::unique_ptr<BlockCipher> c2(block_cipher.make(spec.arg(1)));

   if(c1 && c2)
      return new Cascade_Cipher(c1.release(), c2.release());
   return nullptr;
   }

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::Cascade_Cipher::name ( ) const [virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 60 of file cascade.cpp.

Referenced by Cascade_Cipher().

   {
   return "Cascade(" + m_cipher1->name() + "," + m_cipher2->name() + ")";
   }

Cascade_Cipher& Botan::Cascade_Cipher::operator= ( const Cascade_Cipher & )

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::ECB_Mode::update_granularity(), and Botan::CBC_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/cascade/cascade.h
src/lib/block/cascade/cascade.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation