Botan
1.11.15
|
#include <siv.h>
Public Types | |
typedef SCAN_Name | Spec |
Public Member Functions | |
bool | authenticated () const override |
void | clear () override |
size_t | default_nonce_length () const override |
virtual void | finish (secure_vector< byte > &final_block, size_t offset=0)=0 |
Key_Length_Specification | key_spec () const override |
virtual size_t | minimum_final_size () const =0 |
std::string | name () const override |
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) |
void | set_associated_data (const byte ad[], size_t ad_len) override |
void | set_associated_data_n (size_t n, const byte ad[], size_t ad_len) |
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 () |
template<typename Alloc > | |
secure_vector< byte > | start_vec (const std::vector< byte, Alloc > &nonce) |
size_t | tag_size () const override |
void | update (secure_vector< byte > &blocks, size_t offset=0) override |
size_t | update_granularity () const override |
bool | valid_keylength (size_t length) const |
bool | valid_nonce_length (size_t) const override |
Protected Member Functions | |
StreamCipher & | ctr () |
secure_vector< byte > & | msg_buf () |
secure_vector< byte > | S2V (const byte text[], size_t text_len) |
void | set_ctr_iv (secure_vector< byte > V) |
SIV_Mode (BlockCipher *cipher) |
Base class for SIV encryption and decryption (
typedef SCAN_Name Botan::Transform::Spec [inherited] |
Definition at line 27 of file transform.h.
Botan::SIV_Mode::SIV_Mode | ( | BlockCipher * | cipher | ) | [protected] |
bool Botan::AEAD_Mode::authenticated | ( | ) | const [inline, override, virtual, inherited] |
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; }
void Botan::SIV_Mode::clear | ( | ) | [override, virtual] |
Implements Botan::Transform.
Definition at line 25 of file siv.cpp.
{ m_ctr.reset(); m_nonce.clear(); m_msg_buf.clear(); m_ad_macs.clear(); }
StreamCipher& Botan::SIV_Mode::ctr | ( | ) | [inline, protected] |
Definition at line 48 of file siv.h.
Referenced by Botan::SIV_Encryption::finish(), Botan::SIV_Decryption::finish(), and set_ctr_iv().
{ return *m_ctr; }
size_t Botan::AEAD_Mode::default_nonce_length | ( | ) | const [inline, override, virtual, inherited] |
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().
Key_Length_Specification Botan::SIV_Mode::key_spec | ( | ) | const [override, virtual] |
Implements Botan::Keyed_Transform.
Definition at line 54 of file siv.cpp.
{
return m_cmac->key_spec().multiple(2);
}
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().
secure_vector<byte>& Botan::SIV_Mode::msg_buf | ( | ) | [inline, protected] |
Definition at line 52 of file siv.h.
Referenced by Botan::SIV_Encryption::finish(), and Botan::SIV_Decryption::finish().
{ return m_msg_buf; }
std::string Botan::SIV_Mode::name | ( | ) | const [override, virtual] |
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"; }
secure_vector< byte > Botan::SIV_Mode::S2V | ( | const byte | text[], |
size_t | text_len | ||
) | [protected] |
Definition at line 100 of file siv.cpp.
References Botan::CMAC::poly_double(), and Botan::xor_buf().
Referenced by Botan::SIV_Encryption::finish(), and Botan::SIV_Decryption::finish().
{ const byte zero[16] = { 0 }; secure_vector<byte> V = m_cmac->process(zero, 16); for(size_t i = 0; i != m_ad_macs.size(); ++i) { V = CMAC::poly_double(V); V ^= m_ad_macs[i]; } if(m_nonce.size()) { V = CMAC::poly_double(V); V ^= m_nonce; } if(text_len < 16) { V = CMAC::poly_double(V); xor_buf(&V[0], text, text_len); V[text_len] ^= 0x80; return m_cmac->process(V); } m_cmac->update(text, text_len - 16); xor_buf(&V[0], &text[text_len - 16], 16); m_cmac->update(V); return m_cmac->final(); }
void Botan::AEAD_Mode::set_ad | ( | const std::vector< byte, Alloc > & | ad | ) | [inline, inherited] |
Definition at line 48 of file aead.h.
{ set_associated_data(&ad[0], ad.size()); }
void Botan::SIV_Mode::set_associated_data | ( | const byte | ad[], |
size_t | ad_len | ||
) | [inline, override, 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 |
Implements Botan::AEAD_Mode.
Definition at line 28 of file siv.h.
{ set_associated_data_n(0, ad, ad_len); }
void Botan::SIV_Mode::set_associated_data_n | ( | size_t | n, |
const byte | ad[], | ||
size_t | ad_len | ||
) |
void Botan::AEAD_Mode::set_associated_data_vec | ( | const std::vector< byte, Alloc > & | ad | ) | [inline, inherited] |
Definition at line 42 of file aead.h.
{ set_associated_data(&ad[0], ad.size()); }
void Botan::SIV_Mode::set_ctr_iv | ( | secure_vector< byte > | V | ) | [protected] |
Definition at line 133 of file siv.cpp.
References ctr(), and Botan::StreamCipher::set_iv().
Referenced by Botan::SIV_Encryption::finish(), and Botan::SIV_Decryption::finish().
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); }
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()); }
size_t Botan::SIV_Mode::tag_size | ( | ) | const [inline, override, virtual] |
Return the size of the authentication tag used (in bytes)
Reimplemented from Botan::Cipher_Mode.
Definition at line 43 of file siv.h.
Referenced by Botan::SIV_Decryption::finish().
{ return 16; }
void Botan::SIV_Mode::update | ( | secure_vector< byte > & | blocks, |
size_t | offset = 0 |
||
) | [override, virtual] |
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 |
Implements Botan::Transform.
Definition at line 90 of file siv.cpp.
References BOTAN_ASSERT.
{ BOTAN_ASSERT(buffer.size() >= offset, "Offset is sane"); const size_t sz = buffer.size() - offset; byte* buf = &buffer[offset]; m_msg_buf.insert(m_msg_buf.end(), buf, buf + sz); buffer.resize(offset); // truncate msg }
size_t Botan::SIV_Mode::update_granularity | ( | ) | const [override, virtual] |
Implements Botan::Transform.
Definition at line 43 of file siv.cpp.
{ /* This value does not particularly matter as regardless SIV_Mode::update buffers all input, so in theory this could be 1. However as for instance Transform_Filter creates update_granularity() byte buffers, use a somewhat large size to avoid bouncing on a tiny buffer. */ return 128; }
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); }
bool Botan::SIV_Mode::valid_nonce_length | ( | size_t | nonce_len | ) | const [override, virtual] |
Return true iff nonce_len is a valid length for the nonce
Implements Botan::Transform.
Definition at line 38 of file siv.cpp.
{ return true; }