Botan
1.11.15
|
#include <block_cipher.h>
Public Types | |
enum | { BLOCK_SIZE = BS } |
typedef SCAN_Name | Spec |
Public Member Functions | |
size_t | block_size () const |
virtual void | clear ()=0 |
virtual BlockCipher * | clone () 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 |
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 |
Represents a block cipher with a single fixed block size
Definition at line 150 of file block_cipher.h.
typedef SCAN_Name Botan::BlockCipher::Spec [inherited] |
Definition at line 22 of file block_cipher.h.
anonymous enum |
size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::block_size | ( | ) | const [inline, virtual] |
Implements Botan::BlockCipher.
Definition at line 154 of file block_cipher.h.
{ return BS; }
virtual void Botan::SymmetricAlgorithm::clear | ( | ) | [pure virtual, inherited] |
Implemented in Botan::GHASH, Botan::AES_256_NI, Botan::AES_256, Botan::AES_256_SSSE3, Botan::Camellia_256, Botan::GOST_28147_89, Botan::AES_192_NI, Botan::AES_192, Botan::AES_192_SSSE3, Botan::Camellia_192, Botan::TripleDES, Botan::CTR_BE, Botan::OFB, Botan::Lion, Botan::ChaCha, Botan::Salsa20, Botan::Cascade_Cipher, Botan::RC2, Botan::Blowfish, Botan::Poly1305, Botan::AES_128_NI, Botan::Threefish_512, Botan::CMAC, Botan::CBC_MAC, Botan::AES_128, Botan::AES_128_SSSE3, Botan::Camellia_128, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::IDEA, Botan::KASUMI, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::RC5, Botan::RC6, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::TEA, Botan::Twofish, Botan::XTEA, Botan::RC4, Botan::HMAC, Botan::ANSI_X919_MAC, and Botan::SipHash.
Referenced by botan_mac_clear().
virtual BlockCipher* Botan::BlockCipher::clone | ( | ) | const [pure virtual, inherited] |
Implemented in Botan::AES_256_NI, Botan::AES_256, Botan::AES_256_SSSE3, Botan::Camellia_256, Botan::GOST_28147_89, Botan::AES_192_NI, Botan::AES_192, Botan::AES_192_SSSE3, Botan::Camellia_192, Botan::TripleDES, Botan::Lion, Botan::Cascade_Cipher, Botan::RC2, Botan::Blowfish, Botan::AES_128_NI, Botan::Threefish_512, Botan::AES_128, Botan::AES_128_SSSE3, Botan::Camellia_128, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::IDEA, Botan::IDEA_SSE2, Botan::KASUMI, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::Noekeon_SIMD, Botan::RC5, Botan::RC6, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::Serpent_SIMD, Botan::TEA, Botan::Twofish, Botan::XTEA, Botan::XTEA_SIMD, and Botan::Serpent_X86_32.
void Botan::BlockCipher::decrypt | ( | const byte | in[], |
byte | out[] | ||
) | const [inline, inherited] |
Decrypt a block.
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.
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); }
void Botan::BlockCipher::decrypt | ( | std::vector< byte, Alloc > & | block | ) | const [inline, inherited] |
Decrypt one or more blocks
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()); }
void Botan::BlockCipher::decrypt | ( | const std::vector< byte, Alloc > & | in, |
std::vector< byte, Alloc2 > & | out | ||
) | const [inline, inherited] |
Decrypt one or more blocks
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()); }
virtual void Botan::BlockCipher::decrypt_n | ( | const byte | in[], |
byte | out[], | ||
size_t | blocks | ||
) | const [pure virtual, inherited] |
Decrypt one or more blocks
in | the input buffer (multiple of block_size()) |
out | the output buffer (same size as in) |
blocks | the number of blocks to process |
Implemented in Botan::AES_256_NI, Botan::AES_256, Botan::AES_256_SSSE3, Botan::Camellia_256, Botan::GOST_28147_89, Botan::AES_192_NI, Botan::AES_192, Botan::AES_192_SSSE3, Botan::Camellia_192, Botan::TripleDES, Botan::Lion, Botan::AES_128_NI, Botan::IDEA_SSE2, Botan::Noekeon_SIMD, Botan::Serpent_SIMD, Botan::XTEA_SIMD, Botan::AES_128, Botan::AES_128_SSSE3, Botan::Blowfish, Botan::Camellia_128, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::IDEA, Botan::KASUMI, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::RC2, Botan::RC5, Botan::RC6, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::Serpent_X86_32, Botan::TEA, Botan::Threefish_512, Botan::Twofish, and Botan::XTEA.
Referenced by Botan::XTS_Decryption::update(), Botan::ECB_Decryption::update(), and Botan::CBC_Decryption::update().
void Botan::BlockCipher::encrypt | ( | const byte | in[], |
byte | out[] | ||
) | const [inline, inherited] |
Encrypt a block.
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.
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); }
void Botan::BlockCipher::encrypt | ( | std::vector< byte, Alloc > & | block | ) | const [inline, inherited] |
Encrypt one or more blocks
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()); }
void Botan::BlockCipher::encrypt | ( | const std::vector< byte, Alloc > & | in, |
std::vector< byte, Alloc2 > & | out | ||
) | const [inline, inherited] |
Encrypt one or more blocks
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()); }
virtual void Botan::BlockCipher::encrypt_n | ( | const byte | in[], |
byte | out[], | ||
size_t | blocks | ||
) | const [pure virtual, inherited] |
Encrypt one or more blocks
in | the input buffer (multiple of block_size()) |
out | the output buffer (same size as in) |
blocks | the number of blocks to process |
Implemented in Botan::AES_256_NI, Botan::AES_256, Botan::AES_256_SSSE3, Botan::Camellia_256, Botan::GOST_28147_89, Botan::AES_192_NI, Botan::AES_192, Botan::AES_192_SSSE3, Botan::Camellia_192, Botan::TripleDES, Botan::Lion, Botan::AES_128_NI, Botan::IDEA_SSE2, Botan::Noekeon_SIMD, Botan::Serpent_SIMD, Botan::XTEA_SIMD, Botan::AES_128, Botan::AES_128_SSSE3, Botan::Blowfish, Botan::Camellia_128, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::IDEA, Botan::KASUMI, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::RC2, Botan::RC5, Botan::RC6, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::Serpent_X86_32, Botan::TEA, Botan::Threefish_512, Botan::Twofish, and Botan::XTEA.
Referenced by Botan::ECB_Encryption::update(), and Botan::XTS_Encryption::update().
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::key_spec | ( | ) | const [inline, virtual] |
Implements Botan::SymmetricAlgorithm.
Definition at line 156 of file block_cipher.h.
{
return Key_Length_Specification(KMIN, KMAX, KMOD);
}
size_t Botan::SymmetricAlgorithm::maximum_keylength | ( | ) | const [inline, inherited] |
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] |
Definition at line 44 of file sym_algo.h.
{ return key_spec().minimum_keylength(); }
virtual std::string Botan::SymmetricAlgorithm::name | ( | ) | const [pure virtual, inherited] |
Implemented in Botan::GHASH, Botan::AES_256_NI, Botan::AES_256, Botan::AES_256_SSSE3, Botan::Camellia_256, Botan::GOST_28147_89, Botan::AES_192_NI, Botan::AES_192, Botan::AES_192_SSSE3, Botan::Camellia_192, Botan::TripleDES, Botan::MessageAuthenticationCode, Botan::Lion, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::Salsa20, Botan::Cascade_Cipher, Botan::RC2, Botan::Blowfish, Botan::AES_128_NI, Botan::Threefish_512, Botan::AES_128, Botan::AES_128_SSSE3, Botan::Camellia_128, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::IDEA, Botan::KASUMI, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::RC5, Botan::RC6, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::TEA, Botan::Twofish, Botan::XTEA, Botan::RC4, Botan::HMAC, Botan::Poly1305, Botan::ANSI_X919_MAC, Botan::CBC_MAC, Botan::CMAC, and Botan::SipHash.
Referenced by Botan::CBC_Mode::CBC_Mode(), Botan::ECB_Mode::ECB_Mode(), Botan::GCM_Mode::GCM_Mode(), Botan::XTS_Mode::name(), Botan::CFB_Mode::name(), Botan::ECB_Mode::name(), Botan::CBC_Mode::name(), and Botan::XTS_Mode::XTS_Mode().
size_t Botan::BlockCipher::parallel_bytes | ( | ) | const [inline, inherited] |
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] |
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.
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()); }
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.
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.
length | the key length to be checked. |
Definition at line 54 of file sym_algo.h.
Referenced by Botan::aont_package(), and Botan::aont_unpackage().
{ return key_spec().valid_keylength(length); }