Botan 3.0.0
Crypto and TLS for C&
|
#include <cfb.h>
Public Member Functions | |
bool | authenticated () const |
CFB_Decryption (std::unique_ptr< BlockCipher > cipher, size_t feedback_bits) | |
void | clear () override final |
size_t | default_nonce_length () const override final |
void | finish (secure_vector< uint8_t > &final_block, size_t offset=0) |
template<concepts::resizable_byte_buffer T> | |
void | finish (T &final_block, size_t offset=0) |
bool | has_keying_material () const override final |
size_t | ideal_granularity () const override final |
Key_Length_Specification | key_spec () const override final |
size_t | maximum_keylength () const |
size_t | minimum_final_size () const override final |
size_t | minimum_keylength () const |
std::string | name () const override final |
size_t | output_length (size_t input_length) const override final |
size_t | process (std::span< uint8_t > msg) |
size_t | process (uint8_t msg[], size_t msg_len) |
virtual std::string | provider () const |
virtual bool | requires_entire_message () const |
void | reset () override final |
void | set_key (const SymmetricKey &key) |
void | set_key (const uint8_t key[], size_t length) |
void | set_key (std::span< const uint8_t > key) |
void | start () |
void | start (const uint8_t nonce[], size_t nonce_len) |
void | start (std::span< const uint8_t > nonce) |
virtual size_t | tag_size () const |
template<concepts::resizable_byte_buffer T> | |
void | update (T &buffer, size_t offset=0) |
size_t | update_granularity () const override final |
bool | valid_keylength (size_t length) const |
bool | valid_nonce_length (size_t n) const override final |
Static Public Member Functions | |
static std::unique_ptr< Cipher_Mode > | create (std::string_view algo, Cipher_Dir direction, std::string_view provider="") |
static std::unique_ptr< Cipher_Mode > | create_or_throw (std::string_view algo, Cipher_Dir direction, std::string_view provider="") |
static std::vector< std::string > | providers (std::string_view algo_spec) |
Protected Member Functions | |
void | assert_key_material_set () const |
void | assert_key_material_set (bool predicate) const |
size_t | block_size () const |
const BlockCipher & | cipher () const |
size_t | feedback () const |
void | shift_register () |
Protected Attributes | |
secure_vector< uint8_t > | m_keystream |
size_t | m_keystream_pos = 0 |
secure_vector< uint8_t > | m_state |
|
inline |
If feedback_bits is zero, cipher->block_size() bytes will be used.
cipher | block cipher to use |
feedback_bits | number of bits fed back into the shift register, must be a multiple of 8 |
Definition at line 98 of file cfb.h.
|
inlineprotectedinherited |
Definition at line 182 of file sym_algo.h.
Referenced by Botan::Salsa20::cipher_bytes(), 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::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Lion::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::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::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Lion::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::GHASH::final(), Botan::GHASH::ghash_update(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), and Botan::GHASH::update_associated_data().
|
inlineprotectedinherited |
Definition at line 187 of file sym_algo.h.
|
inlineinherited |
Definition at line 239 of file cipher_mode.h.
|
inlineprotectedinherited |
Definition at line 51 of file cfb.h.
Referenced by Botan::CFB_Mode::default_nonce_length(), Botan::CFB_Mode::name(), Botan::CFB_Mode::shift_register(), and Botan::CFB_Mode::valid_nonce_length().
|
inlineprotectedinherited |
Definition at line 50 of file cfb.h.
Referenced by Botan::CFB_Mode::key_spec(), Botan::CFB_Mode::name(), and Botan::CFB_Mode::shift_register().
|
finaloverridevirtualinherited |
Reset the internal state. This includes not just the key, but any partial message that may have been in process.
Implements Botan::SymmetricAlgorithm.
Definition at line 25 of file cfb.cpp.
References Botan::CFB_Mode::m_keystream, and Botan::CFB_Mode::reset().
|
staticinherited |
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(), Botan::Cipher_Mode::create(), Botan::BlockCipherModePaddingMethod::create(), Botan::BlockCipher::create(), Botan::StreamCipher::create(), Botan::Encryption, Botan::make_commoncrypto_cipher_mode(), Botan::parse_algorithm_name(), Botan::Cipher_Mode::provider(), and Botan::split_on().
Referenced by botan_cipher_init(), Botan::Cipher_Mode::create(), Botan::Cipher_Mode::create_or_throw(), Botan::get_cipher_mode(), Botan::pbes2_decrypt(), and Botan::Cipher_Mode::providers().
|
staticinherited |
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 Botan::Cipher_Mode::create(), and Botan::Cipher_Mode::provider().
Referenced by Botan::ECIES_System_Params::create_cipher(), Botan::CryptoBox::decrypt_bin(), Botan::CryptoBox::encrypt(), and Botan::get_cipher().
|
finaloverridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 72 of file cfb.cpp.
References Botan::CFB_Mode::block_size().
|
inlineprotectedinherited |
Definition at line 49 of file cfb.h.
Referenced by Botan::CFB_Mode::CFB_Mode(), Botan::CFB_Mode::ideal_granularity(), Botan::CFB_Mode::name(), Botan::CFB_Mode::shift_register(), and Botan::CFB_Mode::update_granularity().
|
inlineinherited |
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 |
Definition at line 158 of file cipher_mode.h.
Referenced by botan_cipher_update(), and Botan::TLS::write_record().
|
inlineinherited |
Complete procession of a message.
Note: Using this overload with anything but a Botan::secure_vector<> is copying the bytes in the in/out buffer.
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 |
Definition at line 174 of file cipher_mode.h.
|
finaloverridevirtualinherited |
Implements Botan::SymmetricAlgorithm.
Definition at line 82 of file cfb.cpp.
|
finaloverridevirtualinherited |
Return an ideal granularity. This will be a multiple of the result of update_granularity but may be larger. If so it indicates that better performance may be achieved by providing buffers that are at least that size.
Implements Botan::Cipher_Mode.
Definition at line 56 of file cfb.cpp.
References Botan::CFB_Mode::feedback().
|
finaloverridevirtualinherited |
Implements Botan::SymmetricAlgorithm.
Definition at line 67 of file cfb.cpp.
References Botan::CFB_Mode::cipher(), and Botan::SymmetricAlgorithm::key_spec().
|
inlineinherited |
Definition at line 123 of file sym_algo.h.
|
finaloverridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 62 of file cfb.cpp.
|
inlineinherited |
Definition at line 131 of file sym_algo.h.
|
finaloverridevirtualinherited |
Implements Botan::SymmetricAlgorithm.
Definition at line 38 of file cfb.cpp.
References Botan::CFB_Mode::block_size(), Botan::CFB_Mode::cipher(), Botan::CFB_Mode::feedback(), Botan::fmt(), and Botan::CFB_Mode::name().
Referenced by Botan::CFB_Mode::CFB_Mode(), and Botan::CFB_Mode::name().
|
finaloverridevirtualinherited |
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 an upper bound is returned.
Implements Botan::Cipher_Mode.
Definition at line 46 of file cfb.cpp.
|
inlineinherited |
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 |
Definition at line 133 of file cipher_mode.h.
|
inlineinherited |
Definition at line 135 of file cipher_mode.h.
|
inlinevirtualinherited |
Reimplemented in Botan::GCM_Mode.
Definition at line 250 of file cipher_mode.h.
Referenced by Botan::AEAD_Mode::create(), Botan::Cipher_Mode::create(), Botan::AEAD_Mode::create_or_throw(), and Botan::Cipher_Mode::create_or_throw().
|
staticinherited |
algo_spec | algorithm name |
Definition at line 172 of file cipher_mode.cpp.
References Botan::Cipher_Mode::create(), Botan::Encryption, and Botan::Cipher_Mode::providers().
Referenced by Botan::Cipher_Mode::providers().
|
inlinevirtualinherited |
Certain modes require the entire message be available before any processing can occur. For such modes, input will be consumed but not returned, until finish
is called, which returns the entire message.
This function returns true if this mode has this style of operation.
Reimplemented in Botan::CCM_Mode, and Botan::SIV_Mode.
Definition at line 212 of file cipher_mode.h.
|
finaloverridevirtualinherited |
Resets just the message specific state and allows encrypting again under the existing key
Implements Botan::Cipher_Mode.
Definition at line 32 of file cfb.cpp.
References Botan::CFB_Mode::m_keystream, Botan::CFB_Mode::m_state, and Botan::zeroise().
Referenced by Botan::CFB_Mode::clear().
|
inlineinherited |
Set the symmetric key of this object.
key | the SymmetricKey to be set. |
Definition at line 150 of file sym_algo.h.
References Botan::OctetString::begin(), and Botan::OctetString::length().
Referenced by 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().
|
inlineinherited |
Set the symmetric key of this object.
key | the contiguous byte range to be set. |
Definition at line 159 of file sym_algo.h.
|
protectedinherited |
Definition at line 116 of file cfb.cpp.
References Botan::CFB_Mode::block_size(), Botan::CFB_Mode::cipher(), Botan::copy_mem(), Botan::BlockCipher::encrypt(), Botan::CFB_Mode::feedback(), Botan::CFB_Mode::m_keystream, Botan::CFB_Mode::m_keystream_pos, and Botan::CFB_Mode::m_state.
|
inlineinherited |
Begin processing a message.
The exact semantics of this depend on the mode. For many modes, the call will fail since a nonce must be provided.
For certain modes such as CBC this will instead cause the last ciphertext block to be used as the nonce of the new message; doing this isn't a good idea, but some (mostly older) protocols do this.
Definition at line 115 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message with a fresh nonce.
nonce | the per message nonce |
nonce_len | length of nonce |
Definition at line 100 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message with a fresh nonce.
nonce | the per message nonce |
Definition at line 90 of file cipher_mode.h.
Referenced by botan_cipher_start(), and Botan::TLS::write_record().
|
inlinevirtualinherited |
Reimplemented in Botan::ChaCha20Poly1305_Mode, Botan::CCM_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Definition at line 244 of file cipher_mode.h.
|
inlineinherited |
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 144 of file cipher_mode.h.
References BOTAN_ASSERT.
Referenced by botan_cipher_update().
|
finaloverridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 51 of file cfb.cpp.
References Botan::CFB_Mode::feedback().
|
inlineinherited |
Check whether a given key length is valid for this algorithm.
length | the key length to be checked. |
Definition at line 141 of file sym_algo.h.
Referenced by Botan::SymmetricAlgorithm::set_key().
|
finaloverridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 77 of file cfb.cpp.
References Botan::CFB_Mode::block_size().
|
protectedinherited |
Definition at line 54 of file cfb.h.
Referenced by Botan::CFB_Mode::clear(), Botan::CFB_Mode::reset(), and Botan::CFB_Mode::shift_register().
|
protectedinherited |
Definition at line 55 of file cfb.h.
Referenced by Botan::CFB_Mode::shift_register().
|
protectedinherited |
Definition at line 53 of file cfb.h.
Referenced by Botan::CFB_Mode::reset(), and Botan::CFB_Mode::shift_register().