Botan
1.11.15
|
#include <stream_mode.h>
Public Types | |
typedef SCAN_Name | Spec |
Public Member Functions | |
virtual bool | authenticated () const |
void | clear () override |
size_t | default_nonce_length () const override |
void | finish (secure_vector< byte > &buf, size_t offset) 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 |
virtual std::string | provider () const |
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) |
Stream_Cipher_Mode (StreamCipher *cipher) | |
virtual size_t | tag_size () const |
void | update (secure_vector< byte > &buf, size_t offset) override |
size_t | update_granularity () const override |
bool | valid_keylength (size_t length) const |
bool | valid_nonce_length (size_t nonce_len) const override |
Definition at line 15 of file stream_mode.h.
typedef SCAN_Name Botan::Transform::Spec [inherited] |
Definition at line 27 of file transform.h.
Botan::Stream_Cipher_Mode::Stream_Cipher_Mode | ( | StreamCipher * | cipher | ) | [inline] |
Definition at line 18 of file stream_mode.h.
: m_cipher(cipher) {}
virtual bool Botan::Cipher_Mode::authenticated | ( | ) | const [inline, virtual, inherited] |
Returns true iff this mode provides authentication as well as confidentiality.
Reimplemented in Botan::AEAD_Mode.
Definition at line 26 of file cipher_mode.h.
{ return false; }
void Botan::Stream_Cipher_Mode::clear | ( | ) | [inline, override, virtual] |
Implements Botan::Transform.
Definition at line 44 of file stream_mode.h.
{ return m_cipher->clear(); }
size_t Botan::Stream_Cipher_Mode::default_nonce_length | ( | ) | const [inline, override, virtual] |
Return the default size for a nonce
Implements Botan::Transform.
Definition at line 35 of file stream_mode.h.
{ return 0; }
void Botan::Stream_Cipher_Mode::finish | ( | secure_vector< byte > & | final_block, |
size_t | offset | ||
) | [inline, override, virtual] |
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::Transform.
Definition at line 26 of file stream_mode.h.
{ return update(buf, offset); }
Key_Length_Specification Botan::Stream_Cipher_Mode::key_spec | ( | ) | const [inline, override, virtual] |
Implements Botan::Keyed_Transform.
Definition at line 40 of file stream_mode.h.
{ return m_cipher->key_spec(); }
size_t Botan::Stream_Cipher_Mode::minimum_final_size | ( | ) | const [inline, override, virtual] |
Implements Botan::Transform.
Definition at line 33 of file stream_mode.h.
{ return 0; }
std::string Botan::Stream_Cipher_Mode::name | ( | ) | const [inline, override, virtual] |
Implements Botan::Transform.
Definition at line 42 of file stream_mode.h.
{ return m_cipher->name(); }
size_t Botan::Stream_Cipher_Mode::output_length | ( | size_t | input_length | ) | const [inline, override, virtual] |
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::Transform.
Definition at line 29 of file stream_mode.h.
{ return input_length; }
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::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()); }
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; }
void Botan::Stream_Cipher_Mode::update | ( | secure_vector< byte > & | blocks, |
size_t | offset | ||
) | [inline, 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 20 of file stream_mode.h.
{
if(offset < buf.size())
m_cipher->cipher1(&buf[offset], buf.size() - offset);
}
size_t Botan::Stream_Cipher_Mode::update_granularity | ( | ) | const [inline, override, virtual] |
Implements Botan::Transform.
Definition at line 31 of file stream_mode.h.
{ return 64; /* arbitrary */ }
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::Stream_Cipher_Mode::valid_nonce_length | ( | size_t | nonce_len | ) | const [inline, override, virtual] |
Return true iff nonce_len is a valid length for the nonce
Implements Botan::Transform.
Definition at line 37 of file stream_mode.h.
{ return m_cipher->valid_iv_length(nonce_len); }