f8914db3e2c5910422cc2506068db9d09631f463
[openssl.git] / doc / crypto / PKCS5_PBKDF2_HMAC.pod
1 =pod
2
3 =head1 NAME
4
5 PKCS5_PBKDF2_HMAC - password based derivation routine 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 =head1 DESCRIPTION
17
18 PKCS5_PBKDF2_HMAC() derives a key from a password using a salt and iteration count
19 as specified in RFC 2898.
20
21 B<pass> is the password used in the derivation of length B<passlen>. B<pass>
22 is an optional parameter and can be NULL. If B<passlen> is -1, then the
23 function will calculate the length of B<pass> using strlen().
24
25 B<salt> is the salt used in the derivation of length B<saltlen>. If the
26 B<salt> is NULL, then B<saltlen> must be 0. The function will not
27 attempt to calculate the length of the B<salt> because its not assumed to
28 be NULL terminated.
29
30 B<iter> is the iteration count and its value should be greater than or 
31 equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any
32 B<iter> less than 1 is treated as a single iteration.
33
34 B<digest> is message digest function used in the derivation. Values include
35 any of the EVP_* message digests. PKCS5_PBKDF2_HMAC_SHA1() calls
36 PKCS5_PBKDF2_HMAC() with EVP_sha1().
37
38 The derived key will be written to B<out>. The size of the B<out> buffer
39 is specified via B<keylen>.
40
41 =head1 NOTES
42
43 A typical application of this function is to derive keying material for an
44 encryption algorithm from a password in the B<pass>, a salt in B<salt>,
45 and an iteration count.
46
47 Increasing the B<iter> parameter slows down the algorithm which makes it
48 harder for an attacker to peform a brute force attack using a large number
49 of candidate passwords.
50
51 =head1 RETURN VALUES
52
53 PKCS5_PBKDF2_HMAC() returns 1 on success or 0 on error.
54
55 =head1 SEE ALSO
56
57 L<evp(3)|evp(3)>, L<rand(3)|rand(3)>,
58 L<EVP_BytesToKey(3)|EVP_BytesToKey(3)>
59
60 =head1 HISTORY
61
62 =cut