1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "PKCS5_PBKDF2_HMAC 3"
132 .TH PKCS5_PBKDF2_HMAC 3 "2018-11-20" "1.1.1a" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 PKCS5_PBKDF2_HMAC, PKCS5_PBKDF2_HMAC_SHA1 \- password based derivation routines with salt and iteration count
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/evp.h>
144 \& int PKCS5_PBKDF2_HMAC(const char *pass, int passlen,
145 \& const unsigned char *salt, int saltlen, int iter,
146 \& const EVP_MD *digest,
147 \& int keylen, unsigned char *out);
149 \& int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
150 \& const unsigned char *salt, int saltlen, int iter,
151 \& int keylen, unsigned char *out);
154 .IX Header "DESCRIPTION"
155 \&\s-1\fIPKCS5_PBKDF2_HMAC\s0()\fR derives a key from a password using a salt and iteration count
156 as specified in \s-1RFC 2898.\s0
158 \&\fBpass\fR is the password used in the derivation of length \fBpasslen\fR. \fBpass\fR
159 is an optional parameter and can be \s-1NULL.\s0 If \fBpasslen\fR is \-1, then the
160 function will calculate the length of \fBpass\fR using \fIstrlen()\fR.
162 \&\fBsalt\fR is the salt used in the derivation of length \fBsaltlen\fR. If the
163 \&\fBsalt\fR is \s-1NULL,\s0 then \fBsaltlen\fR must be 0. The function will not
164 attempt to calculate the length of the \fBsalt\fR because it is not assumed to
165 be \s-1NULL\s0 terminated.
167 \&\fBiter\fR is the iteration count and its value should be greater than or
168 equal to 1. \s-1RFC 2898\s0 suggests an iteration count of at least 1000. Any
169 \&\fBiter\fR less than 1 is treated as a single iteration.
171 \&\fBdigest\fR is the message digest function used in the derivation. Values include
172 any of the EVP_* message digests. \s-1\fIPKCS5_PBKDF2_HMAC_SHA1\s0()\fR calls
173 \&\s-1\fIPKCS5_PBKDF2_HMAC\s0()\fR with \fIEVP_sha1()\fR.
175 The derived key will be written to \fBout\fR. The size of the \fBout\fR buffer
176 is specified via \fBkeylen\fR.
179 A typical application of this function is to derive keying material for an
180 encryption algorithm from a password in the \fBpass\fR, a salt in \fBsalt\fR,
181 and an iteration count.
183 Increasing the \fBiter\fR parameter slows down the algorithm which makes it
184 harder for an attacker to perform a brute force attack using a large number
185 of candidate passwords.
187 These functions make no assumption regarding the given password.
188 It will simply be treated as a byte sequence.
190 .IX Header "RETURN VALUES"
191 \&\s-1\fIPKCS5_PBKDF2_HMAC\s0()\fR and \s-1\fIPBKCS5_PBKDF2_HMAC_SHA1\s0()\fR return 1 on success or 0 on error.
193 .IX Header "SEE ALSO"
194 \&\fIevp\fR\|(7), \fIRAND_bytes\fR\|(3),
195 \&\fIEVP_BytesToKey\fR\|(3),
196 \&\fIpassphrase\-encoding\fR\|(7)
198 .IX Header "COPYRIGHT"
199 Copyright 2014\-2018 The OpenSSL Project Authors. All Rights Reserved.
201 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
202 this file except in compliance with the License. You can obtain a copy
203 in the file \s-1LICENSE\s0 in the source distribution or at
204 <https://www.openssl.org/source/license.html>.