Botan::StreamCipher_Filter Class Reference

#include <filters.h>

Inheritance diagram for Botan::StreamCipher_Filter:

Public Member Functions
virtual bool	attachable ()
virtual void	end_msg ()
std::string	name () const
void	set_iv (const InitializationVector &iv)
void	set_key (const SymmetricKey &key)
virtual void	start_msg ()
	StreamCipher_Filter (const std::string &cipher)
	StreamCipher_Filter (const std::string &cipher, const SymmetricKey &key)
	StreamCipher_Filter (StreamCipher *cipher_obj)
	StreamCipher_Filter (StreamCipher *cipher_obj, const SymmetricKey &key)
bool	valid_iv_length (size_t iv_len) const
bool	valid_keylength (size_t length) const
void	write (const byte input[], size_t input_len)
	~StreamCipher_Filter ()

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

Stream Cipher Filter.

Definition at line 33 of file filters.h.

Constructor & Destructor Documentation

StreamCipher_Filter() [1/4]

Botan::StreamCipher_Filter::StreamCipher_Filter

(

StreamCipher *

cipher_obj

)

Construct a stream cipher filter.

Parameters

cipher_obj

a cipher object to use

Definition at line 17 of file algo_filt.cpp.

                                                                    :
   buffer(DEFAULT_BUFFERSIZE)
   {
   cipher = stream_cipher;
   }

Referenced by Botan::algorithm_kat(), Botan::aont_package(), Botan::aont_unpackage(), Botan::Core_Engine::get_cipher(), and Botan::get_cipher_mode().

StreamCipher_Filter() [2/4]

Botan::StreamCipher_Filter::StreamCipher_Filter	(	StreamCipher *	cipher_obj,
		const SymmetricKey &	key )

Construct a stream cipher filter.

Parameters

cipher_obj	a cipher object to use
key	the key to use inside this filter

Definition at line 26 of file algo_filt.cpp.

                                                                  :
   buffer(DEFAULT_BUFFERSIZE)
   {
   cipher = stream_cipher;
   cipher->set_key(key);
   }

References Botan::SymmetricAlgorithm::set_key().

StreamCipher_Filter() [3/4]

Botan::StreamCipher_Filter::StreamCipher_Filter

(

const std::string &

cipher

)

Construct a stream cipher filter.

Parameters

cipher

the name of the desired cipher

Definition at line 37 of file algo_filt.cpp.

                                                                 :
   buffer(DEFAULT_BUFFERSIZE)
   {
   Algorithm_Factory& af = global_state().algorithm_factory();
   cipher = af.make_stream_cipher(sc_name);
   }

References Botan::Library_State::algorithm_factory(), Botan::global_state(), and Botan::Algorithm_Factory::make_stream_cipher().

StreamCipher_Filter() [4/4]

Botan::StreamCipher_Filter::StreamCipher_Filter	(	const std::string &	cipher,
		const SymmetricKey &	key )

Construct a stream cipher filter.

Parameters

cipher	the name of the desired cipher
key	the key to use inside this filter

Definition at line 47 of file algo_filt.cpp.

                                                                  :
   buffer(DEFAULT_BUFFERSIZE)
   {
   Algorithm_Factory& af = global_state().algorithm_factory();
   cipher = af.make_stream_cipher(sc_name);
   cipher->set_key(key);
   }

References Botan::Library_State::algorithm_factory(), Botan::global_state(), Botan::Algorithm_Factory::make_stream_cipher(), and Botan::SymmetricAlgorithm::set_key().

~StreamCipher_Filter()

Botan::StreamCipher_Filter::~StreamCipher_Filter ( )

inline

Definition at line 95 of file filters.h.

{ delete cipher; }

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()

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

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 37 of file filters.h.

{ return cipher->name(); }

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::StreamCipher_Filter::set_iv ( const InitializationVector & iv )

virtual

Set the initialization vector for this filter.

Parameters

iv	the initialization vector to set

Reimplemented from Botan::Keyed_Filter.

Definition at line 59 of file algo_filt.cpp.

   {
   cipher->set_iv(iv.begin(), iv.length());
   }

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

set_key()

void Botan::StreamCipher_Filter::set_key ( const SymmetricKey & key )

inlinevirtual

Set the key of this filter.

Parameters

key	the key to set

Implements Botan::Keyed_Filter.

Definition at line 59 of file filters.h.

{ cipher->set_key(key); }

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()

bool Botan::StreamCipher_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 from Botan::Keyed_Filter.

Definition at line 46 of file filters.h.

         { return cipher->valid_iv_length(iv_len); }

valid_keylength()

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

inlinevirtual

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

Implements Botan::Keyed_Filter.

Definition at line 66 of file filters.h.

         { return cipher->valid_keylength(length); }

write()

void Botan::StreamCipher_Filter::write ( const byte input[], size_t input_len )

virtual

Write input data

Parameters

input	data
input_len	length of input in bytes

Implements Botan::Filter.

Definition at line 67 of file algo_filt.cpp.

   {
   while(length)
      {
      size_t copied = std::min<size_t>(length, buffer.size());
      cipher->cipher(input, &buffer[0], copied);
      send(buffer, copied);
      input += copied;
      length -= copied;
      }
   }

References Botan::Filter::send().

---

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

• src/filters/filters.h
• src/filters/algo_filt.cpp