Botan 3.9.0
Crypto and TLS for C&
Botan::Base64_Decoder Class Referencefinal

#include <filters.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 (std::span< const uint8_t > in)
void send (std::span< const uint8_t > in, size_t length)
void send (uint8_t in)

Detailed Description

This object represents a Base64 decoder.

Definition at line 523 of file filters.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 105 of file b64_filt.cpp.

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

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 54 of file filter.h.

54{ return true; }

◆ end_msg()

void Botan::Base64_Decoder::end_msg ( )
overridevirtual

Finish up the current message

Reimplemented from Botan::Filter.

Definition at line 141 of file b64_filt.cpp.

141 {
142 size_t consumed = 0;
143 size_t written = base64_decode(
144 m_out.data(), cast_uint8_ptr_to_char(m_in.data()), m_position, consumed, true, m_checking != FULL_CHECK);
145
146 send(m_out, written);
147
148 const bool not_full_bytes = consumed != m_position;
149
150 m_position = 0;
151
152 if(not_full_bytes) {
153 throw Invalid_Argument("Base64_Decoder: Input not full bytes");
154 }
155}
virtual void send(const uint8_t in[], size_t length)
Definition filter.cpp:30
@ FULL_CHECK
Definition filter.h:167
size_t base64_decode(uint8_t out[], const char in[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition base64.cpp:168
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition mem_ops.h:282

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

◆ name()

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

Implements Botan::Filter.

Definition at line 525 of file filters.h.

525{ return "Base64_Decoder"; }

◆ send() [1/4]

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 30 of file filter.cpp.

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

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), operator=(), send(), Botan::Base64_Decoder::write(), Botan::Chain::write(), Botan::Fork::write(), and Botan::Hex_Decoder::write().

◆ send() [2/4]

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

Definition at line 78 of file filter.h.

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

References send().

Referenced by send().

◆ send() [3/4]

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

This previously took a std::vector, for which the length field (allowing using just a prefix of the vector) somewhat made sense. It makes less sense now that we are using a span here; you can just use first to get a prefix.

Definition at line 22 of file filter.cpp.

22 {
23 BOTAN_ASSERT_NOMSG(length <= in.size());
24 send(in.data(), length);
25}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:75

References BOTAN_ASSERT_NOMSG, and send().

◆ send() [4/4]

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

Definition at line 73 of file filter.h.

73{ send(&in, 1); }

References send().

Referenced by 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.

40 { /* default empty */
41 }

◆ 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 110 of file b64_filt.cpp.

110 {
111 while(length > 0) {
112 size_t to_copy = std::min<size_t>(length, m_in.size() - m_position);
113 if(to_copy == 0) {
114 m_in.resize(m_in.size() * 2);
115 m_out.resize(m_out.size() * 2);
116 }
117 copy_mem(&m_in[m_position], input, to_copy);
118 m_position += to_copy;
119
120 size_t consumed = 0;
121 size_t written = base64_decode(
122 m_out.data(), cast_uint8_ptr_to_char(m_in.data()), m_position, consumed, false, m_checking != FULL_CHECK);
123
124 send(m_out, written);
125
126 if(consumed != m_position) {
127 copy_mem(m_in.data(), m_in.data() + consumed, m_position - consumed);
128 m_position = m_position - consumed;
129 } else {
130 m_position = 0;
131 }
132
133 length -= to_copy;
134 input += to_copy;
135 }
136}
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:145

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


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