Botan::Hex_Encoder Class Reference

#include <filters.h>

Inheritance diagram for Botan::Hex_Encoder:

Public Types
enum	Case : uint8_t { Uppercase , Lowercase }

Public Member Functions
virtual bool	attachable ()
void	end_msg () override
BOTAN_FUTURE_EXPLICIT	Hex_Encoder (bool newlines=false, size_t line_length=72, Case the_case=Uppercase)
	Hex_Encoder (Case the_case)
std::string	name () const override
virtual void	start_msg ()
void	write (const uint8_t in[], 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 arbitrary binary data to hex strings, optionally with newlines inserted

Definition at line 557 of file filters.h.

Member Enumeration Documentation

Case

enum Botan::Hex_Encoder::Case : uint8_t

Whether to use uppercase or lowercase letters for the encoded string.

Enumerator
Uppercase
Lowercase

Definition at line 562 of file filters.h.

: uint8_t { Uppercase, Lowercase };

Constructor & Destructor Documentation

Hex_Encoder() [1/2]

Botan::Hex_Encoder::Hex_Encoder ( Case the_case )

explicit

Create a hex encoder.

Parameters

the_case

the case to use in the encoded strings.

Definition at line 33 of file hex_filt.cpp.

                               : m_casing(c), m_line_length(0) {
   m_in.resize(HEX_CODEC_BUFFER_SIZE);
   m_out.resize(2 * m_in.size());
}

References Botan::HEX_CODEC_BUFFER_SIZE.

Hex_Encoder() [2/2]

Botan::Hex_Encoder::Hex_Encoder	(	bool	newlines = false,
		size_t	line_length = 72,
		Case	the_case = Uppercase )

Create a hex encoder.

Parameters

newlines	should newlines be used
line_length	if newlines are used, how long are lines
the_case	the case to use in the encoded strings

Definition at line 25 of file hex_filt.cpp.

                                                           : m_casing(c), m_line_length(breaks ? length : 0) {
   m_in.resize(HEX_CODEC_BUFFER_SIZE);
   m_out.resize(2 * m_in.size());
}

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.

{ return true; }

end_msg()

void Botan::Hex_Encoder::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 88 of file hex_filt.cpp.

                          {
   encode_and_send(m_in.data(), m_position);
   if(m_counter > 0 && m_line_length > 0) {
      send('\n');
   }
   m_counter = m_position = 0;
}

References Botan::Filter::send().

name()

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

inlineoverridevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 564 of file filters.h.

{ return "Hex_Encoder"; }

send() [1/4]

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

                                                      {
   if(length == 0) {
      return;
   }
 
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j) {
      if(m_next[j] != nullptr) {
         if(!m_write_queue.empty()) {
            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();
   }
}

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

in	some input for the filter

Definition at line 78 of file filter.h.

{ 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

in	some input for the filter
length	the 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.

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

References BOTAN_ASSERT_NOMSG, and send().

send() [4/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 73 of file filter.h.

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

                               { /* default empty */
      }

write()

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

overridevirtual

Write a portion of a message to this filter.

Parameters

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

Implements Botan::Filter.

Definition at line 66 of file hex_filt.cpp.

                                                            {
   const size_t initial_fill = std::min(m_in.size() - m_position, length);
   copy_mem(&m_in[m_position], input, initial_fill);
 
   if(m_position + length >= m_in.size()) {
      encode_and_send(m_in.data(), m_in.size());
      input += (m_in.size() - m_position);
      length -= (m_in.size() - m_position);
      while(length >= m_in.size()) {
         encode_and_send(input, m_in.size());
         input += m_in.size();
         length -= m_in.size();
      }
      copy_mem(m_in.data(), input, length);
      m_position = 0;
   }
   m_position += length;
}

References Botan::copy_mem().

---

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

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