Botan::Hex_Decoder Class Reference

#include <hex_filt.h>

Inheritance diagram for Botan::Hex_Decoder:

Public Member Functions
virtual bool	attachable ()
void	end_msg ()
	Hex_Decoder (Decoder_Checking checking=NONE)
std::string	name () const
virtual void	start_msg ()
void	write (const byte[], size_t)

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

Converts hex strings to bytes

Definition at line 59 of file hex_filt.h.

Constructor & Destructor Documentation

Hex_Decoder()

Botan::Hex_Decoder::Hex_Decoder

(

Decoder_Checking

checking = NONE

)

Construct a Hex Decoder using the specified character checking.

Parameters

checking

the checking to use during decoding.

Definition at line 110 of file hex_filt.cpp.

                                           : checking(c)
   {
   in.resize(HEX_CODEC_BUFFER_SIZE);
   out.resize(in.size() / 2);
   position = 0;
   }

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

{ return true; }

end_msg()

void Botan::Hex_Decoder::end_msg ( )

virtual

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

Reimplemented from Botan::Filter.

Definition at line 153 of file hex_filt.cpp.

   {
   size_t consumed = 0;
   size_t written = hex_decode(&out[0],
                               reinterpret_cast<const char*>(&in[0]),
                               position,
                               consumed,
                               checking != FULL_CHECK);
 
   send(out, written);
 
   const bool not_full_bytes = consumed != position;
 
   position = 0;
 
   if(not_full_bytes)
      throw std::invalid_argument("Hex_Decoder: Input not full bytes");
   }

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

name()

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

inlinevirtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 62 of file hex_filt.h.

{ return "Hex_Decoder"; }

send() [1/4]

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

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

void Botan::Filter::send ( const byte in[], size_t length )

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(&write_queue[0], write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }

Referenced by Botan::Base64_Decoder::end_msg(), Botan::Base64_Encoder::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Bzip_Decompression::end_msg(), Botan::Hash_Filter::end_msg(), Botan::Hex_Decoder::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::MAC_Filter::end_msg(), Botan::PK_Decryptor_Filter::end_msg(), Botan::PK_Encryptor_Filter::end_msg(), Botan::PK_Signer_Filter::end_msg(), Botan::PK_Verifier_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Zlib_Decompression::end_msg(), Botan::Bzip_Compression::flush(), Botan::Zlib_Compression::flush(), send(), Botan::Base64_Decoder::write(), Botan::Bzip_Compression::write(), Botan::Bzip_Decompression::write(), Botan::Chain::write(), Botan::Fork::write(), Botan::Hex_Decoder::write(), Botan::StreamCipher_Filter::write(), Botan::Zlib_Compression::write(), and Botan::Zlib_Decompression::write().

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

{ send(&in[0], in.size()); }

References send(), and Botan::MemoryRegion< T >::size().

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 74 of file filter.h.

         {
         send(&in[0], length);
         }

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

Reimplemented in Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 38 of file filter.h.

{}

write()

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

virtual

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 120 of file hex_filt.cpp.

   {
   while(length)
      {
      size_t to_copy = std::min<size_t>(length, in.size() - position);
      copy_mem(&in[position], input, to_copy);
      position += to_copy;
 
      size_t consumed = 0;
      size_t written = hex_decode(&out[0],
                                  reinterpret_cast<const char*>(&in[0]),
                                  position,
                                  consumed,
                                  checking != FULL_CHECK);
 
      send(out, written);
 
      if(consumed != position)
         {
         copy_mem(&in[0], &in[consumed], position - consumed);
         position = position - consumed;
         }
      else
         position = 0;
 
      length -= to_copy;
      input += to_copy;
      }
   }

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

---

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

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