Botan 3.5.0
Crypto and TLS for C&
|
#include <siv.h>
Public Member Functions | |
virtual bool | associated_data_requires_key () const |
bool | authenticated () const |
void | clear () override final |
size_t | default_nonce_length () const override |
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_associated_data_inputs () const override final |
size_t | maximum_keylength () const |
size_t | minimum_final_size () const override |
size_t | minimum_keylength () const |
std::string | name () const override final |
size_t | output_length (size_t input_length) const override |
size_t | process (std::span< uint8_t > msg) |
size_t | process (uint8_t msg[], size_t msg_len) |
virtual std::string | provider () const |
bool | requires_entire_message () const override final |
void | reset () override final |
void | set_ad (std::span< const uint8_t > ad) |
void | set_associated_data (const uint8_t ad[], size_t ad_len) |
void | set_associated_data (std::span< const uint8_t > ad) |
void | set_associated_data_n (size_t n, std::span< const uint8_t > ad) override final |
template<typename Alloc > | |
void | set_associated_data_vec (const std::vector< uint8_t, Alloc > &ad) |
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) |
SIV_Decryption (std::unique_ptr< BlockCipher > cipher) | |
void | start () |
void | start (const uint8_t nonce[], size_t nonce_len) |
void | start (std::span< const uint8_t > nonce) |
size_t | tag_size () const override final |
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) const override final |
Static Public Member Functions | |
static std::unique_ptr< AEAD_Mode > | create (std::string_view algo, Cipher_Dir direction, std::string_view provider="") |
static std::unique_ptr< AEAD_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 |
StreamCipher & | ctr () |
secure_vector< uint8_t > & | msg_buf () |
secure_vector< uint8_t > | S2V (const uint8_t text[], size_t text_len) |
void | set_ctr_iv (secure_vector< uint8_t > V) |
|
inlineexplicit |
|
inlineprotectedinherited |
Definition at line 139 of file sym_algo.h.
References Botan::SymmetricAlgorithm::assert_key_material_set().
Referenced by Botan::SymmetricAlgorithm::assert_key_material_set(), 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::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Kuznyechik::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::TripleDES::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::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Kuznyechik::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::TripleDES::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 141 of file sym_algo.h.
|
inlinevirtualinherited |
Most AEADs require the key to be set prior to setting the AD A few allow the AD to be set even before the cipher is keyed. Such ciphers would return false from this function.
Reimplemented in Botan::CCM_Mode, and Botan::ChaCha20Poly1305_Mode.
Definition at line 98 of file aead.h.
|
inlineinherited |
Definition at line 223 of file cipher_mode.h.
|
inlineprotectedinherited |
Definition at line 59 of file siv.h.
Referenced by Botan::SIV_Mode::maximum_associated_data_inputs(), and Botan::SIV_Mode::S2V().
|
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 32 of file siv.cpp.
References Botan::SIV_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 53 of file aead.cpp.
References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), BOTAN_UNUSED, Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::Encryption, Botan::parse_algorithm_name(), Botan::Cipher_Mode::provider(), and Botan::split_on().
Referenced by Botan::AEAD_Mode::create(), Botan::Cipher_Mode::create(), Botan::AEAD_Mode::create_or_throw(), and Botan::get_aead().
|
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 43 of file aead.cpp.
References Botan::AEAD_Mode::create(), and Botan::Cipher_Mode::provider().
Referenced by Botan::TLS::Cipher_State::advance_with_server_hello(), Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::TLS::Session::decrypt(), and Botan::TLS::Session::encrypt().
|
inlineprotectedinherited |
Definition at line 61 of file siv.h.
Referenced by Botan::SIV_Mode::set_ctr_iv().
|
inlineoverridevirtualinherited |
Implements Botan::Cipher_Mode.
Reimplemented in Botan::CCM_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.
Definition at line 130 of file aead.h.
|
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 146 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 159 of file cipher_mode.h.
|
finaloverridevirtualinherited |
Implements Botan::SymmetricAlgorithm.
Definition at line 69 of file siv.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 siv.cpp.
|
finaloverridevirtualinherited |
Implements Botan::SymmetricAlgorithm.
Definition at line 65 of file siv.cpp.
|
finaloverridevirtualinherited |
Returns the maximum supported number of associated data inputs which can be provided to set_associated_data_n
If returns 0, then no associated data is supported.
Reimplemented from Botan::AEAD_Mode.
Definition at line 80 of file siv.cpp.
References Botan::SIV_Mode::block_size().
Referenced by Botan::SIV_Mode::set_associated_data_n().
|
inlineinherited |
Definition at line 95 of file sym_algo.h.
|
inlineoverridevirtual |
Implements Botan::Cipher_Mode.
Definition at line 117 of file siv.h.
|
inlineinherited |
Definition at line 100 of file sym_algo.h.
|
inlineprotectedinherited |
|
finaloverridevirtualinherited |
Implements Botan::SymmetricAlgorithm.
Definition at line 44 of file siv.cpp.
Referenced by Botan::SIV_Mode::set_associated_data_n().
|
inlineoverridevirtual |
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 112 of file siv.h.
References BOTAN_ASSERT.
|
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 123 of file cipher_mode.h.
Referenced by botan_cipher_update().
|
inlineinherited |
Definition at line 125 of file cipher_mode.h.
|
inlinevirtualinherited |
Reimplemented in Botan::GCM_Mode.
Definition at line 234 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 164 of file cipher_mode.cpp.
References Botan::Cipher_Mode::create(), Botan::Encryption, and Botan::Cipher_Mode::providers().
Referenced by Botan::Cipher_Mode::providers().
|
finaloverridevirtualinherited |
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 from Botan::Cipher_Mode.
Definition at line 61 of file siv.cpp.
|
finaloverridevirtualinherited |
Resets just the message specific state and allows encrypting again under the existing key
Implements Botan::Cipher_Mode.
Definition at line 38 of file siv.cpp.
Referenced by Botan::SIV_Mode::clear().
|
protectedinherited |
Definition at line 117 of file siv.cpp.
References Botan::SIV_Mode::block_size(), Botan::poly_double_n(), and Botan::xor_buf().
|
inlineinherited |
Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.
ad | the associated data |
Definition at line 124 of file aead.h.
|
inlineinherited |
Definition at line 61 of file aead.h.
References Botan::AEAD_Mode::set_associated_data().
Referenced by Botan::AEAD_Mode::set_associated_data().
|
inlineinherited |
Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.
Unless reset by another call, the associated data is kept between messages. Thus, if the AD does not change, calling once (after set_key) is the optimum.
ad | the associated data |
Definition at line 59 of file aead.h.
Referenced by Botan::TLS::write_record().
|
finaloverridevirtualinherited |
Sets the nth element of the vector of associated data
n | index into the AD vector |
ad | associated data |
Implements Botan::AEAD_Mode.
Definition at line 84 of file siv.cpp.
References Botan::SIV_Mode::maximum_associated_data_inputs(), and Botan::SIV_Mode::name().
|
inlineinherited |
Set associated data that is not included in the ciphertext but that should be authenticated. Must be called after set_key and before start.
ad | the associated data |
|
protectedinherited |
Definition at line 146 of file siv.cpp.
References Botan::SIV_Mode::ctr(), and Botan::StreamCipher::set_iv().
|
inlineinherited |
Set the symmetric key of this object.
key | the SymmetricKey to be set. |
Definition at line 113 of file sym_algo.h.
References Botan::OctetString::begin(), Botan::OctetString::length(), and Botan::SymmetricAlgorithm::set_key().
Referenced by Botan::create_aes_row_generator(), 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(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), Botan::Sodium::randombytes_buf_deterministic(), and Botan::SymmetricAlgorithm::set_key().
|
inlineinherited |
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 126 of file sym_algo.h.
References Botan::SymmetricAlgorithm::set_key().
Referenced by Botan::SymmetricAlgorithm::set_key().
|
inherited |
Set the symmetric key of this object.
key | the contiguous byte range to be set. |
Definition at line 17 of file sym_algo.cpp.
References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::valid_keylength().
|
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 108 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 96 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message with a fresh nonce.
nonce | the per message nonce |
Definition at line 89 of file cipher_mode.h.
Referenced by botan_cipher_start(), and Botan::TLS::write_record().
|
inlinefinaloverridevirtualinherited |
Reimplemented from Botan::Cipher_Mode.
Definition at line 50 of file siv.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 133 of file cipher_mode.h.
References BOTAN_ASSERT.
|
finaloverridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 52 of file siv.cpp.
|
inlineinherited |
Check whether a given key length is valid for this algorithm.
length | the key length to be checked. |
Definition at line 107 of file sym_algo.h.
Referenced by Botan::SymmetricAlgorithm::set_key().
|
finaloverridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 48 of file siv.cpp.