Botan 3.5.0
Crypto and TLS for C&
Botan::Cipher_Mode_Filter Class Referencefinal

#include <filters.h>

Inheritance diagram for Botan::Cipher_Mode_Filter:
Botan::Keyed_Filter Botan::Buffered_Filter Botan::Filter

Public Member Functions

virtual bool attachable ()
 
 Cipher_Mode_Filter (Cipher_Mode *t)
 
 Cipher_Mode_Filter (std::unique_ptr< Cipher_Mode > t)
 
Key_Length_Specification key_spec () const override
 
std::string name () const override
 
void set_iv (const InitializationVector &iv) override
 
void set_key (const SymmetricKey &key) override
 
bool valid_iv_length (size_t length) const override
 
bool valid_keylength (size_t length) const
 

Protected Member Functions

template<typename Alloc >
void send (const std::vector< uint8_t, Alloc > &in)
 
template<typename Alloc >
void send (const std::vector< uint8_t, Alloc > &in, size_t length)
 
virtual void send (const uint8_t in[], size_t length)
 
void send (uint8_t in)
 

Private Member Functions

template<typename Alloc >
void write (const std::vector< uint8_t, Alloc > &in, size_t length)
 

Detailed Description

Filter interface for cipher modes

Definition at line 158 of file filters.h.

Constructor & Destructor Documentation

◆ Cipher_Mode_Filter() [1/2]

Botan::Cipher_Mode_Filter::Cipher_Mode_Filter ( Cipher_Mode * t)
explicit

Definition at line 28 of file cipher_filter.cpp.

28 :
29 Buffered_Filter(choose_update_size(mode->ideal_granularity()), mode->minimum_final_size()),
30 m_mode(mode),
31 m_nonce(mode->default_nonce_length()),
32 m_buffer(m_mode->ideal_granularity()) {}
Buffered_Filter(size_t block_size, size_t final_minimum)
Definition buf_filt.cpp:18

◆ Cipher_Mode_Filter() [2/2]

Botan::Cipher_Mode_Filter::Cipher_Mode_Filter ( std::unique_ptr< Cipher_Mode > t)
inlineexplicit

Definition at line 163 of file filters.h.

163: Cipher_Mode_Filter(t.release()) {}
Cipher_Mode_Filter(Cipher_Mode *t)

Member Function Documentation

◆ attachable()

virtual bool Botan::Filter::attachable ( )
inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns
true if this filter is attachable, false otherwise

Reimplemented in Botan::DataSink, and Botan::SecureQueue.

Definition at line 53 of file filter.h.

53{ return true; }

◆ key_spec()

Key_Length_Specification Botan::Cipher_Mode_Filter::key_spec ( ) const
overridevirtual
Returns
object describing limits on key size

Implements Botan::Keyed_Filter.

Definition at line 46 of file cipher_filter.cpp.

46 {
47 return m_mode->key_spec();
48}

◆ name()

std::string Botan::Cipher_Mode_Filter::name ( ) const
overridevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 34 of file cipher_filter.cpp.

34 {
35 return m_mode->name();
36}

◆ send() [1/4]

template<typename Alloc >
void Botan::Filter::send ( const std::vector< uint8_t, Alloc > & in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 76 of file filter.h.

76 {
77 send(in.data(), in.size());
78 }
virtual void send(const uint8_t in[], size_t length)
Definition filter.cpp:27

◆ send() [2/4]

template<typename Alloc >
void Botan::Filter::send ( const std::vector< uint8_t, Alloc > & in,
size_t length )
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 85 of file filter.h.

85 {
86 BOTAN_ASSERT_NOMSG(length <= in.size());
87 send(in.data(), length);
88 }
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:59

References BOTAN_ASSERT_NOMSG.

◆ send() [3/4]

void Botan::Filter::send ( const uint8_t in[],
size_t length )
protectedvirtualinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 27 of file filter.cpp.

27 {
28 if(!length) {
29 return;
30 }
31
32 bool nothing_attached = true;
33 for(size_t j = 0; j != total_ports(); ++j) {
34 if(m_next[j]) {
35 if(!m_write_queue.empty()) {
36 m_next[j]->write(m_write_queue.data(), m_write_queue.size());
37 }
38 m_next[j]->write(input, length);
39 nothing_attached = false;
40 }
41 }
42
43 if(nothing_attached) {
44 m_write_queue += std::make_pair(input, length);
45 } else {
46 m_write_queue.clear();
47 }
48}

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Decoder::write(), and Botan::Hex_Decoder::write().

◆ send() [4/4]

void Botan::Filter::send ( uint8_t in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 70 of file filter.h.

70{ send(&in, 1); }

References Botan::Filter::send().

Referenced by Botan::Filter::send().

◆ set_iv()

void Botan::Cipher_Mode_Filter::set_iv ( const InitializationVector & iv)
overridevirtual

Set the initialization vector of this filter. Note: you should call set_iv() only after you have called set_key()

Parameters
ivthe initialization vector to use

Reimplemented from Botan::Keyed_Filter.

Definition at line 38 of file cipher_filter.cpp.

38 {
39 m_nonce = unlock(iv.bits_of());
40}
std::vector< T > unlock(const secure_vector< T > &in)
Definition secmem.h:75

References Botan::OctetString::bits_of(), and Botan::unlock().

◆ set_key()

void Botan::Cipher_Mode_Filter::set_key ( const SymmetricKey & key)
overridevirtual

Set the key of this filter

Parameters
keythe key to use

Implements Botan::Keyed_Filter.

Definition at line 42 of file cipher_filter.cpp.

42 {
43 m_mode->set_key(key);
44}

◆ valid_iv_length()

bool Botan::Cipher_Mode_Filter::valid_iv_length ( size_t length) const
overridevirtual

Check whether an IV length is valid for this filter

Parameters
lengththe IV length to be checked for validity
Returns
true if the IV length is valid, false otherwise

Reimplemented from Botan::Keyed_Filter.

Definition at line 50 of file cipher_filter.cpp.

50 {
51 return m_mode->valid_nonce_length(length);
52}

◆ valid_keylength()

bool Botan::Keyed_Filter::valid_keylength ( size_t length) const
inlineinherited

Check whether a key length is valid for this filter

Parameters
lengththe key length to be checked for validity
Returns
true if the key length is valid, false otherwise

Definition at line 140 of file filters.h.

140{ return key_spec().valid_keylength(length); }
bool valid_keylength(size_t length) const
Definition sym_algo.h:42
virtual Key_Length_Specification key_spec() const =0

The documentation for this class was generated from the following files: