Debian Codegraph @

upstream/debian-unstable/man7/EVP_KDF-PBKDF1.7ssl

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 "EVP_KDF-PBKDF1 7SSL"
58 .TH EVP_KDF-PBKDF1 7SSL 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 EVP_KDF\-PBKDF1 \- The PBKDF1 EVP_KDF implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for computing the \fBPBKDF1\fR password-based KDF through the \fBEVP_KDF\fR
68 API.
69 .PP
70 The EVP_KDF\-PBKDF1 algorithm implements the PBKDF1 password-based key
71 derivation function, as described in RFC 8018; it derives a key from a password
72 using a salt and iteration count.
73 .SS Identity
74 .IX Subsection "Identity"
75 "PBKDF1" is the name for this implementation; it
76 can be used with the \fBEVP_KDF_fetch()\fR function.
77 .SS "Supported parameters"
78 .IX Subsection "Supported parameters"
79 The supported parameters are:
80 .IP """pass"" (\fBOSSL_KDF_PARAM_PASSWORD\fR) <octet string>" 4
81 .IX Item """pass"" (OSSL_KDF_PARAM_PASSWORD) <octet string>"
82 .PD 0
83 .IP """salt"" (\fBOSSL_KDF_PARAM_SALT\fR) <octet string>" 4
84 .IX Item """salt"" (OSSL_KDF_PARAM_SALT) <octet string>"
85 .IP """iter"" (\fBOSSL_KDF_PARAM_ITER\fR) <unsigned integer>" 4
86 .IX Item """iter"" (OSSL_KDF_PARAM_ITER) <unsigned integer>"
87 .PD
88 This parameter has a default value of 0 and should be set.
89 .IP """properties"" (\fBOSSL_KDF_PARAM_PROPERTIES\fR) <UTF8 string>" 4
90 .IX Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>"
91 .PD 0
92 .IP """digest"" (\fBOSSL_KDF_PARAM_DIGEST\fR) <UTF8 string>" 4
93 .IX Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>"
94 .PD
95 These parameters work as described in "PARAMETERS" in \fBEVP_KDF\fR\|(3).
96 .SH NOTES
97 .IX Header "NOTES"
98 A typical application of this algorithm is to derive keying material for an
99 encryption algorithm from a password in the "pass", a salt in "salt",
100 and an iteration count.
101 .PP
102 Increasing the "iter" parameter slows down the algorithm which makes it
103 harder for an attacker to perform a brute force attack using a large number
104 of candidate passwords.
105 .PP
106 No assumption is made regarding the given password; it is simply treated as a
107 byte sequence.
108 .PP
109 The legacy provider needs to be available in order to access this algorithm.
110 .SH "CONFORMING TO"
111 .IX Header "CONFORMING TO"
112 RFC 8018
113 .SH "SEE ALSO"
114 .IX Header "SEE ALSO"
115 \&\fBEVP_KDF\fR\|(3),
116 \&\fBEVP_KDF_CTX_new\fR\|(3),
117 \&\fBEVP_KDF_CTX_free\fR\|(3),
118 \&\fBEVP_KDF_CTX_set_params\fR\|(3),
119 \&\fBEVP_KDF_derive\fR\|(3),
120 "PARAMETERS" in \fBEVP_KDF\fR\|(3),
121 \&\fBOSSL_PROVIDER\-legacy\fR\|(7)
122 .SH HISTORY
123 .IX Header "HISTORY"
124 This functionality was added in OpenSSL 3.0.
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.