Botan 3.9.0
Crypto and TLS for C&
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 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

Converts hex strings to bytes

Definition at line 597 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 99 of file hex_filt.cpp.

99 : m_checking(c) {
100 m_in.resize(HEX_CODEC_BUFFER_SIZE);
101 m_out.resize(m_in.size() / 2);
102}
const size_t HEX_CODEC_BUFFER_SIZE
Definition hex_filt.cpp:20

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

54{ 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 134 of file hex_filt.cpp.

134 {
135 size_t consumed = 0;
136 size_t written =
137 hex_decode(m_out.data(), cast_uint8_ptr_to_char(m_in.data()), m_position, consumed, m_checking != FULL_CHECK);
138
139 send(m_out, written);
140
141 const bool not_full_bytes = consumed != m_position;
142
143 m_position = 0;
144
145 if(not_full_bytes) {
146 throw Invalid_Argument("Hex_Decoder: Input not full bytes");
147 }
148}
virtual void send(const uint8_t in[], size_t length)
Definition filter.cpp:30
@ FULL_CHECK
Definition filter.h:167
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition hex.cpp:73
const char * cast_uint8_ptr_to_char(const uint8_t *b)
Definition mem_ops.h:282

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 599 of file filters.h.

599{ return "Hex_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::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 107 of file hex_filt.cpp.

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

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: