Debian Codegraph @

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