Botan  1.11.10
Public Member Functions | Protected Member Functions | List of all members
Botan::PBE Class Referenceabstract

#include <pbe.h>

Inheritance diagram for Botan::PBE:
Botan::Filter Botan::PBE_PKCS5v20

Public Member Functions

virtual bool attachable ()
 
virtual std::vector< byteencode_params () const =0
 
virtual void end_msg ()
 
virtual OID get_oid () const =0
 
virtual std::string name () const =0
 
virtual void start_msg ()
 
virtual void write (const byte input[], size_t length)=0
 

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

Password Based Encryption (PBE) Filter.

Definition at line 21 of file pbe.h.

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; }
virtual std::vector<byte> Botan::PBE::encode_params ( ) const
pure virtual

DER encode the params (the number of iterations and the salt value)

Returns
encoded params

Implemented in Botan::PBE_PKCS5v20.

virtual void Botan::Filter::end_msg ( )
inlinevirtualinherited
virtual OID Botan::PBE::get_oid ( ) const
pure virtual

Get this PBE's OID.

Returns
object identifier

Implemented in Botan::PBE_PKCS5v20.

virtual std::string Botan::Filter::name ( ) const
pure virtualinherited
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::PK_Encryptor_Filter::end_msg(), Botan::Zlib_Compression::end_msg(), Botan::Bzip_Compression::end_msg(), Botan::Lzma_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::PK_Signer_Filter::end_msg(), Botan::Lzma_Decompression::end_msg(), Botan::Zlib_Decompression::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::Lzma_Compression::flush(), Botan::Zlib_Compression::write(), Botan::Bzip_Compression::write(), Botan::Lzma_Compression::write(), Botan::StreamCipher_Filter::write(), Botan::Bzip_Decompression::write(), Botan::Lzma_Decompression::write(), Botan::Zlib_Decompression::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::Zlib_Decompression, Botan::Lzma_Decompression, Botan::Bzip_Decompression, Botan::PBE_PKCS5v20, Botan::Lzma_Compression, Botan::Bzip_Compression, and Botan::Zlib_Compression.

Definition at line 40 of file filter.h.

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

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