4674aaf4f2
3.0.0 is a habit from pre-3.0 OpenSSL, which doesn't make sense with the new version scheme. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9376)
107 lines
2.4 KiB
Text
107 lines
2.4 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_KDF_PBKDF2 - The PBKDF2 EVP_KDF implementation
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Support for computing the B<PBKDF2> password-based KDF through the B<EVP_KDF>
|
|
API.
|
|
|
|
The EVP_KDF_PBKDF2 algorithm implements the PBKDF2 password-based key
|
|
derivation function, as described in SP800-132; it derives a key from a password
|
|
using a salt and iteration count.
|
|
|
|
=head2 Numeric identity
|
|
|
|
B<EVP_KDF_PBKDF2> is the numeric identity for this implementation; it
|
|
can be used with the EVP_KDF_CTX_new_id() function.
|
|
|
|
=head2 Supported controls
|
|
|
|
The supported controls are:
|
|
|
|
=over 4
|
|
|
|
=item B<EVP_KDF_CTRL_SET_PASS>
|
|
|
|
=item B<EVP_KDF_CTRL_SET_SALT>
|
|
|
|
=item B<EVP_KDF_CTRL_SET_ITER>
|
|
|
|
This control has a default value of 2048.
|
|
|
|
=item B<EVP_KDF_CTRL_SET_MD>
|
|
|
|
These controls work as described in L<EVP_KDF_CTX(3)/CONTROLS>.
|
|
|
|
=item B<EVP_KDF_CTRL_SET_PBKDF2_PKCS5_MODE>
|
|
|
|
This control expects one argument: C<int mode>
|
|
|
|
This control can be used to enable or disable SP800-132 compliance checks.
|
|
|
|
Setting the mode to 0 enables the compliance checks.
|
|
|
|
The checks performed are:
|
|
|
|
=over 4
|
|
|
|
=item - the iteration count is at least 1000.
|
|
|
|
=item - the salt length is at least 128 bits.
|
|
|
|
=item - the derived key length is at least 112 bits.
|
|
|
|
=back
|
|
|
|
The default provider uses a default mode of 1 for backwards compatibility,
|
|
and the fips provider uses a default mode of 0.
|
|
|
|
EVP_KDF_ctrl_str() type string: "pkcs5"
|
|
|
|
The value string is expected to be a decimal number 0 or 1.
|
|
|
|
=back
|
|
|
|
=head1 NOTES
|
|
|
|
A typical application of this algorithm is to derive keying material for an
|
|
encryption algorithm from a password in the B<pass>, a salt in B<salt>,
|
|
and an iteration count.
|
|
|
|
Increasing the B<iter> parameter slows down the algorithm which makes it
|
|
harder for an attacker to perform a brute force attack using a large number
|
|
of candidate passwords.
|
|
|
|
No assumption is made regarding the given password; it is simply treated as a
|
|
byte sequence.
|
|
|
|
=head1 CONFORMING TO
|
|
|
|
SP800-132
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<EVP_KDF_CTX>,
|
|
L<EVP_KDF_CTX_new_id(3)>,
|
|
L<EVP_KDF_CTX_free(3)>,
|
|
L<EVP_KDF_ctrl(3)>,
|
|
L<EVP_KDF_derive(3)>,
|
|
L<EVP_KDF_CTX(3)/CONTROLS>
|
|
|
|
=head1 HISTORY
|
|
|
|
This functionality was added to OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|