Botan::Base64_Encoder Class Reference

#include <filters.h>

Inheritance diagram for Botan::Base64_Encoder:

Public Member Functions
virtual bool	attachable ()
	Base64_Encoder (bool breaks=false, size_t length=72, bool t_n=false)
void	end_msg () override
std::string	name () const override
virtual void	start_msg ()
void	write (const uint8_t input[], size_t length) override

Protected Member Functions
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)

Detailed Description

This class represents a Base64 encoder.

Definition at line 505 of file filters.h.

Constructor & Destructor Documentation

Base64_Encoder()

Botan::Base64_Encoder::Base64_Encoder	(	bool	breaks = false,
		size_t	length = 72,
		bool	t_n = false
	)

Create a base64 encoder.

Parameters

breaks	whether to use line breaks in the output
length	the length of the lines of the output
t_n	whether to use a trailing newline

Definition at line 18 of file b64_filt.cpp.

                                                                   :
   m_line_length(breaks ? length : 0),
   m_trailing_newline(t_n && breaks),
   m_in(48),
   m_out(64),
   m_position(0),
   m_out_position(0)
   {
   }

Member Function Documentation

attachable()

virtual bool Botan::Filter::attachable ( )

inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns

true if this filter is attachable, false otherwise

Reimplemented in Botan::DataSink, and Botan::SecureQueue.

Definition at line 52 of file filter.h.

{ return true; }

end_msg()

void Botan::Base64_Encoder::end_msg ( )

overridevirtual

Inform the Encoder that the current message shall be closed.

Reimplemented from Botan::Filter.

Definition at line 102 of file b64_filt.cpp.

   {
   encode_and_send(m_in.data(), m_position, true);
 
   if(m_trailing_newline || (m_out_position && m_line_length))
      send('\n');
 
   m_out_position = m_position = 0;
   }

References Botan::Filter::send().

name()

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 508 of file filters.h.

{ return "Base64_Encoder"; }

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.size())
            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 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().

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::Base64_Encoder::write ( const uint8_t  input[], size_t  length  )

overridevirtual

Input a part of a message to the encoder.

Parameters

input	the message to input as a byte array
length	the length of the byte array input

Implements Botan::Filter.

Definition at line 79 of file b64_filt.cpp.

   {
   buffer_insert(m_in, m_position, input, length);
   if(m_position + length >= m_in.size())
      {
      encode_and_send(m_in.data(), m_in.size());
      input += (m_in.size() - m_position);
      length -= (m_in.size() - m_position);
      while(length >= m_in.size())
         {
         encode_and_send(input, m_in.size());
         input += m_in.size();
         length -= m_in.size();
         }
      copy_mem(m_in.data(), input, length);
      m_position = 0;
      }
   m_position += length;
   }

References Botan::buffer_insert(), and Botan::copy_mem().

---

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

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