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, setgenparamfncnt
= 0;
42 int importfncnt
= 0, exportfncnt
= 0;
44 if ((keymgmt
= keymgmt_new()) == NULL
) {
45 EVP_KEYMGMT_free(keymgmt
);
48 keymgmt
->name_id
= name_id
;
50 for (; fns
->function_id
!= 0; fns
++) {
51 switch (fns
->function_id
) {
52 case OSSL_FUNC_KEYMGMT_NEW
:
53 if (keymgmt
->new == NULL
)
54 keymgmt
->new = OSSL_get_OP_keymgmt_new(fns
);
56 case OSSL_FUNC_KEYMGMT_GEN_INIT
:
57 if (keymgmt
->gen_init
== NULL
)
58 keymgmt
->gen_init
= OSSL_get_OP_keymgmt_gen_init(fns
);
60 case OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE
:
61 if (keymgmt
->gen_set_template
== NULL
)
62 keymgmt
->gen_set_template
=
63 OSSL_get_OP_keymgmt_gen_set_template(fns
);
65 case OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS
:
66 if (keymgmt
->gen_set_params
== NULL
) {
68 keymgmt
->gen_set_params
=
69 OSSL_get_OP_keymgmt_gen_set_params(fns
);
72 case OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS
:
73 if (keymgmt
->gen_settable_params
== NULL
) {
75 keymgmt
->gen_settable_params
=
76 OSSL_get_OP_keymgmt_gen_settable_params(fns
);
79 case OSSL_FUNC_KEYMGMT_GEN
:
80 if (keymgmt
->gen
== NULL
)
81 keymgmt
->gen
= OSSL_get_OP_keymgmt_gen(fns
);
83 case OSSL_FUNC_KEYMGMT_GEN_CLEANUP
:
84 if (keymgmt
->gen_cleanup
== NULL
)
85 keymgmt
->gen_cleanup
= OSSL_get_OP_keymgmt_gen_cleanup(fns
);
87 case OSSL_FUNC_KEYMGMT_FREE
:
88 if (keymgmt
->free
== NULL
)
89 keymgmt
->free
= OSSL_get_OP_keymgmt_free(fns
);
91 case OSSL_FUNC_KEYMGMT_GET_PARAMS
:
92 if (keymgmt
->get_params
== NULL
) {
94 keymgmt
->get_params
= OSSL_get_OP_keymgmt_get_params(fns
);
97 case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
:
98 if (keymgmt
->gettable_params
== NULL
) {
100 keymgmt
->gettable_params
=
101 OSSL_get_OP_keymgmt_gettable_params(fns
);
104 case OSSL_FUNC_KEYMGMT_SET_PARAMS
:
105 if (keymgmt
->set_params
== NULL
) {
107 keymgmt
->set_params
= OSSL_get_OP_keymgmt_set_params(fns
);
110 case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS
:
111 if (keymgmt
->settable_params
== NULL
) {
113 keymgmt
->settable_params
=
114 OSSL_get_OP_keymgmt_settable_params(fns
);
117 case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME
:
118 if (keymgmt
->query_operation_name
== NULL
)
119 keymgmt
->query_operation_name
=
120 OSSL_get_OP_keymgmt_query_operation_name(fns
);
122 case OSSL_FUNC_KEYMGMT_HAS
:
123 if (keymgmt
->has
== NULL
)
124 keymgmt
->has
= OSSL_get_OP_keymgmt_has(fns
);
126 case OSSL_FUNC_KEYMGMT_VALIDATE
:
127 if (keymgmt
->validate
== NULL
)
128 keymgmt
->validate
= OSSL_get_OP_keymgmt_validate(fns
);
130 case OSSL_FUNC_KEYMGMT_MATCH
:
131 if (keymgmt
->match
== NULL
)
132 keymgmt
->match
= OSSL_get_OP_keymgmt_match(fns
);
134 case OSSL_FUNC_KEYMGMT_IMPORT
:
135 if (keymgmt
->import
== NULL
) {
137 keymgmt
->import
= OSSL_get_OP_keymgmt_import(fns
);
140 case OSSL_FUNC_KEYMGMT_IMPORT_TYPES
:
141 if (keymgmt
->import_types
== NULL
) {
143 keymgmt
->import_types
= OSSL_get_OP_keymgmt_import_types(fns
);
146 case OSSL_FUNC_KEYMGMT_EXPORT
:
147 if (keymgmt
->export
== NULL
) {
149 keymgmt
->export
= OSSL_get_OP_keymgmt_export(fns
);
152 case OSSL_FUNC_KEYMGMT_EXPORT_TYPES
:
153 if (keymgmt
->export_types
== NULL
) {
155 keymgmt
->export_types
= OSSL_get_OP_keymgmt_export_types(fns
);
161 * Try to check that the method is sensible.
162 * At least one constructor and the destructor are MANDATORY
163 * The functions 'has' is MANDATORY
164 * It makes no sense being able to free stuff if you can't create it.
165 * It makes no sense providing OSSL_PARAM descriptors for import and
166 * export if you can't import or export.
168 if (keymgmt
->free
== NULL
169 || (keymgmt
->new == NULL
&& keymgmt
->gen
== NULL
)
170 || keymgmt
->has
== NULL
171 || (getparamfncnt
!= 0 && getparamfncnt
!= 2)
172 || (setparamfncnt
!= 0 && setparamfncnt
!= 2)
173 || (setgenparamfncnt
!= 0 && setgenparamfncnt
!= 2)
174 || (importfncnt
!= 0 && importfncnt
!= 2)
175 || (exportfncnt
!= 0 && exportfncnt
!= 2)
176 || (keymgmt
->gen
!= NULL
177 && (keymgmt
->gen_init
== NULL
178 || keymgmt
->gen_cleanup
== NULL
))) {
179 EVP_KEYMGMT_free(keymgmt
);
180 EVPerr(0, EVP_R_INVALID_PROVIDER_FUNCTIONS
);
183 keymgmt
->prov
= prov
;
185 ossl_provider_up_ref(prov
);
190 EVP_KEYMGMT
*evp_keymgmt_fetch_by_number(OPENSSL_CTX
*ctx
, int name_id
,
191 const char *properties
)
193 return evp_generic_fetch_by_number(ctx
,
194 OSSL_OP_KEYMGMT
, name_id
, properties
,
195 keymgmt_from_dispatch
,
196 (int (*)(void *))EVP_KEYMGMT_up_ref
,
197 (void (*)(void *))EVP_KEYMGMT_free
);
200 EVP_KEYMGMT
*EVP_KEYMGMT_fetch(OPENSSL_CTX
*ctx
, const char *algorithm
,
201 const char *properties
)
203 return evp_generic_fetch(ctx
, OSSL_OP_KEYMGMT
, algorithm
, properties
,
204 keymgmt_from_dispatch
,
205 (int (*)(void *))EVP_KEYMGMT_up_ref
,
206 (void (*)(void *))EVP_KEYMGMT_free
);
209 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT
*keymgmt
)
213 CRYPTO_UP_REF(&keymgmt
->refcnt
, &ref
, keymgmt
->lock
);
217 void EVP_KEYMGMT_free(EVP_KEYMGMT
*keymgmt
)
224 CRYPTO_DOWN_REF(&keymgmt
->refcnt
, &ref
, keymgmt
->lock
);
227 ossl_provider_free(keymgmt
->prov
);
228 CRYPTO_THREAD_lock_free(keymgmt
->lock
);
229 OPENSSL_free(keymgmt
);
232 const OSSL_PROVIDER
*EVP_KEYMGMT_provider(const EVP_KEYMGMT
*keymgmt
)
234 return keymgmt
->prov
;
237 int EVP_KEYMGMT_number(const EVP_KEYMGMT
*keymgmt
)
239 return keymgmt
->name_id
;
242 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT
*keymgmt
, const char *name
)
244 return evp_is_a(keymgmt
->prov
, keymgmt
->name_id
, NULL
, name
);
247 void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX
*libctx
,
248 void (*fn
)(EVP_KEYMGMT
*keymgmt
, void *arg
),
251 evp_generic_do_all(libctx
, OSSL_OP_KEYMGMT
,
252 (void (*)(void *, void *))fn
, arg
,
253 keymgmt_from_dispatch
,
254 (void (*)(void *))EVP_KEYMGMT_free
);
257 void EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT
*keymgmt
,
258 void (*fn
)(const char *name
, void *data
),
261 if (keymgmt
->prov
!= NULL
)
262 evp_names_do_all(keymgmt
->prov
, keymgmt
->name_id
, fn
, data
);
266 * Internal API that interfaces with the method function pointers
268 void *evp_keymgmt_newdata(const EVP_KEYMGMT
*keymgmt
)
270 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
273 * TODO(3.0) 'new' is currently mandatory on its own, but when new
274 * constructors appear, it won't be quite as mandatory, so we have
275 * a check for future cases.
277 if (keymgmt
->new == NULL
)
279 return keymgmt
->new(provctx
);
282 void evp_keymgmt_freedata(const EVP_KEYMGMT
*keymgmt
, void *keydata
)
284 /* This is mandatory, no need to check for its presence */
285 keymgmt
->free(keydata
);
288 void *evp_keymgmt_gen_init(const EVP_KEYMGMT
*keymgmt
, int selection
)
290 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
292 if (keymgmt
->gen_init
== NULL
)
294 return keymgmt
->gen_init(provctx
, selection
);
297 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
300 if (keymgmt
->gen_set_template
== NULL
)
302 return keymgmt
->gen_set_template(genctx
, template);
305 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
306 const OSSL_PARAM params
[])
308 if (keymgmt
->gen_set_params
== NULL
)
310 return keymgmt
->gen_set_params(genctx
, params
);
313 const OSSL_PARAM
*evp_keymgmt_gen_settable_params(const EVP_KEYMGMT
*keymgmt
)
315 void *provctx
= ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt
));
317 if (keymgmt
->gen_settable_params
== NULL
)
319 return keymgmt
->gen_settable_params(provctx
);
322 void *evp_keymgmt_gen(const EVP_KEYMGMT
*keymgmt
, void *genctx
,
323 OSSL_CALLBACK
*cb
, void *cbarg
)
325 if (keymgmt
->gen
== NULL
)
327 return keymgmt
->gen(genctx
, cb
, cbarg
);
330 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT
*keymgmt
, void *genctx
)
332 if (keymgmt
->gen
!= NULL
)
333 keymgmt
->gen_cleanup(genctx
);
336 int evp_keymgmt_get_params(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
339 if (keymgmt
->get_params
== NULL
)
341 return keymgmt
->get_params(keydata
, params
);
344 const OSSL_PARAM
*evp_keymgmt_gettable_params(const EVP_KEYMGMT
*keymgmt
)
346 if (keymgmt
->gettable_params
== NULL
)
348 return keymgmt
->gettable_params();
351 int evp_keymgmt_set_params(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
352 const OSSL_PARAM params
[])
354 if (keymgmt
->set_params
== NULL
)
356 return keymgmt
->set_params(keydata
, params
);
359 const OSSL_PARAM
*evp_keymgmt_settable_params(const EVP_KEYMGMT
*keymgmt
)
361 if (keymgmt
->settable_params
== NULL
)
363 return keymgmt
->settable_params();
366 int evp_keymgmt_has(const EVP_KEYMGMT
*keymgmt
, void *keydata
, int selection
)
368 /* This is mandatory, no need to check for its presence */
369 return keymgmt
->has(keydata
, selection
);
372 int evp_keymgmt_validate(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
375 /* We assume valid if the implementation doesn't have a function */
376 if (keymgmt
->validate
== NULL
)
378 return keymgmt
->validate(keydata
, selection
);
381 int evp_keymgmt_match(const EVP_KEYMGMT
*keymgmt
,
382 const void *keydata1
, const void *keydata2
,
385 /* We assume no match if the implementation doesn't have a function */
386 if (keymgmt
->match
== NULL
)
388 return keymgmt
->match(keydata1
, keydata2
, selection
);
391 int evp_keymgmt_import(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
392 int selection
, const OSSL_PARAM params
[])
394 if (keymgmt
->import
== NULL
)
396 return keymgmt
->import(keydata
, selection
, params
);
399 const OSSL_PARAM
*evp_keymgmt_import_types(const EVP_KEYMGMT
*keymgmt
,
402 if (keymgmt
->import_types
== NULL
)
404 return keymgmt
->import_types(selection
);
407 int evp_keymgmt_export(const EVP_KEYMGMT
*keymgmt
, void *keydata
,
408 int selection
, OSSL_CALLBACK
*param_cb
, void *cbarg
)
410 if (keymgmt
->export
== NULL
)
412 return keymgmt
->export(keydata
, selection
, param_cb
, cbarg
);
415 const OSSL_PARAM
*evp_keymgmt_export_types(const EVP_KEYMGMT
*keymgmt
,
418 if (keymgmt
->export_types
== NULL
)
420 return keymgmt
->export_types(selection
);
423 int evp_keymgmt_copy(const EVP_KEYMGMT
*keymgmt
,
424 void *keydata_to
, const void *keydata_from
,
427 /* We assume no copy if the implementation doesn't have a function */
428 if (keymgmt
->copy
== NULL
)
430 return keymgmt
->copy(keydata_to
, keydata_from
, selection
);