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, importfncnt = 0, exportfncnt = 0;
43 if ((keymgmt = keymgmt_new()) == NULL) {
44 EVP_KEYMGMT_free(keymgmt);
47 keymgmt->name_id = name_id;
49 for (; fns->function_id != 0; fns++) {
50 switch (fns->function_id) {
51 case OSSL_FUNC_KEYMGMT_NEW:
52 if (keymgmt->new == NULL)
53 keymgmt->new = OSSL_get_OP_keymgmt_new(fns);
55 case OSSL_FUNC_KEYMGMT_FREE:
56 if (keymgmt->free == NULL)
57 keymgmt->free = OSSL_get_OP_keymgmt_free(fns);
59 case OSSL_FUNC_KEYMGMT_GET_PARAMS:
60 if (keymgmt->get_params == NULL) {
62 keymgmt->get_params = OSSL_get_OP_keymgmt_get_params(fns);
65 case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS:
66 if (keymgmt->gettable_params == NULL) {
68 keymgmt->gettable_params =
69 OSSL_get_OP_keymgmt_gettable_params(fns);
72 case OSSL_FUNC_KEYMGMT_SET_PARAMS:
73 if (keymgmt->set_params == NULL) {
75 keymgmt->set_params = OSSL_get_OP_keymgmt_set_params(fns);
78 case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS:
79 if (keymgmt->settable_params == NULL) {
81 keymgmt->settable_params =
82 OSSL_get_OP_keymgmt_settable_params(fns);
85 case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME:
86 if (keymgmt->query_operation_name == NULL)
87 keymgmt->query_operation_name =
88 OSSL_get_OP_keymgmt_query_operation_name(fns);
90 case OSSL_FUNC_KEYMGMT_HAS:
91 if (keymgmt->has == NULL)
92 keymgmt->has = OSSL_get_OP_keymgmt_has(fns);
94 case OSSL_FUNC_KEYMGMT_VALIDATE:
95 if (keymgmt->validate == NULL)
96 keymgmt->validate = OSSL_get_OP_keymgmt_validate(fns);
98 case OSSL_FUNC_KEYMGMT_IMPORT:
99 if (keymgmt->import == NULL) {
101 keymgmt->import = OSSL_get_OP_keymgmt_import(fns);
104 case OSSL_FUNC_KEYMGMT_IMPORT_TYPES:
105 if (keymgmt->import_types == NULL) {
107 keymgmt->import_types = OSSL_get_OP_keymgmt_import_types(fns);
110 case OSSL_FUNC_KEYMGMT_EXPORT:
111 if (keymgmt->export == NULL) {
113 keymgmt->export = OSSL_get_OP_keymgmt_export(fns);
116 case OSSL_FUNC_KEYMGMT_EXPORT_TYPES:
117 if (keymgmt->export_types == NULL) {
119 keymgmt->export_types = OSSL_get_OP_keymgmt_export_types(fns);
125 * Try to check that the method is sensible.
126 * At least one constructor and the destructor are MANDATORY
127 * The functions 'has' is MANDATORY
128 * It makes no sense being able to free stuff if you can't create it.
129 * It makes no sense providing OSSL_PARAM descriptors for import and
130 * export if you can't import or export.
132 if (keymgmt->free == NULL
133 || keymgmt->new == NULL
134 || keymgmt->has == NULL
135 || (getparamfncnt != 0 && getparamfncnt != 2)
136 || (setparamfncnt != 0 && setparamfncnt != 2)
137 || (importfncnt != 0 && importfncnt != 2)
138 || (exportfncnt != 0 && exportfncnt != 2)) {
139 EVP_KEYMGMT_free(keymgmt);
140 EVPerr(0, EVP_R_INVALID_PROVIDER_FUNCTIONS);
143 keymgmt->prov = prov;
145 ossl_provider_up_ref(prov);
150 EVP_KEYMGMT *evp_keymgmt_fetch_by_number(OPENSSL_CTX *ctx, int name_id,
151 const char *properties)
153 return evp_generic_fetch_by_number(ctx,
154 OSSL_OP_KEYMGMT, name_id, properties,
155 keymgmt_from_dispatch,
156 (int (*)(void *))EVP_KEYMGMT_up_ref,
157 (void (*)(void *))EVP_KEYMGMT_free);
160 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
161 const char *properties)
163 return evp_generic_fetch(ctx, OSSL_OP_KEYMGMT, algorithm, properties,
164 keymgmt_from_dispatch,
165 (int (*)(void *))EVP_KEYMGMT_up_ref,
166 (void (*)(void *))EVP_KEYMGMT_free);
169 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT *keymgmt)
173 CRYPTO_UP_REF(&keymgmt->refcnt, &ref, keymgmt->lock);
177 void EVP_KEYMGMT_free(EVP_KEYMGMT *keymgmt)
184 CRYPTO_DOWN_REF(&keymgmt->refcnt, &ref, keymgmt->lock);
187 ossl_provider_free(keymgmt->prov);
188 CRYPTO_THREAD_lock_free(keymgmt->lock);
189 OPENSSL_free(keymgmt);
192 const OSSL_PROVIDER *EVP_KEYMGMT_provider(const EVP_KEYMGMT *keymgmt)
194 return keymgmt->prov;
197 int EVP_KEYMGMT_number(const EVP_KEYMGMT *keymgmt)
199 return keymgmt->name_id;
202 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name)
204 return evp_is_a(keymgmt->prov, keymgmt->name_id, NULL, name);
207 void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX *libctx,
208 void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
211 evp_generic_do_all(libctx, OSSL_OP_KEYMGMT,
212 (void (*)(void *, void *))fn, arg,
213 keymgmt_from_dispatch,
214 (void (*)(void *))EVP_KEYMGMT_free);
217 void EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT *keymgmt,
218 void (*fn)(const char *name, void *data),
221 if (keymgmt->prov != NULL)
222 evp_names_do_all(keymgmt->prov, keymgmt->name_id, fn, data);
226 * Internal API that interfaces with the method function pointers
228 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt)
230 void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
233 * TODO(3.0) 'new' is currently mandatory on its own, but when new
234 * constructors appear, it won't be quite as mandatory, so we have
235 * a check for future cases.
237 if (keymgmt->new == NULL)
239 return keymgmt->new(provctx);
242 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keydata)
244 /* This is mandatory, no need to check for its presence */
245 keymgmt->free(keydata);
248 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt, void *keydata,
251 if (keymgmt->get_params == NULL)
253 return keymgmt->get_params(keydata, params);
256 const OSSL_PARAM *evp_keymgmt_gettable_params(const EVP_KEYMGMT *keymgmt)
258 if (keymgmt->gettable_params == NULL)
260 return keymgmt->gettable_params();
263 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt, void *keydata,
264 const OSSL_PARAM params[])
266 if (keymgmt->set_params == NULL)
268 return keymgmt->set_params(keydata, params);
271 const OSSL_PARAM *evp_keymgmt_settable_params(const EVP_KEYMGMT *keymgmt)
273 if (keymgmt->settable_params == NULL)
275 return keymgmt->settable_params();
278 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keydata, int selection)
280 /* This is mandatory, no need to check for its presence */
281 return keymgmt->has(keydata, selection);
284 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
287 /* We assume valid if the implementation doesn't have a function */
288 if (keymgmt->validate == NULL)
290 return keymgmt->validate(keydata, selection);
293 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
294 int selection, const OSSL_PARAM params[])
296 if (keymgmt->import == NULL)
298 return keymgmt->import(keydata, selection, params);
301 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
304 if (keymgmt->import_types == NULL)
306 return keymgmt->import_types(selection);
309 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
310 int selection, OSSL_CALLBACK *param_cb, void *cbarg)
312 if (keymgmt->export == NULL)
314 return keymgmt->export(keydata, selection, param_cb, cbarg);
317 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
320 if (keymgmt->export_types == NULL)
322 return keymgmt->export_types(selection);