Botan::Cipher_Mode_Filter Class Reference

#include <filters.h>

Inheritance diagram for Botan::Cipher_Mode_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
virtual void	send (const uint8_t in[], size_t length)
void	send (std::span< const uint8_t > in)
void	send (std::span< 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 166 of file filters.h.

Constructor & Destructor Documentation

Cipher_Mode_Filter() [1/2]

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

explicit

Construct a filter wrapping the given cipher mode

Parameters

t	the cipher mode to use

Definition at line 28 of file cipher_filter.cpp.

                                                        :
      Buffered_Filter(choose_update_size(mode->ideal_granularity()), mode->minimum_final_size()),
      m_mode(mode),
      m_buffer(m_mode->ideal_granularity()) {}

References Botan::Buffered_Filter::Buffered_Filter().

Referenced by Cipher_Mode_Filter().

Cipher_Mode_Filter() [2/2]

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

inlineexplicit

Construct a filter wrapping the given cipher mode

Parameters

t	the cipher mode to use

Definition at line 179 of file filters.h.

: Cipher_Mode_Filter(t.release()) {}

References Cipher_Mode_Filter().

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.

{ return true; }

key_spec()

Key_Length_Specification Botan::Cipher_Mode_Filter::key_spec ( ) const

overridevirtual

Return the key lengths supported by this filter

Returns

the key length specification

Implements Botan::Keyed_Filter.

Definition at line 45 of file cipher_filter.cpp.

                                                            {
   return m_mode->key_spec();
}

name()

std::string Botan::Cipher_Mode_Filter::name ( ) const

overridevirtual

Return a descriptive name for this filter

Returns

the name of the underlying cipher mode

Implements Botan::Filter.

Definition at line 33 of file cipher_filter.cpp.

                                         {
   return m_mode->name();
}

send() [1/4]

void Botan::Filter::send ( const uint8_t in[], size_t length )

protectedvirtualinherited

Send some bytes to the next filter in the chain

Parameters

in	some input for the filter
length	the length of in

Definition at line 30 of file filter.cpp.

                                                      {
   if(length == 0) {
      return;
   }
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j) {
      if(m_next[j] != nullptr) {
         if(!m_write_queue.empty()) {
            m_next[j]->write(m_write_queue.data(), m_write_queue.size());
         }
         m_next[j]->write(input, length);
         nothing_attached = false;
      }
   }
 
   if(nothing_attached) {
      m_write_queue += std::make_pair(input, length);
   } else {
      m_write_queue.clear();
   }
}

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), operator=(), send(), Botan::Base64_Decoder::write(), Botan::Chain::write(), Botan::Fork::write(), and Botan::Hex_Decoder::write().

send() [2/4]

void Botan::Filter::send ( std::span< const uint8_t > in )

inlineprotectedinherited

Send some bytes to the next filter in the chain

Parameters

in	some input for the filter

Definition at line 83 of file filter.h.

{ send(in.data(), in.size()); }

References send().

Referenced by send().

send() [3/4]

void Botan::Filter::send ( std::span< const uint8_t > in, size_t length )

protectedinherited

Send some bytes to the next filter in the chain

Parameters

in	some input for the filter
length	the number of bytes of in to send

This previously took a std::vector, for which the length field (allowing using just a prefix of the vector) somewhat made sense. It makes less sense now that we are using a span here; you can just use first to get a prefix.

Definition at line 22 of file filter.cpp.

                                                          {
   BOTAN_ASSERT_NOMSG(length <= in.size());
   send(in.data(), length);
}

References BOTAN_ASSERT_NOMSG, and send().

send() [4/4]

void Botan::Filter::send ( uint8_t in )

inlineprotectedinherited

Send some bytes to the next filter in the chain

Parameters

in	some input for the filter

Definition at line 76 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

set_iv()

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

overridevirtual

Set the initialization vector for this filter

Parameters

iv	the initialization vector to set

Reimplemented from Botan::Keyed_Filter.

Definition at line 37 of file cipher_filter.cpp.

                                                              {
   m_nonce = unlock(iv.bits_of());
}

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

key	the key to set

Implements Botan::Keyed_Filter.

Definition at line 41 of file cipher_filter.cpp.

                                                        {
   m_mode->set_key(key);
}

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

length

the IV length to be checked for validity

Returns

true if the IV length is valid

Reimplemented from Botan::Keyed_Filter.

Definition at line 49 of file cipher_filter.cpp.

                                                            {
   return m_mode->valid_nonce_length(length);
}

valid_keylength()

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

inlineinherited

Check whether a key length is valid for this filter

Parameters

length

the key length to be checked for validity

Returns

true if the key length is valid, false otherwise

Definition at line 148 of file filters.h.

{ return key_spec().valid_keylength(length); }

References key_spec().

---

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

• src/lib/filters/filters.h
• src/lib/filters/cipher_filter.cpp