Botan
2.1.0
Crypto and TLS for C++11
|
#include <aead.h>
Public Member Functions | |
bool | authenticated () const override |
virtual void | clear ()=0 |
size_t | default_nonce_length () const override |
virtual void | finish (secure_vector< uint8_t > &final_block, size_t offset=0)=0 |
virtual Key_Length_Specification | key_spec () const =0 |
virtual size_t | minimum_final_size () const =0 |
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_ad (const std::vector< uint8_t, Alloc > &ad) |
virtual void | set_associated_data (const uint8_t ad[], size_t ad_len)=0 |
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) |
template<typename Alloc > | |
void | start (const std::vector< uint8_t, Alloc > &nonce) |
void | start (const uint8_t nonce[], size_t nonce_len) |
void | start () |
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 |
virtual | ~AEAD_Mode ()=default |
Interface for AEAD (Authenticated Encryption with Associated Data) modes. These modes provide both encryption and message authentication, and can authenticate additional per-message data which is not included in the ciphertext (for instance a sequence number).
|
virtualdefault |
|
inlineoverridevirtual |
Reimplemented from Botan::Cipher_Mode.
|
pure virtualinherited |
Zeroise all state See also reset_msg()
Implemented in Botan::SIV_Mode, Botan::Stream_Cipher_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CFB_Mode, Botan::XTS_Mode, and Botan::CBC_Mode.
Referenced by botan_cipher_clear().
|
inlineoverridevirtual |
Implements Botan::Cipher_Mode.
Reimplemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, and Botan::CCM_Mode.
|
pure virtualinherited |
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::TLS::TLS_CBC_HMAC_AEAD_Decryption, Botan::CTS_Decryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, Botan::CBC_Decryption, Botan::OCB_Decryption, Botan::CCM_Decryption, Botan::EAX_Decryption, Botan::GCM_Decryption, Botan::SIV_Decryption, Botan::CTS_Encryption, Botan::CFB_Decryption, Botan::ChaCha20Poly1305_Decryption, Botan::OCB_Encryption, Botan::CCM_Encryption, Botan::SIV_Encryption, Botan::XTS_Decryption, Botan::EAX_Encryption, Botan::GCM_Encryption, Botan::CBC_Encryption, Botan::CFB_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::XTS_Encryption, and Botan::Stream_Cipher_Mode.
Referenced by botan_cipher_update(), and Botan::TLS::write_record().
|
pure virtualinherited |
Implemented in Botan::SIV_Mode, Botan::Stream_Cipher_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CFB_Mode, Botan::XTS_Mode, and Botan::CBC_Mode.
Referenced by botan_cipher_query_keylen().
|
pure virtualinherited |
Implemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption, Botan::CTS_Decryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, Botan::CBC_Decryption, Botan::CCM_Decryption, Botan::OCB_Decryption, Botan::SIV_Decryption, Botan::EAX_Decryption, Botan::GCM_Decryption, Botan::CTS_Encryption, Botan::CCM_Encryption, Botan::SIV_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::OCB_Encryption, Botan::EAX_Encryption, Botan::CBC_Encryption, Botan::GCM_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::Stream_Cipher_Mode, Botan::CFB_Mode, and Botan::XTS_Mode.
Referenced by botan_cipher_update().
|
pure virtualinherited |
|
pure virtualinherited |
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.
Implemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Decryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, Botan::CBC_Decryption, Botan::CCM_Decryption, Botan::OCB_Decryption, Botan::SIV_Decryption, Botan::EAX_Decryption, Botan::GCM_Decryption, Botan::CTS_Encryption, Botan::CCM_Encryption, Botan::SIV_Encryption, Botan::XTS_Decryption, Botan::OCB_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::CBC_Encryption, Botan::EAX_Encryption, Botan::GCM_Encryption, Botan::XTS_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::Stream_Cipher_Mode, and Botan::CFB_Mode.
Referenced by Botan::TLS::write_record().
|
pure virtualinherited |
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::CBC_Decryption, Botan::OCB_Decryption, Botan::EAX_Decryption, Botan::GCM_Decryption, Botan::CFB_Decryption, Botan::ChaCha20Poly1305_Decryption, Botan::OCB_Encryption, Botan::XTS_Decryption, Botan::EAX_Encryption, Botan::GCM_Encryption, Botan::CBC_Encryption, Botan::CFB_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::XTS_Encryption, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::SIV_Mode, and Botan::Stream_Cipher_Mode.
|
inlinevirtualinherited |
Reimplemented in Botan::GCM_Mode.
Definition at line 202 of file cipher_mode.h.
|
pure virtualinherited |
Resets just the message specific state and allows encrypting again under the existing key
Implemented in Botan::CBC_Decryption, Botan::Stream_Cipher_Mode, Botan::SIV_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CFB_Mode, Botan::XTS_Mode, and Botan::CBC_Mode.
|
inline |
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 66 of file aead.h.
Referenced by Botan::TLS::write_record().
|
pure virtual |
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 |
Implemented in Botan::TLS::TLS_CBC_HMAC_AEAD_Encryption, Botan::SIV_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.
|
inline |
|
inlineinherited |
Set the symmetric key of this transform
key | contains the key material |
Definition at line 172 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 181 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 191 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message.
nonce | the per message nonce |
Definition at line 38 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 48 of file cipher_mode.h.
|
inlineinherited |
Begin processing a message.
Definition at line 56 of file cipher_mode.h.
|
pure virtualinherited |
|
inlinevirtualinherited |
Reimplemented in Botan::SIV_Mode, Botan::CCM_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.
Definition at line 150 of file cipher_mode.h.
Referenced by botan_cipher_get_tag_length().
|
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 81 of file cipher_mode.h.
References BOTAN_ASSERT.
Referenced by botan_cipher_update(), Botan::XTS_Encryption::finish(), Botan::ChaCha20Poly1305_Encryption::finish(), Botan::CBC_Encryption::finish(), Botan::CFB_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().
|
pure virtualinherited |
Implemented in Botan::SIV_Mode, Botan::OCB_Mode, Botan::Stream_Cipher_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CBC_Mode, Botan::CFB_Mode, and Botan::XTS_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 162 of file cipher_mode.h.
|
pure virtualinherited |
Implemented in Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::SIV_Mode, Botan::Stream_Cipher_Mode, Botan::OCB_Mode, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::CFB_Mode, Botan::EAX_Mode, Botan::XTS_Mode, and Botan::CBC_Mode.
Referenced by botan_cipher_valid_nonce_length().