Botan::Keyed_Filter Class Reference

#include <key_filt.h>

Inheritance diagram for Botan::Keyed_Filter:

Public Member Functions
virtual bool	attachable ()
virtual void	end_msg ()
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
virtual bool	valid_keylength (size_t length) const =0
virtual void	write (const byte input[], size_t length)=0

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

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 20 of file key_filt.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 50 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::Base64_Decoder, Botan::Base64_Encoder, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 44 of file filter.h.

{}

name()

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

pure virtualinherited

Returns

descriptive name for this filter

Implemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::Chain, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::DataSink_Stream, Botan::EAX_Base, Botan::ECB_Decryption, Botan::ECB_Encryption, Botan::Fork, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::SecureQueue, Botan::StreamCipher_Filter, Botan::XTS_Decryption, Botan::XTS_Encryption, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Referenced by Botan::Keyed_Filter::set_iv().

send() [1/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

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

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(&write_queue[0], write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::Hash_Filter::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::MAC_Filter::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::PK_Encryptor_Filter::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Bzip_Compression::flush(), Botan::Zlib_Compression::flush(), send(), Botan::Base64_Decoder::write(), Botan::Bzip_Compression::write(), Botan::Bzip_Decompression::write(), Botan::Chain::write(), Botan::Fork::write(), Botan::Hex_Decoder::write(), Botan::StreamCipher_Filter::write(), Botan::Zlib_Compression::write(), and Botan::Zlib_Decompression::write().

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

{ send(&in[0], in.size()); }

References send(), and Botan::MemoryRegion< T >::size().

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

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

Definition at line 74 of file filter.h.

         {
         send(&in[0], length);
         }

References send().

set_iv()

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

virtual

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::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::EAX_Base, Botan::StreamCipher_Filter, Botan::XTS_Decryption, and Botan::XTS_Encryption.

Definition at line 13 of file basefilt.cpp.

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

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

Referenced by Botan::algorithm_kat(), Botan::get_cipher(), and set_key().

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::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::EAX_Base, Botan::ECB_Decryption, Botan::ECB_Encryption, Botan::MAC_Filter, Botan::StreamCipher_Filter, Botan::XTS_Decryption, and Botan::XTS_Encryption.

References set_iv().

Referenced by Botan::algorithm_kat(), and 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.

Reimplemented in Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 38 of file filter.h.

{}

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::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::EAX_Base, Botan::StreamCipher_Filter, Botan::XTS_Decryption, and Botan::XTS_Encryption.

Definition at line 48 of file key_filt.h.

         { return (length == 0); }

Referenced by Botan::algorithm_kat().

valid_keylength()

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

pure virtual

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

Implemented in Botan::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::EAX_Base, Botan::ECB_Decryption, Botan::ECB_Encryption, Botan::MAC_Filter, Botan::StreamCipher_Filter, Botan::XTS_Decryption, and Botan::XTS_Encryption.

write()

virtual void Botan::Filter::write ( const byte 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::Base64_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Chain, Botan::DataSink_Stream, Botan::Fork, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::SecureQueue, Botan::StreamCipher_Filter, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

---

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

• src/filters/key_filt.h
• src/filters/basefilt.cpp