Botan::PBE_PKCS5v20 Class Reference

#include <pbes2.h>

Inheritance diagram for Botan::PBE_PKCS5v20:

Public Member Functions
virtual bool	attachable ()
void	end_msg ()
std::string	name () const
	PBE_PKCS5v20 (BlockCipher *cipher, HashFunction *hash)
	PBE_PKCS5v20 (DataSource &input)
void	start_msg ()
void	write (const byte[], size_t)
	~PBE_PKCS5v20 ()

Static Public Member Functions
static bool	known_cipher (const std::string &cipher)

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

PKCS #5 v2.0 PBE

Definition at line 21 of file pbes2.h.

Constructor & Destructor Documentation

PBE_PKCS5v20() [1/2]

Botan::PBE_PKCS5v20::PBE_PKCS5v20

(

DataSource &

input

)

Load a PKCS #5 v2.0 encrypted stream

Parameters

input

is the input source

Definition at line 228 of file pbes2.cpp.

                                             : direction(DECRYPTION)
   {
   hash_function = 0;
   block_cipher = 0;
   decode_params(params);
   }

References Botan::DECRYPTION.

Referenced by Botan::get_pbe(), and Botan::get_pbe().

PBE_PKCS5v20() [2/2]

Botan::PBE_PKCS5v20::PBE_PKCS5v20	(	BlockCipher *	cipher,
		HashFunction *	hash )

Parameters

cipher	the block cipher to use
hash	the hash function to use

Definition at line 211 of file pbes2.cpp.

                                                 :
   direction(ENCRYPTION),
   block_cipher(cipher),
   hash_function(digest),
   iterations(0),
   key_length(0)
   {
   if(!known_cipher(block_cipher->name()))
      throw Invalid_Argument("PBE-PKCS5 v2.0: Invalid cipher " + cipher->name());
   if(hash_function->name() != "SHA-160")
      throw Invalid_Argument("PBE-PKCS5 v2.0: Invalid digest " + digest->name());
   }

References Botan::ENCRYPTION, known_cipher(), and Botan::Algorithm::name().

~PBE_PKCS5v20()

Botan::PBE_PKCS5v20::~PBE_PKCS5v20

(

)

Definition at line 235 of file pbes2.cpp.

   {
   delete hash_function;
   delete block_cipher;
   }

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; }

end_msg()

void Botan::PBE_PKCS5v20::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 55 of file pbes2.cpp.

   {
   pipe.end_msg();
   flush_pipe(false);
   pipe.reset();
   }

known_cipher()

bool Botan::PBE_PKCS5v20::known_cipher ( const std::string & cipher )

static

Parameters

cipher

names a block cipher

Returns

true iff PKCS #5 knows how to use this cipher

Definition at line 193 of file pbes2.cpp.

   {
   if(algo == "AES-128" || algo == "AES-192" || algo == "AES-256")
      return true;
   if(algo == "DES" || algo == "TripleDES")
      return true;
   return false;
   }

Referenced by PBE_PKCS5v20().

name()

std::string Botan::PBE_PKCS5v20::name ( ) const

virtual

Returns

descriptive name for this filter

Implements Botan::Filter.

Definition at line 202 of file pbes2.cpp.

   {
   return "PBE-PKCS5v20(" + block_cipher->name() + "," +
                            hash_function->name() + ")";
   }

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().

start_msg()

void Botan::PBE_PKCS5v20::start_msg ( )

virtual

Start a new message. Must be closed by end_msg() before another message can be started.

Reimplemented from Botan::Filter.

Definition at line 36 of file pbes2.cpp.

   {
   if(direction == ENCRYPTION)
      pipe.append(new CBC_Encryption(block_cipher->clone(),
                                     new PKCS7_Padding,
                                     key, iv));
   else
      pipe.append(new CBC_Decryption(block_cipher->clone(),
                                     new PKCS7_Padding,
                                     key, iv));
 
   pipe.start_msg();
   if(pipe.message_count() > 1)
      pipe.set_default_msg(pipe.default_msg() + 1);
   }

References Botan::CBC_Decryption::CBC_Decryption(), Botan::CBC_Encryption::CBC_Encryption(), and Botan::ENCRYPTION.

write()

void Botan::PBE_PKCS5v20::write ( const byte input[], size_t 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 27 of file pbes2.cpp.

   {
   pipe.write(input, length);
   flush_pipe(true);
   }

---

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

• src/pbe/pbes2/pbes2.h
• src/pbe/pbes2/pbes2.cpp