Botan  2.6.0
Crypto and TLS for C++11
Public Member Functions | Protected Member Functions | List of all members
Botan::Base64_Decoder Class Referencefinal

#include <b64_filt.h>

Inheritance diagram for Botan::Base64_Decoder:
Botan::Filter

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)
 
void send (const secure_vector< uint8_t > &in)
 
void send (const std::vector< uint8_t > &in)
 
void send (const secure_vector< uint8_t > &in, size_t length)
 
void send (const std::vector< uint8_t > &in, size_t length)
 

Detailed Description

This object represents a Base64 decoder.

Definition at line 57 of file b64_filt.h.

Constructor & Destructor Documentation

◆ Base64_Decoder()

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

Create a base64 decoder.

Parameters
checkingthe type of checking that shall be performed by the decoder

Definition at line 115 of file b64_filt.cpp.

115  :
116  m_checking(c), m_in(64), m_out(48), m_position(0)
117  {
118  }

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

Definition at line 52 of file filter.h.

52 { return true; }

◆ end_msg()

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

163  {
164  size_t consumed = 0;
165  size_t written = base64_decode(m_out.data(),
166  cast_uint8_ptr_to_char(m_in.data()),
167  m_position,
168  consumed,
169  true,
170  m_checking != FULL_CHECK);
171 
172  send(m_out, written);
173 
174  const bool not_full_bytes = consumed != m_position;
175 
176  m_position = 0;
177 
178  if(not_full_bytes)
179  throw Invalid_Argument("Base64_Decoder: Input not full bytes");
180  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27
size_t base64_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition: base64.cpp:100
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition: mem_ops.h:136

◆ name()

std::string Botan::Base64_Decoder::name ( ) const
inlineoverridevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 60 of file b64_filt.h.

60 { return "Base64_Decoder"; }

◆ send() [1/6]

void Botan::Filter::send ( const uint8_t  in[],
size_t  length 
)
protectedvirtualinherited
Parameters
insome input for the filter
lengththe length of in

Definition at line 27 of file filter.cpp.

References Botan::Filter::write().

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

28  {
29  if(!length)
30  return;
31 
32  bool nothing_attached = true;
33  for(size_t j = 0; j != total_ports(); ++j)
34  if(m_next[j])
35  {
36  if(m_write_queue.size())
37  m_next[j]->write(m_write_queue.data(), m_write_queue.size());
38  m_next[j]->write(input, length);
39  nothing_attached = false;
40  }
41 
42  if(nothing_attached)
43  m_write_queue += std::make_pair(input, length);
44  else
45  m_write_queue.clear();
46  }
virtual void write(const uint8_t input[], size_t length)=0

◆ send() [2/6]

void Botan::Filter::send ( uint8_t  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

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

65 { send(&in, 1); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [3/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

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

70 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [4/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

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

75 { send(in.data(), in.size()); }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [5/6]

void Botan::Filter::send ( const secure_vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

82  {
83  send(in.data(), length);
84  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

◆ send() [6/6]

void Botan::Filter::send ( const std::vector< uint8_t > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

91  {
92  send(in.data(), length);
93  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27

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

40 { /* default empty */ }

◆ write()

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

Input a part of a message to the decoder.

Parameters
inputthe message to input as a byte array
lengththe 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().

124  {
125  while(length)
126  {
127  size_t to_copy = std::min<size_t>(length, m_in.size() - m_position);
128  if(to_copy == 0)
129  {
130  m_in.resize(m_in.size()*2);
131  m_out.resize(m_out.size()*2);
132  }
133  copy_mem(&m_in[m_position], input, to_copy);
134  m_position += to_copy;
135 
136  size_t consumed = 0;
137  size_t written = base64_decode(m_out.data(),
138  cast_uint8_ptr_to_char(m_in.data()),
139  m_position,
140  consumed,
141  false,
142  m_checking != FULL_CHECK);
143 
144  send(m_out, written);
145 
146  if(consumed != m_position)
147  {
148  copy_mem(m_in.data(), m_in.data() + consumed, m_position - consumed);
149  m_position = m_position - consumed;
150  }
151  else
152  m_position = 0;
153 
154  length -= to_copy;
155  input += to_copy;
156  }
157  }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27
size_t base64_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition: base64.cpp:100
void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:108
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition: mem_ops.h:136

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