Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Member Functions | Protected Member Functions | List of all members
Botan::Hex_Decoder Class Referencefinal

#include <filters.h>

Inheritance diagram for Botan::Hex_Decoder:
Botan::Filter

Public Member Functions

virtual bool attachable ()
 
void end_msg () override
 
 Hex_Decoder (Decoder_Checking checking=NONE)
 
std::string name () const override
 
virtual void start_msg ()
 
void write (const uint8_t[], size_t) 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

Converts hex strings to bytes

Definition at line 613 of file filters.h.

Constructor & Destructor Documentation

◆ Hex_Decoder()

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

Construct a Hex Decoder using the specified character checking.

Parameters
checkingthe checking to use during decoding.

Definition at line 108 of file hex_filt.cpp.

108 : m_checking(c)
109 {
110 m_in.resize(HEX_CODEC_BUFFER_SIZE);
111 m_out.resize(m_in.size() / 2);
112 m_position = 0;
113 }
const size_t HEX_CODEC_BUFFER_SIZE
Definition: hex_filt.cpp:18

References Botan::HEX_CODEC_BUFFER_SIZE.

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.

52{ return true; }

◆ end_msg()

void Botan::Hex_Decoder::end_msg ( )
overridevirtual

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented from Botan::Filter.

Definition at line 151 of file hex_filt.cpp.

152 {
153 size_t consumed = 0;
154 size_t written = hex_decode(m_out.data(),
155 cast_uint8_ptr_to_char(m_in.data()),
156 m_position,
157 consumed,
158 m_checking != FULL_CHECK);
159
160 send(m_out, written);
161
162 const bool not_full_bytes = consumed != m_position;
163
164 m_position = 0;
165
166 if(not_full_bytes)
167 throw Invalid_Argument("Hex_Decoder: Input not full bytes");
168 }
virtual void send(const uint8_t in[], size_t length)
Definition: filter.cpp:27
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition: hex.cpp:89
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition: mem_ops.h:188
@ FULL_CHECK
Definition: filter.h:166

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

◆ name()

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

Implements Botan::Filter.

Definition at line 616 of file filters.h.

616{ return "Hex_Decoder"; }

◆ send() [1/4]

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

Definition at line 71 of file filter.h.

72 {
73 send(in.data(), in.size());
74 }

◆ send() [2/4]

template<typename Alloc >
void Botan::Filter::send ( const std::vector< uint8_t, Alloc > &  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 BOTAN_ASSERT_NOMSG(length <= in.size());
84 send(in.data(), length);
85 }
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:67

References BOTAN_ASSERT_NOMSG.

◆ send() [3/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 27 of file filter.cpp.

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

References Botan::Filter::write().

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

◆ send() [4/4]

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

Definition at line 65 of file filter.h.

65{ 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.

40{ /* default empty */ }

◆ write()

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

Write a portion of a message to this filter.

Parameters
inputthe input as a byte array
lengththe length of the byte array input

Implements Botan::Filter.

Definition at line 118 of file hex_filt.cpp.

119 {
120 while(length)
121 {
122 size_t to_copy = std::min<size_t>(length, m_in.size() - m_position);
123 copy_mem(&m_in[m_position], input, to_copy);
124 m_position += to_copy;
125
126 size_t consumed = 0;
127 size_t written = hex_decode(m_out.data(),
128 cast_uint8_ptr_to_char(m_in.data()),
129 m_position,
130 consumed,
131 m_checking != FULL_CHECK);
132
133 send(m_out, written);
134
135 if(consumed != m_position)
136 {
137 copy_mem(m_in.data(), m_in.data() + consumed, m_position - consumed);
138 m_position = m_position - consumed;
139 }
140 else
141 m_position = 0;
142
143 length -= to_copy;
144 input += to_copy;
145 }
146 }
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:126

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


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