Botan::SecureQueue Class Reference

#include <secqueue.h>

Inheritance diagram for Botan::SecureQueue:

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

Protected Member Functions
void	attach (Filter *f)
void	incr_owns ()
template<typename Alloc >
void	send (const std::vector< uint8_t, Alloc > &in)
template<typename Alloc >
void	send (const std::vector< uint8_t, Alloc > &in, size_t length)
virtual void	send (const uint8_t in[], size_t length)
void	send (uint8_t in)
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 20 of file secqueue.h.

Constructor & Destructor Documentation

SecureQueue() [1/3]

Botan::SecureQueue::SecureQueue ( SecureQueue &&  other )

delete

SecureQueue() [2/3]

Botan::SecureQueue::SecureQueue

(

)

SecureQueue default constructor (creates empty queue)

Definition at line 66 of file secqueue.cpp.

   {
   m_bytes_read = 0;
   set_next(nullptr, 0);
   m_head = m_tail = new SecureQueueNode;
   }

References Botan::Fanout_Filter::set_next().

SecureQueue() [3/3]

Botan::SecureQueue::SecureQueue

(

const SecureQueue &

other

)

SecureQueue copy constructor

Parameters

other

the queue to copy

Definition at line 76 of file secqueue.cpp.

                                                 :
   Fanout_Filter(), DataSource()
   {
   m_bytes_read = 0;
   set_next(nullptr, 0);
 
   m_head = m_tail = new SecureQueueNode;
   SecureQueueNode* temp = input.m_head;
   while(temp)
      {
      write(&temp->m_buffer[temp->m_start], temp->m_end - temp->m_start);
      temp = temp->m_next;
      }
   }

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

~SecureQueue()

Botan::SecureQueue::~SecureQueue ( )

inline

Definition at line 64 of file secqueue.h.

{ destroy(); }

Member Function Documentation

attach()

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

inlineprotectedinherited

Definition at line 157 of file filter.h.

{ Filter::attach(f); }

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

attachable()

bool Botan::SecureQueue::attachable ( )

inlineoverridevirtual

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented from Botan::Filter.

Definition at line 42 of file secqueue.h.

{ return false; }

check_available()

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

inlineoverridevirtual

Implements Botan::DataSource.

Definition at line 35 of file secqueue.h.

{ return n <= 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 39 of file data_src.cpp.

   {
   uint8_t buf[64] = { 0 };
   size_t discarded = 0;
 
   while(n)
      {
      const size_t got = this->read(buf, std::min(n, sizeof(buf)));
      discarded += got;
      n -= got;
 
      if(got == 0)
         break;
      }
 
   return discarded;
   }

References Botan::DataSource::read().

empty()

bool Botan::SecureQueue::empty

(

)

const

Definition at line 232 of file secqueue.cpp.

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

References size().

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::DataSink_Stream, Botan::Base64_Encoder, Botan::Base64_Decoder, Botan::Hex_Encoder, and Botan::Hex_Decoder.

Definition at line 46 of file filter.h.

{ /* default empty */ }

end_of_data()

bool Botan::SecureQueue::end_of_data ( ) const

overridevirtual

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

Returns

true if there is no more data to read, false otherwise

Implements Botan::DataSource.

Definition at line 227 of file secqueue.cpp.

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

References size().

get_bytes_read()

size_t Botan::SecureQueue::get_bytes_read ( ) const

overridevirtual

Return how many bytes have been read so far.

Implements Botan::DataSource.

Definition at line 203 of file secqueue.cpp.

   {
   return m_bytes_read;
   }

Referenced by Botan::Output_Buffers::get_bytes_read(), and operator=().

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_Stream.

Definition at line 59 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 151 of file filter.h.

{ ++m_filter_owns; }

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

name()

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 23 of file secqueue.h.

{ return "Queue"; }

operator=() [1/2]

SecureQueue & Botan::SecureQueue::operator=

(

const SecureQueue &

other

)

SecureQueue assignment

Parameters

other

the queue to copy

Definition at line 109 of file secqueue.cpp.

   {
   if(this == &input)
      return *this;
 
   destroy();
   m_bytes_read = input.get_bytes_read();
   m_head = m_tail = new SecureQueueNode;
   SecureQueueNode* temp = input.m_head;
   while(temp)
      {
      write(&temp->m_buffer[temp->m_start], temp->m_end - temp->m_start);
      temp = temp->m_next;
      }
   return (*this);
   }

References get_bytes_read(), and write().

operator=() [2/2]

SecureQueue & Botan::SecureQueue::operator= ( SecureQueue &&  other )

delete

peek()

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

overridevirtual

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

   {
   SecureQueueNode* current = m_head;
 
   while(offset && current)
      {
      if(offset >= current->size())
         {
         offset -= current->size();
         current = current->m_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->m_next;
      }
   return got;
   }

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

peek_byte()

size_t Botan::DataSource::peek_byte ( uint8_t &  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 31 of file data_src.cpp.

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

References Botan::DataSource::peek().

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

read()

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

overridevirtual

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

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

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

read_byte()

size_t Botan::DataSource::read_byte ( uint8_t &  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 23 of file data_src.cpp.

   {
   return read(&out, 1);
   }

References Botan::DataSource::read().

Referenced by Botan::PEM_Code::decode(), Botan::BER_Decoder::discard_remaining(), and Botan::ASN1::maybe_BER().

send() [1/4]

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 71 of file filter.h.

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

send() [2/4]

template<typename Alloc >

void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  in, size_t  length  )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 81 of file filter.h.

         {
         BOTAN_ASSERT_NOMSG(length <= in.size());
         send(in.data(), length);
         }

References BOTAN_ASSERT_NOMSG.

send() [3/4]

void Botan::Filter::send ( const uint8_t  in[], size_t  length  )

protectedvirtualinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 27 of file filter.cpp.

   {
   if(!length)
      return;
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(m_next[j])
         {
         if(!m_write_queue.empty())
            m_next[j]->write(m_write_queue.data(), m_write_queue.size());
         m_next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      m_write_queue += std::make_pair(input, length);
   else
      m_write_queue.clear();
   }

References Botan::Filter::write().

Referenced by Botan::Base64_Encoder::end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Base64_Decoder::write(), and Botan::Hex_Decoder::write().

send() [4/4]

void Botan::Filter::send ( uint8_t  in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 65 of file filter.h.

{ send(&in, 1); }

References Botan::Filter::send().

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

set_next()

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

inlineprotectedinherited

Definition at line 155 of file filter.h.

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

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

set_port()

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

inlineprotectedinherited

Definition at line 153 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 211 of file secqueue.cpp.

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

Referenced by empty(), 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.

Definition at line 40 of file filter.h.

{ /* default empty */ }

write()

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

overridevirtual

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

   {
   if(!m_head)
      m_head = m_tail = new SecureQueueNode;
   while(length)
      {
      const size_t n = m_tail->write(input, length);
      input += n;
      length -= n;
      if(length)
         {
         m_tail->m_next = new SecureQueueNode;
         m_tail = m_tail->m_next;
         }
      }
   }

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

---

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

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