Botan
2.6.0
Crypto and TLS for C++11
|
#include <siv.h>
Public Member Functions | |
bool | authenticated () const override |
void | clear () override |
size_t | default_nonce_length () const override |
void | finish (secure_vector< uint8_t > &final_block, size_t offset=0) override |
Key_Length_Specification | key_spec () const override |
size_t | minimum_final_size () const override |
std::string | name () const override |
size_t | output_length (size_t input_length) const override |
size_t | process (uint8_t buf[], size_t size) override |
virtual std::string | provider () const |
void | reset () override |
template<typename Alloc > | |
void | set_ad (const std::vector< uint8_t, Alloc > &ad) |
void | set_associated_data (const uint8_t ad[], size_t ad_len) override |
void | set_associated_data_n (size_t n, const uint8_t ad[], size_t ad_len) |
template<typename Alloc > | |
void | set_associated_data_vec (const std::vector< uint8_t, Alloc > &ad) |
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) |
SIV_Decryption (BlockCipher *cipher) | |
template<typename Alloc > | |
void | start (const std::vector< uint8_t, Alloc > &nonce) |
void | start (const uint8_t nonce[], size_t nonce_len) |
void | start () |
size_t | tag_size () const override |
void | update (secure_vector< uint8_t > &buffer, size_t offset=0) |
size_t | update_granularity () const override |
bool | valid_keylength (size_t length) const |
bool | valid_nonce_length (size_t) const override |
Static Public Member Functions | |
static std::unique_ptr< AEAD_Mode > | create (const std::string &algo, Cipher_Dir direction, const std::string &provider="") |
static std::unique_ptr< AEAD_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 | |
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 |
|
inlineoverridevirtualinherited |
Reimplemented from Botan::Cipher_Mode.
|
inlineprotectedinherited |
Definition at line 60 of file siv.h.
Referenced by finish(), Botan::SIV_Mode::S2V(), and Botan::SIV_Mode::set_associated_data_n().
|
overridevirtualinherited |
Zeroise all state See also reset_msg()
Implements Botan::Cipher_Mode.
Definition at line 33 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 52 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::BlockCipher::create(), Botan::ENCRYPTION, Botan::parse_algorithm_name(), Botan::Cipher_Mode::provider(), and Botan::split_on().
Referenced by 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 42 of file aead.cpp.
References Botan::AEAD_Mode::create(), and Botan::Cipher_Mode::provider().
Referenced by Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::TLS::Session::decrypt(), Botan::TLS::Session::encrypt(), Botan::mceies_decrypt(), and Botan::mceies_encrypt().
|
inlineprotectedinherited |
Definition at line 62 of file siv.h.
Referenced by Botan::SIV_Encryption::finish(), finish(), and Botan::SIV_Mode::set_ctr_iv().
|
inlineoverridevirtualinherited |
Implements Botan::Cipher_Mode.
Reimplemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, and Botan::CCM_Mode.
|
overridevirtual |
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 |
Implements Botan::Cipher_Mode.
Definition at line 172 of file siv.cpp.
References Botan::SIV_Mode::block_size(), BOTAN_ASSERT, Botan::StreamCipher::cipher(), Botan::constant_time_compare(), Botan::SIV_Mode::ctr(), Botan::SIV_Mode::msg_buf(), Botan::SIV_Mode::S2V(), Botan::SIV_Mode::set_ctr_iv(), T, and Botan::SIV_Mode::tag_size().
|
overridevirtualinherited |
Implements Botan::Cipher_Mode.
|
inlineoverridevirtual |
Implements Botan::Cipher_Mode.
Definition at line 120 of file siv.h.
|
inlineprotectedinherited |
Definition at line 66 of file siv.h.
Referenced by Botan::SIV_Encryption::finish(), and finish().
|
overridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 47 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. Will throw if unable to give a precise answer.
Implements Botan::Cipher_Mode.
Definition at line 114 of file siv.h.
References BOTAN_ASSERT.
|
overridevirtualinherited |
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 |
Implements Botan::Cipher_Mode.
|
inlinevirtualinherited |
Reimplemented in Botan::GCM_Mode.
Definition at line 236 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 173 of file cipher_mode.cpp.
References Botan::Cipher_Mode::create(), and Botan::ENCRYPTION.
|
overridevirtualinherited |
Resets just the message specific state and allows encrypting again under the existing key
Implements Botan::Cipher_Mode.
Definition at line 40 of file siv.cpp.
Referenced by Botan::SIV_Mode::clear().
|
protectedinherited |
Definition at line 113 of file siv.cpp.
References Botan::SIV_Mode::block_size(), Botan::poly_double_n(), and Botan::xor_buf().
Referenced by Botan::SIV_Encryption::finish(), and finish().
|
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 88 of file aead.h.
Referenced by Botan::TLS::write_record().
|
inlineoverridevirtualinherited |
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 |
ad_len | length of add in bytes |
Implements Botan::AEAD_Mode.
Definition at line 36 of file siv.h.
|
inherited |
Sets the nth element of the vector of associated data
n | index into the AD vector |
ad | associated data |
ad_len | length of associated data in bytes |
Definition at line 81 of file siv.cpp.
References Botan::SIV_Mode::block_size(), Botan::SIV_Mode::name(), and Botan::ASN1::to_string().
|
inlineinherited |
|
protectedinherited |
Definition at line 146 of file siv.cpp.
References Botan::SIV_Mode::ctr(), and Botan::StreamCipher::set_iv().
Referenced by Botan::SIV_Encryption::finish(), and finish().
|
inlineinherited |
Set the symmetric key of this transform
key | contains the key material |
Definition at line 206 of file cipher_mode.h.
Referenced by botan_cipher_set_key().
|
inlineinherited |
Set the symmetric key of this transform
key | contains the key material |
Definition at line 215 of file cipher_mode.h.
References Botan::OctetString::begin(), and Botan::OctetString::length().
|
inlineinherited |
Set the symmetric key of this transform
key | contains the key material |
length | in bytes of key param |
Definition at line 225 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message.
nonce | the per message nonce |
Definition at line 72 of file cipher_mode.h.
Referenced by botan_cipher_start(), and Botan::TLS::write_record().
|
inlineinherited |
Begin processing a message.
nonce | the per message nonce |
nonce_len | length of nonce |
Definition at line 82 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message.
Definition at line 90 of file cipher_mode.h.
|
inlineoverridevirtualinherited |
Reimplemented from Botan::Cipher_Mode.
Definition at line 53 of file siv.h.
Referenced by finish().
|
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 115 of file cipher_mode.h.
References BOTAN_ASSERT.
Referenced by botan_cipher_update(), Botan::XTS_Encryption::finish(), Botan::ChaCha20Poly1305_Encryption::finish(), Botan::CFB_Encryption::finish(), Botan::CBC_Encryption::finish(), Botan::EAX_Encryption::finish(), Botan::XTS_Decryption::finish(), Botan::CFB_Decryption::finish(), Botan::CTS_Encryption::finish(), Botan::CBC_Decryption::finish(), Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption::finish(), Botan::CTS_Decryption::finish(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption::finish().
|
overridevirtualinherited |
Implements Botan::Cipher_Mode.
Definition at line 57 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 196 of file cipher_mode.h.
|
overridevirtualinherited |
Implements Botan::Cipher_Mode.