Botan::SecureQueue Class Reference

#include <secqueue.h>

Inheritance diagram for Botan::SecureQueue:

List of all members.

Public Member Functions
bool	attachable ()
u32bit	discard_next (u32bit N)
virtual void	end_msg ()
bool	end_of_data () const
virtual std::string	id () const
std::string	name () const
SecureQueue &	operator= (const SecureQueue &)
u32bit	peek (byte[], u32bit, u32bit=0) const
u32bit	peek_byte (byte &out) const
u32bit	read (byte[], u32bit)
u32bit	read_byte (byte &out)
	SecureQueue (const SecureQueue &)
	SecureQueue ()
u32bit	size () const
virtual void	start_msg ()
void	write (const byte[], u32bit)
	~SecureQueue ()
Protected Member Functions
void	attach (Filter *f)
void	incr_owns ()
void	send (const MemoryRegion< byte > &in)
void	send (byte in)
void	send (const byte in[], u32bit length)
void	set_next (Filter *f[], u32bit n)
void	set_port (u32bit n)

---

Detailed Description

A queue that knows how to zeroize itself

Definition at line 19 of file secqueue.h.

---

Constructor & Destructor Documentation

Botan::SecureQueue::SecureQueue

(

)

Definition at line 58 of file secqueue.cpp.

References Botan::Fanout_Filter::set_next().

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

Botan::SecureQueue::SecureQueue

(

const SecureQueue &

input

)

Definition at line 67 of file secqueue.cpp.

References head, Botan::Fanout_Filter::set_next(), and write().

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

Botan::SecureQueue::~SecureQueue

(

)

[inline]

Definition at line 36 of file secqueue.h.

{ destroy(); }

---

Member Function Documentation

void Botan::Fanout_Filter::attach

(

Filter *

f

)

[inline, protected, inherited]

Attach another filter to this one

Parameters:

f

filter to attach

Reimplemented from Botan::Filter.

Definition at line 136 of file filter.h.

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

{ Filter::attach(f); }

bool Botan::SecureQueue::attachable

(

)

[inline, virtual]

Check whether this filter is an attachable filter.

Returns:

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 31 of file secqueue.h.

{ return false; }

u32bit Botan::DataSource::discard_next

(

u32bit

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

References Botan::DataSource::read_byte().

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

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::Base64_Encoder, Botan::Base64_Decoder, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Hash_Filter, Botan::MAC_Filter, Botan::Hex_Encoder, Botan::Hex_Decoder, Botan::PK_Encryptor_Filter, Botan::PK_Decryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::Zlib_Compression, Botan::Zlib_Decompression, Botan::PBE_PKCS5v15, and Botan::PBE_PKCS5v20.

Definition at line 44 of file filter.h.

{}

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

References size().

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

virtual std::string Botan::DataSource::id

(

)

const [inline, virtual, inherited]

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

void Botan::Fanout_Filter::incr_owns

(

)

[inline, protected, inherited]

Increment the number of filters past us that we own

Definition at line 130 of file filter.h.

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

{ ++filter_owns; }

std::string Botan::SecureQueue::name

(

)

const [inline, virtual]

Returns:

descriptive name for this filter

Implements Botan::Filter.

Definition at line 22 of file secqueue.h.

{ return "Queue"; }

SecureQueue & Botan::SecureQueue::operator=

(

const SecureQueue &

input

)

Definition at line 99 of file secqueue.cpp.

References head, and write().

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

u32bit Botan::SecureQueue::peek	(	byte	out[],
		u32bit	length,
		u32bit	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 157 of file secqueue.cpp.

References n.

Referenced by Botan::Record_Reader::get_record(), and Botan::Output_Buffers::peek().

   {
   SecureQueueNode* current = head;

   while(offset && current)
      {
      if(offset >= current->size())
         {
         offset -= current->size();
         current = current->next;
         }
      else
         break;
      }

   u32bit got = 0;
   while(length && current)
      {
      const u32bit n = current->peek(output, length, offset);
      offset = 0;
      output += n;
      got += n;
      length -= n;
      current = current->next;
      }
   return got;
   }

u32bit 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 28 of file data_src.cpp.

References Botan::DataSource::peek().

Referenced by Botan::ASN1::maybe_BER().

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

u32bit Botan::SecureQueue::read	(	byte	out[],
		u32bit	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 135 of file secqueue.cpp.

References n.

Referenced by Botan::Record_Reader::get_record(), Botan::TLS_Server::read(), Botan::TLS_Client::read(), and Botan::Output_Buffers::read().

   {
   u32bit got = 0;
   while(length && head)
      {
      const u32bit 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;
   }

u32bit 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 20 of file data_src.cpp.

References Botan::DataSource::read().

Referenced by Botan::PEM_Code::decode(), Botan::DataSource::discard_next(), Botan::BER_Decoder::discard_remaining(), Botan::PGP_decode(), and Botan::BER_Decoder::raw_bytes().

   {
   return read(&out, 1);
   }

void Botan::Filter::send

(

const MemoryRegion< byte > &

in

)

[inline, protected, inherited]

Parameters:

in

some input for the filter

Definition at line 68 of file filter.h.

References Botan::MemoryRegion< T >::begin(), Botan::Filter::send(), and Botan::MemoryRegion< T >::size().

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

{ send(in.begin(), in.size()); }

void Botan::Filter::send

(

byte

in

)

[inline, protected, inherited]

Parameters:

in

some input for the filter

Definition at line 63 of file filter.h.

References Botan::Filter::send().

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

{ send(&in, 1); }

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

Parameters:

	in	some input for the filter
	length	the length of in

Definition at line 28 of file filter.cpp.

References Botan::MemoryRegion< T >::append(), Botan::MemoryRegion< T >::destroy(), Botan::MemoryRegion< T >::size(), and Botan::Filter::write().

Referenced by Botan::Zlib_Decompression::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::PK_Encryptor_Filter::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Hash_Filter::end_msg(), Botan::Zlib_Compression::flush(), Botan::Bzip_Compression::flush(), Botan::Zlib_Decompression::write(), Botan::Zlib_Compression::write(), Botan::Bzip_Decompression::write(), Botan::Bzip_Compression::write(), and Botan::StreamCipher_Filter::write().

   {
   bool nothing_attached = true;
   for(u32bit j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(write_queue, write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }

   if(nothing_attached)
      write_queue.append(input, length);
   else
      write_queue.destroy();
   }

void Botan::Fanout_Filter::set_next	(	Filter *	filters[],
		u32bit	count
	)			[inline, protected, inherited]

Parameters:

	filters	the filters to set
	count	number of items in filters

Reimplemented from Botan::Filter.

Definition at line 134 of file filter.h.

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

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

void Botan::Fanout_Filter::set_port

(

u32bit

new_port

)

[inline, protected, inherited]

Set the active port

Parameters:

new_port

the new value

Reimplemented from Botan::Filter.

Reimplemented in Botan::Fork.

Definition at line 132 of file filter.h.

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

{ Filter::set_port(n); }

u32bit Botan::SecureQueue::size

(

)

const

Definition at line 188 of file secqueue.cpp.

Referenced by end_of_data(), Botan::Record_Reader::get_record(), Botan::TLS_Server::read(), Botan::TLS_Client::read(), and Botan::Output_Buffers::remaining().

   {
   SecureQueueNode* current = head;
   u32bit count = 0;

   while(current)
      {
      count += current->size();
      current = current->next;
      }
   return count;
   }

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::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::Zlib_Compression, Botan::Zlib_Decompression, Botan::PBE_PKCS5v15, and Botan::PBE_PKCS5v20.

Definition at line 38 of file filter.h.

{}

void Botan::SecureQueue::write	(	const	input[],
		u32bit	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 115 of file secqueue.cpp.

References n.

Referenced by Botan::Record_Reader::add_input(), operator=(), and SecureQueue().

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

---

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

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