Botan 3.1.1
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::PKCS5_PBKDF2 Class Referencefinal

#include <pbkdf2.h>

Inheritance diagram for Botan::PKCS5_PBKDF2:
Botan::PBKDF

Public Member Functions

PBKDFclone () const
 
template<typename Alloc >
OctetString derive_key (size_t out_len, std::string_view passphrase, const std::vector< uint8_t, Alloc > &salt, size_t iterations) const
 
template<typename Alloc >
OctetString derive_key (size_t out_len, std::string_view passphrase, const std::vector< uint8_t, Alloc > &salt, std::chrono::milliseconds msec, size_t &iterations) const
 
OctetString derive_key (size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, size_t iterations) const
 
OctetString derive_key (size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
 
std::string name () const override
 
std::unique_ptr< PBKDFnew_object () const override
 
size_t pbkdf (uint8_t output_buf[], size_t output_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, size_t iterations, std::chrono::milliseconds msec) const override
 
secure_vector< uint8_t > pbkdf_iterations (size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, size_t iterations) const
 
void pbkdf_iterations (uint8_t out[], size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, size_t iterations) const
 
secure_vector< uint8_t > pbkdf_timed (size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
 
void pbkdf_timed (uint8_t out[], size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
 
 PKCS5_PBKDF2 (MessageAuthenticationCode *mac_fn)
 
 PKCS5_PBKDF2 (std::unique_ptr< MessageAuthenticationCode > mac_fn)
 

Static Public Member Functions

static std::unique_ptr< PBKDFcreate (std::string_view algo_spec, std::string_view provider="")
 
static std::unique_ptr< PBKDFcreate_or_throw (std::string_view algo_spec, std::string_view provider="")
 
static std::vector< std::string > providers (std::string_view algo_spec)
 

Detailed Description

PKCS #5 PBKDF2 (old interface)

Definition at line 100 of file pbkdf2.h.

Constructor & Destructor Documentation

◆ PKCS5_PBKDF2() [1/2]

Botan::PKCS5_PBKDF2::PKCS5_PBKDF2 ( MessageAuthenticationCode mac_fn)
inlineexplicit

Create a PKCS #5 instance using the specified message auth code

Parameters
mac_fnthe MAC object to use as PRF

Definition at line 120 of file pbkdf2.h.

120: m_mac(mac_fn) {}

◆ PKCS5_PBKDF2() [2/2]

Botan::PKCS5_PBKDF2::PKCS5_PBKDF2 ( std::unique_ptr< MessageAuthenticationCode mac_fn)
inlineexplicit

Create a PKCS #5 instance using the specified message auth code

Parameters
mac_fnthe MAC object to use as PRF

Definition at line 126 of file pbkdf2.h.

126: m_mac(std::move(mac_fn)) {}

Member Function Documentation

◆ clone()

PBKDF * Botan::PBKDF::clone ( ) const
inlineinherited
Returns
new instance of this same algorithm

Definition at line 62 of file pbkdf.h.

62{ return this->new_object().release(); }
virtual std::unique_ptr< PBKDF > new_object() const =0

◆ create()

std::unique_ptr< PBKDF > Botan::PBKDF::create ( std::string_view  algo_spec,
std::string_view  provider = "" 
)
staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters
algo_specalgorithm name
providerprovider implementation to choose
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 23 of file pbkdf.cpp.

23 {
24 const SCAN_Name req(algo_spec);
25
26#if defined(BOTAN_HAS_PBKDF2)
27 if(req.algo_name() == "PBKDF2") {
28 // TODO OpenSSL
29
30 if(provider.empty() || provider == "base") {
31 if(auto mac = MessageAuthenticationCode::create("HMAC(" + req.arg(0) + ")")) {
32 return std::make_unique<PKCS5_PBKDF2>(std::move(mac));
33 }
34
35 if(auto mac = MessageAuthenticationCode::create(req.arg(0))) {
36 return std::make_unique<PKCS5_PBKDF2>(std::move(mac));
37 }
38 }
39
40 return nullptr;
41 }
42#endif
43
44#if defined(BOTAN_HAS_PGP_S2K)
45 if(req.algo_name() == "OpenPGP-S2K" && req.arg_count() == 1) {
46 if(auto hash = HashFunction::create(req.arg(0))) {
47 return std::make_unique<OpenPGP_S2K>(std::move(hash));
48 }
49 }
50#endif
51
52 BOTAN_UNUSED(req);
53 BOTAN_UNUSED(provider);
54
55 return nullptr;
56}
#define BOTAN_UNUSED
Definition: assert.h:118
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition: hash.cpp:103
static std::unique_ptr< MessageAuthenticationCode > create(std::string_view algo_spec, std::string_view provider="")
Definition: mac.cpp:46

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_count(), BOTAN_UNUSED, Botan::HashFunction::create(), and Botan::MessageAuthenticationCode::create().

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

◆ create_or_throw()

std::unique_ptr< PBKDF > Botan::PBKDF::create_or_throw ( std::string_view  algo_spec,
std::string_view  provider = "" 
)
staticinherited

Create an instance based on a name, or throw if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 59 of file pbkdf.cpp.

59 {
60 if(auto pbkdf = PBKDF::create(algo, provider)) {
61 return pbkdf;
62 }
63 throw Lookup_Error("PBKDF", algo, provider);
64}
virtual size_t pbkdf(uint8_t out[], size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, size_t iterations, std::chrono::milliseconds msec) const =0
static std::unique_ptr< PBKDF > create(std::string_view algo_spec, std::string_view provider="")
Definition: pbkdf.cpp:23

References Botan::PBKDF::create(), and Botan::PBKDF::pbkdf().

◆ derive_key() [1/4]

template<typename Alloc >
OctetString Botan::PBKDF::derive_key ( size_t  out_len,
std::string_view  passphrase,
const std::vector< uint8_t, Alloc > &  salt,
size_t  iterations 
) const
inlineinherited

Derive a key from a passphrase

Parameters
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
iterationsthe number of iterations to use (use 10K or more)

Definition at line 186 of file pbkdf.h.

189 {
190 return OctetString(pbkdf_iterations(out_len, passphrase, salt.data(), salt.size(), iterations));
191 }
void pbkdf_iterations(uint8_t out[], size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, size_t iterations) const
Definition: pbkdf.cpp:80

◆ derive_key() [2/4]

template<typename Alloc >
OctetString Botan::PBKDF::derive_key ( size_t  out_len,
std::string_view  passphrase,
const std::vector< uint8_t, 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_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
msecis how long to run the PBKDF
iterationsis set to the number of iterations used

Definition at line 220 of file pbkdf.h.

224 {
225 return OctetString(pbkdf_timed(out_len, passphrase, salt.data(), salt.size(), msec, iterations));
226 }
void pbkdf_timed(uint8_t out[], size_t out_len, std::string_view passphrase, const uint8_t salt[], size_t salt_len, std::chrono::milliseconds msec, size_t &iterations) const
Definition: pbkdf.cpp:70

◆ derive_key() [3/4]

OctetString Botan::PBKDF::derive_key ( size_t  out_len,
std::string_view  passphrase,
const uint8_t  salt[],
size_t  salt_len,
size_t  iterations 
) const
inlineinherited

Derive a key from a passphrase

Parameters
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
iterationsthe number of iterations to use (use 10K or more)

Definition at line 173 of file pbkdf.h.

174 {
175 return OctetString(pbkdf_iterations(out_len, passphrase, salt, salt_len, iterations));
176 }

Referenced by Botan::check_passhash9(), and Botan::generate_passhash9().

◆ derive_key() [4/4]

OctetString Botan::PBKDF::derive_key ( size_t  out_len,
std::string_view  passphrase,
const uint8_t  salt[],
size_t  salt_len,
std::chrono::milliseconds  msec,
size_t &  iterations 
) const
inlineinherited

Derive a key from a passphrase

Parameters
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
msecis how long to run the PBKDF
iterationsis set to the number of iterations used

Definition at line 202 of file pbkdf.h.

207 {
208 return OctetString(pbkdf_timed(out_len, passphrase, salt, salt_len, msec, iterations));
209 }

◆ name()

std::string Botan::PKCS5_PBKDF2::name ( ) const
overridevirtual
Returns
name of this PBKDF

Implements Botan::PBKDF.

Definition at line 158 of file pbkdf2.cpp.

158 {
159 return fmt("PBKDF2({})", m_mac->name());
160}
std::string fmt(std::string_view format, const T &... args)
Definition: fmt.h:53

References Botan::fmt().

◆ new_object()

std::unique_ptr< PBKDF > Botan::PKCS5_PBKDF2::new_object ( ) const
overridevirtual
Returns
new instance of this same algorithm

Implements Botan::PBKDF.

Definition at line 162 of file pbkdf2.cpp.

162 {
163 return std::make_unique<PKCS5_PBKDF2>(m_mac->new_object());
164}

◆ pbkdf()

size_t Botan::PKCS5_PBKDF2::pbkdf ( uint8_t  out[],
size_t  out_len,
std::string_view  passphrase,
const uint8_t  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 msec time has elapsed.

Parameters
outbuffer to store the derived key, must be of out_len bytes
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
iterationsthe number of iterations to use (use 10K or more)
msecif 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 140 of file pbkdf2.cpp.

146 {
147 if(iterations == 0) {
148 iterations = tune_pbkdf2(*m_mac, key_len, msec);
149 }
150
151 PBKDF2 pbkdf2(*m_mac, iterations);
152
153 pbkdf2.derive_key(key, key_len, password.data(), password.size(), salt, salt_len);
154
155 return iterations;
156}
size_t pbkdf2(MessageAuthenticationCode &prf, uint8_t out[], size_t out_len, std::string_view password, const uint8_t salt[], size_t salt_len, size_t iterations, std::chrono::milliseconds msec)
Definition: pbkdf2.cpp:78

References Botan::pbkdf2().

◆ pbkdf_iterations() [1/2]

secure_vector< uint8_t > Botan::PBKDF::pbkdf_iterations ( size_t  out_len,
std::string_view  passphrase,
const uint8_t  salt[],
size_t  salt_len,
size_t  iterations 
) const
inherited

Derive a key from a passphrase for a number of iterations.

Parameters
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
iterationsthe number of iterations to use (use 10K or more)
Returns
the derived key

Definition at line 95 of file pbkdf.cpp.

96 {
97 secure_vector<uint8_t> out(out_len);
98 pbkdf_iterations(out.data(), out_len, passphrase, salt, salt_len, iterations);
99 return out;
100}

References Botan::PBKDF::pbkdf_iterations().

◆ pbkdf_iterations() [2/2]

void Botan::PBKDF::pbkdf_iterations ( uint8_t  out[],
size_t  out_len,
std::string_view  passphrase,
const uint8_t  salt[],
size_t  salt_len,
size_t  iterations 
) const
inherited

Derive a key from a passphrase for a number of iterations.

Parameters
outbuffer to store the derived key, must be of out_len bytes
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
iterationsthe number of iterations to use (use 10K or more)

Definition at line 80 of file pbkdf.cpp.

85 {
86 if(iterations == 0) {
87 throw Invalid_Argument(name() + ": Invalid iteration count");
88 }
89
90 const size_t iterations_run =
91 pbkdf(out, out_len, passphrase, salt, salt_len, iterations, std::chrono::milliseconds(0));
92 BOTAN_ASSERT_EQUAL(iterations, iterations_run, "Expected PBKDF iterations");
93}
#define BOTAN_ASSERT_EQUAL(expr1, expr2, assertion_made)
Definition: assert.h:68
virtual std::string name() const =0

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

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

◆ pbkdf_timed() [1/2]

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

Derive a key from a passphrase, running until msec time has elapsed.

Parameters
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
msecif iterations is zero, then instead the PBKDF is run until msec milliseconds has passed.
iterationsset to the number iterations executed
Returns
the derived key

Definition at line 102 of file pbkdf.cpp.

107 {
108 secure_vector<uint8_t> out(out_len);
109 pbkdf_timed(out.data(), out_len, passphrase, salt, salt_len, msec, iterations);
110 return out;
111}

References Botan::PBKDF::pbkdf_timed().

◆ pbkdf_timed() [2/2]

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

Derive a key from a passphrase, running until msec time has elapsed.

Parameters
outbuffer to store the derived key, must be of out_len bytes
out_lenthe desired length of the key to produce
passphrasethe password to derive the key from
salta randomly chosen salt
salt_lenlength of salt in bytes
msecif iterations is zero, then instead the PBKDF is run until msec milliseconds has passed.
iterationsset to the number iterations executed

Definition at line 70 of file pbkdf.cpp.

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

References Botan::PBKDF::pbkdf().

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

◆ providers()

std::vector< std::string > Botan::PBKDF::providers ( std::string_view  algo_spec)
staticinherited
Returns
list of available providers for this algorithm, empty if not available

Definition at line 66 of file pbkdf.cpp.

66 {
67 return probe_providers_of<PBKDF>(algo_spec);
68}

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