Debian Codegraph @

upstream/debian-unstable/man3/PKCS5_PBKDF2_HMAC.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PKCS5_PBKDF2_HMAC 3SSL"
58 .TH PKCS5_PBKDF2_HMAC 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 PKCS5_PBKDF2_HMAC, PKCS5_PBKDF2_HMAC_SHA1 \- password based derivation routines with salt and iteration count
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/evp.h>
69 \&
70 \& int PKCS5_PBKDF2_HMAC(const char *pass, int passlen,
71 \& const unsigned char *salt, int saltlen, int iter,
72 \& const EVP_MD *digest,
73 \& int keylen, unsigned char *out);
74 \&
75 \& int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen,
76 \& const unsigned char *salt, int saltlen, int iter,
77 \& int keylen, unsigned char *out);
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\fBPKCS5_PBKDF2_HMAC()\fR derives a key from a password using a salt and iteration count
82 as specified in RFC 2898.
83 .PP
84 \&\fBpass\fR is the password used in the derivation of length \fBpasslen\fR. \fBpass\fR
85 is an optional parameter and can be NULL. If \fBpasslen\fR is \-1, then the
86 function will calculate the length of \fBpass\fR using \fBstrlen()\fR.
87 .PP
88 \&\fBsalt\fR is the salt used in the derivation of length \fBsaltlen\fR. If the
89 \&\fBsalt\fR is NULL, then \fBsaltlen\fR must be 0. The function will not
90 attempt to calculate the length of the \fBsalt\fR because it is not assumed to
91 be NULL terminated.
92 .PP
93 \&\fBiter\fR is the iteration count and its value should be greater than or
94 equal to 1. RFC 2898 suggests an iteration count of at least 1000. Any
95 \&\fBiter\fR value less than 1 is invalid; such values will result in failure
96 and raise the PROV_R_INVALID_ITERATION_COUNT error.
97 .PP
98 \&\fBdigest\fR is the message digest function used in the derivation.
99 \&\fBPKCS5_PBKDF2_HMAC_SHA1()\fR calls \fBPKCS5_PBKDF2_HMAC()\fR with \fBEVP_sha1()\fR.
100 .PP
101 The derived key will be written to \fBout\fR. The size of the \fBout\fR buffer
102 is specified via \fBkeylen\fR.
103 .SH NOTES
104 .IX Header "NOTES"
105 A typical application of this function is to derive keying material for an
106 encryption algorithm from a password in the \fBpass\fR, a salt in \fBsalt\fR,
107 and an iteration count.
108 .PP
109 Increasing the \fBiter\fR parameter slows down the algorithm which makes it
110 harder for an attacker to perform a brute force attack using a large number
111 of candidate passwords.
112 .PP
113 These functions make no assumption regarding the given password.
114 It will simply be treated as a byte sequence.
115 .SH "RETURN VALUES"
116 .IX Header "RETURN VALUES"
117 \&\fBPKCS5_PBKDF2_HMAC()\fR and \fBPBKCS5_PBKDF2_HMAC_SHA1()\fR return 1 on success or 0 on error.
118 .SH "SEE ALSO"
119 .IX Header "SEE ALSO"
120 \&\fBevp\fR\|(7), \fBRAND_bytes\fR\|(3),
121 \&\fBEVP_BytesToKey\fR\|(3),
122 \&\fBpassphrase\-encoding\fR\|(7)
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright 2014\-2021 The OpenSSL Project Authors. All Rights Reserved.
126 .PP
127 Licensed under the Apache License 2.0 (the "License"). You may not use
128 this file except in compliance with the License. You can obtain a copy
129 in the file LICENSE in the source distribution or at
130 <https://www.openssl.org/source/license.html>.