ba322d40c6d294143e24efa417bea3d2e86c54de
[openssl.git] / doc / man7 / EVP_KDF_PBKDF2.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_KDF_PBKDF2 - The PBKDF2 EVP_KDF implementation
6
7 =head1 DESCRIPTION
8
9 Support for computing the B<PBKDF2> password-based KDF through the B<EVP_KDF>
10 API.
11
12 The EVP_KDF_PBKDF2 algorithm implements the PBKDF2 password-based key
13 derivation function, as described in RFC 2898; it derives a key from a password
14 using a salt and iteration count.
15
16 =head2 Numeric identity
17
18 B<EVP_KDF_PBKDF2> is the numeric identity for this implementation; it
19 can be used with the EVP_KDF_CTX_new_id() function.
20
21 =head2 Supported controls
22
23 The supported controls are:
24
25 =over 4
26
27 =item B<EVP_KDF_CTRL_SET_PASS>
28
29 =item B<EVP_KDF_CTRL_SET_SALT>
30
31 =item B<EVP_KDF_CTRL_SET_ITER>
32
33 =item B<EVP_KDF_CTRL_SET_MD>
34
35 These controls work as described in L<EVP_KDF_CTX(3)/CONTROLS>.
36
37 B<iter> is the iteration count and its value should be greater than or equal to
38 1. RFC 2898 suggests an iteration count of at least 1000.  The default value is
39 2048.  Any B<iter> less than 1 is treated as a single iteration.
40
41 =back
42
43 =head1 NOTES
44
45 A typical application of this algorithm is to derive keying material for an
46 encryption algorithm from a password in the B<pass>, a salt in B<salt>,
47 and an iteration count.
48
49 Increasing the B<iter> parameter slows down the algorithm which makes it
50 harder for an attacker to perform a brute force attack using a large number
51 of candidate passwords.
52
53 No assumption is made regarding the given password; it is simply treated as a
54 byte sequence.
55
56 =head1 CONFORMING TO
57
58 RFC 2898
59
60 =head1 SEE ALSO
61
62 L<EVP_KDF_CTX>,
63 L<EVP_KDF_CTX_new_id(3)>,
64 L<EVP_KDF_CTX_free(3)>,
65 L<EVP_KDF_ctrl(3)>,
66 L<EVP_KDF_derive(3)>,
67 L<EVP_KDF_CTX(3)/CONTROLS>
68
69 =head1 COPYRIGHT
70
71 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
72
73 Licensed under the Apache License 2.0 (the "License").  You may not use
74 this file except in compliance with the License.  You can obtain a copy
75 in the file LICENSE in the source distribution or at
76 L<https://www.openssl.org/source/license.html>.
77
78 =cut