Debian Codegraph @

upstream/debian-unstable/man7/EVP_KDF-KB.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-KB 7SSL"
58 .TH EVP_KDF-KB 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\-KB \- The Key\-Based EVP_KDF implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 The EVP_KDF\-KB algorithm implements the Key-Based key derivation function
68 (KBKDF). KBKDF derives a key from repeated application of a keyed MAC to an
69 input secret (and other optional values).
70 .PP
71 The output is considered to be keying material.
72 .SS Identity
73 .IX Subsection "Identity"
74 "KBKDF" is the name for this implementation; it can be used with the
75 \&\fBEVP_KDF_fetch()\fR function.
76 .SS "Supported parameters"
77 .IX Subsection "Supported parameters"
78 The supported parameters are:
79 .IP """mode"" (\fBOSSL_KDF_PARAM_MODE\fR) <UTF8 string>" 4
80 .IX Item """mode"" (OSSL_KDF_PARAM_MODE) <UTF8 string>"
81 The mode parameter determines which flavor of KBKDF to use \- currently the
82 choices are "counter" and "feedback". "counter" is the default, and will be
83 used if unspecified.
84 .IP """mac"" (\fBOSSL_KDF_PARAM_MAC\fR) <UTF8 string>" 4
85 .IX Item """mac"" (OSSL_KDF_PARAM_MAC) <UTF8 string>"
86 The value is either CMAC, HMAC, KMAC128 or KMAC256.
87 .IP """digest"" (\fBOSSL_KDF_PARAM_DIGEST\fR) <UTF8 string>" 4
88 .IX Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>"
89 .PD 0
90 .IP """cipher"" (\fBOSSL_KDF_PARAM_CIPHER\fR) <UTF8 string>" 4
91 .IX Item """cipher"" (OSSL_KDF_PARAM_CIPHER) <UTF8 string>"
92 .IP """properties"" (\fBOSSL_KDF_PARAM_PROPERTIES\fR) <UTF8 string>" 4
93 .IX Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>"
94 .IP """key"" (\fBOSSL_KDF_PARAM_KEY\fR) <octet string>" 4
95 .IX Item """key"" (OSSL_KDF_PARAM_KEY) <octet string>"
96 .IP """salt"" (\fBOSSL_KDF_PARAM_SALT\fR) <octet string>" 4
97 .IX Item """salt"" (OSSL_KDF_PARAM_SALT) <octet string>"
98 .IP """info (\fBOSSL_KDF_PARAM_INFO\fR) <octet string>" 4
99 .IX Item """info (OSSL_KDF_PARAM_INFO) <octet string>"
100 .IP """seed"" (\fBOSSL_KDF_PARAM_SEED\fR) <octet string>" 4
101 .IX Item """seed"" (OSSL_KDF_PARAM_SEED) <octet string>"
102 .PD
103 The seed parameter is unused in counter mode.
104 .IP """use-l"" (\fBOSSL_KDF_PARAM_KBKDF_USE_L\fR) <integer>" 4
105 .IX Item """use-l"" (OSSL_KDF_PARAM_KBKDF_USE_L) <integer>"
106 Set to \fB0\fR to disable use of the optional Fixed Input data 'L' (see SP800\-108).
107 The default value of \fB1\fR will be used if unspecified.
108 .IP """use-separator"" (\fBOSSL_KDF_PARAM_KBKDF_USE_SEPARATOR\fR) <integer>" 4
109 .IX Item """use-separator"" (OSSL_KDF_PARAM_KBKDF_USE_SEPARATOR) <integer>"
110 Set to \fB0\fR to disable use of the optional Fixed Input data 'zero separator'
111 (see SP800\-108) that is placed between the Label and Context.
112 The default value of \fB1\fR will be used if unspecified.
113 .IP """r"" (\fBOSSL_KDF_PARAM_KBKDF_R\fR) <integer>" 4
114 .IX Item """r"" (OSSL_KDF_PARAM_KBKDF_R) <integer>"
115 Set the fixed value 'r', indicating the length of the counter in bits.
116 .Sp
117 Supported values are \fB8\fR, \fB16\fR, \fB24\fR, and \fB32\fR.
118 The default value of \fB32\fR will be used if unspecified.
119 .PP
120 The OpenSSL FIPS provider also supports the following parameters:
121 .IP """fips-indicator"" (\fBOSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
122 .IX Item """fips-indicator"" (OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
123 A getter that returns 1 if the operation is FIPS approved, or 0 otherwise.
124 This may be used after calling EVP_KDF_derive. It returns 0 if "key-check"
125 is set to 0 and the check fails.
126 .IP """key-check"" (\fBOSSL_KDF_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
127 .IX Item """key-check"" (OSSL_KDF_PARAM_FIPS_KEY_CHECK) <integer>"
128 The default value of 1 causes an error during \fBEVP_KDF_CTX_set_params()\fR if the
129 length of used key-derivation key (\fBOSSL_KDF_PARAM_KEY\fR) is shorter than 112
130 bits.
131 Setting this to zero will ignore the error and set the approved
132 "fips-indicator" to 0.
133 This option breaks FIPS compliance if it causes the approved "fips-indicator"
134 to return 0.
135 .PP
136 Depending on whether mac is CMAC or HMAC, either digest or cipher is required
137 (respectively) and the other is unused. They are unused for KMAC128 and KMAC256.
138 .PP
139 The parameters key, salt, info, and seed correspond to KI, Label, Context, and
140 IV (respectively) in SP800\-108. As in that document, salt, info, and seed are
141 optional and may be omitted.
142 .PP
143 "mac", "digest", cipher" and "properties" are described in
144 "PARAMETERS" in \fBEVP_KDF\fR\|(3).
145 .SH NOTES
146 .IX Header "NOTES"
147 A context for KBKDF can be obtained by calling:
148 .PP
149 .Vb 2
150 \& EVP_KDF *kdf = EVP_KDF_fetch(NULL, "KBKDF", NULL);
151 \& EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf);
152 .Ve
153 .PP
154 The output length of an KBKDF is specified via the \f(CW\*(C`keylen\*(C'\fR
155 parameter to the \fBEVP_KDF_derive\fR\|(3) function.
156 .PP
157 Note that currently OpenSSL only implements counter and feedback modes. Other
158 variants may be supported in the future.
159 .SH EXAMPLES
160 .IX Header "EXAMPLES"
161 This example derives 10 bytes using COUNTER\-HMAC\-SHA256, with KI "secret",
162 Label "label", and Context "context".
163 .PP
164 .Vb 4
165 \& EVP_KDF *kdf;
166 \& EVP_KDF_CTX *kctx;
167 \& unsigned char out[10];
168 \& OSSL_PARAM params[6], *p = params;
169 \&
170 \& kdf = EVP_KDF_fetch(NULL, "KBKDF", NULL);
171 \& kctx = EVP_KDF_CTX_new(kdf);
172 \& EVP_KDF_free(kdf);
173 \&
174 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
175 \& "SHA2\-256", 0);
176 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_MAC,
177 \& "HMAC", 0);
178 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
179 \& "secret", strlen("secret"));
180 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
181 \& "label", strlen("label"));
182 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
183 \& "context", strlen("context"));
184 \& *p = OSSL_PARAM_construct_end();
185 \& if (EVP_KDF_derive(kctx, out, sizeof(out), params) <= 0)
186 \& error("EVP_KDF_derive");
187 \&
188 \& EVP_KDF_CTX_free(kctx);
189 .Ve
190 .PP
191 This example derives 10 bytes using FEEDBACK\-CMAC\-AES256, with KI "secret",
192 Label "label", and IV "sixteen bytes iv".
193 .PP
194 .Vb 5
195 \& EVP_KDF *kdf;
196 \& EVP_KDF_CTX *kctx;
197 \& unsigned char out[10];
198 \& OSSL_PARAM params[8], *p = params;
199 \& unsigned char *iv = "sixteen bytes iv";
200 \&
201 \& kdf = EVP_KDF_fetch(NULL, "KBKDF", NULL);
202 \& kctx = EVP_KDF_CTX_new(kdf);
203 \& EVP_KDF_free(kdf);
204 \&
205 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_CIPHER, "AES256", 0);
206 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_MAC, "CMAC", 0);
207 \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_MODE, "FEEDBACK", 0);
208 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_KEY,
209 \& "secret", strlen("secret"));
210 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SALT,
211 \& "label", strlen("label"));
212 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
213 \& "context", strlen("context"));
214 \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
215 \& iv, strlen(iv));
216 \& *p = OSSL_PARAM_construct_end();
217 \& if (EVP_KDF_derive(kctx, out, sizeof(out), params) <= 0)
218 \& error("EVP_KDF_derive");
219 \&
220 \& EVP_KDF_CTX_free(kctx);
221 .Ve
222 .SH "CONFORMING TO"
223 .IX Header "CONFORMING TO"
224 NIST SP800\-108, IETF RFC 6803, IETF RFC 8009.
225 .SH "SEE ALSO"
226 .IX Header "SEE ALSO"
227 \&\fBEVP_KDF\fR\|(3),
228 \&\fBEVP_KDF_CTX_free\fR\|(3),
229 \&\fBEVP_KDF_CTX_get_kdf_size\fR\|(3),
230 \&\fBEVP_KDF_derive\fR\|(3),
231 "PARAMETERS" in \fBEVP_KDF\fR\|(3)
232 .SH HISTORY
233 .IX Header "HISTORY"
234 This functionality was added in OpenSSL 3.0.
235 .PP
236 Support for KMAC was added in OpenSSL 3.1.
237 .SH COPYRIGHT
238 .IX Header "COPYRIGHT"
239 Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved.
240 Copyright 2019 Red Hat, Inc.
241 .PP
242 Licensed under the Apache License 2.0 (the "License"). You may not use
243 this file except in compliance with the License. You can obtain a copy
244 in the file LICENSE in the source distribution or at
245 <https://www.openssl.org/source/license.html>.