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>
22 # include <openssl/engine.h>
24 #include "internal/param_build_set.h"
25 #include "prov/implementations.h"
26 #include "prov/providercommon.h"
27 #include "prov/provider_ctx.h"
28 #include "prov/macsignature.h"
29 #include "e_os.h" /* strcasecmp */
31 static OSSL_FUNC_keymgmt_new_fn mac_new
;
32 static OSSL_FUNC_keymgmt_free_fn mac_free
;
33 static OSSL_FUNC_keymgmt_gen_init_fn mac_gen_init
;
34 static OSSL_FUNC_keymgmt_gen_fn mac_gen
;
35 static OSSL_FUNC_keymgmt_gen_cleanup_fn mac_gen_cleanup
;
36 static OSSL_FUNC_keymgmt_gen_set_params_fn mac_gen_set_params
;
37 static OSSL_FUNC_keymgmt_gen_settable_params_fn mac_gen_settable_params
;
38 static OSSL_FUNC_keymgmt_get_params_fn mac_get_params
;
39 static OSSL_FUNC_keymgmt_gettable_params_fn mac_gettable_params
;
40 static OSSL_FUNC_keymgmt_set_params_fn mac_set_params
;
41 static OSSL_FUNC_keymgmt_settable_params_fn mac_settable_params
;
42 static OSSL_FUNC_keymgmt_has_fn mac_has
;
43 static OSSL_FUNC_keymgmt_match_fn mac_match
;
44 static OSSL_FUNC_keymgmt_import_fn mac_import
;
45 static OSSL_FUNC_keymgmt_import_types_fn mac_imexport_types
;
46 static OSSL_FUNC_keymgmt_export_fn mac_export
;
47 static OSSL_FUNC_keymgmt_export_types_fn mac_imexport_types
;
49 static OSSL_FUNC_keymgmt_new_fn mac_new_cmac
;
50 static OSSL_FUNC_keymgmt_gettable_params_fn cmac_gettable_params
;
51 static OSSL_FUNC_keymgmt_import_types_fn cmac_imexport_types
;
52 static OSSL_FUNC_keymgmt_export_types_fn cmac_imexport_types
;
53 static OSSL_FUNC_keymgmt_gen_init_fn cmac_gen_init
;
54 static OSSL_FUNC_keymgmt_gen_set_params_fn cmac_gen_set_params
;
55 static OSSL_FUNC_keymgmt_gen_settable_params_fn cmac_gen_settable_params
;
60 unsigned char *priv_key
;
65 MAC_KEY
*ossl_mac_key_new(OSSL_LIB_CTX
*libctx
, int cmac
)
69 if (!ossl_prov_is_running())
72 mackey
= OPENSSL_zalloc(sizeof(*mackey
));
76 mackey
->lock
= CRYPTO_THREAD_lock_new();
77 if (mackey
->lock
== NULL
) {
81 mackey
->libctx
= libctx
;
88 void ossl_mac_key_free(MAC_KEY
*mackey
)
95 CRYPTO_DOWN_REF(&mackey
->refcnt
, &ref
, mackey
->lock
);
99 OPENSSL_secure_clear_free(mackey
->priv_key
, mackey
->priv_key_len
);
100 OPENSSL_free(mackey
->properties
);
101 ossl_prov_cipher_reset(&mackey
->cipher
);
102 CRYPTO_THREAD_lock_free(mackey
->lock
);
103 OPENSSL_free(mackey
);
106 int ossl_mac_key_up_ref(MAC_KEY
*mackey
)
110 /* This is effectively doing a new operation on the MAC_KEY and should be
111 * adequately guarded again modules' error states. However, both current
112 * calls here are guarded properly in signature/mac_legacy.c. Thus, it
113 * could be removed here. The concern is that something in the future
114 * might call this function without adequate guards. It's a cheap call,
115 * it seems best to leave it even though it is currently redundant.
117 if (!ossl_prov_is_running())
120 CRYPTO_UP_REF(&mackey
->refcnt
, &ref
, mackey
->lock
);
124 static void *mac_new(void *provctx
)
126 return ossl_mac_key_new(PROV_LIBCTX_OF(provctx
), 0);
129 static void *mac_new_cmac(void *provctx
)
131 return ossl_mac_key_new(PROV_LIBCTX_OF(provctx
), 1);
134 static void mac_free(void *mackey
)
136 ossl_mac_key_free(mackey
);
139 static int mac_has(const void *keydata
, int selection
)
141 const MAC_KEY
*key
= keydata
;
144 if (ossl_prov_is_running() && key
!= NULL
) {
146 * MAC keys always have all the parameters they need (i.e. none).
147 * Therefore we always return with 1, if asked about parameters.
148 * Similarly for public keys.
152 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0)
153 ok
= key
->priv_key
!= NULL
;
158 static int mac_match(const void *keydata1
, const void *keydata2
, int selection
)
160 const MAC_KEY
*key1
= keydata1
;
161 const MAC_KEY
*key2
= keydata2
;
164 if (!ossl_prov_is_running())
167 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0) {
168 if ((key1
->priv_key
== NULL
&& key2
->priv_key
!= NULL
)
169 || (key1
->priv_key
!= NULL
&& key2
->priv_key
== NULL
)
170 || key1
->priv_key_len
!= key2
->priv_key_len
171 || (key1
->cipher
.cipher
== NULL
&& key2
->cipher
.cipher
!= NULL
)
172 || (key1
->cipher
.cipher
!= NULL
&& key2
->cipher
.cipher
== NULL
))
175 ok
= ok
&& (key1
->priv_key
== NULL
/* implies key2->privkey == NULL */
176 || CRYPTO_memcmp(key1
->priv_key
, key2
->priv_key
,
177 key1
->priv_key_len
) == 0);
178 if (key1
->cipher
.cipher
!= NULL
)
179 ok
= ok
&& EVP_CIPHER_is_a(key1
->cipher
.cipher
,
180 EVP_CIPHER_get0_name(key2
->cipher
.cipher
));
185 static int mac_key_fromdata(MAC_KEY
*key
, const OSSL_PARAM params
[])
189 p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PRIV_KEY
);
191 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
) {
192 ERR_raise(ERR_LIB_PROV
, ERR_R_PASSED_INVALID_ARGUMENT
);
195 OPENSSL_secure_clear_free(key
->priv_key
, key
->priv_key_len
);
196 /* allocate at least one byte to distinguish empty key from no key set */
197 key
->priv_key
= OPENSSL_secure_malloc(p
->data_size
> 0 ? p
->data_size
: 1);
198 if (key
->priv_key
== NULL
) {
199 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
202 memcpy(key
->priv_key
, p
->data
, p
->data_size
);
203 key
->priv_key_len
= p
->data_size
;
206 p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PROPERTIES
);
208 if (p
->data_type
!= OSSL_PARAM_UTF8_STRING
) {
209 ERR_raise(ERR_LIB_PROV
, ERR_R_PASSED_INVALID_ARGUMENT
);
212 OPENSSL_free(key
->properties
);
213 key
->properties
= OPENSSL_strdup(p
->data
);
214 if (key
->properties
== NULL
) {
215 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
220 if (key
->cmac
&& !ossl_prov_cipher_load_from_params(&key
->cipher
, params
,
222 ERR_raise(ERR_LIB_PROV
, ERR_R_PASSED_INVALID_ARGUMENT
);
226 if (key
->priv_key
!= NULL
)
232 static int mac_import(void *keydata
, int selection
, const OSSL_PARAM params
[])
234 MAC_KEY
*key
= keydata
;
236 if (!ossl_prov_is_running() || key
== NULL
)
239 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) == 0)
242 return mac_key_fromdata(key
, params
);
245 static int key_to_params(MAC_KEY
*key
, OSSL_PARAM_BLD
*tmpl
,
251 if (key
->priv_key
!= NULL
252 && !ossl_param_build_set_octet_string(tmpl
, params
,
253 OSSL_PKEY_PARAM_PRIV_KEY
,
254 key
->priv_key
, key
->priv_key_len
))
257 if (key
->cipher
.cipher
!= NULL
258 && !ossl_param_build_set_utf8_string(tmpl
, params
,
259 OSSL_PKEY_PARAM_CIPHER
,
260 EVP_CIPHER_get0_name(key
->cipher
.cipher
)))
263 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
264 if (key
->cipher
.engine
!= NULL
265 && !ossl_param_build_set_utf8_string(tmpl
, params
,
266 OSSL_PKEY_PARAM_ENGINE
,
267 ENGINE_get_id(key
->cipher
.engine
)))
274 static int mac_export(void *keydata
, int selection
, OSSL_CALLBACK
*param_cb
,
277 MAC_KEY
*key
= keydata
;
278 OSSL_PARAM_BLD
*tmpl
;
279 OSSL_PARAM
*params
= NULL
;
282 if (!ossl_prov_is_running() || key
== NULL
)
285 tmpl
= OSSL_PARAM_BLD_new();
289 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0
290 && !key_to_params(key
, tmpl
, NULL
))
293 params
= OSSL_PARAM_BLD_to_param(tmpl
);
297 ret
= param_cb(params
, cbarg
);
298 OSSL_PARAM_free(params
);
300 OSSL_PARAM_BLD_free(tmpl
);
304 static const OSSL_PARAM mac_key_types
[] = {
305 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
306 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES
, NULL
, 0),
309 static const OSSL_PARAM
*mac_imexport_types(int selection
)
311 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0)
312 return mac_key_types
;
316 static const OSSL_PARAM cmac_key_types
[] = {
317 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
318 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER
, NULL
, 0),
319 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE
, NULL
, 0),
320 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES
, NULL
, 0),
323 static const OSSL_PARAM
*cmac_imexport_types(int selection
)
325 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0)
326 return cmac_key_types
;
330 static int mac_get_params(void *key
, OSSL_PARAM params
[])
332 return key_to_params(key
, NULL
, params
);
335 static const OSSL_PARAM
*mac_gettable_params(void *provctx
)
337 static const OSSL_PARAM gettable_params
[] = {
338 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
341 return gettable_params
;
344 static const OSSL_PARAM
*cmac_gettable_params(void *provctx
)
346 static const OSSL_PARAM gettable_params
[] = {
347 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
348 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER
, NULL
, 0),
349 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_ENGINE
, NULL
, 0),
352 return gettable_params
;
355 static int mac_set_params(void *keydata
, const OSSL_PARAM params
[])
357 MAC_KEY
*key
= keydata
;
363 p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PRIV_KEY
);
365 return mac_key_fromdata(key
, params
);
370 static const OSSL_PARAM
*mac_settable_params(void *provctx
)
372 static const OSSL_PARAM settable_params
[] = {
373 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
376 return settable_params
;
379 static void *mac_gen_init_common(void *provctx
, int selection
)
381 OSSL_LIB_CTX
*libctx
= PROV_LIBCTX_OF(provctx
);
382 struct mac_gen_ctx
*gctx
= NULL
;
384 if (!ossl_prov_is_running())
387 if ((gctx
= OPENSSL_zalloc(sizeof(*gctx
))) != NULL
) {
388 gctx
->libctx
= libctx
;
389 gctx
->selection
= selection
;
394 static void *mac_gen_init(void *provctx
, int selection
,
395 const OSSL_PARAM params
[])
397 struct mac_gen_ctx
*gctx
= mac_gen_init_common(provctx
, selection
);
399 if (gctx
!= NULL
&& !mac_gen_set_params(gctx
, params
)) {
406 static void *cmac_gen_init(void *provctx
, int selection
,
407 const OSSL_PARAM params
[])
409 struct mac_gen_ctx
*gctx
= mac_gen_init_common(provctx
, selection
);
411 if (gctx
!= NULL
&& !cmac_gen_set_params(gctx
, params
)) {
418 static int mac_gen_set_params(void *genctx
, const OSSL_PARAM params
[])
420 struct mac_gen_ctx
*gctx
= genctx
;
426 p
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_PRIV_KEY
);
428 if (p
->data_type
!= OSSL_PARAM_OCTET_STRING
) {
429 ERR_raise(ERR_LIB_PROV
, ERR_R_PASSED_INVALID_ARGUMENT
);
432 gctx
->priv_key
= OPENSSL_secure_malloc(p
->data_size
);
433 if (gctx
->priv_key
== NULL
) {
434 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
437 memcpy(gctx
->priv_key
, p
->data
, p
->data_size
);
438 gctx
->priv_key_len
= p
->data_size
;
444 static int cmac_gen_set_params(void *genctx
, const OSSL_PARAM params
[])
446 struct mac_gen_ctx
*gctx
= genctx
;
448 if (!mac_gen_set_params(genctx
, params
))
451 if (!ossl_prov_cipher_load_from_params(&gctx
->cipher
, params
,
453 ERR_raise(ERR_LIB_PROV
, ERR_R_PASSED_INVALID_ARGUMENT
);
460 static const OSSL_PARAM
*mac_gen_settable_params(ossl_unused
void *genctx
,
461 ossl_unused
void *provctx
)
463 static OSSL_PARAM settable
[] = {
464 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
470 static const OSSL_PARAM
*cmac_gen_settable_params(ossl_unused
void *genctx
,
471 ossl_unused
void *provctx
)
473 static OSSL_PARAM settable
[] = {
474 OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY
, NULL
, 0),
475 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_CIPHER
, NULL
, 0),
481 static void *mac_gen(void *genctx
, OSSL_CALLBACK
*cb
, void *cbarg
)
483 struct mac_gen_ctx
*gctx
= genctx
;
486 if (!ossl_prov_is_running() || gctx
== NULL
)
489 if ((key
= ossl_mac_key_new(gctx
->libctx
, 0)) == NULL
) {
490 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
494 /* If we're doing parameter generation then we just return a blank key */
495 if ((gctx
->selection
& OSSL_KEYMGMT_SELECT_KEYPAIR
) == 0)
498 if (gctx
->priv_key
== NULL
) {
499 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
500 ossl_mac_key_free(key
);
505 * This is horrible but required for backwards compatibility. We don't
506 * actually do real key generation at all. We simply copy the key that was
507 * previously set in the gctx. Hopefully at some point in the future all
508 * of this can be removed and we will only support the EVP_KDF APIs.
510 if (!ossl_prov_cipher_copy(&key
->cipher
, &gctx
->cipher
)) {
511 ossl_mac_key_free(key
);
512 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
515 ossl_prov_cipher_reset(&gctx
->cipher
);
516 key
->priv_key
= gctx
->priv_key
;
517 key
->priv_key_len
= gctx
->priv_key_len
;
518 gctx
->priv_key_len
= 0;
519 gctx
->priv_key
= NULL
;
524 static void mac_gen_cleanup(void *genctx
)
526 struct mac_gen_ctx
*gctx
= genctx
;
528 OPENSSL_secure_clear_free(gctx
->priv_key
, gctx
->priv_key_len
);
529 ossl_prov_cipher_reset(&gctx
->cipher
);
533 const OSSL_DISPATCH ossl_mac_legacy_keymgmt_functions
[] = {
534 { OSSL_FUNC_KEYMGMT_NEW
, (void (*)(void))mac_new
},
535 { OSSL_FUNC_KEYMGMT_FREE
, (void (*)(void))mac_free
},
536 { OSSL_FUNC_KEYMGMT_GET_PARAMS
, (void (*) (void))mac_get_params
},
537 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
, (void (*) (void))mac_gettable_params
},
538 { OSSL_FUNC_KEYMGMT_SET_PARAMS
, (void (*) (void))mac_set_params
},
539 { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS
, (void (*) (void))mac_settable_params
},
540 { OSSL_FUNC_KEYMGMT_HAS
, (void (*)(void))mac_has
},
541 { OSSL_FUNC_KEYMGMT_MATCH
, (void (*)(void))mac_match
},
542 { OSSL_FUNC_KEYMGMT_IMPORT
, (void (*)(void))mac_import
},
543 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES
, (void (*)(void))mac_imexport_types
},
544 { OSSL_FUNC_KEYMGMT_EXPORT
, (void (*)(void))mac_export
},
545 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES
, (void (*)(void))mac_imexport_types
},
546 { OSSL_FUNC_KEYMGMT_GEN_INIT
, (void (*)(void))mac_gen_init
},
547 { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS
, (void (*)(void))mac_gen_set_params
},
548 { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS
,
549 (void (*)(void))mac_gen_settable_params
},
550 { OSSL_FUNC_KEYMGMT_GEN
, (void (*)(void))mac_gen
},
551 { OSSL_FUNC_KEYMGMT_GEN_CLEANUP
, (void (*)(void))mac_gen_cleanup
},
555 const OSSL_DISPATCH ossl_cmac_legacy_keymgmt_functions
[] = {
556 { OSSL_FUNC_KEYMGMT_NEW
, (void (*)(void))mac_new_cmac
},
557 { OSSL_FUNC_KEYMGMT_FREE
, (void (*)(void))mac_free
},
558 { OSSL_FUNC_KEYMGMT_GET_PARAMS
, (void (*) (void))mac_get_params
},
559 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS
, (void (*) (void))cmac_gettable_params
},
560 { OSSL_FUNC_KEYMGMT_SET_PARAMS
, (void (*) (void))mac_set_params
},
561 { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS
, (void (*) (void))mac_settable_params
},
562 { OSSL_FUNC_KEYMGMT_HAS
, (void (*)(void))mac_has
},
563 { OSSL_FUNC_KEYMGMT_MATCH
, (void (*)(void))mac_match
},
564 { OSSL_FUNC_KEYMGMT_IMPORT
, (void (*)(void))mac_import
},
565 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES
, (void (*)(void))cmac_imexport_types
},
566 { OSSL_FUNC_KEYMGMT_EXPORT
, (void (*)(void))mac_export
},
567 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES
, (void (*)(void))cmac_imexport_types
},
568 { OSSL_FUNC_KEYMGMT_GEN_INIT
, (void (*)(void))cmac_gen_init
},
569 { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS
, (void (*)(void))cmac_gen_set_params
},
570 { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS
,
571 (void (*)(void))cmac_gen_settable_params
},
572 { OSSL_FUNC_KEYMGMT_GEN
, (void (*)(void))mac_gen
},
573 { OSSL_FUNC_KEYMGMT_GEN_CLEANUP
, (void (*)(void))mac_gen_cleanup
},