Botan  1.11.15
Public Member Functions | Protected Member Functions
Botan::Hex_Decoder Class Reference

#include <hex_filt.h>

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

List of all members.

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

virtual void send (const byte in[], size_t length)
void send (byte in)
void send (const secure_vector< byte > &in)
void send (const std::vector< byte > &in)
void send (const secure_vector< byte > &in, size_t length)
void send (const std::vector< byte > &in, size_t length)

Detailed Description

Converts hex strings to bytes

Definition at line 59 of file hex_filt.h.


Constructor & Destructor Documentation

Construct a Hex Decoder using the specified character checking.

Parameters:
checkingthe checking to use during decoding.

Definition at line 110 of file hex_filt.cpp.

References Botan::HEX_CODEC_BUFFER_SIZE.

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

Member Function Documentation

virtual bool Botan::Filter::attachable ( ) [inline, virtual, inherited]

Check whether this filter is an attachable filter.

Returns:
true if this filter is attachable, false otherwise

Reimplemented in Botan::SecureQueue, and Botan::DataSink.

Definition at line 52 of file filter.h.

{ return true; }
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.

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

   {
   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");
   }
std::string Botan::Hex_Decoder::name ( ) const [inline, virtual]
Returns:
descriptive name for this filter

Implements Botan::Filter.

Definition at line 62 of file hex_filt.h.

{ return "Hex_Decoder"; }
void Botan::Filter::send ( const byte  in[],
size_t  length 
) [protected, virtual, inherited]
Parameters:
insome input for the filter
lengththe length of in

Reimplemented in Botan::Threaded_Fork.

Definition at line 28 of file filter.cpp.

References Botan::Filter::write().

Referenced by Botan::Compression_Decompression_Filter::end_msg(), Botan::Hex_Encoder::end_msg(), Botan::Base64_Encoder::end_msg(), end_msg(), Botan::Base64_Decoder::end_msg(), Botan::Hash_Filter::end_msg(), Botan::MAC_Filter::end_msg(), Botan::Compression_Decompression_Filter::flush(), Botan::Compression_Decompression_Filter::start_msg(), Botan::Compression_Decompression_Filter::write(), Botan::StreamCipher_Filter::write(), write(), and Botan::Base64_Decoder::write().

   {
   if(!length)
      return;

   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();
   }
void Botan::Filter::send ( byte  in) [inline, protected, inherited]
Parameters:
insome input for the filter

Definition at line 65 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in, 1); }
void Botan::Filter::send ( const secure_vector< byte > &  in) [inline, protected, inherited]
Parameters:
insome input for the filter

Definition at line 70 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in[0], in.size()); }
void Botan::Filter::send ( const std::vector< byte > &  in) [inline, protected, inherited]
Parameters:
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

Referenced by Botan::Filter::send().

{ send(&in[0], in.size()); }
void Botan::Filter::send ( const secure_vector< byte > &  in,
size_t  length 
) [inline, protected, inherited]
Parameters:
insome input for the filter
lengththe number of bytes of in to send

Definition at line 81 of file filter.h.

         {
         send(&in[0], length);
         }
void Botan::Filter::send ( const std::vector< byte > &  in,
size_t  length 
) [inline, protected, inherited]
Parameters:
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

         {
         send(&in[0], length);
         }
virtual void Botan::Filter::start_msg ( ) [inline, virtual, inherited]

Start a new message. Must be closed by end_msg() before another message can be started.

Reimplemented in Botan::Compression_Decompression_Filter.

Definition at line 40 of file filter.h.

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

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

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

   {
   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;
      }
   }

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