Botan
1.11.15
|
#include <aead.h>
Public Types | |
typedef SCAN_Name | Spec |
Public Member Functions | |
bool | authenticated () const override |
virtual void | clear ()=0 |
size_t | default_nonce_length () const override |
virtual void | finish (secure_vector< byte > &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 std::string | provider () const |
template<typename Alloc > | |
void | set_ad (const std::vector< byte, Alloc > &ad) |
virtual void | set_associated_data (const byte ad[], size_t ad_len)=0 |
template<typename Alloc > | |
void | set_associated_data_vec (const std::vector< byte, Alloc > &ad) |
template<typename Alloc > | |
void | set_key (const std::vector< byte, Alloc > &key) |
void | set_key (const SymmetricKey &key) |
void | set_key (const byte key[], size_t length) |
template<typename Alloc > | |
secure_vector< byte > | start (const std::vector< byte, Alloc > &nonce) |
secure_vector< byte > | start (const byte nonce[], size_t nonce_len) |
secure_vector< byte > | start () |
virtual secure_vector< byte > | start_raw (const byte nonce[], size_t nonce_len)=0 |
template<typename Alloc > | |
secure_vector< byte > | start_vec (const std::vector< byte, Alloc > &nonce) |
virtual size_t | tag_size () const |
virtual void | update (secure_vector< byte > &blocks, size_t offset=0)=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 |
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).
typedef SCAN_Name Botan::Transform::Spec [inherited] |
Definition at line 27 of file transform.h.
bool Botan::AEAD_Mode::authenticated | ( | ) | const [inline, override, virtual] |
Returns true iff this mode provides authentication as well as confidentiality.
Reimplemented from Botan::Cipher_Mode.
Definition at line 25 of file aead.h.
{ return true; }
virtual void Botan::Transform::clear | ( | ) | [pure virtual, inherited] |
Implemented in Botan::Stream_Decompression, Botan::Stream_Compression, Botan::Stream_Cipher_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CFB_Mode, Botan::XTS_Mode, Botan::CBC_Mode, and Botan::ECB_Mode.
Referenced by botan_cipher_clear().
size_t Botan::AEAD_Mode::default_nonce_length | ( | ) | const [inline, override, virtual] |
Default AEAD nonce size (a commonly supported value among AEAD modes, and large enough that random collisions are unlikely).
Implements Botan::Transform.
Reimplemented in Botan::CCM_Mode.
Definition at line 57 of file aead.h.
{ return 12; }
virtual void Botan::Transform::finish | ( | secure_vector< byte > & | final_block, |
size_t | offset = 0 |
||
) | [pure virtual, inherited] |
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::CTS_Decryption, Botan::OCB_Decryption, Botan::CCM_Decryption, Botan::EAX_Decryption, Botan::CBC_Decryption, Botan::GCM_Decryption, Botan::SIV_Decryption, Botan::OCB_Encryption, Botan::CCM_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::CTS_Encryption, Botan::Stream_Decompression, Botan::CFB_Decryption, Botan::EAX_Encryption, Botan::SIV_Encryption, Botan::ECB_Decryption, Botan::XTS_Decryption, Botan::GCM_Encryption, Botan::CBC_Encryption, Botan::CFB_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::Stream_Compression, Botan::XTS_Encryption, Botan::ECB_Encryption, and Botan::Stream_Cipher_Mode.
Referenced by botan_cipher_update().
virtual Key_Length_Specification Botan::Keyed_Transform::key_spec | ( | ) | const [pure virtual, inherited] |
Implemented in Botan::Stream_Cipher_Mode, Botan::SIV_Mode, Botan::OCB_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CFB_Mode, Botan::XTS_Mode, Botan::CBC_Mode, and Botan::ECB_Mode.
virtual size_t Botan::Transform::minimum_final_size | ( | ) | const [pure virtual, inherited] |
Implemented in Botan::CTS_Decryption, Botan::CCM_Decryption, Botan::OCB_Decryption, Botan::CBC_Decryption, Botan::SIV_Decryption, Botan::EAX_Decryption, Botan::GCM_Decryption, Botan::CCM_Encryption, Botan::OCB_Encryption, Botan::CTS_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::SIV_Encryption, Botan::ECB_Decryption, Botan::EAX_Encryption, Botan::CBC_Encryption, Botan::GCM_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::ECB_Encryption, Botan::Stream_Cipher_Mode, Botan::CFB_Mode, Botan::XTS_Mode, and Botan::Compressor_Transform.
Referenced by botan_cipher_update().
virtual std::string Botan::Transform::name | ( | ) | const [pure virtual, inherited] |
Implemented in Botan::Gzip_Decompression, Botan::Gzip_Compression, Botan::Deflate_Decompression, Botan::Deflate_Compression, Botan::Bzip2_Decompression, Botan::LZMA_Decompression, Botan::Zlib_Decompression, Botan::Stream_Cipher_Mode, Botan::SIV_Mode, Botan::OCB_Mode, Botan::Bzip2_Compression, Botan::LZMA_Compression, Botan::Zlib_Compression, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CBC_Mode, Botan::CFB_Mode, Botan::ECB_Mode, and Botan::XTS_Mode.
Referenced by Botan::Compression_Decompression_Filter::Compression_Decompression_Filter(), and Botan::Stream_Decompression::finish().
virtual size_t Botan::Transform::output_length | ( | size_t | input_length | ) | const [pure virtual, inherited] |
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::CCM_Decryption, Botan::OCB_Decryption, Botan::CBC_Decryption, Botan::SIV_Decryption, Botan::EAX_Decryption, Botan::CCM_Encryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::CTS_Encryption, Botan::SIV_Encryption, Botan::ECB_Decryption, Botan::ChaCha20Poly1305_Decryption, Botan::XTS_Decryption, Botan::EAX_Encryption, Botan::CBC_Encryption, Botan::GCM_Encryption, Botan::XTS_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::ECB_Encryption, Botan::CFB_Mode, Botan::Compressor_Transform, and Botan::Stream_Cipher_Mode.
virtual std::string Botan::Transform::provider | ( | ) | const [inline, virtual, inherited] |
Return some short name describing the provider of this tranformation. Useful in cases where multiple implementations are available (eg, different implementations of AES). Default "core" is used for the 'standard' implementation included in the library.
Definition at line 120 of file transform.h.
{ return "core"; }
void Botan::AEAD_Mode::set_ad | ( | const std::vector< byte, Alloc > & | ad | ) | [inline] |
Definition at line 48 of file aead.h.
{ set_associated_data(&ad[0], ad.size()); }
virtual void Botan::AEAD_Mode::set_associated_data | ( | const byte | ad[], |
size_t | ad_len | ||
) | [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::OCB_Mode, Botan::SIV_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.
void Botan::AEAD_Mode::set_associated_data_vec | ( | const std::vector< byte, Alloc > & | ad | ) | [inline] |
Definition at line 42 of file aead.h.
{ set_associated_data(&ad[0], ad.size()); }
void Botan::Keyed_Transform::set_key | ( | const std::vector< byte, Alloc > & | key | ) | [inline, inherited] |
Definition at line 148 of file transform.h.
Referenced by botan_cipher_set_key().
{ set_key(&key[0], key.size()); }
void Botan::Keyed_Transform::set_key | ( | const SymmetricKey & | key | ) | [inline, inherited] |
Definition at line 153 of file transform.h.
References Botan::OctetString::begin(), and Botan::OctetString::length().
{ set_key(key.begin(), key.length()); }
void Botan::Keyed_Transform::set_key | ( | const byte | key[], |
size_t | length | ||
) | [inline, inherited] |
Set the symmetric key of this transform
key | contains the key material |
length | in bytes of key param |
Definition at line 163 of file transform.h.
{ if(!valid_keylength(length)) throw Invalid_Key_Length(name(), length); key_schedule(key, length); }
secure_vector<byte> Botan::Transform::start | ( | const std::vector< byte, Alloc > & | nonce | ) | [inline, inherited] |
Begin processing a message.
nonce | the per message nonce |
Definition at line 34 of file transform.h.
Referenced by botan_cipher_start().
{ return start(&nonce[0], nonce.size()); }
secure_vector<byte> Botan::Transform::start | ( | const byte | nonce[], |
size_t | nonce_len | ||
) | [inline, inherited] |
Begin processing a message.
nonce | the per message nonce |
nonce_len | length of nonce |
Definition at line 55 of file transform.h.
{ return start_raw(nonce, nonce_len); }
secure_vector<byte> Botan::Transform::start | ( | ) | [inline, inherited] |
Begin processing a message.
Definition at line 63 of file transform.h.
{ return start_raw(nullptr, 0); }
virtual secure_vector<byte> Botan::Transform::start_raw | ( | const byte | nonce[], |
size_t | nonce_len | ||
) | [pure virtual, inherited] |
secure_vector<byte> Botan::Transform::start_vec | ( | const std::vector< byte, Alloc > & | nonce | ) | [inline, inherited] |
Begin processing a message.
nonce | the per message nonce |
Definition at line 45 of file transform.h.
{ return start(&nonce[0], nonce.size()); }
virtual size_t Botan::Cipher_Mode::tag_size | ( | ) | const [inline, virtual, inherited] |
Return the size of the authentication tag used (in bytes)
Reimplemented in Botan::SIV_Mode, Botan::CCM_Mode, Botan::OCB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, and Botan::EAX_Mode.
Definition at line 31 of file cipher_mode.h.
Referenced by botan_cipher_get_tag_length().
{ return 0; }
virtual void Botan::Transform::update | ( | secure_vector< byte > & | blocks, |
size_t | offset = 0 |
||
) | [pure virtual, inherited] |
Process some data. Input must be in size update_granularity() byte blocks.
blocks | in/out paramter which will possibly be resized |
offset | an offset into blocks to begin processing |
Implemented in Botan::OCB_Decryption, Botan::EAX_Decryption, Botan::CBC_Decryption, Botan::GCM_Decryption, Botan::OCB_Encryption, Botan::ChaCha20Poly1305_Decryption, Botan::Stream_Decompression, Botan::CFB_Decryption, Botan::EAX_Encryption, Botan::ECB_Decryption, Botan::XTS_Decryption, Botan::GCM_Encryption, Botan::CBC_Encryption, Botan::CFB_Encryption, Botan::ChaCha20Poly1305_Encryption, Botan::Stream_Compression, Botan::XTS_Encryption, Botan::ECB_Encryption, Botan::CCM_Mode, Botan::SIV_Mode, and Botan::Stream_Cipher_Mode.
Referenced by botan_cipher_update().
virtual size_t Botan::Transform::update_granularity | ( | ) | const [pure virtual, inherited] |
Implemented in Botan::SIV_Mode, Botan::OCB_Mode, Botan::CCM_Mode, Botan::Stream_Cipher_Mode, Botan::ChaCha20Poly1305_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::CBC_Mode, Botan::CFB_Mode, Botan::ECB_Mode, Botan::XTS_Mode, and Botan::Compressor_Transform.
Referenced by botan_cipher_start(), and botan_cipher_update().
bool Botan::Keyed_Transform::valid_keylength | ( | size_t | length | ) | const [inline, inherited] |
Check whether a given key length is valid for this algorithm.
length | the key length to be checked. |
Definition at line 142 of file transform.h.
References Botan::Key_Length_Specification::valid_keylength().
{ return key_spec().valid_keylength(length); }
virtual bool Botan::Transform::valid_nonce_length | ( | size_t | nonce_len | ) | const [pure virtual, inherited] |
Return true iff nonce_len is a valid length for the nonce
Implemented in Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::SIV_Mode, Botan::OCB_Mode, Botan::Stream_Cipher_Mode, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::CFB_Mode, Botan::GCM_Mode, Botan::EAX_Mode, Botan::XTS_Mode, Botan::CBC_Mode, Botan::ECB_Mode, and Botan::Compressor_Transform.
Referenced by botan_cipher_valid_nonce_length().