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

#include <hex_filt.h>

Inheritance diagram for Botan::Hex_Encoder:
Botan::Filter

Public Types

enum  Case { Uppercase, Lowercase }
 

Public Member Functions

virtual bool attachable ()
 
void end_msg ()
 
 Hex_Encoder (Case the_case)
 
 Hex_Encoder (bool newlines=false, size_t line_length=72, Case the_case=Uppercase)
 
std::string name () const
 
virtual void start_msg ()
 
void write (const byte in[], size_t length)
 

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 arbitrary binary data to hex strings, optionally with newlines inserted

Definition at line 19 of file hex_filt.h.

Member Enumeration Documentation

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

Enumerator
Uppercase 
Lowercase 

Definition at line 25 of file hex_filt.h.

Constructor & Destructor Documentation

Botan::Hex_Encoder::Hex_Encoder ( Case  the_case)

Create a hex encoder.

Parameters
the_casethe case to use in the encoded strings.

Definition at line 36 of file hex_filt.cpp.

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

36  : casing(c), line_length(0)
37  {
39  out.resize(2*in.size());
40  counter = position = 0;
41  }
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
Botan::Hex_Encoder::Hex_Encoder ( bool  newlines = false,
size_t  line_length = 72,
Case  the_case = Uppercase 
)

Create a hex encoder.

Parameters
newlinesshould newlines be used
line_lengthif newlines are used, how long are lines
the_casethe case to use in the encoded strings

Definition at line 25 of file hex_filt.cpp.

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

25  :
26  casing(c), line_length(breaks ? length : 0)
27  {
29  out.resize(2*in.size());
30  counter = position = 0;
31  }
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_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 99 of file hex_filt.cpp.

References Botan::Filter::send().

100  {
101  encode_and_send(&in[0], position);
102  if(counter && line_length)
103  send('\n');
104  counter = position = 0;
105  }
void send(const byte in[], size_t length)
Definition: filter.cpp:28
std::string Botan::Hex_Encoder::name ( ) const
inlinevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 27 of file hex_filt.h.

27 { return "Hex_Encoder"; }
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(), 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(), Botan::Hex_Decoder::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::Zlib_Compression::write(), Botan::Bzip_Compression::write(), Botan::StreamCipher_Filter::write(), Botan::Bzip_Decompression::write(), Botan::Zlib_Decompression::write(), Botan::Hex_Decoder::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_Encoder::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 76 of file hex_filt.cpp.

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

77  {
78  in.copy(position, input, length);
79  if(position + length >= in.size())
80  {
81  encode_and_send(&in[0], in.size());
82  input += (in.size() - position);
83  length -= (in.size() - position);
84  while(length >= in.size())
85  {
86  encode_and_send(input, in.size());
87  input += in.size();
88  length -= in.size();
89  }
90  in.copy(input, length);
91  position = 0;
92  }
93  position += length;
94  }
void copy(const T in[], size_t n)
Definition: secmem.h:120
size_t size() const
Definition: secmem.h:29

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