Botan::Base64_Decoder Class Reference

#include <filters.h>

Inheritance diagram for Botan::Base64_Decoder:

Public Member Functions
virtual bool	attachable ()
	Base64_Decoder (Decoder_Checking checking=NONE)
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
virtual void	send (const uint8_t in[], size_t length)
void	send (uint8_t in)
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)

Detailed Description

This object represents a Base64 decoder.

Definition at line 544 of file filters.h.

Constructor & Destructor Documentation

Botan::Base64_Decoder::Base64_Decoder ( Decoder_Checking  checking = NONE )

explicit

Create a base64 decoder.

Parameters

checking

the type of checking that shall be performed by the decoder

Definition at line 115 of file b64_filt.cpp.

                                                 :
   m_checking(c), m_in(64), m_out(48), m_position(0)
   {
   }

Member Function Documentation

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::SecureQueue, and Botan::DataSink.

Definition at line 52 of file filter.h.

{ return true; }

void Botan::Base64_Decoder::end_msg ( )

overridevirtual

Finish up the current message

Reimplemented from Botan::Filter.

Definition at line 162 of file b64_filt.cpp.

References Botan::base64_decode(), Botan::cast_uint8_ptr_to_char(), Botan::FULL_CHECK, and Botan::Filter::send().

   {
   size_t consumed = 0;
   size_t written = base64_decode(m_out.data(),
                                  cast_uint8_ptr_to_char(m_in.data()),
                                  m_position,
                                  consumed,
                                  true,
                                  m_checking != FULL_CHECK);

   send(m_out, written);

   const bool not_full_bytes = consumed != m_position;

   m_position = 0;

   if(not_full_bytes)
      throw Invalid_Argument("Base64_Decoder: Input not full bytes");
   }

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 547 of file filters.h.

{ return "Base64_Decoder"; }

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.

References Botan::Filter::write().

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

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

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

inlineprotectedinherited

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

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

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.

References BOTAN_ASSERT_NOMSG.

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

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 */ }

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

overridevirtual

Input a part of a message to the decoder.

Parameters

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

Implements Botan::Filter.

Definition at line 123 of file b64_filt.cpp.

References Botan::base64_decode(), Botan::cast_uint8_ptr_to_char(), Botan::copy_mem(), Botan::FULL_CHECK, and Botan::Filter::send().

   {
   while(length)
      {
      size_t to_copy = std::min<size_t>(length, m_in.size() - m_position);
      if(to_copy == 0)
         {
         m_in.resize(m_in.size()*2);
         m_out.resize(m_out.size()*2);
         }
      copy_mem(&m_in[m_position], input, to_copy);
      m_position += to_copy;

      size_t consumed = 0;
      size_t written = base64_decode(m_out.data(),
                                     cast_uint8_ptr_to_char(m_in.data()),
                                     m_position,
                                     consumed,
                                     false,
                                     m_checking != FULL_CHECK);

      send(m_out, written);

      if(consumed != m_position)
         {
         copy_mem(m_in.data(), m_in.data() + consumed, m_position - consumed);
         m_position = m_position - consumed;
         }
      else
         m_position = 0;

      length -= to_copy;
      input += to_copy;
      }
   }

---

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

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