Botan::Hex_Encoder Class Reference

#include <hex.h>

Inheritance diagram for Botan::Hex_Encoder:

List of all members.

Public Types
enum	Case { Uppercase, Lowercase }
Public Member Functions
virtual bool	attachable ()
void	end_msg ()
	Hex_Encoder (bool newlines=false, u32bit line_length=72, Case the_case=Uppercase)
	Hex_Encoder (Case the_case)
std::string	name () const
virtual void	start_msg ()
void	write (const byte in[], u32bit length)
Static Public Member Functions
static void	encode (byte in, byte out[2], Case the_case=Uppercase)
Protected Member Functions
void	send (const MemoryRegion< byte > &in)
void	send (byte in)
void	send (const byte in[], u32bit length)

---

Detailed Description

This class represents a hex encoder. It encodes byte arrays to hex strings.

Definition at line 18 of file hex.h.

---

Member Enumeration Documentation

enum Botan::Hex_Encoder::Case

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

Enumerator:

Uppercase
Lowercase

Definition at line 24 of file hex.h.

{ Uppercase, Lowercase };

---

Constructor & Destructor Documentation

Botan::Hex_Encoder::Hex_Encoder

(

Case

the_case

)

Create a hex encoder.

Parameters:

the_case

the case to use in the encoded strings.

Definition at line 35 of file hex.cpp.

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

                               : casing(c), line_length(0)
   {
   in.resize(HEX_CODEC_BUFFER_SIZE);
   out.resize(2*in.size());
   counter = position = 0;
   }

Botan::Hex_Encoder::Hex_Encoder	(	bool	newlines = false,
		u32bit	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 24 of file hex.cpp.

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

                                                           :
   casing(c), line_length(breaks ? length : 0)
   {
   in.resize(HEX_CODEC_BUFFER_SIZE);
   out.resize(2*in.size());
   counter = 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::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

{ return true; }

void Botan::Hex_Encoder::encode	(	byte	in,
		byte	out[2],
		Hex_Encoder::Case	casing = Uppercase
	)			[static]

Encode a single byte into two hex characters

Definition at line 45 of file hex.cpp.

References Uppercase.

Referenced by Botan::BigInt::encode().

   {
   const byte* BIN_TO_HEX = ((casing == Uppercase) ? BIN_TO_HEX_UPPER :
                                                     BIN_TO_HEX_LOWER);

   out[0] = BIN_TO_HEX[((in >> 4) & 0x0F)];
   out[1] = BIN_TO_HEX[((in     ) & 0x0F)];
   }

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

References Botan::Filter::send().

   {
   encode_and_send(in, position);
   if(counter && line_length)
      send('\n');
   counter = position = 0;
   }

std::string Botan::Hex_Encoder::name

(

)

const [inline, virtual]

Returns:

descriptive name for this filter

Implements Botan::Filter.

Definition at line 31 of file hex.h.

{ return "Hex_Encoder"; }

void Botan::Filter::send

(

const MemoryRegion< byte > &

in

)

[inline, protected, inherited]

Parameters:

in

some input for the filter

Definition at line 68 of file filter.h.

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

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

{ send(in.begin(), in.size()); }

void Botan::Filter::send

(

byte

in

)

[inline, protected, inherited]

Parameters:

in

some input for the filter

Definition at line 63 of file filter.h.

References Botan::Filter::send().

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

{ send(&in, 1); }

void Botan::Filter::send	(	const byte	in[],
		u32bit	length
	)			[protected, inherited]

Parameters:

	in	some input for the filter
	length	the length of in

Definition at line 28 of file filter.cpp.

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

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

   {
   bool nothing_attached = true;
   for(u32bit j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(write_queue, write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }

   if(nothing_attached)
      write_queue.append(input, length);
   else
      write_queue.destroy();
   }

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::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::Zlib_Compression, Botan::Zlib_Decompression, Botan::PBE_PKCS5v15, and Botan::PBE_PKCS5v20.

Definition at line 38 of file filter.h.

{}

void Botan::Hex_Encoder::write	(	const byte	input[],
		u32bit	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 86 of file hex.cpp.

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

   {
   in.copy(position, input, length);
   if(position + length >= in.size())
      {
      encode_and_send(in, in.size());
      input += (in.size() - position);
      length -= (in.size() - position);
      while(length >= in.size())
         {
         encode_and_send(input, in.size());
         input += in.size();
         length -= in.size();
         }
      in.copy(input, length);
      position = 0;
      }
   position += length;
   }

---

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

• src/filters/hex/hex.h
• src/filters/hex/hex.cpp
• src/filters/hex/hex_char.cpp