Botan  1.10.9
Public Member Functions | Protected Member Functions | List of all members
Botan::Hex_Decoder Class Reference

#include <hex_filt.h>

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

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 (const byte in[], size_t length)
 
void send (byte in)
 
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

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

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::MemoryRegion< T >::resize(), and Botan::MemoryRegion< T >::size().

110  : checking(c)
111  {
113  out.resize(in.size() / 2);
114  position = 0;
115  }
void resize(size_t n)
Definition: secmem.h:211
const size_t HEX_CODEC_BUFFER_SIZE
Definition: hex_filt.cpp:20
size_t size() const
Definition: secmem.h:29

Member Function Documentation

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::SecureQueue, and Botan::DataSink.

Definition at line 50 of file filter.h.

50 { 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().

154  {
155  size_t consumed = 0;
156  size_t written = hex_decode(&out[0],
157  reinterpret_cast<const char*>(&in[0]),
158  position,
159  consumed,
160  checking != FULL_CHECK);
161 
162  send(out, written);
163 
164  const bool not_full_bytes = consumed != position;
165 
166  position = 0;
167 
168  if(not_full_bytes)
169  throw std::invalid_argument("Hex_Decoder: Input not full bytes");
170  }
size_t hex_decode(byte output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition: hex.cpp:55
void send(const byte in[], size_t length)
Definition: filter.cpp:28
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.

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

Definition at line 28 of file filter.cpp.

References Botan::MemoryRegion< T >::clear(), Botan::MemoryRegion< T >::size(), and Botan::Filter::write().

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

29  {
30  bool nothing_attached = true;
31  for(size_t j = 0; j != total_ports(); ++j)
32  if(next[j])
33  {
34  if(write_queue.size())
35  next[j]->write(&write_queue[0], write_queue.size());
36  next[j]->write(input, length);
37  nothing_attached = false;
38  }
39 
40  if(nothing_attached)
41  write_queue += std::make_pair(input, length);
42  else
43  write_queue.clear();
44  }
virtual void write(const byte input[], size_t length)=0
size_t size() const
Definition: secmem.h:29
void Botan::Filter::send ( byte  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 63 of file filter.h.

References Botan::Filter::send().

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

63 { send(&in, 1); }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const MemoryRegion< byte > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 68 of file filter.h.

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

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

68 { send(&in[0], in.size()); }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
size_t size() const
Definition: secmem.h:29
void Botan::Filter::send ( const MemoryRegion< byte > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 74 of file filter.h.

75  {
76  send(&in[0], length);
77  }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
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::Zlib_Decompression, Botan::EAX_Base, Botan::Bzip_Decompression, Botan::PBE_PKCS5v20, Botan::PBE_PKCS5v15, Botan::Bzip_Compression, and Botan::Zlib_Compression.

Definition at line 38 of file filter.h.

38 {}
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(), Botan::Filter::send(), and Botan::MemoryRegion< T >::size().

121  {
122  while(length)
123  {
124  size_t to_copy = std::min<size_t>(length, in.size() - position);
125  copy_mem(&in[position], input, to_copy);
126  position += to_copy;
127 
128  size_t consumed = 0;
129  size_t written = hex_decode(&out[0],
130  reinterpret_cast<const char*>(&in[0]),
131  position,
132  consumed,
133  checking != FULL_CHECK);
134 
135  send(out, written);
136 
137  if(consumed != position)
138  {
139  copy_mem(&in[0], &in[consumed], position - consumed);
140  position = position - consumed;
141  }
142  else
143  position = 0;
144 
145  length -= to_copy;
146  input += to_copy;
147  }
148  }
size_t hex_decode(byte output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition: hex.cpp:55
void send(const byte in[], size_t length)
Definition: filter.cpp:28
size_t size() const
Definition: secmem.h:29
void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:22

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