xref: /freebsd/crypto/openssl/doc/man3/PKCS5_PBKDF2_HMAC.pod (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
1=pod
2
3=head1 NAME
4
5PKCS5_PBKDF2_HMAC, PKCS5_PBKDF2_HMAC_SHA1 - password based derivation routines with salt and iteration count
6
7=head1 SYNOPSIS
8
9 #include <openssl/evp.h>
10
11 int PKCS5_PBKDF2_HMAC(const char *pass, int passlen,
12                       const unsigned char *salt, int saltlen, int iter,
13                       const EVP_MD *digest,
14                       int keylen, unsigned char *out);
15
16 int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
17                            const unsigned char *salt, int saltlen, int iter,
18                            int keylen, unsigned char *out);
19
20=head1 DESCRIPTION
21
22PKCS5_PBKDF2_HMAC() derives a key from a password using a salt and iteration count
23as specified in RFC 2898.
24
25B<pass> is the password used in the derivation of length B<passlen>. B<pass>
26is an optional parameter and can be NULL. If B<passlen> is -1, then the
27function will calculate the length of B<pass> using strlen().
28
29B<salt> is the salt used in the derivation of length B<saltlen>. If the
30B<salt> is NULL, then B<saltlen> must be 0. The function will not
31attempt to calculate the length of the B<salt> because it is not assumed to
32be NULL terminated.
33
34B<iter> is the iteration count and its value should be greater than or
35equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any
36B<iter> less than 1 is treated as a single iteration.
37
38B<digest> is the message digest function used in the derivation.
39PKCS5_PBKDF2_HMAC_SHA1() calls PKCS5_PBKDF2_HMAC() with EVP_sha1().
40
41The derived key will be written to B<out>. The size of the B<out> buffer
42is specified via B<keylen>.
43
44=head1 NOTES
45
46A typical application of this function is to derive keying material for an
47encryption algorithm from a password in the B<pass>, a salt in B<salt>,
48and an iteration count.
49
50Increasing the B<iter> parameter slows down the algorithm which makes it
51harder for an attacker to perform a brute force attack using a large number
52of candidate passwords.
53
54These functions make no assumption regarding the given password.
55It will simply be treated as a byte sequence.
56
57=head1 RETURN VALUES
58
59PKCS5_PBKDF2_HMAC() and PBKCS5_PBKDF2_HMAC_SHA1() return 1 on success or 0 on error.
60
61=head1 SEE ALSO
62
63L<evp(7)>, L<RAND_bytes(3)>,
64L<EVP_BytesToKey(3)>,
65L<passphrase-encoding(7)>
66
67=head1 COPYRIGHT
68
69Copyright 2014-2021 The OpenSSL Project Authors. All Rights Reserved.
70
71Licensed under the Apache License 2.0 (the "License").  You may not use
72this file except in compliance with the License.  You can obtain a copy
73in the file LICENSE in the source distribution or at
74L<https://www.openssl.org/source/license.html>.
75
76=cut
77