Botan  1.11.32
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Botan::Cascade_Cipher Class Referencefinal

#include <cascade.h>

Inheritance diagram for Botan::Cascade_Cipher:
Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

typedef SCAN_Name Spec
 

Public Member Functions

size_t block_size () const override
 
 Cascade_Cipher (BlockCipher *cipher1, BlockCipher *cipher2)
 
 Cascade_Cipher (const Cascade_Cipher &)=delete
 
void clear () override
 
BlockCipherclone () 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
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
std::string name () const override
 
Cascade_Cipheroperator= (const Cascade_Cipher &)=delete
 
size_t parallel_bytes () const
 
virtual size_t parallelism () const
 
virtual std::string provider () 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 std::unique_ptr< BlockCiphercreate (const std::string &algo_spec, const std::string &provider="")
 
static Cascade_Ciphermake (const Spec &spec)
 
static std::vector< std::string > providers (const std::string &algo_spec)
 

Detailed Description

Block Cipher Cascade

Definition at line 18 of file cascade.h.

Member Typedef Documentation

§ Spec

Definition at line 23 of file block_cipher.h.

Constructor & Destructor Documentation

§ Cascade_Cipher() [1/2]

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

Create a cascade of two block ciphers

Parameters
cipher1the first cipher
cipher2the second cipher

Definition at line 93 of file cascade.cpp.

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

Referenced by clone(), and make().

93  :
94  m_cipher1(c1), m_cipher2(c2)
95  {
96  m_block = block_size_for_cascade(c1->block_size(), c2->block_size());
97 
98  if(block_size() % c1->block_size() || block_size() % c2->block_size())
99  throw Internal_Error("Failure in " + name() + " constructor");
100  }
std::string name() const override
Definition: cascade.cpp:56
size_t block_size() const override
Definition: cascade.h:24

§ Cascade_Cipher() [2/2]

Botan::Cascade_Cipher::Cascade_Cipher ( const Cascade_Cipher )
delete

Member Function Documentation

§ block_size()

size_t Botan::Cascade_Cipher::block_size ( ) const
inlineoverridevirtual
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().

24 { return m_block; }

§ clear()

void Botan::Cascade_Cipher::clear ( )
overridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 50 of file cascade.cpp.

51  {
52  m_cipher1->clear();
53  m_cipher2->clear();
54  }

§ clone()

BlockCipher * Botan::Cascade_Cipher::clone ( ) const
overridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 61 of file cascade.cpp.

References Cascade_Cipher(), and Botan::gcd().

62  {
63  return new Cascade_Cipher(m_cipher1->clone(),
64  m_cipher2->clone());
65  }
Cascade_Cipher(BlockCipher *cipher1, BlockCipher *cipher2)
Definition: cascade.cpp:93

§ create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( const std::string &  algo_spec,
const std::string &  provider = "" 
)
staticinherited

Create an instance based on a name Will return a null pointer if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 86 of file block_cipher.cpp.

References Botan::BlockCipher::provider().

Referenced by Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::get_block_cipher(), make(), Botan::CBC_MAC::make(), Botan::CTR_BE::make(), Botan::OFB::make(), Botan::CMAC::make(), Botan::make_block_cipher(), Botan::make_block_cipher_mode(), Botan::make_block_cipher_mode_len(), Botan::make_block_cipher_mode_len2(), Botan::rfc3394_keyunwrap(), and Botan::rfc3394_keywrap().

88  {
89  return std::unique_ptr<BlockCipher>(make_a<BlockCipher>(Botan::BlockCipher::Spec(algo_spec), provider));
90  }
virtual std::string provider() const
Definition: block_cipher.h:60

§ decrypt() [1/4]

void Botan::BlockCipher::decrypt ( const byte  in[],
byte  out[] 
) const
inlineinherited

Decrypt a block.

Parameters
inThe ciphertext block to be decypted as a byte array. Must be of length block_size().
outThe byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 79 of file block_cipher.h.

Referenced by Botan::DESX::decrypt_n(), Botan::XTS_Decryption::finish(), Botan::CTS_Decryption::finish(), and Botan::TLS::write_record().

80  { decrypt_n(in, out, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0

§ decrypt() [2/4]

void Botan::BlockCipher::decrypt ( byte  block[]) const
inlineinherited

Decrypt a block.

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

Definition at line 96 of file block_cipher.h.

96 { decrypt_n(block, block, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0

§ decrypt() [3/4]

template<typename Alloc >
void Botan::BlockCipher::decrypt ( std::vector< byte, Alloc > &  block) const
inlineinherited

Decrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 113 of file block_cipher.h.

114  {
115  return decrypt_n(block.data(), block.data(), block.size() / block_size());
116  }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0

§ decrypt() [4/4]

template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::decrypt ( const std::vector< byte, Alloc > &  in,
std::vector< byte, Alloc2 > &  out 
) const
inlineinherited

Decrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 136 of file block_cipher.h.

138  {
139  return decrypt_n(in.data(), out.data(), in.size() / block_size());
140  }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0

§ decrypt_n()

void Botan::Cascade_Cipher::decrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const
overridevirtual

Decrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)
blocksthe number of blocks to process

Implements Botan::BlockCipher.

Definition at line 32 of file cascade.cpp.

References block_size().

34  {
35  size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
36  size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());
37 
38  m_cipher2->decrypt_n(in, out, c2_blocks);
39  m_cipher1->decrypt_n(out, out, c1_blocks);
40  }
size_t block_size() const override
Definition: cascade.h:24

§ encrypt() [1/4]

void Botan::BlockCipher::encrypt ( const byte  in[],
byte  out[] 
) const
inlineinherited

Encrypt a block.

Parameters
inThe plaintext block to be encrypted as a byte array. Must be of length block_size().
outThe byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 69 of file block_cipher.h.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::GOST_34_11::clear(), Botan::DESX::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::TLS::Connection_Cipher_State::format_ad(), Botan::CFB_Encryption::process(), Botan::CBC_Encryption::process(), Botan::CFB_Decryption::process(), and Botan::CFB_Mode::valid_nonce_length().

70  { encrypt_n(in, out, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0

§ encrypt() [2/4]

void Botan::BlockCipher::encrypt ( byte  block[]) const
inlineinherited

Encrypt a block.

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

Definition at line 88 of file block_cipher.h.

88 { encrypt_n(block, block, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0

§ encrypt() [3/4]

template<typename Alloc >
void Botan::BlockCipher::encrypt ( std::vector< byte, Alloc > &  block) const
inlineinherited

Encrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 103 of file block_cipher.h.

104  {
105  return encrypt_n(block.data(), block.data(), block.size() / block_size());
106  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0

§ encrypt() [4/4]

template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::encrypt ( const std::vector< byte, Alloc > &  in,
std::vector< byte, Alloc2 > &  out 
) const
inlineinherited

Encrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 124 of file block_cipher.h.

126  {
127  return encrypt_n(in.data(), out.data(), in.size() / block_size());
128  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0

§ encrypt_n()

void Botan::Cascade_Cipher::encrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const
overridevirtual

Encrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)
blocksthe number of blocks to process

Implements Botan::BlockCipher.

Definition at line 22 of file cascade.cpp.

References block_size().

24  {
25  size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
26  size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());
27 
28  m_cipher1->encrypt_n(in, out, c1_blocks);
29  m_cipher2->encrypt_n(out, out, c2_blocks);
30  }
size_t block_size() const override
Definition: cascade.h:24

§ key_spec()

Key_Length_Specification Botan::Cascade_Cipher::key_spec ( ) const
inlineoverridevirtual
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 26 of file cascade.h.

27  {
28  return Key_Length_Specification(m_cipher1->maximum_keylength() +
29  m_cipher2->maximum_keylength());
30  }

§ make()

Cascade_Cipher * Botan::Cascade_Cipher::make ( const Spec spec)
static

Definition at line 12 of file cascade.cpp.

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

13  {
14  std::unique_ptr<BlockCipher> c1(BlockCipher::create(spec.arg(0)));
15  std::unique_ptr<BlockCipher> c2(BlockCipher::create(spec.arg(1)));
16 
17  if(c1 && c2)
18  return new Cascade_Cipher(c1.release(), c2.release());
19  return nullptr;
20  }
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
Cascade_Cipher(BlockCipher *cipher1, BlockCipher *cipher2)
Definition: cascade.cpp:93

§ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 36 of file sym_algo.h.

37  {
38  return key_spec().maximum_keylength();
39  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0

§ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
maxmium allowed key length

Definition at line 44 of file sym_algo.h.

45  {
46  return key_spec().minimum_keylength();
47  }
virtual Key_Length_Specification key_spec() const =0
size_t minimum_keylength() const
Definition: key_spec.h:61

§ name()

std::string Botan::Cascade_Cipher::name ( ) const
overridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 56 of file cascade.cpp.

Referenced by Cascade_Cipher().

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

§ operator=()

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

§ parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const
inlineinherited
Returns
prefererred parallelism of this cipher in bytes

Definition at line 51 of file block_cipher.h.

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

52  {
53  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
54  }
virtual size_t parallelism() const
Definition: block_cipher.h:46
virtual size_t block_size() const =0

§ parallelism()

virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtualinherited
Returns
native parallelism of this cipher in blocks

Reimplemented in Botan::Serpent.

Definition at line 46 of file block_cipher.h.

46 { return 1; }

§ provider()

virtual std::string Botan::BlockCipher::provider ( ) const
inlinevirtualinherited
Returns
provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented in Botan::AES_256, Botan::AES_192, Botan::Threefish_512, Botan::AES_128, Botan::IDEA, Botan::Serpent, and Botan::Noekeon.

Definition at line 60 of file block_cipher.h.

Referenced by Botan::BlockCipher::create().

60 { return "base"; }

§ providers()

std::vector< std::string > Botan::BlockCipher::providers ( const std::string &  algo_spec)
staticinherited

Returns the list of available providers for this algorithm, empty if not available

Definition at line 92 of file block_cipher.cpp.

Referenced by Botan::TLS::Ciphersuite::by_id(), and Botan::get_block_cipher_providers().

93  {
94  return providers_of<BlockCipher>(BlockCipher::Spec(algo_spec));
95  }

§ set_key() [1/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited

Set the symmetric key of this object.

Parameters
keythe 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::GOST_34_11::clear(), Botan::DESX::decrypt_n(), Botan::pbkdf2(), and Botan::TLS_PRF::TLS_PRF().

64  {
65  set_key(key.begin(), key.length());
66  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:63

§ set_key() [2/3]

template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< byte, Alloc > &  key)
inlineinherited

Definition at line 69 of file sym_algo.h.

70  {
71  set_key(key.data(), key.size());
72  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:63

§ set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( const byte  key[],
size_t  length 
)
inlineinherited

Set the symmetric key of this object.

Parameters
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 79 of file sym_algo.h.

80  {
81  if(!valid_keylength(length))
82  throw Invalid_Key_Length(name(), length);
83  key_schedule(key, length);
84  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:54
virtual std::string name() const =0

§ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t  length) const
inlineinherited

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

Parameters
lengththe 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().

55  {
56  return key_spec().valid_keylength(length);
57  }
bool valid_keylength(size_t length) const
Definition: key_spec.h:51
virtual Key_Length_Specification key_spec() const =0

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