Botan  1.11.10
Public Member Functions | Protected Member Functions | List of all members
Botan::Base64_Encoder Class Reference

#include <b64_filt.h>

Inheritance diagram for Botan::Base64_Encoder:
Botan::Filter

Public Member Functions

virtual bool attachable ()
 
 Base64_Encoder (bool breaks=false, size_t length=72, bool t_n=false)
 
void end_msg ()
 
std::string name () const
 
virtual void start_msg ()
 
void write (const byte input[], size_t length)
 

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

This class represents a Base64 encoder.

Definition at line 18 of file b64_filt.h.

Constructor & Destructor Documentation

Botan::Base64_Encoder::Base64_Encoder ( bool  breaks = false,
size_t  length = 72,
bool  t_n = false 
)

Create a base64 encoder.

Parameters
breakswhether to use line breaks in the output
lengththe length of the lines of the output
t_nwhether to use a trailing newline

Definition at line 19 of file b64_filt.cpp.

19  :
20  line_length(breaks ? length : 0),
21  trailing_newline(t_n && breaks),
22  in(48),
23  out(64),
24  position(0),
25  out_position(0)
26  {
27  }

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

52 { return true; }
void Botan::Base64_Encoder::end_msg ( )
virtual

Inform the Encoder that the current message shall be closed.

Reimplemented from Botan::Filter.

Definition at line 103 of file b64_filt.cpp.

References Botan::Filter::send().

104  {
105  encode_and_send(&in[0], position, true);
106 
107  if(trailing_newline || (out_position && line_length))
108  send('\n');
109 
110  out_position = position = 0;
111  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
std::string Botan::Base64_Encoder::name ( ) const
inlinevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 21 of file b64_filt.h.

21 { return "Base64_Encoder"; }
void Botan::Filter::send ( const byte  in[],
size_t  length 
)
protectedvirtualinherited
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(), end_msg(), Botan::Hex_Decoder::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(), Botan::Hex_Decoder::write(), and Botan::Base64_Decoder::write().

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

Definition at line 65 of file filter.h.

References Botan::Filter::send().

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

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

Definition at line 70 of file filter.h.

References Botan::Filter::send().

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

70 { send(&in[0], in.size()); }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const std::vector< byte > &  in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 75 of file filter.h.

References Botan::Filter::send().

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

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

Definition at line 81 of file filter.h.

82  {
83  send(&in[0], length);
84  }
virtual void send(const byte in[], size_t length)
Definition: filter.cpp:28
void Botan::Filter::send ( const std::vector< byte > &  in,
size_t  length 
)
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 90 of file filter.h.

91  {
92  send(&in[0], length);
93  }
virtual 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::Compression_Decompression_Filter.

Definition at line 40 of file filter.h.

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

Input a part of a message to the encoder.

Parameters
inputthe message to input as a byte array
lengththe length of the byte array input

Implements Botan::Filter.

Definition at line 80 of file b64_filt.cpp.

References Botan::buffer_insert(), and Botan::copy_mem().

81  {
82  buffer_insert(in, position, input, length);
83  if(position + length >= in.size())
84  {
85  encode_and_send(&in[0], in.size());
86  input += (in.size() - position);
87  length -= (in.size() - position);
88  while(length >= in.size())
89  {
90  encode_and_send(input, in.size());
91  input += in.size();
92  length -= in.size();
93  }
94  copy_mem(&in[0], input, length);
95  position = 0;
96  }
97  position += length;
98  }
void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:39
size_t buffer_insert(std::vector< T, Alloc > &buf, size_t buf_offset, const T input[], size_t input_length)
Definition: secmem.h:103

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