#include <transform_filter.h>

Inheritance diagram for Botan::Transform_Filter:

Classes
class	Nonce_State
Public Member Functions
virtual bool	attachable ()
Key_Length_Specification	key_spec () const override
std::string	name () const override
void	set_iv (const InitializationVector &iv) override
void	set_key (const SymmetricKey &key) override
	Transform_Filter (Transform *t)
bool	valid_iv_length (size_t length) const override
bool	valid_keylength (size_t length) const
Protected Member Functions
const Transform &	get_transform () const
Transform &	get_transform ()
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)
Private Member Functions
void	buffer_reset ()
size_t	buffered_block_size () const
size_t	current_position () const
template<typename Alloc >
void	write (const std::vector< byte, Alloc > &in, size_t length)

Detailed Description

Filter interface for Transforms

Definition at line 20 of file transform_filter.h.

Constructor & Destructor Documentation

Botan::Transform_Filter::Transform_Filter ( Transform * t )

Definition at line 27 of file transform_filter.cpp.

                                                       :
   Buffered_Filter(choose_update_size(transform->update_granularity()),
                   transform->minimum_final_size()),
   m_nonce(transform->default_nonce_length() == 0),
   m_transform(transform),
   m_buffer(m_transform->update_granularity())
   {
   }

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

const Transform& Botan::Transform_Filter::get_transform ( ) const [inline, protected]

Definition at line 37 of file transform_filter.h.

{ return *m_transform; }

Transform& Botan::Transform_Filter::get_transform ( ) [inline, protected]

Definition at line 39 of file transform_filter.h.

{ return *m_transform; }

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

Returns:: object describing limits on key size

Implements Botan::Keyed_Filter.

Definition at line 69 of file transform_filter.cpp.

   {
   if(Keyed_Transform* keyed = dynamic_cast<Keyed_Transform*>(m_transform.get()))
      return keyed->key_spec();
   return Key_Length_Specification(0);
   }

std::string Botan::Transform_Filter::name ( ) const [override, virtual]

Returns:: descriptive name for this filter

Implements Botan::Filter.

Definition at line 36 of file transform_filter.cpp.

Referenced by set_key().

   {
   return m_transform->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(), 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::Transform_Filter::set_iv ( const InitializationVector & iv ) [override, 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 from Botan::Keyed_Filter.

Definition at line 56 of file transform_filter.cpp.

   {
   m_nonce.update(iv);
   }

void Botan::Transform_Filter::set_key ( const SymmetricKey & key ) [override, virtual]

Set the key of this filter

Parameters:

key	the key to use

Implements Botan::Keyed_Filter.

Definition at line 61 of file transform_filter.cpp.

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

   {
   if(Keyed_Transform* keyed = dynamic_cast<Keyed_Transform*>(m_transform.get()))
      keyed->set_key(key);
   else if(key.length() != 0)
      throw std::runtime_error("Transform " + name() + " does not accept keys");
   }

bool Botan::Transform_Filter::valid_iv_length ( size_t length ) const [override, 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 76 of file transform_filter.cpp.

   {
   return m_transform->valid_nonce_length(length);
   }

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

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

src/lib/filters/transform_filter.h
src/lib/filters/transform_filter.cpp

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation