Botan 3.6.1
Crypto and TLS for C&
|
#include <scrypt.h>
Public Member Functions | |
std::unique_ptr< PasswordHash > | default_params () const override |
std::unique_ptr< PasswordHash > | from_iterations (size_t iter) const override |
std::unique_ptr< PasswordHash > | from_params (size_t N, size_t r, size_t p) const override |
std::string | name () const override |
std::unique_ptr< PasswordHash > | tune (size_t output_length, std::chrono::milliseconds msec, size_t max_memory, std::chrono::milliseconds tune_msec) const override |
Static Public Member Functions | |
static std::unique_ptr< PasswordHashFamily > | create (std::string_view algo_spec, std::string_view provider="") |
static std::unique_ptr< PasswordHashFamily > | create_or_throw (std::string_view algo_spec, std::string_view provider="") |
static std::vector< std::string > | providers (std::string_view algo_spec) |
|
staticinherited |
Create an instance based on a name If provider is empty then best available is chosen.
algo_spec | algorithm name |
provider | provider implementation to choose |
Definition at line 53 of file pwdhash.cpp.
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_pwdhash(), botan_pwdhash_timed(), and Botan::PasswordHashFamily::create_or_throw().
|
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 109 of file pwdhash.cpp.
References Botan::PasswordHashFamily::create().
Referenced by Botan::argon2_check_pwhash(), Botan::argon2_generate_pwhash(), Botan::CryptoBox::decrypt_bin(), and Botan::CryptoBox::encrypt().
|
overridevirtual |
Return some default parameter set for this PBKDF that should be good enough for most users. The value returned may change over time as processing power and attacks improve.
Implements Botan::PasswordHashFamily.
Definition at line 32 of file scrypt.cpp.
Referenced by tune().
|
overridevirtual |
Return a parameter chosen based on a rough approximation with the specified iteration count. The exact value this returns for a particular algorithm may change from over time. Think of it as an alternative to tune, where time is expressed in terms of PBKDF2 iterations rather than milliseconds.
Implements Botan::PasswordHashFamily.
Definition at line 118 of file scrypt.cpp.
|
overridevirtual |
Create a password hash using some scheme specific format. Parameters are as follows:
All unneeded parameters should be set to 0 or left blank.
Implements Botan::PasswordHashFamily.
Definition at line 114 of file scrypt.cpp.
Referenced by tune().
|
overridevirtual |
Implements Botan::PasswordHashFamily.
Definition at line 28 of file scrypt.cpp.
|
staticinherited |
Definition at line 117 of file pwdhash.cpp.
References Botan::probe_providers_of().
|
overridevirtual |
Return a new parameter set tuned for this machine
Return a password hash instance tuned to run for approximately msec
milliseconds when producing an output of length output_length
. (Accuracy may vary, use the command line utility botan pbkdf_tune
to check.)
The parameters will be selected to use at most max_memory_usage_mb
megabytes of memory, or if left as zero any size is allowed.
This function works by runing a short tuning loop to estimate the performance of the algorithm, then scaling the parameters appropriately to hit the target size. The length of time the tuning loop runs can be controlled using the tuning_msec
parameter.
output_length | how long the output length will be |
msec | the desired execution time in milliseconds |
max_memory_usage_mb | some password hash functions can use a tunable amount of memory, in this case max_memory_usage limits the amount of RAM the returned parameters will require, in mebibytes (2**20 bytes). It may require some small amount above the request. Set to zero to place no limit at all. |
tuning_msec | how long to run the tuning loop |
Implements Botan::PasswordHashFamily.
Definition at line 36 of file scrypt.cpp.
References BOTAN_UNUSED, default_params(), Botan::Timer::events(), from_params(), Botan::Timer::run_until_elapsed(), and Botan::Timer::value().