#include <pbkdf1.h>

Inheritance diagram for Botan::PKCS5_PBKDF1:

Public Types
typedef SCAN_Name	Spec

Public Member Functions
PBKDF *	clone () const override

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

std::string	name () const override

size_t	pbkdf (byte output_buf[], size_t output_len, const std::string &passphrase, const byte salt[], size_t salt_len, size_t iterations, std::chrono::milliseconds msec) const override

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

	PKCS5_PBKDF1 (HashFunction *hash)

Static Public Member Functions
static std::unique_ptr< PBKDF >	create (const std::string &algo_spec, const std::string &provider="")

static std::vector< std::string >	providers (const std::string &algo_spec)

Detailed Description

PKCS #5 v1 PBKDF, aka PBKDF1 Can only generate a key up to the size of the hash output. Unless needed for backwards compatibility, use PKCS5_PBKDF2

Definition at line 21 of file pbkdf1.h.

Member Typedef Documentation

typedef SCAN_Name Botan::PBKDF::Spec

inherited

Definition at line 40 of file pbkdf.h.

Constructor & Destructor Documentation

Botan::PKCS5_PBKDF1::PKCS5_PBKDF1 ( HashFunction * hash )

inlineexplicit

Create a PKCS #5 instance using the specified hash function.

Parameters

hash	pointer to a hash function object to use

Definition at line 28 of file pbkdf1.h.

28 : m_hash(hash) {}

hash

MechanismType hash

Definition: p11_mechanism.cpp:61

Member Function Documentation

PBKDF* Botan::PKCS5_PBKDF1::clone ( ) const

inlineoverridevirtual

Returns: new instance of this same algorithm

Implements Botan::PBKDF.

Definition at line 35 of file pbkdf1.h.

          {
          return new PKCS5_PBKDF1(m_hash->clone());
          }

std::unique_ptr< PBKDF > Botan::PBKDF::create	(	const std::string &	algo_spec,
		const std::string &	provider = `""`
	)

staticinherited

Create an instance based on a name Will return a null pointer if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 34 of file pbkdf.cpp.

Referenced by Botan::get_pbkdf().

    {
    return std::unique_ptr<PBKDF>(make_a<PBKDF>(Botan::PBKDF::Spec(algo_spec), provider));
    }

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

inlineinherited

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 103 of file pbkdf.h.

Referenced by Botan::check_passhash9(), Botan::CryptoBox::decrypt(), and Botan::CryptoBox::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

inlineinherited

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 119 of file pbkdf.h.

          {
          return pbkdf_iterations(out_len, passphrase, salt.data(), 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

inlineinherited

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 136 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

inlineinherited

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 154 of file pbkdf.h.

          {
          return pbkdf_timed(out_len, passphrase, salt.data(), salt.size(), msec, iterations);
          }

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

inlineoverridevirtual

Implements Botan::PBKDF.

Definition at line 30 of file pbkdf1.h.

          {
          return "PBKDF1(" + m_hash->name() + ")";
          }

size_t Botan::PKCS5_PBKDF1::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

overridevirtual

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

Implements Botan::PBKDF.

Definition at line 13 of file pbkdf1.cpp.

References Botan::copy_mem().

    {
    if(output_len > m_hash->output_length())
       throw Invalid_Argument("PKCS5_PBKDF1: Requested output length too long");
 
    m_hash->update(passphrase);
    m_hash->update(salt, salt_len);
    secure_vector<byte> key = m_hash->final();
 
    const auto start = std::chrono::high_resolution_clock::now();
    size_t iterations_performed = 1;
 
    while(true)
       {
       if(iterations == 0)
          {
          if(iterations_performed % 10000 == 0)
             {
             auto time_taken = std::chrono::high_resolution_clock::now() - start;
             auto msec_taken = std::chrono::duration_cast<std::chrono::milliseconds>(time_taken);
             if(msec_taken > msec)
                break;
             }
          }
       else if(iterations_performed == iterations)
          break;
 
       m_hash->update(key);
       m_hash->final(key.data());
 
       ++iterations_performed;
       }
 
    copy_mem(output_buf, key.data(), output_len);
    return iterations_performed;
    }

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

inherited

Definition at line 54 of file pbkdf.cpp.

References BOTAN_ASSERT_EQUAL, Botan::PBKDF::name(), and Botan::PBKDF::pbkdf().

Referenced by Botan::PBKDF::pbkdf_iterations().

    {
    if(iterations == 0)
       throw 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

inherited

Definition at line 68 of file pbkdf.cpp.

References Botan::PBKDF::pbkdf_iterations().

    {
    secure_vector<byte> out(out_len);
    pbkdf_iterations(out.data(), 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

inherited

Definition at line 45 of file pbkdf.cpp.

References Botan::PBKDF::pbkdf().

Referenced by Botan::PBKDF::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

inherited

Definition at line 78 of file pbkdf.cpp.

References Botan::PBKDF::pbkdf_timed().

    {
    secure_vector<byte> out(out_len);
    pbkdf_timed(out.data(), out_len, passphrase, salt, salt_len, msec, iterations);
    return out;
    }

std::vector< std::string > Botan::PBKDF::providers ( const std::string & algo_spec )

staticinherited

Returns the list of available providers for this algorithm, empty if not available

Definition at line 40 of file pbkdf.cpp.

    {
    return providers_of<PBKDF>(PBKDF::Spec(algo_spec));
    }

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

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation