2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #include <openssl/crypto.h>
11 #include <openssl/core_dispatch.h>
12 #include <openssl/evp.h>
13 #include <openssl/err.h>
14 #include "internal/provider.h"
15 #include "internal/refcount.h"
16 #include "internal/core.h"
17 #include "crypto/evp.h"
18 #include "evp_local.h"
20 static void *keymgmt_new(void)
22 EVP_KEYMGMT
*keymgmt
= NULL
;
24 if ((keymgmt
= OPENSSL_zalloc(sizeof(*keymgmt
))) == NULL
25 || (keymgmt
->lock
= CRYPTO_THREAD_lock_new()) == NULL
) {
26 EVP_KEYMGMT_free(keymgmt
);
27 ERR_raise(ERR_LIB_EVP
, ERR_R_MALLOC_FAILURE
);
36 static void *keymgmt_from_algorithm(int name_id
,
37 const OSSL_ALGORITHM
*algodef
,
40 const OSSL_DISPATCH
*fns
= algodef
->implementation
;
41 EVP_KEYMGMT
*keymgmt
= NULL
;
42 int setparamfncnt
= 0, getparamfncnt
= 0;
43 int setgenparamfncnt
= 0;
44 int importfncnt
= 0, exportfncnt
= 0;
46 if ((keymgmt
= keymgmt_new()) == NULL
)
49 keymgmt
->name_id
= name_id
;
50 if ((keymgmt
->type_name
= ossl_algorithm_get1_first_name(algodef
)) == NULL
) {
51 EVP_KEYMGMT_free(keymgmt
);
54 keymgmt
->description
= algodef
->algorithm_description
;
56 for (; fns
->function_id
!= 0; fns
++) {
57 switch (fns
->function_id
) {
58 case OSSL_FUNC_KEYMGMT_NEW
:
59 if (keymgmt
->new == NULL
)
60 keymgmt
->new = OSSL_FUNC_keymgmt_new(fns
);
62 case OSSL_FUNC_KEYMGMT_GEN_INIT
:
63 if (keymgmt
->gen_init
== NULL
)
64 keymgmt
->gen_init
= OSSL_FUNC_keymgmt_gen_init(fns
);
66 case OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE
:
67 if (keymgmt
->gen_set_template
== NULL
)
68 keymgmt
->gen_set_template
=
69 OSSL_FUNC_keymgmt_gen_set_template(fns
);
71 case OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS
:
72 if (keymgmt
->gen_set_params
== NULL
) {
74 keymgmt
->gen_set_params
=
75 OSSL_FUNC_keymgmt_gen_set_params(fns
);
78 case OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS
:
79 if (keymgmt
->gen_settable_params
== NULL
) {
81 keymgmt
->gen_settable_params
=
82 OSSL_FUNC_keymgmt_gen_settable_params(fns
);
85 case OSSL_FUNC_KEYMGMT_GEN
:
86 if (keymgmt
->gen
== NULL
)
87 keymgmt
->gen
= OSSL_FUNC_keymgmt_gen(fns
);
89 case OSSL_FUNC_KEYMGMT_GEN_CLEANUP
:
90 if (keymgmt
->gen_cleanup
== NULL
)
91 keymgmt
->gen_cleanup
= OSSL_FUNC_keymgmt_gen_cleanup(fns
);
93 case OSSL_FUNC_KEYMGMT_FREE
:
94 if (keymgmt
->free
== NULL
)
95 keymgmt
->free
= OSSL_FUNC_keymgmt_free(fns
);
97 case OSSL_FUNC_KEYMGMT_LOAD
:
98 if (keymgmt
->load
== NULL
)
99 keymgmt
->load
= OSSL_FUNC_keymgmt_load(fns
);
101 case OSSL_FUNC_KEYMGMT_GET_PARAMS
:
102 if (keymgmt
->get_params
== NULL
) {
104 keymgmt
->get_params
= OSSL_FUNC_keymgmt_get_params(fns
);
107 case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
:
108 if (keymgmt
->gettable_params
== NULL
) {
110 keymgmt
->gettable_params
=
111 OSSL_FUNC_keymgmt_gettable_params(fns
);
114 case OSSL_FUNC_KEYMGMT_SET_PARAMS
:
115 if (keymgmt
->set_params
== NULL
) {
117 keymgmt
->set_params
= OSSL_FUNC_keymgmt_set_params(fns
);
120 case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS
:
121 if (keymgmt
->settable_params
== NULL
) {
123 keymgmt
->settable_params
=
124 OSSL_FUNC_keymgmt_settable_params(fns
);
127 case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME
:
128 if (keymgmt
->query_operation_name
== NULL
)
129 keymgmt
->query_operation_name
=
130 OSSL_FUNC_keymgmt_query_operation_name(fns
);
132 case OSSL_FUNC_KEYMGMT_HAS
:
133 if (keymgmt
->has
== NULL
)
134 keymgmt
->has
= OSSL_FUNC_keymgmt_has(fns
);
136 case OSSL_FUNC_KEYMGMT_DUP
:
137 if (keymgmt
->dup
== NULL
)
138 keymgmt
->dup
= OSSL_FUNC_keymgmt_dup(fns
);
140 case OSSL_FUNC_KEYMGMT_VALIDATE
:
141 if (keymgmt
->validate
== NULL
)
142 keymgmt
->validate
= OSSL_FUNC_keymgmt_validate(fns
);
144 case OSSL_FUNC_KEYMGMT_MATCH
:
145 if (keymgmt
->match
== NULL
)
146 keymgmt
->match
= OSSL_FUNC_keymgmt_match(fns
);
148 case OSSL_FUNC_KEYMGMT_IMPORT
:
149 if (keymgmt
->import
== NULL
) {
151 keymgmt
->import
= OSSL_FUNC_keymgmt_import(fns
);
154 case OSSL_FUNC_KEYMGMT_IMPORT_TYPES
:
155 if (keymgmt
->import_types
== NULL
) {
157 keymgmt
->import_types
= OSSL_FUNC_keymgmt_import_types(fns
);
160 case OSSL_FUNC_KEYMGMT_EXPORT
:
161 if (keymgmt
->export
== NULL
) {
163 keymgmt
->export
= OSSL_FUNC_keymgmt_export(fns
);
166 case OSSL_FUNC_KEYMGMT_EXPORT_TYPES
:
167 if (keymgmt
->export_types
== NULL
) {
169 keymgmt
->export_types
= OSSL_FUNC_keymgmt_export_types(fns
);
175 * Try to check that the method is sensible.
176 * At least one constructor and the destructor are MANDATORY
177 * The functions 'has' is MANDATORY
178 * It makes no sense being able to free stuff if you can't create it.
179 * It makes no sense providing OSSL_PARAM descriptors for import and
180 * export if you can't import or export.
182 if (keymgmt
->free
== NULL
183 || (keymgmt
->new == NULL
184 && keymgmt
->gen
== NULL
185 && keymgmt
->load
== NULL
)
186 || keymgmt
->has
== NULL
187 || (getparamfncnt
!= 0 && getparamfncnt
!= 2)
188 || (setparamfncnt
!= 0 && setparamfncnt
!= 2)
189 || (setgenparamfncnt
!= 0 && setgenparamfncnt
!= 2)
190 || (importfncnt
!= 0 && importfncnt
!= 2)
191 || (exportfncnt
!= 0 && exportfncnt
!= 2)
192 || (keymgmt
->gen
!= NULL
193 && (keymgmt
->gen_init
== NULL
194 || keymgmt
->gen_cleanup
== NULL
))) {
195 EVP_KEYMGMT_free(keymgmt
);
196 ERR_raise(ERR_LIB_EVP
, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
199 keymgmt
->prov
= prov
;
201 ossl_provider_up_ref(prov
);
206 EVP_KEYMGMT
*evp_keymgmt_fetch_by_number(OSSL_LIB_CTX
*ctx
, int name_id
,
207 const char *properties
)
209 return evp_generic_fetch_by_number(ctx
,
210 OSSL_OP_KEYMGMT
, name_id
, properties
,
211 keymgmt_from_algorithm
,
212 (int (*)(void *))EVP_KEYMGMT_up_ref
,
213 (void (*)(void *))EVP_KEYMGMT_free
);
216 EVP_KEYMGMT
*EVP_KEYMGMT_fetch(OSSL_LIB_CTX
*ctx
, const char *algorithm
,
217 const char *properties
)
219 return evp_generic_fetch(ctx
, OSSL_OP_KEYMGMT
, algorithm
, properties
,
220 keymgmt_from_algorithm
,
221 (int (*)(void *))EVP_KEYMGMT_up_ref
,
222 (void (*)(void *))EVP_KEYMGMT_free
);
225 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT
*keymgmt
)
229 CRYPTO_UP_REF(&keymgmt
->refcnt
, &ref
, keymgmt
->lock
);
233 void EVP_KEYMGMT_free(EVP_KEYMGMT
*keymgmt
)
240 CRYPTO_DOWN_REF(&keymgmt
->refcnt
, &ref
, keymgmt
->lock
);
243 OPENSSL_free(keymgmt
->type_name
);
244 ossl_provider_free(keymgmt
->prov
);
245 CRYPTO_THREAD_lock_free(keymgmt
->lock
);
246 OPENSSL_free(keymgmt
);
249 const OSSL_PROVIDER
*EVP_KEYMGMT_provider(const EVP_KEYMGMT
*keymgmt
)
251 return keymgmt
->prov
;
254 int EVP_KEYMGMT_number(const EVP_KEYMGMT
*keymgmt
)
256 return keymgmt
->name_id
;
259 const char *EVP_KEYMGMT_description(const EVP_KEYMGMT
*keymgmt
)
261 return keymgmt
->description
;
264 const char *EVP_KEYMGMT_name(const EVP_KEYMGMT
*keymgmt
)
266 return keymgmt
->type_name
;
269 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT
*keymgmt
, const char *name
)
271 return evp_is_a(keymgmt
->prov
, keymgmt
->name_id
, NULL
, name
);
274 void EVP_KEYMGMT_do_all_provided(OSSL_LIB_CTX
*libctx
,
275 void (*fn
)(EVP_KEYMGMT
*keymgmt
, void *arg
),
278 evp_generic_do_all(libctx
, OSSL_OP_KEYMGMT
,
279 (void (*)(void *, void *))fn
, arg
,
280 keymgmt_from_algorithm
,
281 (void (*)(void *))EVP_KEYMGMT_free
);
284 int EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT
*keymgmt
,
285 void (*fn
)(const char *name
, void *data
),
288 if (keymgmt
->prov
!= NULL
)
289 return evp_names_do_all(keymgmt
->prov
, keymgmt
->name_id
, fn
, data
);
295 * Internal API that interfaces with the method function pointers
297 void *evp_keymgmt_newdata(const EVP_KEYMGMT
*keymgmt
)
299 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
302 * 'new' is currently mandatory on its own, but when new
303 * constructors appear, it won't be quite as mandatory,
304 * so we have a check for future cases.
306 if (keymgmt
->new == NULL
)
308 return keymgmt
->new(provctx
);
311 void evp_keymgmt_freedata(const EVP_KEYMGMT
*keymgmt
, void *keydata
)
313 /* This is mandatory, no need to check for its presence */
314 keymgmt
->free(keydata
);
317 void *evp_keymgmt_gen_init(const EVP_KEYMGMT
*keymgmt
, int selection
,
318 const OSSL_PARAM params
[])
320 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
322 if (keymgmt
->gen_init
== NULL
)
324 return keymgmt
->gen_init(provctx
, selection
, params
);
327 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
331 * It's arguable if we actually should return success in this case, as
332 * it allows the caller to set a template key, which is then ignored.
333 * However, this is how the legacy methods (EVP_PKEY_METHOD) operate,
334 * so we do this in the interest of backward compatibility.
336 if (keymgmt
->gen_set_template
== NULL
)
338 return keymgmt
->gen_set_template(genctx
, template);
341 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
342 const OSSL_PARAM params
[])
344 if (keymgmt
->gen_set_params
== NULL
)
346 return keymgmt
->gen_set_params(genctx
, params
);
349 const OSSL_PARAM
*EVP_KEYMGMT_gen_settable_params(const EVP_KEYMGMT
*keymgmt
)
351 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
353 if (keymgmt
->gen_settable_params
== NULL
)
355 return keymgmt
->gen_settable_params(NULL
, provctx
);
358 void *evp_keymgmt_gen(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
359 OSSL_CALLBACK
*cb
, void *cbarg
)
361 if (keymgmt
->gen
== NULL
)
363 return keymgmt
->gen(genctx
, cb
, cbarg
);
366 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT
*keymgmt
, void *genctx
)
368 if (keymgmt
->gen
!= NULL
)
369 keymgmt
->gen_cleanup(genctx
);
372 void *evp_keymgmt_load(const EVP_KEYMGMT
*keymgmt
,
373 const void *objref
, size_t objref_sz
)
375 if (keymgmt
->load
!= NULL
)
376 return keymgmt
->load(objref
, objref_sz
);
380 int evp_keymgmt_get_params(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
383 if (keymgmt
->get_params
== NULL
)
385 return keymgmt
->get_params(keydata
, params
);
388 const OSSL_PARAM
*EVP_KEYMGMT_gettable_params(const EVP_KEYMGMT
*keymgmt
)
390 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
392 if (keymgmt
->gettable_params
== NULL
)
394 return keymgmt
->gettable_params(provctx
);
397 int evp_keymgmt_set_params(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
398 const OSSL_PARAM params
[])
400 if (keymgmt
->set_params
== NULL
)
402 return keymgmt
->set_params(keydata
, params
);
405 const OSSL_PARAM
*EVP_KEYMGMT_settable_params(const EVP_KEYMGMT
*keymgmt
)
407 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
409 if (keymgmt
->settable_params
== NULL
)
411 return keymgmt
->settable_params(provctx
);
414 int evp_keymgmt_has(const EVP_KEYMGMT
*keymgmt
, void *keydata
, int selection
)
416 /* This is mandatory, no need to check for its presence */
417 return keymgmt
->has(keydata
, selection
);
420 int evp_keymgmt_validate(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
421 int selection
, int checktype
)
423 /* We assume valid if the implementation doesn't have a function */
424 if (keymgmt
->validate
== NULL
)
426 return keymgmt
->validate(keydata
, selection
, checktype
);
429 int evp_keymgmt_match(const EVP_KEYMGMT
*keymgmt
,
430 const void *keydata1
, const void *keydata2
,
433 /* We assume no match if the implementation doesn't have a function */
434 if (keymgmt
->match
== NULL
)
436 return keymgmt
->match(keydata1
, keydata2
, selection
);
439 int evp_keymgmt_import(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
440 int selection
, const OSSL_PARAM params
[])
442 if (keymgmt
->import
== NULL
)
444 return keymgmt
->import(keydata
, selection
, params
);
447 const OSSL_PARAM
*evp_keymgmt_import_types(const EVP_KEYMGMT
*keymgmt
,
450 if (keymgmt
->import_types
== NULL
)
452 return keymgmt
->import_types(selection
);
455 int evp_keymgmt_export(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
456 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
)
458 if (keymgmt
->export
== NULL
)
460 return keymgmt
->export(keydata
, selection
, param_cb
, cbarg
);
463 const OSSL_PARAM
*evp_keymgmt_export_types(const EVP_KEYMGMT
*keymgmt
,
466 if (keymgmt
->export_types
== NULL
)
468 return keymgmt
->export_types(selection
);
471 void *evp_keymgmt_dup(const EVP_KEYMGMT
*keymgmt
, const void *keydata_from
,
474 /* We assume no dup if the implementation doesn't have a function */
475 if (keymgmt
->dup
== NULL
)
477 return keymgmt
->dup(keydata_from
, selection
);