Debian Codegraph @

upstream/debian-unstable/man7/provider-keymgmt.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 "PROVIDER-KEYMGMT 7SSL"
58 .TH PROVIDER-KEYMGMT 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 provider\-keymgmt \- The KEYMGMT library <\-> provider functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/core_dispatch.h>
69 \&
70 \& /*
71 \& * None of these are actual functions, but are displayed like this for
72 \& * the function signatures for functions that are offered as function
73 \& * pointers in OSSL_DISPATCH arrays.
74 \& */
75 \&
76 \& /* Key object (keydata) creation and destruction */
77 \& void *OSSL_FUNC_keymgmt_new(void *provctx);
78 \& void OSSL_FUNC_keymgmt_free(void *keydata);
79 \&
80 \& /* Generation, a more complex constructor */
81 \& void *OSSL_FUNC_keymgmt_gen_init(void *provctx, int selection,
82 \& const OSSL_PARAM params[]);
83 \& int OSSL_FUNC_keymgmt_gen_set_template(void *genctx, void *template);
84 \& int OSSL_FUNC_keymgmt_gen_get_params(void *genctx, OSSL_PARAM params[]);
85 \& int OSSL_FUNC_keymgmt_gen_set_params(void *genctx, const OSSL_PARAM params[]);
86 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_gen_gettable_params(void *genctx,
87 \& void *provctx);
88 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_gen_settable_params(void *genctx,
89 \& void *provctx);
90 \& void *OSSL_FUNC_keymgmt_gen(void *genctx, OSSL_CALLBACK *cb, void *cbarg);
91 \& void OSSL_FUNC_keymgmt_gen_cleanup(void *genctx);
92 \&
93 \& /* Key loading by object reference, also a constructor */
94 \& void *OSSL_FUNC_keymgmt_load(const void *reference, size_t reference_sz);
95 \&
96 \& /* Key object information */
97 \& int OSSL_FUNC_keymgmt_get_params(void *keydata, OSSL_PARAM params[]);
98 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_gettable_params(void *provctx);
99 \& int OSSL_FUNC_keymgmt_set_params(void *keydata, const OSSL_PARAM params[]);
100 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_settable_params(void *provctx);
101 \&
102 \& /* Key object content checks */
103 \& int OSSL_FUNC_keymgmt_has(const void *keydata, int selection);
104 \& int OSSL_FUNC_keymgmt_match(const void *keydata1, const void *keydata2,
105 \& int selection);
106 \&
107 \& /* Discovery of supported operations */
108 \& const char *OSSL_FUNC_keymgmt_query_operation_name(int operation_id);
109 \&
110 \& /* Key object import and export functions */
111 \& int OSSL_FUNC_keymgmt_import(void *keydata, int selection, const OSSL_PARAM params[]);
112 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_import_types(int selection);
113 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_import_types_ex(void *provctx, int selection);
114 \& int OSSL_FUNC_keymgmt_export(void *keydata, int selection,
115 \& OSSL_CALLBACK *param_cb, void *cbarg);
116 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_export_types(int selection);
117 \& const OSSL_PARAM *OSSL_FUNC_keymgmt_export_types_ex(void *provctx, int selection);
118 \&
119 \& /* Key object duplication, a constructor */
120 \& void *OSSL_FUNC_keymgmt_dup(const void *keydata_from, int selection);
121 \&
122 \& /* Key object validation */
123 \& int OSSL_FUNC_keymgmt_validate(const void *keydata, int selection, int checktype);
124 .Ve
125 .SH DESCRIPTION
126 .IX Header "DESCRIPTION"
127 The KEYMGMT operation doesn't have much public visibility in OpenSSL
128 libraries, it's rather an internal operation that's designed to work
129 in tandem with operations that use private/public key pairs.
130 .PP
131 Because the KEYMGMT operation shares knowledge with the operations it
132 works with in tandem, they must belong to the same provider.
133 The OpenSSL libraries will ensure that they do.
134 .PP
135 The primary responsibility of the KEYMGMT operation is to hold the
136 provider side key data for the OpenSSL library EVP_PKEY structure.
137 .PP
138 All "functions" mentioned here are passed as function pointers between
139 \&\fIlibcrypto\fR and the provider in \fBOSSL_DISPATCH\fR\|(3) arrays via
140 \&\fBOSSL_ALGORITHM\fR\|(3) arrays that are returned by the provider's
141 \&\fBprovider_query_operation()\fR function
142 (see "Provider Functions" in \fBprovider\-base\fR\|(7)).
143 .PP
144 All these "functions" have a corresponding function type definition
145 named \fBOSSL_FUNC_{name}_fn\fR, and a helper function to retrieve the
146 function pointer from a \fBOSSL_DISPATCH\fR\|(3) element named
147 \&\fBOSSL_FUNC_{name}\fR.
148 For example, the "function" \fBOSSL_FUNC_keymgmt_new()\fR has these:
149 .PP
150 .Vb 3
151 \& typedef void *(OSSL_FUNC_keymgmt_new_fn)(void *provctx);
152 \& static ossl_inline OSSL_FUNC_keymgmt_new_fn
153 \& OSSL_FUNC_keymgmt_new(const OSSL_DISPATCH *opf);
154 .Ve
155 .PP
156 \&\fBOSSL_DISPATCH\fR\|(3) arrays are indexed by numbers that are provided as
157 macros in \fBopenssl\-core_dispatch.h\fR\|(7), as follows:
158 .PP
159 .Vb 2
160 \& OSSL_FUNC_keymgmt_new OSSL_FUNC_KEYMGMT_NEW
161 \& OSSL_FUNC_keymgmt_free OSSL_FUNC_KEYMGMT_FREE
162 \&
163 \& OSSL_FUNC_keymgmt_gen_init OSSL_FUNC_KEYMGMT_GEN_INIT
164 \& OSSL_FUNC_keymgmt_gen_set_template OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE
165 \& OSSL_FUNC_keymgmt_gen_get_params OSSL_FUNC_KEYMGMT_GEN_GET_PARAMS
166 \& OSSL_FUNC_keymgmt_gen_gettable_params OSSL_FUNC_KEYMGMT_GEN_GETTABLE_PARAMS
167 \& OSSL_FUNC_keymgmt_gen_set_params OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS
168 \& OSSL_FUNC_keymgmt_gen_settable_params OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS
169 \& OSSL_FUNC_keymgmt_gen OSSL_FUNC_KEYMGMT_GEN
170 \& OSSL_FUNC_keymgmt_gen_cleanup OSSL_FUNC_KEYMGMT_GEN_CLEANUP
171 \&
172 \& OSSL_FUNC_keymgmt_load OSSL_FUNC_KEYMGMT_LOAD
173 \&
174 \& OSSL_FUNC_keymgmt_get_params OSSL_FUNC_KEYMGMT_GET_PARAMS
175 \& OSSL_FUNC_keymgmt_gettable_params OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
176 \& OSSL_FUNC_keymgmt_set_params OSSL_FUNC_KEYMGMT_SET_PARAMS
177 \& OSSL_FUNC_keymgmt_settable_params OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS
178 \&
179 \& OSSL_FUNC_keymgmt_query_operation_name OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME
180 \&
181 \& OSSL_FUNC_keymgmt_has OSSL_FUNC_KEYMGMT_HAS
182 \& OSSL_FUNC_keymgmt_validate OSSL_FUNC_KEYMGMT_VALIDATE
183 \& OSSL_FUNC_keymgmt_match OSSL_FUNC_KEYMGMT_MATCH
184 \&
185 \& OSSL_FUNC_keymgmt_import OSSL_FUNC_KEYMGMT_IMPORT
186 \& OSSL_FUNC_keymgmt_import_types OSSL_FUNC_KEYMGMT_IMPORT_TYPES
187 \& OSSL_FUNC_keymgmt_import_types_ex OSSL_FUNC_KEYMGMT_IMPORT_TYPES_EX
188 \& OSSL_FUNC_keymgmt_export OSSL_FUNC_KEYMGMT_EXPORT
189 \& OSSL_FUNC_keymgmt_export_types OSSL_FUNC_KEYMGMT_EXPORT_TYPES
190 \& OSSL_FUNC_keymgmt_export_types_ex OSSL_FUNC_KEYMGMT_EXPORT_TYPES_EX
191 \&
192 \& OSSL_FUNC_keymgmt_dup OSSL_FUNC_KEYMGMT_DUP
193 .Ve
194 .SS "Key Objects"
195 .IX Subsection "Key Objects"
196 A key object is a collection of data for an asymmetric key, and is
197 represented as \fIkeydata\fR in this manual.
198 .PP
199 The exact contents of a key object are defined by the provider, and it
200 is assumed that different operations in one and the same provider use
201 the exact same structure to represent this collection of data, so that
202 for example, a key object that has been created using the KEYMGMT
203 interface that we document here can be passed as is to other provider
204 operations, such as \fBOP_signature_sign_init()\fR (see
205 \&\fBprovider\-signature\fR\|(7)).
206 .PP
207 With some of the KEYMGMT functions, it's possible to select a specific
208 subset of data to handle, governed by the bits in a \fIselection\fR
209 indicator. The bits are:
210 .IP \fBOSSL_KEYMGMT_SELECT_PRIVATE_KEY\fR 4
211 .IX Item "OSSL_KEYMGMT_SELECT_PRIVATE_KEY"
212 Indicating that the private key data in a key object should be
213 considered.
214 .IP \fBOSSL_KEYMGMT_SELECT_PUBLIC_KEY\fR 4
215 .IX Item "OSSL_KEYMGMT_SELECT_PUBLIC_KEY"
216 Indicating that the public key data in a key object should be
217 considered.
218 .IP \fBOSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\fR 4
219 .IX Item "OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS"
220 Indicating that the domain parameters in a key object should be
221 considered.
222 .IP \fBOSSL_KEYMGMT_SELECT_OTHER_PARAMETERS\fR 4
223 .IX Item "OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS"
224 Indicating that other parameters in a key object should be
225 considered.
226 .Sp
227 Other parameters are key parameters that don't fit any other
228 classification. In other words, this particular selector bit works as
229 a last resort bit bucket selector.
230 .PP
231 Some selector bits have also been combined for easier use:
232 .IP \fBOSSL_KEYMGMT_SELECT_ALL_PARAMETERS\fR 4
233 .IX Item "OSSL_KEYMGMT_SELECT_ALL_PARAMETERS"
234 Indicating that all key object parameters should be considered,
235 regardless of their more granular classification.
236 .Sp
237 This is a combination of \fBOSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\fR and
238 \&\fBOSSL_KEYMGMT_SELECT_OTHER_PARAMETERS\fR.
239 .IP \fBOSSL_KEYMGMT_SELECT_KEYPAIR\fR 4
240 .IX Item "OSSL_KEYMGMT_SELECT_KEYPAIR"
241 Indicating that both the whole key pair in a key object should be
242 considered, i.e. the combination of public and private key.
243 .Sp
244 This is a combination of \fBOSSL_KEYMGMT_SELECT_PRIVATE_KEY\fR and
245 \&\fBOSSL_KEYMGMT_SELECT_PUBLIC_KEY\fR.
246 .IP \fBOSSL_KEYMGMT_SELECT_ALL\fR 4
247 .IX Item "OSSL_KEYMGMT_SELECT_ALL"
248 Indicating that everything in a key object should be considered.
249 .PP
250 The exact interpretation of those bits or how they combine is left to
251 each function where you can specify a selector.
252 .PP
253 It's left to the provider implementation to decide what is reasonable
254 to do with regards to received selector bits and how to do it.
255 Among others, an implementation of \fBOSSL_FUNC_keymgmt_match()\fR might opt
256 to not compare the private half if it has compared the public half,
257 since a match of one half implies a match of the other half.
258 .SS "Constructing and Destructing Functions"
259 .IX Subsection "Constructing and Destructing Functions"
260 \&\fBOSSL_FUNC_keymgmt_new()\fR should create a provider side key object. The
261 provider context \fIprovctx\fR is passed and may be incorporated in the
262 key object, but that is not mandatory.
263 .PP
264 \&\fBOSSL_FUNC_keymgmt_free()\fR should free the passed \fIkeydata\fR.
265 .PP
266 \&\fBOSSL_FUNC_keymgmt_gen_init()\fR, \fBOSSL_FUNC_keymgmt_gen_set_template()\fR,
267 \&\fBOSSL_FUNC_keymgmt_gen_get_params()\fR, \fBOSSL_FUNC_keymgmt_gen_gettable_params()\fR,
268 \&\fBOSSL_FUNC_keymgmt_gen_set_params()\fR, \fBOSSL_FUNC_keymgmt_gen_settable_params()\fR,
269 \&\fBOSSL_FUNC_keymgmt_gen()\fR and \fBOSSL_FUNC_keymgmt_gen_cleanup()\fR work together as a
270 more elaborate context based key object constructor.
271 .PP
272 \&\fBOSSL_FUNC_keymgmt_gen_init()\fR should create the key object generation context
273 and initialize it with \fIselections\fR, which will determine what kind
274 of contents the key object to be generated should get.
275 The \fIparams\fR, if not NULL, should be set on the context in a manner similar to
276 using \fBOSSL_FUNC_keymgmt_set_params()\fR.
277 .PP
278 \&\fBOSSL_FUNC_keymgmt_gen_set_template()\fR should add \fItemplate\fR to the context
279 \&\fIgenctx\fR. The \fItemplate\fR is assumed to be a key object constructed
280 with the same KEYMGMT, and from which content that the implementation
281 chooses can be used as a template for the key object to be generated.
282 Typically, the generation of a DSA or DH key would get the domain
283 parameters from this \fItemplate\fR.
284 .PP
285 \&\fBOSSL_FUNC_keymgmt_gen_get_params()\fR should retrieve parameters into
286 \&\fIparams\fR in the key object generation context \fIgenctx\fR.
287 .PP
288 \&\fBOSSL_FUNC_keymgmt_gen_gettable_params()\fR should return a constant array of
289 descriptor \fBOSSL_PARAM\fR\|(3), for parameters that
290 \&\fBOSSL_FUNC_keymgmt_gen_get_params()\fR can handle.
291 .PP
292 \&\fBOSSL_FUNC_keymgmt_gen_set_params()\fR should set additional parameters from
293 \&\fIparams\fR in the key object generation context \fIgenctx\fR.
294 .PP
295 \&\fBOSSL_FUNC_keymgmt_gen_settable_params()\fR should return a constant array of
296 descriptor \fBOSSL_PARAM\fR\|(3), for parameters that \fBOSSL_FUNC_keymgmt_gen_set_params()\fR
297 can handle.
298 .PP
299 \&\fBOSSL_FUNC_keymgmt_gen()\fR should perform the key object generation itself, and
300 return the result. The callback \fIcb\fR should be called at regular
301 intervals with indications on how the key object generation
302 progresses.
303 .PP
304 \&\fBOSSL_FUNC_keymgmt_gen_cleanup()\fR should clean up and free the key object
305 generation context \fIgenctx\fR
306 .PP
307 \&\fBOSSL_FUNC_keymgmt_load()\fR creates a provider side key object based on a
308 \&\fIreference\fR object with a size of \fIreference_sz\fR bytes, that only the
309 provider knows how to interpret, but that may come from other operations.
310 Outside the provider, this reference is simply an array of bytes.
311 .PP
312 At least one of \fBOSSL_FUNC_keymgmt_new()\fR, \fBOSSL_FUNC_keymgmt_gen()\fR and
313 \&\fBOSSL_FUNC_keymgmt_load()\fR are mandatory, as well as \fBOSSL_FUNC_keymgmt_free()\fR and
314 \&\fBOSSL_FUNC_keymgmt_has()\fR. Additionally, if \fBOSSL_FUNC_keymgmt_gen()\fR is present,
315 \&\fBOSSL_FUNC_keymgmt_gen_init()\fR and \fBOSSL_FUNC_keymgmt_gen_cleanup()\fR must be
316 present as well.
317 .SS "Key Object Information Functions"
318 .IX Subsection "Key Object Information Functions"
319 \&\fBOSSL_FUNC_keymgmt_get_params()\fR should extract information data associated
320 with the given \fIkeydata\fR, see "Common Information Parameters".
321 .PP
322 \&\fBOSSL_FUNC_keymgmt_gettable_params()\fR should return a constant array of
323 descriptor \fBOSSL_PARAM\fR\|(3), for parameters that \fBOSSL_FUNC_keymgmt_get_params()\fR
324 can handle.
325 .PP
326 If \fBOSSL_FUNC_keymgmt_gettable_params()\fR is present, \fBOSSL_FUNC_keymgmt_get_params()\fR
327 must also be present, and vice versa.
328 .PP
329 \&\fBOSSL_FUNC_keymgmt_set_params()\fR should update information data associated
330 with the given \fIkeydata\fR, see "Common Information Parameters".
331 .PP
332 \&\fBOSSL_FUNC_keymgmt_settable_params()\fR should return a constant array of
333 descriptor \fBOSSL_PARAM\fR\|(3), for parameters that \fBOSSL_FUNC_keymgmt_set_params()\fR
334 can handle.
335 .PP
336 If \fBOSSL_FUNC_keymgmt_settable_params()\fR is present, \fBOSSL_FUNC_keymgmt_set_params()\fR
337 must also be present, and vice versa.
338 .SS "Key Object Checking Functions"
339 .IX Subsection "Key Object Checking Functions"
340 \&\fBOSSL_FUNC_keymgmt_query_operation_name()\fR should return the name of the
341 supported algorithm for the operation \fIoperation_id\fR. This is
342 similar to \fBprovider_query_operation()\fR (see \fBprovider\-base\fR\|(7)),
343 but only works as an advisory. If this function is not present, or
344 returns NULL, the caller is free to assume that there's an algorithm
345 from the same provider, of the same name as the one used to fetch the
346 keymgmt and try to use that.
347 .PP
348 \&\fBOSSL_FUNC_keymgmt_has()\fR should check whether the given \fIkeydata\fR contains the subsets
349 of data indicated by the \fIselector\fR. A combination of several
350 selector bits must consider all those subsets, not just one. An
351 implementation is, however, free to consider an empty subset of data
352 to still be a valid subset. For algorithms where some selection is
353 not meaningful such as \fBOSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\fR for
354 RSA keys the function should just return 1 as the selected subset
355 is not really missing in the key.
356 .PP
357 \&\fBOSSL_FUNC_keymgmt_validate()\fR should check if the \fIkeydata\fR contains valid
358 data subsets indicated by \fIselection\fR. Some combined selections of
359 data subsets may cause validation of the combined data.
360 For example, the combination of \fBOSSL_KEYMGMT_SELECT_PRIVATE_KEY\fR and
361 \&\fBOSSL_KEYMGMT_SELECT_PUBLIC_KEY\fR (or \fBOSSL_KEYMGMT_SELECT_KEYPAIR\fR
362 for short) is expected to check that the pairwise consistency of
363 \&\fIkeydata\fR is valid. The \fIchecktype\fR parameter controls what type of check is
364 performed on the subset of data. Two types of check are defined:
365 \&\fBOSSL_KEYMGMT_VALIDATE_FULL_CHECK\fR and \fBOSSL_KEYMGMT_VALIDATE_QUICK_CHECK\fR.
366 The interpretation of how much checking is performed in a full check versus a
367 quick check is key type specific. Some providers may have no distinction
368 between a full check and a quick check. For algorithms where some selection is
369 not meaningful such as \fBOSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS\fR for
370 RSA keys the function should just return 1 as there is nothing to validate for
371 that selection.
372 .PP
373 \&\fBOSSL_FUNC_keymgmt_match()\fR should check if the data subset indicated by
374 \&\fIselection\fR in \fIkeydata1\fR and \fIkeydata2\fR match. It is assumed that
375 the caller has ensured that \fIkeydata1\fR and \fIkeydata2\fR are both owned
376 by the implementation of this function.
377 .SS "Key Object Import, Export and Duplication Functions"
378 .IX Subsection "Key Object Import, Export and Duplication Functions"
379 \&\fBOSSL_FUNC_keymgmt_import()\fR should import data indicated by \fIselection\fR into
380 \&\fIkeydata\fR with values taken from the \fBOSSL_PARAM\fR\|(3) array \fIparams\fR.
381 .PP
382 \&\fBOSSL_FUNC_keymgmt_export()\fR should extract values indicated by \fIselection\fR
383 from \fIkeydata\fR, create an \fBOSSL_PARAM\fR\|(3) array with them and call
384 \&\fIparam_cb\fR with that array as well as the given \fIcbarg\fR.
385 .PP
386 \&\fBOSSL_FUNC_keymgmt_import_types()\fR and \fBOSSL_FUNC_keymgmt_import_types_ex()\fR
387 should return a constant array of descriptor
388 \&\fBOSSL_PARAM\fR\|(3) for data indicated by \fIselection\fR, for parameters that
389 \&\fBOSSL_FUNC_keymgmt_import()\fR can handle.
390 Either \fBOSSL_FUNC_keymgmt_import_types()\fR or \fBOSSL_FUNC_keymgmt_import_types_ex()\fR,
391 must be implemented, if \fBOSSL_FUNC_keymgmt_import_types_ex()\fR is implemented, then
392 it is preferred over \fBOSSL_FUNC_keymgmt_import_types()\fR.
393 Providers that are supposed to be backward compatible with OpenSSL 3.0 or 3.1
394 must continue to implement \fBOSSL_FUNC_keymgmt_import_types()\fR.
395 .PP
396 \&\fBOSSL_FUNC_keymgmt_export_types()\fR and \fBOSSL_FUNC_keymgmt_export_types_ex()\fR
397 should return a constant array of descriptor
398 \&\fBOSSL_PARAM\fR\|(3) for data indicated by \fIselection\fR, that the
399 \&\fBOSSL_FUNC_keymgmt_export()\fR callback can expect to receive.
400 Either \fBOSSL_FUNC_keymgmt_export_types()\fR or \fBOSSL_FUNC_keymgmt_export_types_ex()\fR,
401 must be implemented, if \fBOSSL_FUNC_keymgmt_export_types_ex()\fR is implemented, then
402 it is preferred over \fBOSSL_FUNC_keymgmt_export_types()\fR.
403 Providers that are supposed to be backward compatible with OpenSSL 3.0 or 3.1
404 must continue to implement \fBOSSL_FUNC_keymgmt_export_types()\fR.
405 .PP
406 \&\fBOSSL_FUNC_keymgmt_dup()\fR should duplicate data subsets indicated by
407 \&\fIselection\fR or the whole key data \fIkeydata_from\fR and create a new
408 provider side key object with the data.
409 .SS "Common Information Parameters"
410 .IX Subsection "Common Information Parameters"
411 See \fBOSSL_PARAM\fR\|(3) for further details on the parameters structure.
412 .PP
413 Common information parameters currently recognised by all built-in
414 keymgmt algorithms are as follows:
415 .IP """bits"" (\fBOSSL_PKEY_PARAM_BITS\fR) <integer>" 4
416 .IX Item """bits"" (OSSL_PKEY_PARAM_BITS) <integer>"
417 The value should be the cryptographic length of the cryptosystem to
418 which the key belongs, in bits. The definition of cryptographic
419 length is specific to the key cryptosystem.
420 .IP """max-size"" (\fBOSSL_PKEY_PARAM_MAX_SIZE\fR) <integer>" 4
421 .IX Item """max-size"" (OSSL_PKEY_PARAM_MAX_SIZE) <integer>"
422 The value should be the maximum size that a caller should allocate to
423 safely store a signature (called \fIsig\fR in \fBprovider\-signature\fR\|(7)),
424 the result of asymmetric encryption / decryption (\fIout\fR in
425 \&\fBprovider\-asym_cipher\fR\|(7), a derived secret (\fIsecret\fR in
426 \&\fBprovider\-keyexch\fR\|(7), and similar data).
427 .Sp
428 Providers need to implement this parameter
429 in order to properly support various use cases such as CMS signing.
430 .Sp
431 Because an EVP_KEYMGMT method is always tightly bound to another method
432 (signature, asymmetric cipher, key exchange, ...) and must be of the
433 same provider, this number only needs to be synchronised with the
434 dimensions handled in the rest of the same provider.
435 .IP """security-bits"" (\fBOSSL_PKEY_PARAM_SECURITY_BITS\fR) <integer>" 4
436 .IX Item """security-bits"" (OSSL_PKEY_PARAM_SECURITY_BITS) <integer>"
437 The value should be the number of security bits of the given key.
438 Bits of security is defined in SP800\-57.
439 .IP """security-category"" (\fBOSSL_PKEY_PARAM_SECURITY_CATEGORY\fR) <integer>" 4
440 .IX Item """security-category"" (OSSL_PKEY_PARAM_SECURITY_CATEGORY) <integer>"
441 The value is the NIST
442 post-quantum security category <https://nvlpubs.nist.gov/nistpubs/ir/2024/NIST.IR.8547.ipd.pdf>
443 for the algorithm. It is an integer value in the range [0, 5] inclusive.
444 .IP """mandatory-digest"" (\fBOSSL_PKEY_PARAM_MANDATORY_DIGEST\fR) <UTF8 string>" 4
445 .IX Item """mandatory-digest"" (OSSL_PKEY_PARAM_MANDATORY_DIGEST) <UTF8 string>"
446 If there is a mandatory digest for performing a signature operation with
447 keys from this keymgmt, this parameter should get its name as value.
448 .Sp
449 When \fBEVP_PKEY_get_default_digest_name()\fR queries this parameter and it's
450 filled in by the implementation, its return value will be 2.
451 .Sp
452 If the keymgmt implementation fills in the value \f(CW""\fR or \f(CW"UNDEF"\fR,
453 \&\fBEVP_PKEY_get_default_digest_name\fR\|(3) will place the string \f(CW"UNDEF"\fR into
454 its argument \fImdname\fR. This signifies that no digest should be specified
455 with the corresponding signature operation.
456 .IP """default-digest"" (\fBOSSL_PKEY_PARAM_DEFAULT_DIGEST\fR) <UTF8 string>" 4
457 .IX Item """default-digest"" (OSSL_PKEY_PARAM_DEFAULT_DIGEST) <UTF8 string>"
458 If there is a default digest for performing a signature operation with
459 keys from this keymgmt, this parameter should get its name as value.
460 .Sp
461 When \fBEVP_PKEY_get_default_digest_name\fR\|(3) queries this parameter and it's
462 filled in by the implementation, its return value will be 1. Note that if
463 \&\fBOSSL_PKEY_PARAM_MANDATORY_DIGEST\fR is responded to as well,
464 \&\fBEVP_PKEY_get_default_digest_name\fR\|(3) ignores the response to this
465 parameter.
466 .Sp
467 If the keymgmt implementation fills in the value \f(CW""\fR or \f(CW"UNDEF"\fR,
468 \&\fBEVP_PKEY_get_default_digest_name\fR\|(3) will place the string \f(CW"UNDEF"\fR into
469 its argument \fImdname\fR. This signifies that no digest has to be specified
470 with the corresponding signature operation, but may be specified as an
471 option.
472 .IP """ri-type"" (\fBOSSL_PKEY_PARAM_CMS_RI_TYPE\fR) <integer>" 4
473 .IX Item """ri-type"" (OSSL_PKEY_PARAM_CMS_RI_TYPE) <integer>"
474 The value should be the CMS RecipientInfo type for the given key, for example
475 \&\fBCMS_RECIPINFO_KEM\fR or \fBCMS_RECIPINFO_AGREE\fR.
476 The value that can be given through this parameter is found in
477 \&\fI<openssl/cms.h>\fR, with the macros having names starting with
478 \&\f(CW\*(C`CMS_RECIPINFO_\*(C'\fR.
479 .Sp
480 CMS will query this parameter first to determine the RecipientInfo type. If
481 this parameter is not filled in, CMS will check for known key types and map
482 them to the appropriate RecipientInfo type. Otherwise, CMS will default to
483 using \fBCMS_RECIPINFO_TRANS\fR.
484 .IP """kemri-kdf-alg"" (\fBOSSL_PKEY_PARAM_CMS_KEMRI_KDF_ALGORITHM\fR) <UTF8 string>" 4
485 .IX Item """kemri-kdf-alg"" (OSSL_PKEY_PARAM_CMS_KEMRI_KDF_ALGORITHM) <UTF8 string>"
486 The value should be the DER-encoded X509_ALGOR for the default KDF for this key
487 if it supports the KEMRecipientInfo (\fBCMS_RECIPINFO_KEM\fR) type.
488 .Sp
489 Any KDF that takes \fBOSSL_KDF_PARAM_KEY\fR and \fBOSSL_KDF_PARAM_INFO\fR parameters
490 and is otherwise fully defined by its OID can be used, for example \fBHKDF\-SHA256\fR.
491 .Sp
492 If \fBOSSL_PKEY_PARAM_CMS_KEMRI_KDF_ALGORITHM\fR is not implemented, \fBHKDF\-SHA256\fR
493 will be used as the default KDF.
494 .PP
495 The OpenSSL FIPS provider also supports the following parameters:
496 .IP """fips-indicator"" (\fBOSSL_PKEY_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
497 .IX Item """fips-indicator"" (OSSL_PKEY_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
498 A getter that returns 1 if the operation is FIPS approved, or 0 otherwise.
499 This may be used after calling \fBOSSL_FUNC_keymgmt_gen()\fR function. It may
500 return 0 if either the "key-check", or "sign-check" are set to 0.
501 .IP """key-check"" (\fBOSSL_PKEY_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
502 .IX Item """key-check"" (OSSL_PKEY_PARAM_FIPS_KEY_CHECK) <integer>"
503 If required this parameter should be set using \fBOSSL_FUNC_keymgmt_gen_set_params()\fR
504 or \fBOSSL_FUNC_keymgmt_gen_init()\fR.
505 The default value of 1 causes an error during the init if the key is not FIPS
506 approved (e.g. The key has a security strength of less than 112 bits). Setting
507 this to 0 will ignore the error and set the approved "fips-indicator" to 0.
508 This option breaks FIPS compliance if it causes the approved "fips-indicator"
509 to return 0.
510 .IP """sign-check"" (\fBOSSL_PKEY_PARAM_FIPS_SIGN_CHECK\fR) <integer>" 4
511 .IX Item """sign-check"" (OSSL_PKEY_PARAM_FIPS_SIGN_CHECK) <integer>"
512 If required this parameter should be set before the \fBOSSL_FUNC_keymgmt_gen()\fR
513 function. This value is not supported by all keygen algorithms.
514 The default value of 1 will cause an error if the generated key is not
515 allowed to be used for signing.
516 Setting this to 0 will ignore the error and set the approved "fips-indicator" to 0.
517 This option breaks FIPS compliance if it causes the approved "fips-indicator"
518 to return 0.
519 .SH "RETURN VALUES"
520 .IX Header "RETURN VALUES"
521 \&\fBOSSL_FUNC_keymgmt_new()\fR and \fBOSSL_FUNC_keymgmt_dup()\fR should return a valid
522 reference to the newly created provider side key object, or NULL on failure.
523 .PP
524 \&\fBOSSL_FUNC_keymgmt_import()\fR, \fBOSSL_FUNC_keymgmt_export()\fR, \fBOSSL_FUNC_keymgmt_get_params()\fR and
525 \&\fBOSSL_FUNC_keymgmt_set_params()\fR should return 1 for success or 0 on error.
526 .PP
527 \&\fBOSSL_FUNC_keymgmt_validate()\fR should return 1 on successful validation, or 0 on
528 failure.
529 .PP
530 \&\fBOSSL_FUNC_keymgmt_has()\fR should return 1 if all the selected data subsets are contained
531 in the given \fIkeydata\fR or 0 otherwise.
532 .PP
533 \&\fBOSSL_FUNC_keymgmt_query_operation_name()\fR should return a pointer to a string matching
534 the requested operation, or NULL if the same name used to fetch the keymgmt
535 applies.
536 .PP
537 \&\fBOSSL_FUNC_keymgmt_gettable_params()\fR and \fBOSSL_FUNC_keymgmt_settable_params()\fR
538 \&\fBOSSL_FUNC_keymgmt_import_types()\fR, \fBOSSL_FUNC_keymgmt_import_types_ex()\fR,
539 \&\fBOSSL_FUNC_keymgmt_export_types()\fR, \fBOSSL_FUNC_keymgmt_export_types_ex()\fR
540 should
541 always return a constant \fBOSSL_PARAM\fR\|(3) array.
542 .SH NOTES
543 .IX Header "NOTES"
544 LMS support is disabled by default at compile-time.
545 To enable, specify the \fBenable-lms\fR build configuration option.
546 .SH "SEE ALSO"
547 .IX Header "SEE ALSO"
548 \&\fBEVP_PKEY_get_size\fR\|(3),
549 \&\fBEVP_PKEY_get_bits\fR\|(3),
550 \&\fBEVP_PKEY_get_security_bits\fR\|(3),
551 \&\fBprovider\fR\|(7),
552 \&\fBEVP_PKEY\-X25519\fR\|(7),
553 \&\fBEVP_PKEY\-X448\fR\|(7),
554 \&\fBEVP_PKEY\-ED25519\fR\|(7),
555 \&\fBEVP_PKEY\-ED448\fR\|(7),
556 \&\fBEVP_PKEY\-EC\fR\|(7),
557 \&\fBEVP_PKEY\-RSA\fR\|(7),
558 \&\fBEVP_PKEY\-DSA\fR\|(7),
559 \&\fBEVP_PKEY\-DH\fR\|(7),
560 \&\fBEVP_PKEY\-LMS\fR\|(7),
561 \&\fBEVP_PKEY\-ML\-DSA\fR\|(7),
562 \&\fBEVP_PKEY\-ML\-KEM\fR\|(7),
563 \&\fBEVP_PKEY\-SLH\-DSA\fR\|(7).
564 .SH HISTORY
565 .IX Header "HISTORY"
566 The KEYMGMT interface was introduced in OpenSSL 3.0.
567 .PP
568 Functions \fBOSSL_FUNC_keymgmt_import_types_ex()\fR, and \fBOSSL_FUNC_keymgmt_export_types_ex()\fR
569 were added with OpenSSL 3.2.
570 .PP
571 The functions \fBOSSL_FUNC_keymgmt_gen_get_params()\fR and
572 \&\fBOSSL_FUNC_keymgmt_gen_gettable_params()\fR were added in OpenSSL 3.4.
573 .PP
574 The parameters "sign-check" and "fips-indicator" were added in OpenSSL 3.4.
575 .PP
576 Support for the \fBML-DSA\fR, \fBML-KEM\fR and \fBSLH-DSA\fR algorithms was added in OpenSSL 3.5.
577 .PP
578 Support for the \fBLMS\fR algorithm was added in OpenSSL 3.6.
579 .SH COPYRIGHT
580 .IX Header "COPYRIGHT"
581 Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved.
582 .PP
583 Licensed under the Apache License 2.0 (the "License"). You may not use
584 this file except in compliance with the License. You can obtain a copy
585 in the file LICENSE in the source distribution or at
586 <https://www.openssl.org/source/license.html>.