Botan  1.11.32
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD > Class Template Referenceabstract

#include <block_cipher.h>

Inheritance diagram for Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >:
Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  { BLOCK_SIZE = BS }
 
typedef SCAN_Name Spec
 

Public Member Functions

size_t block_size () const override
 
virtual void clear ()=0
 
virtual BlockCipherclone () const =0
 
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
 
virtual void decrypt_n (const byte in[], byte out[], size_t blocks) const =0
 
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
 
virtual void encrypt_n (const byte in[], byte out[], size_t blocks) const =0
 
Key_Length_Specification key_spec () const override
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
virtual std::string name () const =0
 
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 std::vector< std::string > providers (const std::string &algo_spec)
 

Detailed Description

template<size_t BS, size_t KMIN, size_t KMAX = 0, size_t KMOD = 1>
class Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >

Represents a block cipher with a single fixed block size

Definition at line 172 of file block_cipher.h.

Member Typedef Documentation

§ Spec

Definition at line 23 of file block_cipher.h.

Member Enumeration Documentation

§ anonymous enum

template<size_t BS, size_t KMIN, size_t KMAX = 0, size_t KMOD = 1>
anonymous enum
Enumerator
BLOCK_SIZE 

Definition at line 175 of file block_cipher.h.

Member Function Documentation

§ block_size()

template<size_t BS, size_t KMIN, size_t KMAX = 0, size_t KMOD = 1>
size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::block_size ( ) const
inlineoverridevirtual
Returns
block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 176 of file block_cipher.h.

176 { return BS; }

§ clear()

virtual void Botan::SymmetricAlgorithm::clear ( )
pure virtualinherited

§ clone()

virtual BlockCipher* Botan::BlockCipher::clone ( ) const
pure virtualinherited

§ 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(), Botan::Cascade_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()

virtual void Botan::BlockCipher::decrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const
pure virtualinherited

§ 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()

virtual void Botan::BlockCipher::encrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const
pure virtualinherited

§ key_spec()

template<size_t BS, size_t KMIN, size_t KMAX = 0, size_t KMOD = 1>
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::key_spec ( ) const
inlineoverridevirtual
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 178 of file block_cipher.h.

179  {
180  return Key_Length_Specification(KMIN, KMAX, KMOD);
181  }

§ 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()

virtual std::string Botan::SymmetricAlgorithm::name ( ) const
pure virtualinherited

§ 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 file: