Botan  1.11.15
Public Types | Public Member Functions
Botan::BlockCipher Class Reference

#include <block_cipher.h>

Inheritance diagram for Botan::BlockCipher:
Botan::SymmetricAlgorithm Botan::Block_Cipher_Fixed_Params< 16, 1, 32 > Botan::Block_Cipher_Fixed_Params< 16, 16 > Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 4 > Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 > Botan::Block_Cipher_Fixed_Params< 16, 24 > Botan::Block_Cipher_Fixed_Params< 16, 32 > Botan::Block_Cipher_Fixed_Params< 16, 4, 32, 4 > Botan::Block_Cipher_Fixed_Params< 64, 64 > Botan::Block_Cipher_Fixed_Params< 8, 1, 32 > Botan::Block_Cipher_Fixed_Params< 8, 1, 56 > Botan::Block_Cipher_Fixed_Params< 8, 11, 16 > Botan::Block_Cipher_Fixed_Params< 8, 16 > Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 > Botan::Block_Cipher_Fixed_Params< 8, 24 > Botan::Block_Cipher_Fixed_Params< 8, 32 > Botan::Block_Cipher_Fixed_Params< 8, 8 > Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD > Botan::Cascade_Cipher Botan::Lion

List of all members.

Public Types

typedef SCAN_Name Spec

Public Member Functions

virtual size_t block_size () const =0
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
virtual Key_Length_Specification key_spec () const =0
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
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

This class represents a block cipher object.

Definition at line 19 of file block_cipher.h.


Member Typedef Documentation

Definition at line 22 of file block_cipher.h.


Member Function Documentation

virtual size_t Botan::BlockCipher::block_size ( ) const [pure virtual]
Returns:
block size of this algorithm

Implemented in Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >, Botan::Block_Cipher_Fixed_Params< 16, 32 >, Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 4 >, Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >, Botan::Block_Cipher_Fixed_Params< 8, 32 >, Botan::Block_Cipher_Fixed_Params< 16, 16 >, Botan::Block_Cipher_Fixed_Params< 8, 11, 16 >, Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >, Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >, Botan::Block_Cipher_Fixed_Params< 16, 4, 32, 4 >, Botan::Block_Cipher_Fixed_Params< 64, 64 >, Botan::Block_Cipher_Fixed_Params< 8, 1, 32 >, Botan::Block_Cipher_Fixed_Params< 16, 24 >, Botan::Block_Cipher_Fixed_Params< 8, 16 >, Botan::Block_Cipher_Fixed_Params< 16, 1, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 8 >, Botan::Block_Cipher_Fixed_Params< 8, 24 >, Botan::Lion, and Botan::Cascade_Cipher.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::Cascade_Cipher::Cascade_Cipher(), Botan::CBC_Mode::CBC_Mode(), Botan::CFB_Mode::CFB_Mode(), Botan::CBC_Mode::default_nonce_length(), Botan::XTS_Mode::default_nonce_length(), Botan::CFB_Mode::default_nonce_length(), Botan::ECB_Mode::ECB_Mode(), Botan::ECB_Encryption::finish(), Botan::XTS_Encryption::finish(), Botan::CBC_Encryption::finish(), Botan::XTS_Decryption::finish(), Botan::ECB_Decryption::finish(), Botan::CTS_Encryption::finish(), Botan::CBC_Decryption::finish(), Botan::CTS_Decryption::finish(), Botan::GCM_Mode::GCM_Mode(), Botan::XTS_Mode::minimum_final_size(), Botan::ECB_Decryption::minimum_final_size(), Botan::CTS_Encryption::minimum_final_size(), Botan::CBC_Decryption::minimum_final_size(), Botan::CTS_Decryption::minimum_final_size(), Botan::ECB_Encryption::update(), Botan::XTS_Encryption::update(), Botan::CFB_Encryption::update(), Botan::CBC_Encryption::update(), Botan::XTS_Decryption::update(), Botan::ECB_Decryption::update(), Botan::CFB_Decryption::update(), Botan::CBC_Decryption::update(), and Botan::XTS_Mode::valid_nonce_length().

virtual void Botan::SymmetricAlgorithm::clear ( ) [pure virtual, inherited]
virtual BlockCipher* Botan::BlockCipher::clone ( ) const [pure virtual]
void Botan::BlockCipher::decrypt ( const byte  in[],
byte  out[] 
) const [inline]

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 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]

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 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]

Decrypt one or more blocks

Parameters:
blockthe 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]

Decrypt one or more blocks

Parameters:
inthe input buffer (multiple of block_size())
outthe 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());
         }
virtual void Botan::BlockCipher::decrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const [pure virtual]
void Botan::BlockCipher::encrypt ( const byte  in[],
byte  out[] 
) const [inline]

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 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]

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 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]

Encrypt one or more blocks

Parameters:
blockthe 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]

Encrypt one or more blocks

Parameters:
inthe input buffer (multiple of block_size())
outthe 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());
         }
virtual void Botan::BlockCipher::encrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const [pure virtual]
virtual Key_Length_Specification Botan::SymmetricAlgorithm::key_spec ( ) const [pure virtual, inherited]
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();
         }
virtual std::string Botan::SymmetricAlgorithm::name ( ) const [pure virtual, inherited]
size_t Botan::BlockCipher::parallel_bytes ( ) const [inline]
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]
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:
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::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:
keythe to be set as a byte array.
lengthin 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:
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().

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

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