#include <key_filt.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 byte input[], size_t length)=0
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

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

Definition at line 21 of file key_filt.h.

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.

{}

virtual Key_Length_Specification Botan::Keyed_Filter::key_spec ( ) const [pure virtual]

Returns:: object describing limits on key size

Implemented in Botan::MAC_Filter, Botan::StreamCipher_Filter, and Botan::Transform_Filter.

virtual std::string Botan::Filter::name ( ) const [pure virtual, inherited]

Returns:: descriptive name for this filter

Implemented in Botan::MAC_Filter, Botan::Hash_Filter, Botan::Threaded_Fork, Botan::Fork, Botan::Hex_Decoder, Botan::Base64_Decoder, Botan::Chain, Botan::StreamCipher_Filter, Botan::DataSink_Stream, Botan::Transform_Filter, Botan::Compression_Decompression_Filter, Botan::Hex_Encoder, Botan::BitBucket, Botan::SecureQueue, and Botan::Base64_Encoder.

Referenced by set_iv().

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(), Botan::StreamCipher_Filter::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::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::StreamCipher_Filter, and Botan::Transform_Filter.

Definition at line 13 of file basefilt.cpp.

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

Referenced by Botan::get_cipher().

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

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::MAC_Filter, Botan::StreamCipher_Filter, and Botan::Transform_Filter.

Referenced by Botan::get_cipher().

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.

{}

virtual bool Botan::Keyed_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 in Botan::StreamCipher_Filter, and Botan::Transform_Filter.

Definition at line 57 of file key_filt.h.

         { return (length == 0); }

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

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

virtual void Botan::Filter::write	(	const byte	input[],
		size_t	length
	)		`[pure virtual, inherited]`

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::MAC_Filter, Botan::Hash_Filter, Botan::Base64_Decoder, Botan::Hex_Decoder, Botan::Fork, Botan::StreamCipher_Filter, Botan::DataSink_Stream, Botan::Chain, Botan::Hex_Encoder, Botan::Base64_Encoder, Botan::Compression_Decompression_Filter, Botan::SecureQueue, and Botan::BitBucket.

Referenced by Botan::Filter::send(), and Botan::Pipe::write().

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation