Botan 2.19.3
Crypto and TLS for C&
|
#include <cipher_mode.h>
Public Member Functions | |
virtual bool | authenticated () const |
virtual void | clear ()=0 |
virtual size_t | default_nonce_length () const =0 |
virtual void | finish (secure_vector< uint8_t > &final_block, size_t offset=0)=0 |
virtual Key_Length_Specification | key_spec () const =0 |
size_t | maximum_keylength () const |
virtual size_t | minimum_final_size () const =0 |
size_t | minimum_keylength () const |
virtual std::string | name () const =0 |
virtual size_t | output_length (size_t input_length) const =0 |
virtual size_t | process (uint8_t msg[], size_t msg_len)=0 |
virtual std::string | provider () const |
virtual void | reset ()=0 |
template<typename Alloc > | |
void | set_key (const std::vector< uint8_t, Alloc > &key) |
void | set_key (const SymmetricKey &key) |
void | set_key (const uint8_t key[], size_t length) |
void | start () |
template<typename Alloc > | |
void | start (const std::vector< uint8_t, Alloc > &nonce) |
void | start (const uint8_t nonce[], size_t nonce_len) |
virtual void | start_msg (const uint8_t nonce[], size_t nonce_len)=0 |
virtual size_t | tag_size () const |
void | update (secure_vector< uint8_t > &buffer, size_t offset=0) |
virtual size_t | update_granularity () const =0 |
bool | valid_keylength (size_t length) const |
virtual bool | valid_nonce_length (size_t nonce_len) const =0 |
Static Public Member Functions | |
static std::unique_ptr< Cipher_Mode > | create (const std::string &algo, Cipher_Dir direction, const std::string &provider="") |
static std::unique_ptr< Cipher_Mode > | create_or_throw (const std::string &algo, Cipher_Dir direction, const std::string &provider="") |
static std::vector< std::string > | providers (const std::string &algo_spec) |
Protected Member Functions | |
void | verify_key_set (bool cond) const |
Interface for cipher modes
Definition at line 28 of file cipher_mode.h.
|
inlinevirtual |
Reimplemented in Botan::AEAD_Mode.
Definition at line 169 of file cipher_mode.h.
|
pure virtualinherited |
Reset the state.
Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::TripleDES, Botan::DESX, Botan::GOST_28147_89, Botan::IDEA, Botan::KASUMI, Botan::Lion, Botan::MISTY1, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::Twofish, Botan::XTEA, Botan::CBC_MAC, Botan::CMAC, Botan::GMAC, Botan::HMAC, Botan::Poly1305, Botan::SipHash, Botan::ANSI_X919_MAC, Botan::FPE_FE1, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, Botan::GHASH, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Referenced by botan_block_cipher_clear(), botan_cipher_clear(), botan_mac_clear(), Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear(), and Botan::RC4::~RC4().
|
static |
Create an AEAD mode
algo | the algorithm to create |
direction | specify if this should be an encryption or decryption AEAD |
provider | optional specification for provider to use |
Definition at line 50 of file cipher_mode.cpp.
References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::AEAD_Mode::create(), create(), Botan::BlockCipher::create(), Botan::StreamCipher::create(), Botan::ENCRYPTION, Botan::get_bc_pad(), Botan::make_commoncrypto_cipher_mode(), Botan::parse_algorithm_name(), provider(), and Botan::split_on().
Referenced by botan_cipher_init(), create(), create_or_throw(), Botan::get_cipher_mode(), Botan::pbes2_decrypt(), and providers().
|
static |
Create an AEAD mode, or throw
algo | the algorithm to create |
direction | specify if this should be an encryption or decryption AEAD |
provider | optional specification for provider to use |
Definition at line 40 of file cipher_mode.cpp.
References create(), and provider().
Referenced by Botan::ECIES_System_Params::create_cipher(), Botan::CryptoBox::decrypt_bin(), Botan::CryptoBox::encrypt(), and Botan::get_cipher().
|
pure virtual |
Implemented in Botan::AEAD_Mode, Botan::CCM_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Referenced by botan_cipher_get_default_nonce_length().
|
pure virtual |
Complete processing of a message.
final_block | in/out parameter which must be at least minimum_final_size() bytes, and will be set to any final output |
offset | an offset into final_block to begin processing |
Implemented in Botan::CCM_Encryption, Botan::CCM_Decryption, Botan::ChaCha20Poly1305_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::EAX_Encryption, Botan::EAX_Decryption, Botan::GCM_Encryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::OCB_Decryption, Botan::SIV_Encryption, Botan::SIV_Decryption, Botan::CBC_Encryption, Botan::CTS_Encryption, Botan::CBC_Decryption, Botan::CTS_Decryption, Botan::CFB_Encryption, Botan::CFB_Decryption, Botan::XTS_Encryption, Botan::XTS_Decryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, and Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption.
Referenced by botan_cipher_update(), and Botan::TLS::write_record().
|
pure virtualinherited |
Implemented in Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >, Botan::Block_Cipher_Fixed_Params< 16, 16 >, 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< 32, 16, 64, 4 >, Botan::Block_Cipher_Fixed_Params< 64, 64, 0, 1, Tweakable_Block_Cipher >, 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::Cascade_Cipher, Botan::Lion, Botan::CBC_MAC, Botan::CMAC, Botan::GMAC, Botan::HMAC, Botan::Poly1305, Botan::SipHash, Botan::ANSI_X919_MAC, Botan::FPE_FE1, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, Botan::GHASH, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Referenced by botan_cipher_get_keyspec(), botan_cipher_query_keylen(), Botan::CBC_Mode::key_spec(), Botan::XTS_Mode::key_spec(), and Botan::CFB_Mode::key_spec().
|
inlineinherited |
Definition at line 120 of file sym_algo.h.
|
pure virtual |
Implemented in Botan::CCM_Encryption, Botan::CCM_Decryption, Botan::ChaCha20Poly1305_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::EAX_Encryption, Botan::EAX_Decryption, Botan::GCM_Encryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::OCB_Decryption, Botan::SIV_Encryption, Botan::SIV_Decryption, Botan::CBC_Encryption, Botan::CTS_Encryption, Botan::CBC_Decryption, Botan::CTS_Decryption, Botan::XTS_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption, and Botan::CFB_Mode.
Referenced by botan_cipher_update().
|
inlineinherited |
Definition at line 128 of file sym_algo.h.
Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().
|
pure virtualinherited |
Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::TripleDES, Botan::DESX, Botan::GOST_28147_89, Botan::IDEA, Botan::KASUMI, Botan::Lion, Botan::MISTY1, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::Twofish, Botan::XTEA, Botan::CBC_MAC, Botan::CMAC, Botan::GMAC, Botan::HMAC, Botan::Poly1305, Botan::SipHash, Botan::ANSI_X919_MAC, Botan::FPE_FE1, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, Botan::GHASH, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Referenced by Botan::CBC_Mode::CBC_Mode(), Botan::CBC_Mode::name(), Botan::XTS_Mode::name(), Botan::CFB_Mode::name(), Botan::AEAD_Mode::set_associated_data_n(), Botan::SymmetricAlgorithm::set_key(), Botan::MessageAuthenticationCode::start_msg(), and Botan::XTS_Mode::XTS_Mode().
|
pure virtual |
Returns the size of the output if this transform is used to process a message with input_length bytes. In most cases the answer is precise. If it is not possible to precise (namely for CBC decryption) instead a lower bound is returned.
Implemented in Botan::CCM_Encryption, Botan::CCM_Decryption, Botan::ChaCha20Poly1305_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::EAX_Encryption, Botan::EAX_Decryption, Botan::GCM_Encryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::OCB_Decryption, Botan::SIV_Encryption, Botan::SIV_Decryption, Botan::CBC_Encryption, Botan::CTS_Encryption, Botan::CBC_Decryption, Botan::XTS_Encryption, Botan::XTS_Decryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption, and Botan::CFB_Mode.
Referenced by botan_cipher_output_length(), and Botan::TLS::write_record().
|
pure virtual |
Process message blocks
Input must be a multiple of update_granularity
Processes msg in place and returns bytes written. Normally this will be either msg_len (indicating the entire message was processed) or for certain AEAD modes zero (indicating that the mode requires the entire message be processed in one pass).
msg | the message to be processed |
msg_len | length of the message in bytes |
Implemented in Botan::ChaCha20Poly1305_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::EAX_Encryption, Botan::EAX_Decryption, Botan::GCM_Encryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::OCB_Decryption, Botan::SIV_Mode, Botan::CBC_Encryption, Botan::CBC_Decryption, Botan::CFB_Encryption, Botan::CFB_Decryption, Botan::XTS_Encryption, Botan::XTS_Decryption, Botan::CCM_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
|
inlinevirtual |
Reimplemented in Botan::GCM_Mode.
Definition at line 180 of file cipher_mode.h.
Referenced by Botan::AEAD_Mode::create(), create(), Botan::AEAD_Mode::create_or_throw(), and create_or_throw().
|
static |
algo_spec | algorithm name |
Definition at line 173 of file cipher_mode.cpp.
References create(), Botan::ENCRYPTION, and providers().
Referenced by providers().
|
pure virtual |
Resets just the message specific state and allows encrypting again under the existing key
Implemented in Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::CBC_Decryption, Botan::XTS_Mode, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Referenced by botan_cipher_reset().
|
inlineinherited |
Definition at line 153 of file sym_algo.h.
|
inlineinherited |
Set the symmetric key of this object.
key | the SymmetricKey to be set. |
Definition at line 147 of file sym_algo.h.
References Botan::OctetString::begin(), and Botan::OctetString::length().
Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_block_cipher_set_key(), botan_cipher_set_key(), botan_mac_set_key(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), and Botan::Sodium::randombytes_buf_deterministic().
|
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 17 of file sym_algo.cpp.
References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().
|
inline |
Begin processing a message.
Definition at line 87 of file cipher_mode.h.
|
inline |
Begin processing a message.
nonce | the per message nonce |
Definition at line 69 of file cipher_mode.h.
Referenced by botan_cipher_start(), and Botan::TLS::write_record().
|
inline |
Begin processing a message.
nonce | the per message nonce |
nonce_len | length of nonce |
Definition at line 79 of file cipher_mode.h.
|
pure virtual |
|
inlinevirtual |
Reimplemented in Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Definition at line 174 of file cipher_mode.h.
Referenced by botan_cipher_get_tag_length(), Botan::CCM_Decryption::minimum_final_size(), Botan::ChaCha20Poly1305_Decryption::minimum_final_size(), Botan::EAX_Decryption::minimum_final_size(), Botan::GCM_Decryption::minimum_final_size(), Botan::OCB_Decryption::minimum_final_size(), Botan::SIV_Decryption::minimum_final_size(), Botan::CCM_Encryption::output_length(), Botan::CCM_Decryption::output_length(), Botan::ChaCha20Poly1305_Encryption::output_length(), Botan::ChaCha20Poly1305_Decryption::output_length(), Botan::EAX_Encryption::output_length(), Botan::EAX_Decryption::output_length(), Botan::GCM_Encryption::output_length(), Botan::GCM_Decryption::output_length(), Botan::OCB_Encryption::output_length(), Botan::OCB_Decryption::output_length(), Botan::SIV_Encryption::output_length(), and Botan::SIV_Decryption::output_length().
|
inline |
Process some data. Input must be in size update_granularity() uint8_t blocks.
buffer | in/out parameter which will possibly be resized |
offset | an offset into blocks to begin processing |
Definition at line 112 of file cipher_mode.h.
References BOTAN_ASSERT.
Referenced by botan_cipher_update().
|
pure virtual |
Implemented in Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Referenced by botan_cipher_get_update_granularity(), botan_cipher_start(), and botan_cipher_update().
|
inlineinherited |
Check whether a given key length is valid for this algorithm.
length | the key length to be checked. |
Definition at line 138 of file sym_algo.h.
Referenced by Botan::aont_package(), Botan::aont_unpackage(), and Botan::SymmetricAlgorithm::set_key().
|
pure virtual |
Implemented in Botan::GCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::CBC_Mode, Botan::CTS_Encryption, Botan::CTS_Decryption, Botan::XTS_Mode, Botan::CFB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::EAX_Mode, Botan::OCB_Mode, and Botan::SIV_Mode.
Referenced by botan_cipher_valid_nonce_length().
|
inlineprotectedinherited |
Definition at line 171 of file sym_algo.h.
Referenced by Botan::ChaCha::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::Salsa20::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::DESX::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::Lion::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::DESX::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::Lion::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data(), Botan::ChaCha::set_iv(), Botan::Salsa20::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().