Botan::PBE Class Reference

#include <pbe.h>

Inheritance diagram for Botan::PBE:

Public Member Functions
virtual bool	attachable ()
virtual void	decode_params (DataSource &src)=0
virtual MemoryVector< byte >	encode_params () const =0
virtual void	end_msg ()
virtual OID	get_oid () const =0
virtual std::string	name () const =0
virtual void	new_params (RandomNumberGenerator &rng)=0
virtual void	set_key (const std::string &pw)=0
virtual void	start_msg ()
virtual void	write (const byte input[], size_t length)=0

Protected Member Functions
void	send (byte in)
void	send (const byte in[], size_t length)
void	send (const MemoryRegion< byte > &in)
void	send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

Password Based Encryption (PBE) Filter.

Definition at line 21 of file pbe.h.

Member Function Documentation

attachable()

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

Definition at line 50 of file filter.h.

{ return true; }

decode_params()

virtual void Botan::PBE::decode_params ( DataSource & src )

pure virtual

Decode params and use them inside this Filter.

Parameters

src	a data source to read the encoded params from

Referenced by Botan::get_pbe().

encode_params()

virtual MemoryVector< byte > Botan::PBE::encode_params ( ) const

pure virtual

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

Returns

encoded params

end_msg()

virtual void Botan::Filter::end_msg ( )

inlinevirtualinherited

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 44 of file filter.h.

{}

get_oid()

virtual OID Botan::PBE::get_oid ( ) const

pure virtual

Get this PBE's OID.

Returns

object identifier

name()

virtual std::string Botan::Filter::name ( ) const

pure virtualinherited

Returns

descriptive name for this filter

Implemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::CBC_Decryption, Botan::CBC_Encryption, Botan::CFB_Decryption, Botan::CFB_Encryption, Botan::Chain, Botan::CTS_Decryption, Botan::CTS_Encryption, Botan::DataSink_Stream, Botan::EAX_Base, Botan::ECB_Decryption, Botan::ECB_Encryption, Botan::Fork, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::SecureQueue, Botan::StreamCipher_Filter, Botan::XTS_Decryption, Botan::XTS_Encryption, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Referenced by Botan::Keyed_Filter::set_iv().

new_params()

virtual void Botan::PBE::new_params ( RandomNumberGenerator & rng )

pure virtual

Create a new random salt value and set the default iterations value.

Parameters

rng	a random number generator

send() [1/4]

void Botan::Filter::send ( byte in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 63 of file filter.h.

{ send(&in, 1); }

References send().

Referenced by send().

send() [2/4]

void Botan::Filter::send ( const byte in[], size_t length )

protectedinherited

Parameters

in	some input for the filter
length	the length of in

Definition at line 28 of file filter.cpp.

   {
   bool nothing_attached = true;
   for(size_t j = 0; j != total_ports(); ++j)
      if(next[j])
         {
         if(write_queue.size())
            next[j]->write(&write_queue[0], write_queue.size());
         next[j]->write(input, length);
         nothing_attached = false;
         }
 
   if(nothing_attached)
      write_queue += std::make_pair(input, length);
   else
      write_queue.clear();
   }

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

send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in )

inlineprotectedinherited

Parameters

in	some input for the filter

Definition at line 68 of file filter.h.

{ send(&in[0], in.size()); }

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

Referenced by send().

send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in, size_t length )

inlineprotectedinherited

Parameters

in	some input for the filter
length	the number of bytes of in to send

Definition at line 74 of file filter.h.

         {
         send(&in[0], length);
         }

References send().

set_key()

virtual void Botan::PBE::set_key ( const std::string & pw )

pure virtual

Set this filter's key.

Parameters

pw	the password to be used for the encryption

start_msg()

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

Definition at line 38 of file filter.h.

{}

write()

virtual void Botan::Filter::write ( const byte input[], size_t length )

pure virtualinherited

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

Implemented in Botan::Base64_Decoder, Botan::Base64_Encoder, Botan::BitBucket, Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::Chain, Botan::DataSink_Stream, Botan::Fork, Botan::Hash_Filter, Botan::Hex_Decoder, Botan::Hex_Encoder, Botan::MAC_Filter, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::PK_Decryptor_Filter, Botan::PK_Encryptor_Filter, Botan::PK_Signer_Filter, Botan::PK_Verifier_Filter, Botan::SecureQueue, Botan::StreamCipher_Filter, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

---

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

• src/pbe/pbe.h