#include <filters.h>

Inheritance diagram for Botan::StreamCipher_Filter:

Public Member Functions
virtual bool	attachable ()
virtual void	end_msg ()
Key_Length_Specification	key_spec () const override
std::string	name () const
void	set_iv (const InitializationVector &iv)
void	set_key (const SymmetricKey &key)
virtual void	start_msg ()
	StreamCipher_Filter (StreamCipher *cipher)
	StreamCipher_Filter (StreamCipher *cipher, const SymmetricKey &key)
	StreamCipher_Filter (const std::string &cipher)
	StreamCipher_Filter (const std::string &cipher, 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)
Protected Member Functions
virtual void	send (const byte in[], size_t length)
void	send (byte in)
void	send (const secure_vector< byte > &in)
void	send (const std::vector< byte > &in)
void	send (const secure_vector< byte > &in, size_t length)
void	send (const std::vector< byte > &in, size_t length)

Detailed Description

Stream Cipher Filter

Definition at line 33 of file filters.h.

Constructor & Destructor Documentation

Botan::StreamCipher_Filter::StreamCipher_Filter ( StreamCipher * cipher )

Construct a stream cipher filter.

Parameters:

cipher a cipher object to use

Definition at line 17 of file algo_filt.cpp.

                                                             :
   buffer(DEFAULT_BUFFERSIZE), m_cipher(cipher)
   {
   }

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

Construct a stream cipher filter.

Parameters:

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

Definition at line 25 of file algo_filt.cpp.

                                                                  :
   buffer(DEFAULT_BUFFERSIZE),
   m_cipher(cipher)
   {
   m_cipher->set_key(key);
   }

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 36 of file algo_filt.cpp.

                                                                 :
   buffer(DEFAULT_BUFFERSIZE)
   {
   m_cipher.reset(Algo_Registry<StreamCipher>::global_registry().make(sc_name));
   }

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 45 of file algo_filt.cpp.

                                                                  :
   buffer(DEFAULT_BUFFERSIZE)
   {
   m_cipher.reset(Algo_Registry<StreamCipher>::global_registry().make(sc_name));
   m_cipher->set_key(key);
   }

Member Function Documentation

virtual bool Botan::Filter::attachable ( ) [inline, virtual, inherited]

Check whether this filter is an attachable filter.

Returns:: true if this filter is attachable, false otherwise

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

Definition at line 52 of file filter.h.

{ return true; }

virtual void Botan::Filter::end_msg ( ) [inline, virtual, inherited]

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

Reimplemented in Botan::MAC_Filter, Botan::Hash_Filter, Botan::Base64_Decoder, Botan::Hex_Decoder, Botan::Base64_Encoder, Botan::Hex_Encoder, and Botan::Compression_Decompression_Filter.

Definition at line 46 of file filter.h.

{}

Key_Length_Specification Botan::StreamCipher_Filter::key_spec ( ) const [inline, override, virtual]

Returns:: object describing limits on key size

Implements Botan::Keyed_Filter.

Definition at line 61 of file filters.h.

{ return m_cipher->key_spec(); }

std::string Botan::StreamCipher_Filter::name ( ) const [inline, virtual]

Returns:: descriptive name for this filter

Implements Botan::Filter.

Definition at line 37 of file filters.h.

{ return m_cipher->name(); }

void Botan::Filter::send	(	const byte	in[],
		size_t	length
	)		`[protected, virtual, inherited]`

Parameters:

in	some input for the filter
length	the length of in

Reimplemented in Botan::Threaded_Fork.

Definition at line 28 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::Compression_Decompression_Filter::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hash_Filter::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Compression_Decompression_Filter::flush(), Botan::Compression_Decompression_Filter::start_msg(), Botan::Compression_Decompression_Filter::write(), write(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

   {
   if(!length)
      return;

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

void Botan::Filter::send ( byte in ) [inline, protected, inherited]

Parameters:

in	some input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

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

{ send(&in, 1); }

void Botan::Filter::send ( const secure_vector< byte > & in ) [inline, protected, inherited]

Parameters:

in	some input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

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

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

void Botan::Filter::send ( const std::vector< byte > & in ) [inline, protected, inherited]

Parameters:

in	some input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

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

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

void Botan::Filter::send	(	const secure_vector< byte > &	in,
		size_t	length
	)		`[inline, protected, inherited]`

Parameters:

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

Definition at line 81 of file filter.h.

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

void Botan::Filter::send	(	const std::vector< byte > &	in,
		size_t	length
	)		`[inline, protected, inherited]`

Parameters:

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

Definition at line 90 of file filter.h.

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

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 56 of file algo_filt.cpp.

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

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

void Botan::StreamCipher_Filter::set_key ( const SymmetricKey & key ) [inline, virtual]

Set the key of this filter.

Parameters:

key	the key to set

Implements Botan::Keyed_Filter.

Definition at line 59 of file filters.h.

{ m_cipher->set_key(key); }

virtual void Botan::Filter::start_msg ( ) [inline, virtual, inherited]

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

Reimplemented in Botan::Compression_Decompression_Filter.

Definition at line 40 of file filter.h.

{}

bool Botan::StreamCipher_Filter::valid_iv_length ( size_t length ) const [inline, virtual]

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 m_cipher->valid_iv_length(iv_len); }

bool Botan::Keyed_Filter::valid_keylength ( size_t length ) const [inline, inherited]

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 42 of file key_filt.h.

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

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 64 of file algo_filt.cpp.

References Botan::Filter::send().

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

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

src/lib/filters/filters.h
src/lib/filters/algo_filt.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation