#include <filters.h>

Inheritance diagram for Botan::Hash_Filter:

Public Member Functions
virtual bool	attachable ()
void	end_msg ()
	Hash_Filter (HashFunction *hash, size_t len=0)
	Hash_Filter (const std::string &request, size_t len=0)
std::string	name () const
virtual void	start_msg ()
void	write (const byte input[], size_t 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

Hash Filter.

Definition at line 96 of file filters.h.

Constructor & Destructor Documentation

Botan::Hash_Filter::Hash_Filter	(	HashFunction *	hash,
		size_t	len = `0`
	)		`[inline]`

Construct a hash filter.

Parameters:

hash_fun	the hash function to use
len	the output length of this filter. Leave the default value 0 if you want to use the full output of the hashfunction hash. Otherwise, specify a smaller value here so that the output of the hash algorithm will be cut off.

Definition at line 112 of file filters.h.

                                                      :
         OUTPUT_LENGTH(len), m_hash(hash) {}

Botan::Hash_Filter::Hash_Filter	(	const std::string &	request,
		size_t	len = `0`
	)

Construct a hash filter.

Parameters:

request	the name of the hash algorithm to use
len	the output length of this filter. Leave the default value 0 if you want to use the full output of the hashfunction hash. Otherwise, specify a smaller value here so that the output of the hash algorithm will be cut off.

Definition at line 79 of file algo_filt.cpp.

                                     :
   OUTPUT_LENGTH(len)
   {
   m_hash.reset(Algo_Registry<HashFunction>::global_registry().make(algo_spec));
   }

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

void Botan::Hash_Filter::end_msg ( ) [virtual]

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

Reimplemented from Botan::Filter.

Definition at line 89 of file algo_filt.cpp.

References Botan::Filter::send().

   {
   secure_vector<byte> output = m_hash->final();
   if(OUTPUT_LENGTH)
      send(output, std::min<size_t>(OUTPUT_LENGTH, output.size()));
   else
      send(output);
   }

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

Returns:: descriptive name for this filter

Implements Botan::Filter.

Definition at line 102 of file filters.h.

References m_hash.

{ return m_hash->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(), 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);
         }

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.

{}

void Botan::Hash_Filter::write	(	const byte	input[],
		size_t	length
	)		`[inline, virtual]`

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

Implements Botan::Filter.

Definition at line 99 of file filters.h.

References m_hash.

{ m_hash->update(input, len); }

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