Botan::SecureQueue Class Reference

#include <secqueue.h>

Inheritance diagram for Botan::SecureQueue:

Public Member Functions
bool	attachable ()
bool	check_available (size_t n)
size_t	discard_next (size_t N)
virtual void	end_msg ()
bool	end_of_data () const
virtual std::string	id () const
std::string	name () const
SecureQueue &	operator= (const SecureQueue &other)
size_t	peek (byte[], size_t, size_t=0) const
size_t	peek_byte (byte &out) const
size_t	read (byte[], size_t)
size_t	read_byte (byte &out)
	SecureQueue ()
	SecureQueue (const SecureQueue &other)
size_t	size () const
virtual void	start_msg ()
void	write (const byte[], size_t)
	~SecureQueue ()

Protected Member Functions
void	attach (Filter *f)
void	incr_owns ()
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)
void	set_next (Filter *f[], size_t n)
void	set_port (size_t n)

Detailed Description

A queue that knows how to zeroize itself

Definition at line 19 of file secqueue.h.

Constructor & Destructor Documentation

SecureQueue() [1/2]

Botan::SecureQueue::SecureQueue

(

)

SecureQueue default constructor (creates empty queue)

Definition at line 60 of file secqueue.cpp.

   {
   set_next(0, 0);
   head = tail = new SecureQueueNode;
   }

References Botan::Fanout_Filter::set_next().

Referenced by operator=(), and SecureQueue().

SecureQueue() [2/2]

Botan::SecureQueue::SecureQueue

(

const SecureQueue &

other

)

SecureQueue copy constructor

Parameters

other

the queue to copy

Definition at line 69 of file secqueue.cpp.

                                                 :
   Fanout_Filter(), DataSource()
   {
   set_next(0, 0);
 
   head = tail = new SecureQueueNode;
   SecureQueueNode* temp = input.head;
   while(temp)
      {
      write(&temp->buffer[temp->start], temp->end - temp->start);
      temp = temp->next;
      }
   }

References Botan::DataSource::DataSource(), SecureQueue(), Botan::Fanout_Filter::set_next(), and write().

~SecureQueue()

Botan::SecureQueue::~SecureQueue ( )

inline

Definition at line 57 of file secqueue.h.

{ destroy(); }

Member Function Documentation

attach()

void Botan::Fanout_Filter::attach ( Filter * f )

inlineprotectedinherited

Definition at line 146 of file filter.h.

{ Filter::attach(f); }

References Botan::Filter::Filter().

Referenced by Botan::Chain::Chain(), and Botan::Chain::Chain().

attachable()

bool Botan::SecureQueue::attachable ( )

inlinevirtual

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 36 of file secqueue.h.

{ return false; }

check_available()

bool Botan::SecureQueue::check_available ( size_t n )

inlinevirtual

Implements Botan::DataSource.

Definition at line 38 of file secqueue.h.

{ return n <= size(); }

References size().

discard_next()

size_t Botan::DataSource::discard_next ( size_t N )

inherited

Discard the next N bytes of the data

Parameters

N	the number of bytes to discard

Returns

number of bytes actually discarded

Definition at line 35 of file data_src.cpp.

   {
   size_t discarded = 0;
   byte dummy;
   for(size_t j = 0; j != n; ++j)
      discarded += read_byte(dummy);
   return discarded;
   }

References read_byte().

Referenced by check_available().

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.

{}

end_of_data()

bool Botan::SecureQueue::end_of_data ( ) const

virtual

Test whether the source still has data that can be read.

Returns

true if there is still data to read, false otherwise

Implements Botan::DataSource.

Definition at line 206 of file secqueue.cpp.

   {
   return (size() == 0);
   }

References size().

id()

virtual std::string Botan::DataSource::id ( ) const

inlinevirtualinherited

return the id of this data source

Returns

std::string representing the id of this data source

Reimplemented in Botan::DataSource_Command, and Botan::DataSource_Stream.

Definition at line 57 of file data_src.h.

{ return ""; }

incr_owns()

void Botan::Fanout_Filter::incr_owns ( )

inlineprotectedinherited

Increment the number of filters past us that we own

Definition at line 140 of file filter.h.

{ ++filter_owns; }

Referenced by Botan::Chain::Chain(), and Botan::Chain::Chain().

name()

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

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 22 of file secqueue.h.

{ return "Queue"; }

operator=()

SecureQueue & Botan::SecureQueue::operator=

(

const SecureQueue &

other

)

SecureQueue assignment

Parameters

other

the queue to copy

Definition at line 101 of file secqueue.cpp.

   {
   destroy();
   head = tail = new SecureQueueNode;
   SecureQueueNode* temp = input.head;
   while(temp)
      {
      write(&temp->buffer[temp->start], temp->end - temp->start);
      temp = temp->next;
      }
   return (*this);
   }

References SecureQueue(), and write().

peek()

size_t Botan::SecureQueue::peek ( byte out[], size_t length, size_t peek_offset = 0 ) const

virtual

Read from the source but do not modify the internal offset. Consecutive calls to peek() will return portions of the source starting at the same position.

Parameters

out	the byte array to write the output to
length	the length of the byte array out
peek_offset	the offset into the stream to read at

Returns

length in bytes that was actually read and put into out

Implements Botan::DataSource.

Definition at line 159 of file secqueue.cpp.

   {
   SecureQueueNode* current = head;
 
   while(offset && current)
      {
      if(offset >= current->size())
         {
         offset -= current->size();
         current = current->next;
         }
      else
         break;
      }
 
   size_t got = 0;
   while(length && current)
      {
      const size_t n = current->peek(output, length, offset);
      offset = 0;
      output += n;
      got += n;
      length -= n;
      current = current->next;
      }
   return got;
   }

Referenced by Botan::Output_Buffers::peek().

peek_byte()

size_t Botan::DataSource::peek_byte ( byte & out ) const

inherited

Peek at one byte.

Parameters

out	an output byte

Returns

length in bytes that was actually read and put into out

Definition at line 27 of file data_src.cpp.

   {
   return peek(&out, 1, 0);
   }

References peek().

Referenced by check_available(), and Botan::ASN1::maybe_BER().

read()

size_t Botan::SecureQueue::read ( byte out[], size_t length )

virtual

Read from the source. Moves the internal offset so that every call to read will return a new portion of the source.

Parameters

out	the byte array to write the result to
length	the length of the byte array out

Returns

length in bytes that was actually read and put into out

Implements Botan::DataSource.

Definition at line 137 of file secqueue.cpp.

   {
   size_t got = 0;
   while(length && head)
      {
      const size_t n = head->read(output, length);
      output += n;
      got += n;
      length -= n;
      if(head->size() == 0)
         {
         SecureQueueNode* holder = head->next;
         delete head;
         head = holder;
         }
      }
   return got;
   }

Referenced by Botan::Output_Buffers::read().

read_byte()

size_t Botan::DataSource::read_byte ( byte & out )

inherited

Read one byte.

Parameters

out	the byte to read to

Returns

length in bytes that was actually read and put into out

Definition at line 19 of file data_src.cpp.

   {
   return read(&out, 1);
   }

References read().

Referenced by check_available(), Botan::PEM_Code::decode(), discard_next(), and Botan::PGP_decode().

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

void Botan::Fanout_Filter::set_next ( Filter * f[], size_t n )

inlineprotectedinherited

Definition at line 144 of file filter.h.

{ Filter::set_next(f, n); }

References Botan::Filter::Filter().

Referenced by Botan::Fork::Fork(), Botan::Fork::Fork(), Botan::SecureQueue::SecureQueue(), and Botan::SecureQueue::SecureQueue().

set_port()

void Botan::Fanout_Filter::set_port ( size_t n )

inlineprotectedinherited

Definition at line 142 of file filter.h.

{ Filter::set_port(n); }

Referenced by Botan::Fork::set_port().

size()

size_t Botan::SecureQueue::size

(

)

const

Returns

number of bytes available in the queue

Definition at line 190 of file secqueue.cpp.

   {
   SecureQueueNode* current = head;
   size_t count = 0;
 
   while(current)
      {
      count += current->size();
      current = current->next;
      }
   return count;
   }

Referenced by check_available(), end_of_data(), and Botan::Output_Buffers::remaining().

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.

{}

write()

void Botan::SecureQueue::write ( const byte input[], size_t length )

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 117 of file secqueue.cpp.

   {
   if(!head)
      head = tail = new SecureQueueNode;
   while(length)
      {
      const size_t n = tail->write(input, length);
      input += n;
      length -= n;
      if(length)
         {
         tail->next = new SecureQueueNode;
         tail = tail->next;
         }
      }
   }

Referenced by operator=(), and SecureQueue().

---

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

• src/filters/secqueue.h
• src/filters/secqueue.cpp