Botan::Keyed_Filter Class Reference

#include <filters.h>

Inheritance diagram for Botan::Keyed_Filter:

Public Member Functions
virtual bool	attachable ()
virtual void	end_msg ()
virtual Key_Length_Specification	key_spec () const =0
virtual std::string	name () const =0
virtual void	set_iv (const InitializationVector &iv)
virtual void	set_key (const SymmetricKey &key)=0
virtual void	start_msg ()
virtual bool	valid_iv_length (size_t length) const
bool	valid_keylength (size_t length) const
virtual void	write (const uint8_t input[], size_t length)=0

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)

Detailed Description

This class represents keyed filters, i.e. filters that have to be fed with a key in order to function.

Definition at line 116 of file filters.h.

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; }

end_msg()

virtual void Botan::Filter::end_msg ( )

inlinevirtualinherited

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented in Botan::DataSink_Stream, Botan::Base64_Encoder, Botan::Base64_Decoder, Botan::Hex_Encoder, and Botan::Hex_Decoder.

Definition at line 46 of file filter.h.

                             { /* default empty */
      }

key_spec()

virtual Key_Length_Specification Botan::Keyed_Filter::key_spec ( ) const

pure virtual

Returns

object describing limits on key size

Implemented in Botan::Cipher_Mode_Filter.

name()

virtual std::string Botan::Filter::name ( ) const

pure virtualinherited

Returns

descriptive name for this filter

Implemented in Botan::DataSink_Stream, Botan::Cipher_Mode_Filter, Botan::Base64_Encoder, Botan::Base64_Decoder, Botan::Hex_Encoder, Botan::Hex_Decoder, Botan::BitBucket, Botan::Chain, Botan::Fork, and Botan::SecureQueue.

send() [1/4]

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 76 of file filter.h.

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

send() [2/4]

template<typename Alloc >

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

inlineprotectedinherited

Parameters

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

Definition at line 85 of file filter.h.

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

References BOTAN_ASSERT_NOMSG.

send() [3/4]

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

protectedvirtualinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 27 of file filter.cpp.

                                                      {
   if(!length) {
      return;
   }
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j) {
      if(m_next[j]) {
         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_Encoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::write(), and Botan::Hex_Decoder::write().

send() [4/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 70 of file filter.h.

{ send(&in, 1); }

References Botan::Filter::send().

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

set_iv()

virtual void Botan::Keyed_Filter::set_iv ( const InitializationVector & iv )

inlinevirtual

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

Parameters

iv	the initialization vector to use

Reimplemented in Botan::Cipher_Mode_Filter.

Definition at line 129 of file filters.h.

                                                          {
         if(iv.length() != 0) {
            throw Invalid_IV_Length(name(), iv.length());
         }
      }

References Botan::OctetString::length(), and name.

Referenced by Botan::get_cipher().

set_key()

virtual void Botan::Keyed_Filter::set_key ( const SymmetricKey & key )

pure virtual

Set the key of this filter

Parameters

key	the key to use

Implemented in Botan::Cipher_Mode_Filter.

Referenced by Botan::get_cipher().

start_msg()

virtual void Botan::Filter::start_msg ( )

inlinevirtualinherited

Start a new message. Must be closed by end_msg() before another message can be started.

Definition at line 39 of file filter.h.

                               { /* default empty */
      }

valid_iv_length()

virtual bool Botan::Keyed_Filter::valid_iv_length ( size_t length ) const

inlinevirtual

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, false otherwise

Reimplemented in Botan::Cipher_Mode_Filter.

Definition at line 152 of file filters.h.

{ return (length == 0); }

valid_keylength()

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

inline

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 140 of file filters.h.

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

write()

virtual void Botan::Filter::write ( const uint8_t input[], size_t length )

pure virtualinherited

Write a portion of a message to this filter.

Parameters

input	the input as a byte array
length	the length of the byte array input

Implemented in Botan::Hex_Encoder, Botan::Base64_Encoder, Botan::Base64_Decoder, Botan::Chain, Botan::Fork, Botan::DataSink_Stream, Botan::Hex_Decoder, Botan::BitBucket, and Botan::SecureQueue.

Referenced by Botan::Pipe::write().

---

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

• src/lib/filters/filters.h