2 * Copyright 2020-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 /* We need to use some engine deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
14 #include <openssl/core_dispatch.h>
15 #include <openssl/core_names.h>
16 #include <openssl/params.h>
17 #include <openssl/err.h>
18 #include <openssl/evp.h>
19 #include <openssl/proverr.h>
20 #include "openssl/param_build.h"
21 #include "internal/param_build_set.h"
22 #include "prov/implementations.h"
23 #include "prov/providercommon.h"
24 #include "prov/provider_ctx.h"
25 #include "prov/macsignature.h"
26 #include "e_os.h" /* strcasecmp */
28 static OSSL_FUNC_keymgmt_new_fn mac_new;
29 static OSSL_FUNC_keymgmt_free_fn mac_free;
30 static OSSL_FUNC_keymgmt_gen_init_fn mac_gen_init;
31 static OSSL_FUNC_keymgmt_gen_fn mac_gen;
32 static OSSL_FUNC_keymgmt_gen_cleanup_fn mac_gen_cleanup;
33 static OSSL_FUNC_keymgmt_gen_set_params_fn mac_gen_set_params;
34 static OSSL_FUNC_keymgmt_gen_settable_params_fn mac_gen_settable_params;
35 static OSSL_FUNC_keymgmt_get_params_fn mac_get_params;
36 static OSSL_FUNC_keymgmt_gettable_params_fn mac_gettable_params;
37 static OSSL_FUNC_keymgmt_set_params_fn mac_set_params;
38 static OSSL_FUNC_keymgmt_settable_params_fn mac_settable_params;
39 static OSSL_FUNC_keymgmt_has_fn mac_has;
40 static OSSL_FUNC_keymgmt_match_fn mac_match;
41 static OSSL_FUNC_keymgmt_import_fn mac_import;
42 static OSSL_FUNC_keymgmt_import_types_fn mac_imexport_types;
43 static OSSL_FUNC_keymgmt_export_fn mac_export;
44 static OSSL_FUNC_keymgmt_export_types_fn mac_imexport_types;
46 static OSSL_FUNC_keymgmt_new_fn mac_new_cmac;
47 static OSSL_FUNC_keymgmt_gettable_params_fn cmac_gettable_params;
48 static OSSL_FUNC_keymgmt_import_types_fn cmac_imexport_types;
49 static OSSL_FUNC_keymgmt_export_types_fn cmac_imexport_types;
50 static OSSL_FUNC_keymgmt_gen_init_fn cmac_gen_init;
51 static OSSL_FUNC_keymgmt_gen_set_params_fn cmac_gen_set_params;
52 static OSSL_FUNC_keymgmt_gen_settable_params_fn cmac_gen_settable_params;
57 unsigned char *priv_key;
62 MAC_KEY *ossl_mac_key_new(OSSL_LIB_CTX *libctx, int cmac)
66 if (!ossl_prov_is_running())
69 mackey = OPENSSL_zalloc(sizeof(*mackey));
73 mackey->lock = CRYPTO_THREAD_lock_new();
74 if (mackey->lock == NULL) {
78 mackey->libctx = libctx;
85 void ossl_mac_key_free(MAC_KEY *mackey)
92 CRYPTO_DOWN_REF(&mackey->refcnt, &ref, mackey->lock);
96 OPENSSL_secure_clear_free(mackey->priv_key, mackey->priv_key_len);
97 OPENSSL_free(mackey->properties);
98 ossl_prov_cipher_reset(&mackey->cipher);
99 CRYPTO_THREAD_lock_free(mackey->lock);
100 OPENSSL_free(mackey);
103 int ossl_mac_key_up_ref(MAC_KEY *mackey)
107 /* This is effectively doing a new operation on the MAC_KEY and should be
108 * adequately guarded again modules' error states. However, both current
109 * calls here are guarded propery in signature/mac_legacy.c. Thus, it
110 * could be removed here. The concern is that something in the future
111 * might call this function without adequate guards. It's a cheap call,
112 * it seems best to leave it even though it is currently redundant.
114 if (!ossl_prov_is_running())
117 CRYPTO_UP_REF(&mackey->refcnt, &ref, mackey->lock);
121 static void *mac_new(void *provctx)
123 return ossl_mac_key_new(PROV_LIBCTX_OF(provctx), 0);
126 static void *mac_new_cmac(void *provctx)
128 return ossl_mac_key_new(PROV_LIBCTX_OF(provctx), 1);
131 static void mac_free(void *mackey)
133 ossl_mac_key_free(mackey);
136 static int mac_has(const void *keydata, int selection)
138 const MAC_KEY *key = keydata;
141 if (ossl_prov_is_running() && key != NULL) {
143 * MAC keys always have all the parameters they need (i.e. none).
144 * Therefore we always return with 1, if asked about parameters.
145 * Similarly for public keys.
149 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
150 ok = key->priv_key != NULL;
155 static int mac_match(const void *keydata1, const void *keydata2, int selection)
157 const MAC_KEY *key1 = keydata1;
158 const MAC_KEY *key2 = keydata2;
161 if (!ossl_prov_is_running())
164 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
165 if ((key1->priv_key == NULL && key2->priv_key != NULL)
166 || (key1->priv_key != NULL && key2->priv_key == NULL)
167 || key1->priv_key_len != key2->priv_key_len
168 || (key1->cipher.cipher == NULL && key2->cipher.cipher != NULL)
169 || (key1->cipher.cipher != NULL && key2->cipher.cipher == NULL))
172 ok = ok && (key1->priv_key == NULL /* implies key2->privkey == NULL */
173 || CRYPTO_memcmp(key1->priv_key, key2->priv_key,
174 key1->priv_key_len) == 0);
175 if (key1->cipher.cipher != NULL)
176 ok = ok && EVP_CIPHER_is_a(key1->cipher.cipher,
177 EVP_CIPHER_name(key2->cipher.cipher));
182 static int mac_key_fromdata(MAC_KEY *key, const OSSL_PARAM params[])
186 p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
188 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
189 ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
192 OPENSSL_secure_clear_free(key->priv_key, key->priv_key_len);
193 key->priv_key = OPENSSL_secure_malloc(p->data_size);
194 if (key->priv_key == NULL) {
195 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
198 memcpy(key->priv_key, p->data, p->data_size);
199 key->priv_key_len = p->data_size;
202 p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);
204 if (p->data_type != OSSL_PARAM_UTF8_STRING) {
205 ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
208 OPENSSL_free(key->properties);
209 key->properties = OPENSSL_strdup(p->data);
210 if (key->properties == NULL) {
211 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
216 if (key->cmac && !ossl_prov_cipher_load_from_params(&key->cipher, params,
218 ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
222 if (key->priv_key != NULL)
228 static int mac_import(void *keydata, int selection, const OSSL_PARAM params[])
230 MAC_KEY *key = keydata;
232 if (!ossl_prov_is_running() || key == NULL)
235 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) == 0)
238 return mac_key_fromdata(key, params);
241 static int key_to_params(MAC_KEY *key, OSSL_PARAM_BLD *tmpl,
247 if (key->priv_key != NULL
248 && !ossl_param_build_set_octet_string(tmpl, params,
249 OSSL_PKEY_PARAM_PRIV_KEY,
250 key->priv_key, key->priv_key_len))
253 if (key->cipher.cipher != NULL
254 && !ossl_param_build_set_utf8_string(tmpl, params,
255 OSSL_PKEY_PARAM_CIPHER,
256 EVP_CIPHER_name(key->cipher.cipher)))
259 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
260 if (key->cipher.engine != NULL
261 && !ossl_param_build_set_utf8_string(tmpl, params,
262 OSSL_PKEY_PARAM_ENGINE,
263 ENGINE_get_id(key->cipher.engine)))
270 static int mac_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
273 MAC_KEY *key = keydata;
274 OSSL_PARAM_BLD *tmpl;
275 OSSL_PARAM *params = NULL;
278 if (!ossl_prov_is_running() || key == NULL)
281 tmpl = OSSL_PARAM_BLD_new();
285 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
286 && !key_to_params(key, tmpl, NULL))
289 params = OSSL_PARAM_BLD_to_param(tmpl);
293 ret = param_cb(params, cbarg);
294 OSSL_PARAM_free(params);
296 OSSL_PARAM_BLD_free(tmpl);
300 static const OSSL_PARAM mac_key_types[] = {
301 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
302 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
305 static const OSSL_PARAM *mac_imexport_types(int selection)
307 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
308 return mac_key_types;
312 static const OSSL_PARAM cmac_key_types[] = {
313 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
314 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
315 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE, NULL, 0),
316 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
319 static const OSSL_PARAM *cmac_imexport_types(int selection)
321 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
322 return cmac_key_types;
326 static int mac_get_params(void *key, OSSL_PARAM params[])
328 return key_to_params(key, NULL, params);
331 static const OSSL_PARAM *mac_gettable_params(void *provctx)
333 static const OSSL_PARAM gettable_params[] = {
334 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
337 return gettable_params;
340 static const OSSL_PARAM *cmac_gettable_params(void *provctx)
342 static const OSSL_PARAM gettable_params[] = {
343 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
344 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
345 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE, NULL, 0),
348 return gettable_params;
351 static int mac_set_params(void *keydata, const OSSL_PARAM params[])
353 MAC_KEY *key = keydata;
359 p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
361 return mac_key_fromdata(key, params);
366 static const OSSL_PARAM *mac_settable_params(void *provctx)
368 static const OSSL_PARAM settable_params[] = {
369 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
372 return settable_params;
375 static void *mac_gen_init_common(void *provctx, int selection)
377 OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
378 struct mac_gen_ctx *gctx = NULL;
380 if (!ossl_prov_is_running())
383 if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
384 gctx->libctx = libctx;
385 gctx->selection = selection;
390 static void *mac_gen_init(void *provctx, int selection,
391 const OSSL_PARAM params[])
393 struct mac_gen_ctx *gctx = mac_gen_init_common(provctx, selection);
395 if (gctx != NULL && !mac_gen_set_params(gctx, params)) {
402 static void *cmac_gen_init(void *provctx, int selection,
403 const OSSL_PARAM params[])
405 struct mac_gen_ctx *gctx = mac_gen_init_common(provctx, selection);
407 if (gctx != NULL && !cmac_gen_set_params(gctx, params)) {
414 static int mac_gen_set_params(void *genctx, const OSSL_PARAM params[])
416 struct mac_gen_ctx *gctx = genctx;
422 p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY);
424 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
425 ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
428 gctx->priv_key = OPENSSL_secure_malloc(p->data_size);
429 if (gctx->priv_key == NULL) {
430 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
433 memcpy(gctx->priv_key, p->data, p->data_size);
434 gctx->priv_key_len = p->data_size;
440 static int cmac_gen_set_params(void *genctx, const OSSL_PARAM params[])
442 struct mac_gen_ctx *gctx = genctx;
444 if (!mac_gen_set_params(genctx, params))
447 if (!ossl_prov_cipher_load_from_params(&gctx->cipher, params,
449 ERR_raise(ERR_LIB_PROV, ERR_R_PASSED_INVALID_ARGUMENT);
456 static const OSSL_PARAM *mac_gen_settable_params(ossl_unused void *genctx,
457 ossl_unused void *provctx)
459 static OSSL_PARAM settable[] = {
460 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
466 static const OSSL_PARAM *cmac_gen_settable_params(ossl_unused void *genctx,
467 ossl_unused void *provctx)
469 static OSSL_PARAM settable[] = {
470 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
471 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER, NULL, 0),
477 static void *mac_gen(void *genctx, OSSL_CALLBACK *cb, void *cbarg)
479 struct mac_gen_ctx *gctx = genctx;
482 if (!ossl_prov_is_running() || gctx == NULL)
485 if ((key = ossl_mac_key_new(gctx->libctx, 0)) == NULL) {
486 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
490 /* If we're doing parameter generation then we just return a blank key */
491 if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
494 if (gctx->priv_key == NULL) {
495 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
496 ossl_mac_key_free(key);
501 * This is horrible but required for backwards compatibility. We don't
502 * actually do real key generation at all. We simply copy the key that was
503 * previously set in the gctx. Hopefully at some point in the future all
504 * of this can be removed and we will only support the EVP_KDF APIs.
506 if (!ossl_prov_cipher_copy(&key->cipher, &gctx->cipher)) {
507 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
510 ossl_prov_cipher_reset(&gctx->cipher);
511 key->priv_key = gctx->priv_key;
512 key->priv_key_len = gctx->priv_key_len;
513 gctx->priv_key_len = 0;
514 gctx->priv_key = NULL;
519 static void mac_gen_cleanup(void *genctx)
521 struct mac_gen_ctx *gctx = genctx;
523 OPENSSL_secure_clear_free(gctx->priv_key, gctx->priv_key_len);
524 ossl_prov_cipher_reset(&gctx->cipher);
528 const OSSL_DISPATCH ossl_mac_legacy_keymgmt_functions[] = {
529 { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))mac_new },
530 { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))mac_free },
531 { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))mac_get_params },
532 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))mac_gettable_params },
533 { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))mac_set_params },
534 { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))mac_settable_params },
535 { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))mac_has },
536 { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))mac_match },
537 { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))mac_import },
538 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))mac_imexport_types },
539 { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))mac_export },
540 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))mac_imexport_types },
541 { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))mac_gen_init },
542 { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))mac_gen_set_params },
543 { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
544 (void (*)(void))mac_gen_settable_params },
545 { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))mac_gen },
546 { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))mac_gen_cleanup },
550 const OSSL_DISPATCH ossl_cossl_mac_legacy_keymgmt_functions[] = {
551 { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))mac_new_cmac },
552 { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))mac_free },
553 { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))mac_get_params },
554 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))cmac_gettable_params },
555 { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))mac_set_params },
556 { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))mac_settable_params },
557 { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))mac_has },
558 { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))mac_match },
559 { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))mac_import },
560 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))cmac_imexport_types },
561 { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))mac_export },
562 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))cmac_imexport_types },
563 { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))cmac_gen_init },
564 { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))cmac_gen_set_params },
565 { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
566 (void (*)(void))cmac_gen_settable_params },
567 { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))mac_gen },
568 { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))mac_gen_cleanup },