#include <pbkdf.h>

Inheritance diagram for Botan::PBKDF:

Public Types
typedef SCAN_Name	Spec
Public Member Functions
virtual PBKDF *	clone () const =0
OctetString	derive_key (size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, size_t iterations) const
template<typename Alloc >
OctetString	derive_key (size_t out_len, const std::string &passphrase, const std::vector< byte, Alloc > &salt, size_t iterations) const
OctetString	derive_key (size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
template<typename Alloc >
OctetString	derive_key (size_t out_len, const std::string &passphrase, const std::vector< byte, Alloc > &salt, std::chrono::milliseconds msec, size_t &iterations) const
virtual std::string	name () const =0
virtual size_t	pbkdf (byte out[], size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, size_t iterations, std::chrono::milliseconds msec) const =0
void	pbkdf_iterations (byte out[], size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, size_t iterations) const
secure_vector< byte >	pbkdf_iterations (size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, size_t iterations) const
void	pbkdf_timed (byte out[], size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
secure_vector< byte >	pbkdf_timed (size_t out_len, const std::string &passphrase, const byte salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
virtual	~PBKDF ()

Detailed Description

Base class for PBKDF (password based key derivation function) implementations. Converts a password into a key using a salt and iterated hashing to make brute force attacks harder.

Definition at line 22 of file pbkdf.h.

Member Typedef Documentation

typedef SCAN_Name Botan::PBKDF::Spec

Definition at line 28 of file pbkdf.h.

Constructor & Destructor Documentation

virtual Botan::PBKDF::~PBKDF ( ) [inline, virtual]

Definition at line 26 of file pbkdf.h.

{}

Member Function Documentation

virtual PBKDF* Botan::PBKDF::clone ( ) const [pure virtual]

Returns:: new instance of this same algorithm

Implemented in Botan::PKCS5_PBKDF2, and Botan::PKCS5_PBKDF1.

OctetString Botan::PBKDF::derive_key	(	size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		size_t	iterations
	)		const `[inline]`

Derive a key from a passphrase

Parameters:

out_len	the desired length of the key to produce
passphrase	the password to derive the key from
salt	a randomly chosen salt
salt_len	length of salt in bytes
iterations	the number of iterations to use (use 10K or more)

Definition at line 89 of file pbkdf.h.

Referenced by Botan::check_passhash9(), Botan::CryptoBox::decrypt(), Botan::CryptoBox::encrypt(), Botan::generate_passhash9(), Botan::pbes2_decrypt(), and Botan::pbes2_encrypt().

         {
         return pbkdf_iterations(out_len, passphrase, salt, salt_len, iterations);
         }

template<typename Alloc >

OctetString Botan::PBKDF::derive_key	(	size_t	out_len,
		const std::string &	passphrase,
		const std::vector< byte, Alloc > &	salt,
		size_t	iterations
	)		const `[inline]`

Derive a key from a passphrase

Parameters:

out_len	the desired length of the key to produce
passphrase	the password to derive the key from
salt	a randomly chosen salt
iterations	the number of iterations to use (use 10K or more)

Definition at line 105 of file pbkdf.h.

         {
         return pbkdf_iterations(out_len, passphrase, &salt[0], salt.size(), iterations);
         }

OctetString Botan::PBKDF::derive_key	(	size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		std::chrono::milliseconds	msec,
		size_t &	iterations
	)		const `[inline]`

Derive a key from a passphrase

Parameters:

out_len	the desired length of the key to produce
passphrase	the password to derive the key from
salt	a randomly chosen salt
salt_len	length of salt in bytes
msec	is how long to run the PBKDF
iterations	is set to the number of iterations used

Definition at line 122 of file pbkdf.h.

         {
         return pbkdf_timed(out_len, passphrase, salt, salt_len, msec, iterations);
         }

template<typename Alloc >

OctetString Botan::PBKDF::derive_key	(	size_t	out_len,
		const std::string &	passphrase,
		const std::vector< byte, Alloc > &	salt,
		std::chrono::milliseconds	msec,
		size_t &	iterations
	)		const `[inline]`

Derive a key from a passphrase using a certain amount of time

Parameters:

out_len	the desired length of the key to produce
passphrase	the password to derive the key from
salt	a randomly chosen salt
msec	is how long to run the PBKDF
iterations	is set to the number of iterations used

Definition at line 140 of file pbkdf.h.

         {
         return pbkdf_timed(out_len, passphrase, &salt[0], salt.size(), msec, iterations);
         }

virtual std::string Botan::PBKDF::name ( ) const [pure virtual]

Implemented in Botan::PKCS5_PBKDF2, and Botan::PKCS5_PBKDF1.

Referenced by pbkdf_iterations().

virtual size_t Botan::PBKDF::pbkdf	(	byte	out[],
		size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		size_t	iterations,
		std::chrono::milliseconds	msec
	)		const `[pure virtual]`

Derive a key from a passphrase for a number of iterations specified by either iterations or if iterations == 0 then running until seconds time has elapsed.

Parameters:

out_len	the desired length of the key to produce
passphrase	the password to derive the key from
salt	a randomly chosen salt
salt_len	length of salt in bytes
iterations	the number of iterations to use (use 10K or more)
msec	if iterations is zero, then instead the PBKDF is run until msec milliseconds has passed.

Returns:: the number of iterations performed

Implemented in Botan::PKCS5_PBKDF2, and Botan::PKCS5_PBKDF1.

Referenced by pbkdf_iterations(), and pbkdf_timed().

void Botan::PBKDF::pbkdf_iterations	(	byte	out[],
		size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		size_t	iterations
	)		const

Definition at line 22 of file pbkdf.cpp.

References BOTAN_ASSERT_EQUAL, name(), and pbkdf().

Referenced by pbkdf_iterations().

   {
   if(iterations == 0)
      throw std::invalid_argument(name() + ": Invalid iteration count");

   const size_t iterations_run = pbkdf(out, out_len, passphrase,
                                       salt, salt_len, iterations,
                                       std::chrono::milliseconds(0));
   BOTAN_ASSERT_EQUAL(iterations, iterations_run, "Expected PBKDF iterations");
   }

secure_vector< byte > Botan::PBKDF::pbkdf_iterations	(	size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		size_t	iterations
	)		const

Definition at line 36 of file pbkdf.cpp.

References pbkdf_iterations().

   {
   secure_vector<byte> out(out_len);
   pbkdf_iterations(&out[0], out_len, passphrase, salt, salt_len, iterations);
   return out;
   }

void Botan::PBKDF::pbkdf_timed	(	byte	out[],
		size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		std::chrono::milliseconds	msec,
		size_t &	iterations
	)		const

Definition at line 13 of file pbkdf.cpp.

References pbkdf().

Referenced by pbkdf_timed().

   {
   iterations = pbkdf(out, out_len, passphrase, salt, salt_len, 0, msec);
   }

secure_vector< byte > Botan::PBKDF::pbkdf_timed	(	size_t	out_len,
		const std::string &	passphrase,
		const byte	salt[],
		size_t	salt_len,
		std::chrono::milliseconds	msec,
		size_t &	iterations
	)		const

Definition at line 46 of file pbkdf.cpp.

References pbkdf_timed().

   {
   secure_vector<byte> out(out_len);
   pbkdf_timed(&out[0], out_len, passphrase, salt, salt_len, msec, iterations);
   return out;
   }

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

src/lib/pbkdf/pbkdf.h
src/lib/pbkdf/pbkdf.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation