blob: 210e00349e58c1d1e661967d4b6d3e4c45b0192a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
.\" $OpenBSD: PKCS5_PBKDF2_HMAC.3,v 1.3 2016/11/21 09:56:35 schwarze Exp $
.\"
.Dd $Mdocdate: November 21 2016 $
.Dt PKCS5_PBKDF2_HMAC 3
.Os
.Sh NAME
.Nm PKCS5_PBKDF2_HMAC ,
.Nm PKCS5_PBKDF2_HMAC_SHA1
.Nd password based derivation routines with salt and iteration count
.Sh SYNOPSIS
.In openssl/evp.h
.Ft int
.Fo PKCS5_PBKDF2_HMAC
.Fa "const char *pass"
.Fa "int passlen"
.Fa "const unsigned char *salt"
.Fa "int saltlen"
.Fa "int iter"
.Fa "const EVP_MD *digest"
.Fa "int keylen"
.Fa "unsigned char *out"
.Fc
.Ft int
.Fo PKCS5_PBKDF2_HMAC_SHA1
.Fa "const char *pass"
.Fa "int passlen"
.Fa "const unsigned char *salt"
.Fa "int saltlen"
.Fa "int iter"
.Fa "int keylen"
.Fa "unsigned char *out"
.Fc
.Sh DESCRIPTION
.Fn PKCS5_PBKDF2_HMAC
derives a key from a password using a salt and iteration count as
specified in RFC 2898.
.Pp
.Fa pass
is the password used in the derivation of length
.Fa passlen .
.Fa pass
is an optional parameter and can be
.Dv NULL .
If
.Fa passlen
is -1, then the function will calculate the length of
.Fa pass
using
.Xr strlen 3 .
.Pp
.Fa salt
is the salt used in the derivation of length
.Fa saltlen .
If the
.Fa salt
is
.Dv NULL ,
then
.Fa saltlen
must be 0.
The function will not attempt to calculate the length of the
.Fa salt
because it is not assumed to be NUL terminated.
.Pp
.Fa iter
is the iteration count and its value should be greater than or equal to 1.
RFC 2898 suggests an iteration count of at least 1000.
Any
.Fa iter
less than 1 is treated as a single iteration.
.Pp
.Fa digest
is the message digest function used in the derivation.
Values include any of the EVP_* message digests.
.Fn PKCS5_PBKDF2_HMAC_SHA1
calls
.Fn PKCS5_PBKDF2_HMAC
with
.Xr EVP_sha1 3 .
.Pp
The derived key will be written to
.Fa out .
The size of the
.Fa out
buffer is specified via
.Fa keylen .
.Pp
A typical application of this function is to derive keying material for
an encryption algorithm from a password in the
.Fa pass ,
a salt in
.Fa salt ,
and an iteration count.
.Pp
Increasing the
.Fa 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.
.Sh RETURN VALUES
.Fn PKCS5_PBKDF2_HMAC
and
.Fn PBKCS5_PBKDF2_HMAC_SHA1
return 1 on success or 0 on error.
.Sh SEE ALSO
.Xr evp 3 ,
.Xr EVP_BytesToKey 3 ,
.Xr RAND_bytes 3
|
