2 * Copyright 2019 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_numbers.h>
12 #include <openssl/evp.h>
13 #include <openssl/err.h>
14 #include "internal/provider.h"
15 #include "internal/refcount.h"
16 #include "crypto/evp.h"
17 #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 EVPerr(0, ERR_R_MALLOC_FAILURE);
36 static void *keymgmt_from_dispatch(int name_id,
37 const OSSL_DISPATCH *fns,
40 EVP_KEYMGMT *keymgmt = NULL;
41 int setparamfncnt = 0, getparamfncnt = 0;
42 int setgenparamfncnt = 0, getgenparamfncnt = 0;
43 int importfncnt = 0, exportfncnt = 0;
45 if ((keymgmt = keymgmt_new()) == NULL) {
46 EVP_KEYMGMT_free(keymgmt);
49 keymgmt->name_id = name_id;
51 for (; fns->function_id != 0; fns++) {
52 switch (fns->function_id) {
53 case OSSL_FUNC_KEYMGMT_NEW:
54 if (keymgmt->new == NULL)
55 keymgmt->new = OSSL_get_OP_keymgmt_new(fns);
57 case OSSL_FUNC_KEYMGMT_GEN_INIT:
58 if (keymgmt->gen_init == NULL)
59 keymgmt->gen_init = OSSL_get_OP_keymgmt_gen_init(fns);
61 case OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE:
62 if (keymgmt->gen_set_template == NULL)
63 keymgmt->gen_set_template =
64 OSSL_get_OP_keymgmt_gen_set_template(fns);
66 case OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS:
67 if (keymgmt->gen_set_params == NULL) {
69 keymgmt->gen_set_params =
70 OSSL_get_OP_keymgmt_gen_set_params(fns);
73 case OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS:
74 if (keymgmt->gen_settable_params == NULL) {
76 keymgmt->gen_settable_params =
77 OSSL_get_OP_keymgmt_gen_settable_params(fns);
80 case OSSL_FUNC_KEYMGMT_GEN_GET_PARAMS:
81 if (keymgmt->gen_get_params == NULL) {
83 keymgmt->gen_get_params =
84 OSSL_get_OP_keymgmt_gen_get_params(fns);
87 case OSSL_FUNC_KEYMGMT_GEN_GETTABLE_PARAMS:
88 if (keymgmt->gen_gettable_params == NULL) {
90 keymgmt->gen_gettable_params =
91 OSSL_get_OP_keymgmt_gen_gettable_params(fns);
94 case OSSL_FUNC_KEYMGMT_GEN:
95 if (keymgmt->gen == NULL)
96 keymgmt->gen = OSSL_get_OP_keymgmt_gen(fns);
98 case OSSL_FUNC_KEYMGMT_GEN_CLEANUP:
99 if (keymgmt->gen_cleanup == NULL)
100 keymgmt->gen_cleanup = OSSL_get_OP_keymgmt_gen_cleanup(fns);
102 case OSSL_FUNC_KEYMGMT_FREE:
103 if (keymgmt->free == NULL)
104 keymgmt->free = OSSL_get_OP_keymgmt_free(fns);
106 case OSSL_FUNC_KEYMGMT_GET_PARAMS:
107 if (keymgmt->get_params == NULL) {
109 keymgmt->get_params = OSSL_get_OP_keymgmt_get_params(fns);
112 case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS:
113 if (keymgmt->gettable_params == NULL) {
115 keymgmt->gettable_params =
116 OSSL_get_OP_keymgmt_gettable_params(fns);
119 case OSSL_FUNC_KEYMGMT_SET_PARAMS:
120 if (keymgmt->set_params == NULL) {
122 keymgmt->set_params = OSSL_get_OP_keymgmt_set_params(fns);
125 case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS:
126 if (keymgmt->settable_params == NULL) {
128 keymgmt->settable_params =
129 OSSL_get_OP_keymgmt_settable_params(fns);
132 case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME:
133 if (keymgmt->query_operation_name == NULL)
134 keymgmt->query_operation_name =
135 OSSL_get_OP_keymgmt_query_operation_name(fns);
137 case OSSL_FUNC_KEYMGMT_HAS:
138 if (keymgmt->has == NULL)
139 keymgmt->has = OSSL_get_OP_keymgmt_has(fns);
141 case OSSL_FUNC_KEYMGMT_VALIDATE:
142 if (keymgmt->validate == NULL)
143 keymgmt->validate = OSSL_get_OP_keymgmt_validate(fns);
145 case OSSL_FUNC_KEYMGMT_MATCH:
146 if (keymgmt->match == NULL)
147 keymgmt->match = OSSL_get_OP_keymgmt_match(fns);
149 case OSSL_FUNC_KEYMGMT_IMPORT:
150 if (keymgmt->import == NULL) {
152 keymgmt->import = OSSL_get_OP_keymgmt_import(fns);
155 case OSSL_FUNC_KEYMGMT_IMPORT_TYPES:
156 if (keymgmt->import_types == NULL) {
158 keymgmt->import_types = OSSL_get_OP_keymgmt_import_types(fns);
161 case OSSL_FUNC_KEYMGMT_EXPORT:
162 if (keymgmt->export == NULL) {
164 keymgmt->export = OSSL_get_OP_keymgmt_export(fns);
167 case OSSL_FUNC_KEYMGMT_EXPORT_TYPES:
168 if (keymgmt->export_types == NULL) {
170 keymgmt->export_types = OSSL_get_OP_keymgmt_export_types(fns);
176 * Try to check that the method is sensible.
177 * At least one constructor and the destructor are MANDATORY
178 * The functions 'has' is MANDATORY
179 * It makes no sense being able to free stuff if you can't create it.
180 * It makes no sense providing OSSL_PARAM descriptors for import and
181 * export if you can't import or export.
183 if (keymgmt->free == NULL
184 || (keymgmt->new == NULL && keymgmt->gen == NULL)
185 || keymgmt->has == NULL
186 || (getparamfncnt != 0 && getparamfncnt != 2)
187 || (setparamfncnt != 0 && setparamfncnt != 2)
188 || (setgenparamfncnt != 0 && setgenparamfncnt != 2)
189 || (getgenparamfncnt != 0 && getgenparamfncnt != 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 EVPerr(0, EVP_R_INVALID_PROVIDER_FUNCTIONS);
199 keymgmt->prov = prov;
201 ossl_provider_up_ref(prov);
206 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_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_dispatch,
212 (int (*)(void *))EVP_KEYMGMT_up_ref,
213 (void (*)(void *))EVP_KEYMGMT_free);
216 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
217 const char *properties)
219 return evp_generic_fetch(ctx, OSSL_OP_KEYMGMT, algorithm, properties,
220 keymgmt_from_dispatch,
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 ossl_provider_free(keymgmt->prov);
244 CRYPTO_THREAD_lock_free(keymgmt->lock);
245 OPENSSL_free(keymgmt);
248 const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt)
250 return keymgmt->prov;
253 int EVP_KEYMGMT_number(const EVP_KEYMGMT *keymgmt)
255 return keymgmt->name_id;
258 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name)
260 return evp_is_a(keymgmt->prov, keymgmt->name_id, NULL, name);
263 void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX *libctx,
264 void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
267 evp_generic_do_all(libctx, OSSL_OP_KEYMGMT,
268 (void (*)(void *, void *))fn, arg,
269 keymgmt_from_dispatch,
270 (void (*)(void *))EVP_KEYMGMT_free);
273 void EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT *keymgmt,
274 void (*fn)(const char *name, void *data),
277 if (keymgmt->prov != NULL)
278 evp_names_do_all(keymgmt->prov, keymgmt->name_id, fn, data);
282 * Internal API that interfaces with the method function pointers
284 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt)
286 void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
289 * TODO(3.0) 'new' is currently mandatory on its own, but when new
290 * constructors appear, it won't be quite as mandatory, so we have
291 * a check for future cases.
293 if (keymgmt->new == NULL)
295 return keymgmt->new(provctx);
298 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keydata)
300 /* This is mandatory, no need to check for its presence */
301 keymgmt->free(keydata);
304 void *evp_keymgmt_gen_init(const EVP_KEYMGMT *keymgmt, int selection)
306 void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
308 if (keymgmt->gen_init == NULL)
310 return keymgmt->gen_init(provctx, selection);
313 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT *keymgmt, void *genctx,
316 if (keymgmt->gen_set_template == NULL)
318 return keymgmt->gen_set_template(genctx, template);
321 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT *keymgmt, void *genctx,
322 const OSSL_PARAM params[])
324 if (keymgmt->gen_set_params == NULL)
326 return keymgmt->gen_set_params(genctx, params);
329 const OSSL_PARAM *evp_keymgmt_gen_settable_params(const EVP_KEYMGMT *keymgmt)
331 void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
333 if (keymgmt->gen_settable_params == NULL)
335 return keymgmt->gen_settable_params(provctx);
338 int evp_keymgmt_gen_get_params(const EVP_KEYMGMT *keymgmt, void *genctx,
341 if (keymgmt->gen_get_params == NULL)
343 return keymgmt->gen_get_params(genctx, params);
346 const OSSL_PARAM *evp_keymgmt_gen_gettable_params(const EVP_KEYMGMT *keymgmt)
348 void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
350 if (keymgmt->gen_gettable_params == NULL)
352 return keymgmt->gen_gettable_params(provctx);
355 void *evp_keymgmt_gen(const EVP_KEYMGMT *keymgmt, void *genctx,
356 OSSL_CALLBACK *cb, void *cbarg)
358 if (keymgmt->gen == NULL)
360 return keymgmt->gen(genctx, cb, cbarg);
363 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT *keymgmt, void *genctx)
365 if (keymgmt->gen != NULL)
366 keymgmt->gen_cleanup(genctx);
369 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt, void *keydata,
372 if (keymgmt->get_params == NULL)
374 return keymgmt->get_params(keydata, params);
377 const OSSL_PARAM *evp_keymgmt_gettable_params(const EVP_KEYMGMT *keymgmt)
379 if (keymgmt->gettable_params == NULL)
381 return keymgmt->gettable_params();
384 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt, void *keydata,
385 const OSSL_PARAM params[])
387 if (keymgmt->set_params == NULL)
389 return keymgmt->set_params(keydata, params);
392 const OSSL_PARAM *evp_keymgmt_settable_params(const EVP_KEYMGMT *keymgmt)
394 if (keymgmt->settable_params == NULL)
396 return keymgmt->settable_params();
399 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keydata, int selection)
401 /* This is mandatory, no need to check for its presence */
402 return keymgmt->has(keydata, selection);
405 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
408 /* We assume valid if the implementation doesn't have a function */
409 if (keymgmt->validate == NULL)
411 return keymgmt->validate(keydata, selection);
414 int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
415 const void *keydata1, const void *keydata2,
418 /* We assume no match if the implementation doesn't have a function */
419 if (keymgmt->match == NULL)
421 return keymgmt->match(keydata1, keydata2, selection);
424 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
425 int selection, const OSSL_PARAM params[])
427 if (keymgmt->import == NULL)
429 return keymgmt->import(keydata, selection, params);
432 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
435 if (keymgmt->import_types == NULL)
437 return keymgmt->import_types(selection);
440 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
441 int selection, OSSL_CALLBACK *param_cb, void *cbarg)
443 if (keymgmt->export == NULL)
445 return keymgmt->export(keydata, selection, param_cb, cbarg);
448 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
451 if (keymgmt->export_types == NULL)
453 return keymgmt->export_types(selection);
456 int evp_keymgmt_copy(const EVP_KEYMGMT *keymgmt,
457 void *keydata_to, const void *keydata_from,
460 /* We assume no copy if the implementation doesn't have a function */
461 if (keymgmt->copy == NULL)
463 return keymgmt->copy(keydata_to, keydata_from, selection);