]> git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/evp/p_lib.c
f1ffb80e9040f1d8f8dad7badf2dba366faf379d
[thirdparty/openssl.git] / crypto / evp / p_lib.c
1 /*
2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
3 *
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
8 */
9
10 /*
11 * DSA low level APIs are deprecated for public use, but still ok for
12 * internal use.
13 */
14 #include "internal/deprecated.h"
15
16 #include <assert.h>
17 #include <stdio.h>
18 #include "internal/cryptlib.h"
19 #include "internal/refcount.h"
20 #include "internal/namemap.h"
21 #include <openssl/bn.h>
22 #include <openssl/err.h>
23 #include <openssl/objects.h>
24 #include <openssl/evp.h>
25 #include <openssl/x509.h>
26 #include <openssl/rsa.h>
27 #include <openssl/dsa.h>
28 #include <openssl/dh.h>
29 #include <openssl/ec.h>
30 #include <openssl/cmac.h>
31 #include <openssl/engine.h>
32 #include <openssl/params.h>
33 #include <openssl/param_build.h>
34 #include <openssl/encoder.h>
35 #include <openssl/core_names.h>
36
37 #include "internal/ffc.h"
38 #include "crypto/asn1.h"
39 #include "crypto/evp.h"
40 #include "crypto/ec.h"
41 #include "crypto/ecx.h"
42 #include "crypto/x509.h"
43 #include "internal/provider.h"
44 #include "evp_local.h"
45
46 #include "crypto/ec.h"
47
48 #include "e_os.h" /* strcasecmp on Windows */
49
50 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
51 int len, EVP_KEYMGMT *keymgmt);
52 static void evp_pkey_free_it(EVP_PKEY *key);
53
54 #ifndef FIPS_MODULE
55
56 /* The type of parameters selected in key parameter functions */
57 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
58
59 int EVP_PKEY_bits(const EVP_PKEY *pkey)
60 {
61 int size = 0;
62
63 if (pkey != NULL) {
64 size = pkey->cache.bits;
65 if (pkey->ameth != NULL && pkey->ameth->pkey_bits != NULL)
66 size = pkey->ameth->pkey_bits(pkey);
67 }
68 return size < 0 ? 0 : size;
69 }
70
71 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
72 {
73 int size = 0;
74
75 if (pkey != NULL) {
76 size = pkey->cache.security_bits;
77 if (pkey->ameth != NULL && pkey->ameth->pkey_security_bits != NULL)
78 size = pkey->ameth->pkey_security_bits(pkey);
79 }
80 return size < 0 ? 0 : size;
81 }
82
83 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
84 {
85 # ifndef OPENSSL_NO_DSA
86 if (pkey->type == EVP_PKEY_DSA) {
87 int ret = pkey->save_parameters;
88
89 if (mode >= 0)
90 pkey->save_parameters = mode;
91 return ret;
92 }
93 # endif
94 # ifndef OPENSSL_NO_EC
95 if (pkey->type == EVP_PKEY_EC) {
96 int ret = pkey->save_parameters;
97
98 if (mode >= 0)
99 pkey->save_parameters = mode;
100 return ret;
101 }
102 # endif
103 return 0;
104 }
105
106 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
107 {
108 return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
109 }
110
111 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
112 {
113 return CRYPTO_get_ex_data(&key->ex_data, idx);
114 }
115
116 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
117 {
118 /*
119 * Clean up legacy stuff from this function when legacy support is gone.
120 */
121
122 EVP_PKEY *downgraded_from = NULL;
123 int ok = 0;
124
125 /*
126 * If |to| is a legacy key and |from| isn't, we must make a downgraded
127 * copy of |from|. If that fails, this function fails.
128 */
129 if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from)) {
130 if (!evp_pkey_copy_downgraded(&downgraded_from, from))
131 goto end;
132 from = downgraded_from;
133 }
134
135 /*
136 * Make sure |to| is typed. Content is less important at this early
137 * stage.
138 *
139 * 1. If |to| is untyped, assign |from|'s key type to it.
140 * 2. If |to| contains a legacy key, compare its |type| to |from|'s.
141 * (|from| was already downgraded above)
142 *
143 * If |to| is a provided key, there's nothing more to do here, functions
144 * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
145 * further down help us find out if they are the same or not.
146 */
147 if (evp_pkey_is_blank(to)) {
148 if (evp_pkey_is_legacy(from)) {
149 if (EVP_PKEY_set_type(to, from->type) == 0)
150 goto end;
151 } else {
152 if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
153 goto end;
154 }
155 } else if (evp_pkey_is_legacy(to)) {
156 if (to->type != from->type) {
157 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
158 goto end;
159 }
160 }
161
162 if (EVP_PKEY_missing_parameters(from)) {
163 ERR_raise(ERR_LIB_EVP, EVP_R_MISSING_PARAMETERS);
164 goto end;
165 }
166
167 if (!EVP_PKEY_missing_parameters(to)) {
168 if (EVP_PKEY_parameters_eq(to, from) == 1)
169 ok = 1;
170 else
171 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_PARAMETERS);
172 goto end;
173 }
174
175 /* For purely provided keys, we just call the keymgmt utility */
176 if (to->keymgmt != NULL && from->keymgmt != NULL) {
177 ok = evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
178 goto end;
179 }
180
181 /*
182 * If |to| is provided, we know that |from| is legacy at this point.
183 * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
184 * to copy the appropriate data to |to|'s keydata.
185 */
186 if (to->keymgmt != NULL) {
187 EVP_KEYMGMT *to_keymgmt = to->keymgmt;
188 void *from_keydata =
189 evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
190 NULL);
191
192 /*
193 * If we get a NULL, it could be an internal error, or it could be
194 * that there's a key mismatch. We're pretending the latter...
195 */
196 if (from_keydata == NULL)
197 ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
198 else
199 ok = evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
200 SELECT_PARAMETERS);
201 goto end;
202 }
203
204 /* Both keys are legacy */
205 if (from->ameth != NULL && from->ameth->param_copy != NULL)
206 ok = from->ameth->param_copy(to, from);
207 end:
208 EVP_PKEY_free(downgraded_from);
209 return ok;
210 }
211
212 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
213 {
214 if (pkey != NULL) {
215 if (pkey->keymgmt != NULL)
216 return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
217 else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
218 return pkey->ameth->param_missing(pkey);
219 }
220 return 0;
221 }
222
223 /*
224 * This function is called for any mixture of keys except pure legacy pair.
225 * When legacy keys are gone, we replace a call to this functions with
226 * a call to evp_keymgmt_util_match().
227 */
228 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
229 int selection)
230 {
231 EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
232 void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
233
234 /* If none of them are provided, this function shouldn't have been called */
235 if (!ossl_assert(evp_pkey_is_provided(a) || evp_pkey_is_provided(b)))
236 return -2;
237
238 /* For purely provided keys, we just call the keymgmt utility */
239 if (evp_pkey_is_provided(a) && evp_pkey_is_provided(b))
240 return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
241
242 /*
243 * At this point, one of them is provided, the other not. This allows
244 * us to compare types using legacy NIDs.
245 */
246 if (evp_pkey_is_legacy(a)
247 && !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type)))
248 return -1; /* not the same key type */
249 if (evp_pkey_is_legacy(b)
250 && !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))
251 return -1; /* not the same key type */
252
253 /*
254 * We've determined that they both are the same keytype, so the next
255 * step is to do a bit of cross export to ensure we have keydata for
256 * both keys in the same keymgmt.
257 */
258 keymgmt1 = a->keymgmt;
259 keydata1 = a->keydata;
260 keymgmt2 = b->keymgmt;
261 keydata2 = b->keydata;
262
263 if (keymgmt2 != NULL && keymgmt2->match != NULL) {
264 tmp_keydata =
265 evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
266 if (tmp_keydata != NULL) {
267 keymgmt1 = keymgmt2;
268 keydata1 = tmp_keydata;
269 }
270 }
271 if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
272 tmp_keydata =
273 evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
274 if (tmp_keydata != NULL) {
275 keymgmt2 = keymgmt1;
276 keydata2 = tmp_keydata;
277 }
278 }
279
280 /* If we still don't have matching keymgmt implementations, we give up */
281 if (keymgmt1 != keymgmt2)
282 return -2;
283
284 /* If the keymgmt implementations are NULL, the export failed */
285 if (keymgmt1 == NULL)
286 return -2;
287
288 return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
289 }
290
291 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
292 {
293 return EVP_PKEY_parameters_eq(a, b);
294 }
295
296 int EVP_PKEY_parameters_eq(const EVP_PKEY *a, const EVP_PKEY *b)
297 {
298 /*
299 * This will just call evp_keymgmt_util_match when legacy support
300 * is gone.
301 */
302
303 if (a->keymgmt != NULL || b->keymgmt != NULL)
304 return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
305
306 /* All legacy keys */
307 if (a->type != b->type)
308 return -1;
309 if (a->ameth != NULL && a->ameth->param_cmp != NULL)
310 return a->ameth->param_cmp(a, b);
311 return -2;
312 }
313
314 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
315 {
316 return EVP_PKEY_eq(a, b);
317 }
318
319 int EVP_PKEY_eq(const EVP_PKEY *a, const EVP_PKEY *b)
320 {
321 /*
322 * This will just call evp_keymgmt_util_match when legacy support
323 * is gone.
324 */
325
326 if (a->keymgmt != NULL || b->keymgmt != NULL)
327 return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
328 | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
329
330 /* All legacy keys */
331 if (a->type != b->type)
332 return -1;
333
334 if (a->ameth != NULL) {
335 int ret;
336 /* Compare parameters if the algorithm has them */
337 if (a->ameth->param_cmp != NULL) {
338 ret = a->ameth->param_cmp(a, b);
339 if (ret <= 0)
340 return ret;
341 }
342
343 if (a->ameth->pub_cmp != NULL)
344 return a->ameth->pub_cmp(a, b);
345 }
346
347 return -2;
348 }
349
350
351 static EVP_PKEY *new_raw_key_int(OSSL_LIB_CTX *libctx,
352 const char *strtype,
353 const char *propq,
354 int nidtype,
355 ENGINE *e,
356 const unsigned char *key,
357 size_t len,
358 int key_is_priv)
359 {
360 EVP_PKEY *pkey = NULL;
361 EVP_PKEY_CTX *ctx = NULL;
362 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
363 int result = 0;
364
365 # ifndef OPENSSL_NO_ENGINE
366 /* Check if there is an Engine for this type */
367 if (e == NULL) {
368 ENGINE *tmpe = NULL;
369
370 if (strtype != NULL)
371 ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
372 else if (nidtype != EVP_PKEY_NONE)
373 ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
374
375 /* If tmpe is NULL then no engine is claiming to support this type */
376 if (tmpe == NULL)
377 ameth = NULL;
378
379 ENGINE_finish(tmpe);
380 }
381 # endif
382
383 if (e == NULL && ameth == NULL) {
384 /*
385 * No engine is claiming to support this type, so lets see if we have
386 * a provider.
387 */
388 ctx = EVP_PKEY_CTX_new_from_name(libctx,
389 strtype != NULL ? strtype
390 : OBJ_nid2sn(nidtype),
391 propq);
392 if (ctx == NULL)
393 goto err;
394 /* May fail if no provider available */
395 ERR_set_mark();
396 if (EVP_PKEY_fromdata_init(ctx) == 1) {
397 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
398
399 ERR_clear_last_mark();
400 params[0] = OSSL_PARAM_construct_octet_string(
401 key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
402 : OSSL_PKEY_PARAM_PUB_KEY,
403 (void *)key, len);
404
405 if (EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params) != 1) {
406 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
407 goto err;
408 }
409
410 EVP_PKEY_CTX_free(ctx);
411
412 return pkey;
413 }
414 ERR_pop_to_mark();
415 /* else not supported so fallback to legacy */
416 }
417
418 /* Legacy code path */
419
420 pkey = EVP_PKEY_new();
421 if (pkey == NULL) {
422 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
423 goto err;
424 }
425
426 if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
427 /* EVPerr already called */
428 goto err;
429 }
430
431 if (!ossl_assert(pkey->ameth != NULL))
432 goto err;
433
434 if (key_is_priv) {
435 if (pkey->ameth->set_priv_key == NULL) {
436 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
437 goto err;
438 }
439
440 if (!pkey->ameth->set_priv_key(pkey, key, len)) {
441 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
442 goto err;
443 }
444 } else {
445 if (pkey->ameth->set_pub_key == NULL) {
446 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
447 goto err;
448 }
449
450 if (!pkey->ameth->set_pub_key(pkey, key, len)) {
451 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
452 goto err;
453 }
454 }
455
456 result = 1;
457 err:
458 if (!result) {
459 EVP_PKEY_free(pkey);
460 pkey = NULL;
461 }
462 EVP_PKEY_CTX_free(ctx);
463 return pkey;
464 }
465
466 EVP_PKEY *EVP_PKEY_new_raw_private_key_ex(OSSL_LIB_CTX *libctx,
467 const char *keytype,
468 const char *propq,
469 const unsigned char *priv, size_t len)
470 {
471 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
472 len, 1);
473 }
474
475 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
476 const unsigned char *priv,
477 size_t len)
478 {
479 return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
480 }
481
482 EVP_PKEY *EVP_PKEY_new_raw_public_key_ex(OSSL_LIB_CTX *libctx,
483 const char *keytype, const char *propq,
484 const unsigned char *pub, size_t len)
485 {
486 return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
487 len, 0);
488 }
489
490 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
491 const unsigned char *pub,
492 size_t len)
493 {
494 return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
495 }
496
497 struct raw_key_details_st
498 {
499 unsigned char **key;
500 size_t *len;
501 int selection;
502 };
503
504 static OSSL_CALLBACK get_raw_key_details;
505 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
506 {
507 const OSSL_PARAM *p = NULL;
508 struct raw_key_details_st *raw_key = arg;
509
510 if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
511 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
512 != NULL)
513 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
514 SIZE_MAX, raw_key->len);
515 } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
516 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
517 != NULL)
518 return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
519 SIZE_MAX, raw_key->len);
520 }
521
522 return 0;
523 }
524
525 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
526 size_t *len)
527 {
528 if (pkey->keymgmt != NULL) {
529 struct raw_key_details_st raw_key;
530
531 raw_key.key = priv == NULL ? NULL : &priv;
532 raw_key.len = len;
533 raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
534
535 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
536 get_raw_key_details, &raw_key);
537 }
538
539 if (pkey->ameth == NULL) {
540 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
541 return 0;
542 }
543
544 if (pkey->ameth->get_priv_key == NULL) {
545 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
546 return 0;
547 }
548
549 if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
550 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
551 return 0;
552 }
553
554 return 1;
555 }
556
557 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
558 size_t *len)
559 {
560 if (pkey->keymgmt != NULL) {
561 struct raw_key_details_st raw_key;
562
563 raw_key.key = pub == NULL ? NULL : &pub;
564 raw_key.len = len;
565 raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
566
567 return evp_keymgmt_util_export(pkey, OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
568 get_raw_key_details, &raw_key);
569 }
570
571 if (pkey->ameth == NULL) {
572 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
573 return 0;
574 }
575
576 if (pkey->ameth->get_pub_key == NULL) {
577 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
578 return 0;
579 }
580
581 if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
582 ERR_raise(ERR_LIB_EVP, EVP_R_GET_RAW_KEY_FAILED);
583 return 0;
584 }
585
586 return 1;
587 }
588
589 static EVP_PKEY *new_cmac_key_int(const unsigned char *priv, size_t len,
590 const char *cipher_name,
591 const EVP_CIPHER *cipher,
592 OSSL_LIB_CTX *libctx,
593 const char *propq, ENGINE *e)
594 {
595 # ifndef OPENSSL_NO_CMAC
596 # ifndef OPENSSL_NO_ENGINE
597 const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
598 # endif
599 OSSL_PARAM params[5], *p = params;
600 EVP_PKEY *pkey = NULL;
601 EVP_PKEY_CTX *ctx;
602
603 if (cipher != NULL)
604 cipher_name = EVP_CIPHER_name(cipher);
605
606 if (cipher_name == NULL) {
607 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
608 return NULL;
609 }
610
611 ctx = EVP_PKEY_CTX_new_from_name(libctx, "CMAC", propq);
612 if (ctx == NULL)
613 goto err;
614
615 if (!EVP_PKEY_fromdata_init(ctx)) {
616 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
617 goto err;
618 }
619
620 *p++ = OSSL_PARAM_construct_octet_string(OSSL_PKEY_PARAM_PRIV_KEY,
621 (void *)priv, len);
622 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_CIPHER,
623 (char *)cipher_name, 0);
624 if (propq != NULL)
625 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_PROPERTIES,
626 (char *)propq, 0);
627 # ifndef OPENSSL_NO_ENGINE
628 if (engine_id != NULL)
629 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_ENGINE,
630 (char *)engine_id, 0);
631 # endif
632 *p = OSSL_PARAM_construct_end();
633
634 if (!EVP_PKEY_fromdata(ctx, &pkey, EVP_PKEY_KEYPAIR, params)) {
635 ERR_raise(ERR_LIB_EVP, EVP_R_KEY_SETUP_FAILED);
636 goto err;
637 }
638
639 err:
640 EVP_PKEY_CTX_free(ctx);
641
642 return pkey;
643 # else
644 ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
645 return NULL;
646 # endif
647 }
648
649 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
650 size_t len, const EVP_CIPHER *cipher)
651 {
652 return new_cmac_key_int(priv, len, NULL, cipher, NULL, NULL, e);
653 }
654
655 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
656 {
657 return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
658 }
659
660 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
661 {
662 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
663 }
664
665 # ifndef OPENSSL_NO_DEPRECATED_3_0
666 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
667 {
668 if (!evp_pkey_is_legacy(pkey)) {
669 const char *name = OBJ_nid2sn(type);
670
671 if (name != NULL && EVP_PKEY_is_a(pkey, name))
672 return 1;
673
674 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_OPERATION);
675 return 0;
676 }
677
678 if (pkey->type == type) {
679 return 1; /* it already is that type */
680 }
681
682 /*
683 * The application is requesting to alias this to a different pkey type,
684 * but not one that resolves to the base type.
685 */
686 if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
687 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
688 return 0;
689 }
690
691 pkey->type = type;
692 return 1;
693 }
694 # endif
695
696 # ifndef OPENSSL_NO_ENGINE
697 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
698 {
699 if (e != NULL) {
700 if (!ENGINE_init(e)) {
701 ERR_raise(ERR_LIB_EVP, ERR_R_ENGINE_LIB);
702 return 0;
703 }
704 if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
705 ENGINE_finish(e);
706 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
707 return 0;
708 }
709 }
710 ENGINE_finish(pkey->pmeth_engine);
711 pkey->pmeth_engine = e;
712 return 1;
713 }
714
715 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
716 {
717 return pkey->engine;
718 }
719 # endif
720
721 # ifndef OPENSSL_NO_DEPRECATED_3_0
722 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
723 {
724 int alias = type;
725
726 # ifndef OPENSSL_NO_EC
727 if ((key != NULL) && (EVP_PKEY_type(type) == EVP_PKEY_EC)) {
728 const EC_GROUP *group = EC_KEY_get0_group(key);
729
730 if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
731 alias = EVP_PKEY_SM2;
732 }
733 # endif
734
735 if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
736 return 0;
737 if (!EVP_PKEY_set_alias_type(pkey, alias))
738 return 0;
739 pkey->pkey.ptr = key;
740 return (key != NULL);
741 }
742 # endif
743
744 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
745 {
746 if (pkey == NULL)
747 return NULL;
748
749 if (!evp_pkey_is_provided(pkey))
750 return pkey->pkey.ptr;
751
752 return NULL;
753 }
754
755 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
756 {
757 const ASN1_OCTET_STRING *os = NULL;
758 if (pkey->type != EVP_PKEY_HMAC) {
759 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_AN_HMAC_KEY);
760 return NULL;
761 }
762 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
763 if (os != NULL) {
764 *len = os->length;
765 return os->data;
766 }
767 return NULL;
768 }
769
770 # ifndef OPENSSL_NO_POLY1305
771 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
772 {
773 const ASN1_OCTET_STRING *os = NULL;
774 if (pkey->type != EVP_PKEY_POLY1305) {
775 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_POLY1305_KEY);
776 return NULL;
777 }
778 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
779 if (os != NULL) {
780 *len = os->length;
781 return os->data;
782 }
783 return NULL;
784 }
785 # endif
786
787 # ifndef OPENSSL_NO_SIPHASH
788 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
789 {
790 const ASN1_OCTET_STRING *os = NULL;
791
792 if (pkey->type != EVP_PKEY_SIPHASH) {
793 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_SIPHASH_KEY);
794 return NULL;
795 }
796 os = evp_pkey_get_legacy((EVP_PKEY *)pkey);
797 if (os != NULL) {
798 *len = os->length;
799 return os->data;
800 }
801 return NULL;
802 }
803 # endif
804
805 # ifndef OPENSSL_NO_DSA
806 static DSA *evp_pkey_get0_DSA_int(const EVP_PKEY *pkey)
807 {
808 if (pkey->type != EVP_PKEY_DSA) {
809 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DSA_KEY);
810 return NULL;
811 }
812 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
813 }
814
815 const DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
816 {
817 return evp_pkey_get0_DSA_int(pkey);
818 }
819
820 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
821 {
822 int ret = EVP_PKEY_assign_DSA(pkey, key);
823 if (ret)
824 DSA_up_ref(key);
825 return ret;
826 }
827 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
828 {
829 DSA *ret = evp_pkey_get0_DSA_int(pkey);
830
831 if (ret != NULL)
832 DSA_up_ref(ret);
833 return ret;
834 }
835 # endif /* OPENSSL_NO_DSA */
836
837 # ifndef OPENSSL_NO_EC
838 static const ECX_KEY *evp_pkey_get0_ECX_KEY(const EVP_PKEY *pkey, int type)
839 {
840 if (EVP_PKEY_base_id(pkey) != type) {
841 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_ECX_KEY);
842 return NULL;
843 }
844 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
845 }
846
847 static ECX_KEY *evp_pkey_get1_ECX_KEY(EVP_PKEY *pkey, int type)
848 {
849 ECX_KEY *ret = (ECX_KEY *)evp_pkey_get0_ECX_KEY(pkey, type);
850
851 if (ret != NULL && !ossl_ecx_key_up_ref(ret))
852 ret = NULL;
853 return ret;
854 }
855
856 # define IMPLEMENT_ECX_VARIANT(NAME) \
857 ECX_KEY *ossl_evp_pkey_get1_##NAME(EVP_PKEY *pkey) \
858 { \
859 return evp_pkey_get1_ECX_KEY(pkey, EVP_PKEY_##NAME); \
860 }
861 IMPLEMENT_ECX_VARIANT(X25519)
862 IMPLEMENT_ECX_VARIANT(X448)
863 IMPLEMENT_ECX_VARIANT(ED25519)
864 IMPLEMENT_ECX_VARIANT(ED448)
865
866 # endif
867
868 # if !defined(OPENSSL_NO_DH) && !defined(OPENSSL_NO_DEPRECATED_3_0)
869
870 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
871 {
872 int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
873 int ret = EVP_PKEY_assign(pkey, type, key);
874
875 if (ret)
876 DH_up_ref(key);
877 return ret;
878 }
879
880 DH *evp_pkey_get0_DH_int(const EVP_PKEY *pkey)
881 {
882 if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
883 ERR_raise(ERR_LIB_EVP, EVP_R_EXPECTING_A_DH_KEY);
884 return NULL;
885 }
886 return evp_pkey_get_legacy((EVP_PKEY *)pkey);
887 }
888
889 const DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
890 {
891 return evp_pkey_get0_DH_int(pkey);
892 }
893
894 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
895 {
896 DH *ret = evp_pkey_get0_DH_int(pkey);
897
898 if (ret != NULL)
899 DH_up_ref(ret);
900 return ret;
901 }
902 # endif
903
904 int EVP_PKEY_type(int type)
905 {
906 int ret;
907 const EVP_PKEY_ASN1_METHOD *ameth;
908 ENGINE *e;
909 ameth = EVP_PKEY_asn1_find(&e, type);
910 if (ameth)
911 ret = ameth->pkey_id;
912 else
913 ret = NID_undef;
914 # ifndef OPENSSL_NO_ENGINE
915 ENGINE_finish(e);
916 # endif
917 return ret;
918 }
919
920 int EVP_PKEY_id(const EVP_PKEY *pkey)
921 {
922 return pkey->type;
923 }
924
925 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
926 {
927 return EVP_PKEY_type(pkey->type);
928 }
929
930 /*
931 * These hard coded cases are pure hackery to get around the fact
932 * that names in crypto/objects/objects.txt are a mess. There is
933 * no "EC", and "RSA" leads to the NID for 2.5.8.1.1, an OID that's
934 * fallen out in favor of { pkcs-1 1 }, i.e. 1.2.840.113549.1.1.1,
935 * the NID of which is used for EVP_PKEY_RSA. Strangely enough,
936 * "DSA" is accurate... but still, better be safe and hard-code
937 * names that we know.
938 * On a similar topic, EVP_PKEY_type(EVP_PKEY_SM2) will result in
939 * EVP_PKEY_EC, because of aliasing.
940 * This should be cleaned away along with all other #legacy support.
941 */
942 static const OSSL_ITEM standard_name2type[] = {
943 { EVP_PKEY_RSA, "RSA" },
944 { EVP_PKEY_RSA_PSS, "RSA-PSS" },
945 { EVP_PKEY_EC, "EC" },
946 { EVP_PKEY_ED25519, "ED25519" },
947 { EVP_PKEY_ED448, "ED448" },
948 { EVP_PKEY_X25519, "X25519" },
949 { EVP_PKEY_X448, "X448" },
950 { EVP_PKEY_SM2, "SM2" },
951 { EVP_PKEY_DH, "DH" },
952 { EVP_PKEY_DHX, "X9.42 DH" },
953 { EVP_PKEY_DHX, "DHX" },
954 { EVP_PKEY_DSA, "DSA" },
955 };
956
957 int evp_pkey_name2type(const char *name)
958 {
959 int type;
960 size_t i;
961
962 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
963 if (strcasecmp(name, standard_name2type[i].ptr) == 0)
964 return (int)standard_name2type[i].id;
965 }
966
967 if ((type = EVP_PKEY_type(OBJ_sn2nid(name))) != NID_undef)
968 return type;
969 return EVP_PKEY_type(OBJ_ln2nid(name));
970 }
971
972 const char *evp_pkey_type2name(int type)
973 {
974 size_t i;
975
976 for (i = 0; i < OSSL_NELEM(standard_name2type); i++) {
977 if (type == (int)standard_name2type[i].id)
978 return standard_name2type[i].ptr;
979 }
980
981 return OBJ_nid2sn(type);
982 }
983
984 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
985 {
986 if (pkey->keymgmt == NULL) {
987 int type = evp_pkey_name2type(name);
988
989 return pkey->type == type;
990 }
991 return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
992 }
993
994 int EVP_PKEY_typenames_do_all(const EVP_PKEY *pkey,
995 void (*fn)(const char *name, void *data),
996 void *data)
997 {
998 if (!evp_pkey_is_typed(pkey))
999 return 0;
1000
1001 if (!evp_pkey_is_provided(pkey)) {
1002 const char *name = OBJ_nid2sn(EVP_PKEY_id(pkey));
1003
1004 fn(name, data);
1005 return 1;
1006 }
1007 return EVP_KEYMGMT_names_do_all(pkey->keymgmt, fn, data);
1008 }
1009
1010 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
1011 {
1012 if (pkey->keymgmt == NULL) {
1013 switch (EVP_PKEY_base_id(pkey)) {
1014 case EVP_PKEY_RSA:
1015 return 1;
1016 # ifndef OPENSSL_NO_DSA
1017 case EVP_PKEY_DSA:
1018 return 1;
1019 # endif
1020 # ifndef OPENSSL_NO_EC
1021 case EVP_PKEY_ED25519:
1022 case EVP_PKEY_ED448:
1023 return 1;
1024 case EVP_PKEY_EC: /* Including SM2 */
1025 return EC_KEY_can_sign(pkey->pkey.ec);
1026 # endif
1027 default:
1028 break;
1029 }
1030 } else {
1031 const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
1032 OSSL_LIB_CTX *libctx = ossl_provider_libctx(prov);
1033 const char *supported_sig =
1034 pkey->keymgmt->query_operation_name != NULL
1035 ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
1036 : evp_first_name(prov, pkey->keymgmt->name_id);
1037 EVP_SIGNATURE *signature = NULL;
1038
1039 signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
1040 if (signature != NULL) {
1041 EVP_SIGNATURE_free(signature);
1042 return 1;
1043 }
1044 }
1045 return 0;
1046 }
1047
1048 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1049 {
1050 BIO_set_indent(*out, saved_indent);
1051 if (pop_f_prefix) {
1052 BIO *next = BIO_pop(*out);
1053
1054 BIO_free(*out);
1055 *out = next;
1056 }
1057 return 1;
1058 }
1059
1060 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1061 long indent)
1062 {
1063 *pop_f_prefix = 0;
1064 *saved_indent = 0;
1065 if (indent > 0) {
1066 long i = BIO_get_indent(*out);
1067
1068 *saved_indent = (i < 0 ? 0 : i);
1069 if (BIO_set_indent(*out, indent) <= 0) {
1070 if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1071 return 0;
1072 *pop_f_prefix = 1;
1073 }
1074 if (BIO_set_indent(*out, indent) <= 0) {
1075 print_reset_indent(out, *pop_f_prefix, *saved_indent);
1076 return 0;
1077 }
1078 }
1079 return 1;
1080 }
1081
1082 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1083 const char *kstr)
1084 {
1085 return BIO_indent(out, indent, 128)
1086 && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1087 kstr, OBJ_nid2ln(pkey->type)) > 0;
1088 }
1089
1090 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1091 int selection /* For provided encoding */,
1092 const char *propquery /* For provided encoding */,
1093 int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1094 int indent, ASN1_PCTX *pctx),
1095 ASN1_PCTX *legacy_pctx /* For legacy print */)
1096 {
1097 int pop_f_prefix;
1098 long saved_indent;
1099 OSSL_ENCODER_CTX *ctx = NULL;
1100 int ret = -2; /* default to unsupported */
1101
1102 if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1103 return 0;
1104
1105 ctx = OSSL_ENCODER_CTX_new_for_pkey(pkey, selection, "TEXT", NULL,
1106 propquery);
1107 if (OSSL_ENCODER_CTX_get_num_encoders(ctx) != 0)
1108 ret = OSSL_ENCODER_to_bio(ctx, out);
1109 OSSL_ENCODER_CTX_free(ctx);
1110
1111 if (ret != -2)
1112 goto end;
1113
1114 /* legacy fallback */
1115 if (legacy_print != NULL)
1116 ret = legacy_print(out, pkey, 0, legacy_pctx);
1117 else
1118 ret = unsup_alg(out, pkey, 0, "Public Key");
1119
1120 end:
1121 print_reset_indent(&out, pop_f_prefix, saved_indent);
1122 return ret;
1123 }
1124
1125 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1126 int indent, ASN1_PCTX *pctx)
1127 {
1128 return print_pkey(pkey, out, indent, EVP_PKEY_PUBLIC_KEY, NULL,
1129 (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1130 pctx);
1131 }
1132
1133 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1134 int indent, ASN1_PCTX *pctx)
1135 {
1136 return print_pkey(pkey, out, indent, EVP_PKEY_KEYPAIR, NULL,
1137 (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1138 pctx);
1139 }
1140
1141 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1142 int indent, ASN1_PCTX *pctx)
1143 {
1144 return print_pkey(pkey, out, indent, EVP_PKEY_KEY_PARAMETERS, NULL,
1145 (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1146 pctx);
1147 }
1148
1149 # ifndef OPENSSL_NO_STDIO
1150 int EVP_PKEY_print_public_fp(FILE *fp, const EVP_PKEY *pkey,
1151 int indent, ASN1_PCTX *pctx)
1152 {
1153 int ret;
1154 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1155
1156 if (b == NULL)
1157 return 0;
1158 ret = EVP_PKEY_print_public(b, pkey, indent, pctx);
1159 BIO_free(b);
1160 return ret;
1161 }
1162
1163 int EVP_PKEY_print_private_fp(FILE *fp, const EVP_PKEY *pkey,
1164 int indent, ASN1_PCTX *pctx)
1165 {
1166 int ret;
1167 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1168
1169 if (b == NULL)
1170 return 0;
1171 ret = EVP_PKEY_print_private(b, pkey, indent, pctx);
1172 BIO_free(b);
1173 return ret;
1174 }
1175
1176 int EVP_PKEY_print_params_fp(FILE *fp, const EVP_PKEY *pkey,
1177 int indent, ASN1_PCTX *pctx)
1178 {
1179 int ret;
1180 BIO *b = BIO_new_fp(fp, BIO_NOCLOSE);
1181
1182 if (b == NULL)
1183 return 0;
1184 ret = EVP_PKEY_print_params(b, pkey, indent, pctx);
1185 BIO_free(b);
1186 return ret;
1187 }
1188 # endif
1189
1190 static void mdname2nid(const char *mdname, void *data)
1191 {
1192 int *nid = (int *)data;
1193
1194 if (*nid != NID_undef)
1195 return;
1196
1197 *nid = OBJ_sn2nid(mdname);
1198 if (*nid == NID_undef)
1199 *nid = OBJ_ln2nid(mdname);
1200 }
1201
1202 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1203 int arg1, void *arg2)
1204 {
1205 if (pkey->keymgmt == NULL)
1206 return 0;
1207 switch (op) {
1208 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1209 {
1210 char mdname[80] = "";
1211 int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1212 sizeof(mdname));
1213
1214 if (rv > 0) {
1215 int mdnum;
1216 OSSL_LIB_CTX *libctx = ossl_provider_libctx(pkey->keymgmt->prov);
1217 /* Make sure the MD is in the namemap if available */
1218 EVP_MD *md = EVP_MD_fetch(libctx, mdname, NULL);
1219 OSSL_NAMEMAP *namemap = ossl_namemap_stored(libctx);
1220 int nid = NID_undef;
1221
1222 /*
1223 * The only reason to fetch the MD was to make sure it is in the
1224 * namemap. We can immediately free it.
1225 */
1226 EVP_MD_free(md);
1227 mdnum = ossl_namemap_name2num(namemap, mdname);
1228 if (mdnum == 0)
1229 return 0;
1230
1231 /*
1232 * We have the namemap number - now we need to find the
1233 * associated nid
1234 */
1235 if (!ossl_namemap_doall_names(namemap, mdnum, mdname2nid, &nid))
1236 return 0;
1237 *(int *)arg2 = nid;
1238 }
1239 return rv;
1240 }
1241 default:
1242 return -2;
1243 }
1244 }
1245
1246 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1247 {
1248 if (pkey->ameth == NULL)
1249 return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1250 if (pkey->ameth->pkey_ctrl == NULL)
1251 return -2;
1252 return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1253 }
1254
1255 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1256 {
1257 return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1258 }
1259
1260 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1261 char *mdname, size_t mdname_sz)
1262 {
1263 if (pkey->ameth == NULL)
1264 return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1265 pkey->keydata,
1266 mdname, mdname_sz);
1267
1268 {
1269 int nid = NID_undef;
1270 int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1271 const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1272
1273 if (rv > 0)
1274 OPENSSL_strlcpy(mdname, name, mdname_sz);
1275 return rv;
1276 }
1277 }
1278
1279 int EVP_PKEY_get_group_name(const EVP_PKEY *pkey, char *gname, size_t gname_sz,
1280 size_t *gname_len)
1281 {
1282 return EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_GROUP_NAME,
1283 gname, gname_sz, gname_len);
1284 }
1285
1286 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1287 {
1288 int rv, default_nid;
1289
1290 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1291 if (rv == -2) {
1292 /*
1293 * If there is a mandatory default digest and this isn't it, then
1294 * the answer is 'no'.
1295 */
1296 rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1297 if (rv == 2)
1298 return (nid == default_nid);
1299 /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1300 if (rv == 0)
1301 return -1;
1302 }
1303 return rv;
1304 }
1305
1306 int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, const unsigned char *pub,
1307 size_t publen)
1308 {
1309 if (pkey != NULL && evp_pkey_is_provided(pkey))
1310 return
1311 EVP_PKEY_set_octet_string_param(pkey,
1312 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1313 (unsigned char *)pub, publen);
1314
1315 if (publen > INT_MAX)
1316 return 0;
1317 /* Historically this function was EVP_PKEY_set1_tls_encodedpoint */
1318 if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, publen,
1319 (void *)pub) <= 0)
1320 return 0;
1321 return 1;
1322 }
1323
1324 size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub)
1325 {
1326 int rv;
1327
1328 if (pkey != NULL && evp_pkey_is_provided(pkey)) {
1329 size_t return_size = OSSL_PARAM_UNMODIFIED;
1330
1331 /*
1332 * We know that this is going to fail, but it will give us a size
1333 * to allocate.
1334 */
1335 EVP_PKEY_get_octet_string_param(pkey,
1336 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1337 NULL, 0, &return_size);
1338 if (return_size == OSSL_PARAM_UNMODIFIED)
1339 return 0;
1340
1341 *ppub = OPENSSL_malloc(return_size);
1342 if (*ppub == NULL)
1343 return 0;
1344
1345 if (!EVP_PKEY_get_octet_string_param(pkey,
1346 OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY,
1347 *ppub, return_size, NULL))
1348 return 0;
1349 return return_size;
1350 }
1351
1352
1353 rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppub);
1354 if (rv <= 0)
1355 return 0;
1356 return rv;
1357 }
1358
1359 #endif /* FIPS_MODULE */
1360
1361 /*- All methods below can also be used in FIPS_MODULE */
1362
1363 EVP_PKEY *EVP_PKEY_new(void)
1364 {
1365 EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1366
1367 if (ret == NULL) {
1368 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1369 return NULL;
1370 }
1371
1372 ret->type = EVP_PKEY_NONE;
1373 ret->save_type = EVP_PKEY_NONE;
1374 ret->references = 1;
1375 ret->save_parameters = 1;
1376
1377 ret->lock = CRYPTO_THREAD_lock_new();
1378 if (ret->lock == NULL) {
1379 EVPerr(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1380 goto err;
1381 }
1382
1383 #ifndef FIPS_MODULE
1384 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1385 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1386 goto err;
1387 }
1388 #endif
1389 return ret;
1390
1391 err:
1392 CRYPTO_THREAD_lock_free(ret->lock);
1393 OPENSSL_free(ret);
1394 return NULL;
1395 }
1396
1397 /*
1398 * Setup a public key management method.
1399 *
1400 * For legacy keys, either |type| or |str| is expected to have the type
1401 * information. In this case, the setup consists of finding an ASN1 method
1402 * and potentially an ENGINE, and setting those fields in |pkey|.
1403 *
1404 * For provider side keys, |keymgmt| is expected to be non-NULL. In this
1405 * case, the setup consists of setting the |keymgmt| field in |pkey|.
1406 *
1407 * If pkey is NULL just return 1 or 0 if the key management method exists.
1408 */
1409
1410 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1411 int len, EVP_KEYMGMT *keymgmt)
1412 {
1413 #ifndef FIPS_MODULE
1414 const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1415 ENGINE **eptr = (e == NULL) ? &e : NULL;
1416 #endif
1417
1418 /*
1419 * The setups can't set both legacy and provider side methods.
1420 * It is forbidden
1421 */
1422 if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1423 || !ossl_assert(e == NULL || keymgmt == NULL)) {
1424 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1425 return 0;
1426 }
1427
1428 if (pkey != NULL) {
1429 int free_it = 0;
1430
1431 #ifndef FIPS_MODULE
1432 free_it = free_it || pkey->pkey.ptr != NULL;
1433 #endif
1434 free_it = free_it || pkey->keydata != NULL;
1435 if (free_it)
1436 evp_pkey_free_it(pkey);
1437 #ifndef FIPS_MODULE
1438 /*
1439 * If key type matches and a method exists then this lookup has
1440 * succeeded once so just indicate success.
1441 */
1442 if (pkey->type != EVP_PKEY_NONE
1443 && type == pkey->save_type
1444 && pkey->ameth != NULL)
1445 return 1;
1446 # ifndef OPENSSL_NO_ENGINE
1447 /* If we have ENGINEs release them */
1448 ENGINE_finish(pkey->engine);
1449 pkey->engine = NULL;
1450 ENGINE_finish(pkey->pmeth_engine);
1451 pkey->pmeth_engine = NULL;
1452 # endif
1453 #endif
1454 }
1455 #ifndef FIPS_MODULE
1456 if (str != NULL)
1457 ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1458 else if (type != EVP_PKEY_NONE)
1459 ameth = EVP_PKEY_asn1_find(eptr, type);
1460 # ifndef OPENSSL_NO_ENGINE
1461 if (pkey == NULL && eptr != NULL)
1462 ENGINE_finish(e);
1463 # endif
1464 #endif
1465
1466
1467 {
1468 int check = 1;
1469
1470 #ifndef FIPS_MODULE
1471 check = check && ameth == NULL;
1472 #endif
1473 check = check && keymgmt == NULL;
1474 if (check) {
1475 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_ALGORITHM);
1476 return 0;
1477 }
1478 }
1479 if (pkey != NULL) {
1480 if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1481 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1482 return 0;
1483 }
1484
1485 pkey->keymgmt = keymgmt;
1486
1487 pkey->save_type = type;
1488 pkey->type = type;
1489
1490 #ifndef FIPS_MODULE
1491 /*
1492 * If the internal "origin" key is provider side, don't save |ameth|.
1493 * The main reason is that |ameth| is one factor to detect that the
1494 * internal "origin" key is a legacy one.
1495 */
1496 if (keymgmt == NULL)
1497 pkey->ameth = ameth;
1498 pkey->engine = e;
1499
1500 /*
1501 * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1502 * for any key type that has a legacy implementation, regardless of
1503 * if the internal key is a legacy or a provider side one. When
1504 * there is no legacy implementation for the key, the type becomes
1505 * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1506 * with functions that expect legacy internal keys.
1507 */
1508 if (ameth != NULL)
1509 pkey->type = ameth->pkey_id;
1510 else
1511 pkey->type = EVP_PKEY_KEYMGMT;
1512 #endif
1513 }
1514 return 1;
1515 }
1516
1517 #ifndef FIPS_MODULE
1518 static void find_ameth(const char *name, void *data)
1519 {
1520 const char **str = data;
1521
1522 /*
1523 * The error messages from pkey_set_type() are uninteresting here,
1524 * and misleading.
1525 */
1526 ERR_set_mark();
1527
1528 if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1529 NULL)) {
1530 if (str[0] == NULL)
1531 str[0] = name;
1532 else if (str[1] == NULL)
1533 str[1] = name;
1534 }
1535
1536 ERR_pop_to_mark();
1537 }
1538 #endif
1539
1540 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1541 {
1542 #ifndef FIPS_MODULE
1543 # define EVP_PKEY_TYPE_STR str[0]
1544 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1545 /*
1546 * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1547 * Ideally, only one should be found. If two (or more) are found, the
1548 * match is ambiguous. This should never happen, but...
1549 */
1550 const char *str[2] = { NULL, NULL };
1551
1552 if (!EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str)
1553 || str[1] != NULL) {
1554 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1555 return 0;
1556 }
1557 #else
1558 # define EVP_PKEY_TYPE_STR NULL
1559 # define EVP_PKEY_TYPE_STRLEN -1
1560 #endif
1561 return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1562 EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1563 keymgmt);
1564
1565 #undef EVP_PKEY_TYPE_STR
1566 #undef EVP_PKEY_TYPE_STRLEN
1567 }
1568
1569 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1570 {
1571 int i;
1572
1573 if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1574 return 0;
1575
1576 REF_PRINT_COUNT("EVP_PKEY", pkey);
1577 REF_ASSERT_ISNT(i < 2);
1578 return ((i > 1) ? 1 : 0);
1579 }
1580
1581 #ifndef FIPS_MODULE
1582 EVP_PKEY *EVP_PKEY_dup(EVP_PKEY *pkey)
1583 {
1584 EVP_PKEY *dup_pk;
1585
1586 if (pkey == NULL) {
1587 ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
1588 return NULL;
1589 }
1590
1591 if ((dup_pk = EVP_PKEY_new()) == NULL)
1592 return NULL;
1593
1594 if (evp_pkey_is_blank(pkey))
1595 goto done;
1596
1597 if (evp_pkey_is_provided(pkey)) {
1598 if (!evp_keymgmt_util_copy(dup_pk, pkey,
1599 OSSL_KEYMGMT_SELECT_ALL))
1600 goto err;
1601 goto done;
1602 }
1603
1604 if (evp_pkey_is_legacy(pkey)) {
1605 const EVP_PKEY_ASN1_METHOD *ameth = pkey->ameth;
1606
1607 if (ameth == NULL || ameth->copy == NULL) {
1608 if (pkey->pkey.ptr == NULL /* empty key, just set type */
1609 && EVP_PKEY_set_type(dup_pk, pkey->type) != 0)
1610 goto done;
1611 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1612 goto err;
1613 }
1614 if (!ameth->copy(dup_pk, pkey))
1615 goto err;
1616 goto done;
1617 }
1618
1619 goto err;
1620 done:
1621 /* copy auxiliary data */
1622 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_EVP_PKEY,
1623 &dup_pk->ex_data, &pkey->ex_data))
1624 goto err;
1625
1626 if (pkey->attributes != NULL) {
1627 if ((dup_pk->attributes = ossl_x509at_dup(pkey->attributes)) == NULL)
1628 goto err;
1629 }
1630 return dup_pk;
1631 err:
1632 EVP_PKEY_free(dup_pk);
1633 return NULL;
1634 }
1635
1636 void evp_pkey_free_legacy(EVP_PKEY *x)
1637 {
1638 const EVP_PKEY_ASN1_METHOD *ameth = x->ameth;
1639 ENGINE *tmpe = NULL;
1640
1641 if (ameth == NULL && x->legacy_cache_pkey.ptr != NULL)
1642 ameth = EVP_PKEY_asn1_find(&tmpe, x->type);
1643
1644 if (ameth != NULL) {
1645 if (x->legacy_cache_pkey.ptr != NULL) {
1646 /*
1647 * We should never have both a legacy origin key, and a key in the
1648 * legacy cache.
1649 */
1650 assert(x->pkey.ptr == NULL);
1651 /*
1652 * For the purposes of freeing we make the legacy cache look like
1653 * a legacy origin key.
1654 */
1655 x->pkey = x->legacy_cache_pkey;
1656 x->legacy_cache_pkey.ptr = NULL;
1657 }
1658 if (ameth->pkey_free != NULL)
1659 ameth->pkey_free(x);
1660 x->pkey.ptr = NULL;
1661 }
1662 # ifndef OPENSSL_NO_ENGINE
1663 ENGINE_finish(tmpe);
1664 ENGINE_finish(x->engine);
1665 x->engine = NULL;
1666 ENGINE_finish(x->pmeth_engine);
1667 x->pmeth_engine = NULL;
1668 # endif
1669 }
1670 #endif /* FIPS_MODULE */
1671
1672 static void evp_pkey_free_it(EVP_PKEY *x)
1673 {
1674 /* internal function; x is never NULL */
1675 evp_keymgmt_util_clear_operation_cache(x, 1);
1676 #ifndef FIPS_MODULE
1677 evp_pkey_free_legacy(x);
1678 #endif
1679
1680 if (x->keymgmt != NULL) {
1681 evp_keymgmt_freedata(x->keymgmt, x->keydata);
1682 EVP_KEYMGMT_free(x->keymgmt);
1683 x->keymgmt = NULL;
1684 x->keydata = NULL;
1685 }
1686 x->type = EVP_PKEY_NONE;
1687 }
1688
1689 void EVP_PKEY_free(EVP_PKEY *x)
1690 {
1691 int i;
1692
1693 if (x == NULL)
1694 return;
1695
1696 CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1697 REF_PRINT_COUNT("EVP_PKEY", x);
1698 if (i > 0)
1699 return;
1700 REF_ASSERT_ISNT(i < 0);
1701 evp_pkey_free_it(x);
1702 #ifndef FIPS_MODULE
1703 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1704 #endif
1705 CRYPTO_THREAD_lock_free(x->lock);
1706 #ifndef FIPS_MODULE
1707 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1708 #endif
1709 OPENSSL_free(x);
1710 }
1711
1712 int EVP_PKEY_size(const EVP_PKEY *pkey)
1713 {
1714 int size = 0;
1715
1716 if (pkey != NULL) {
1717 size = pkey->cache.size;
1718 #ifndef FIPS_MODULE
1719 if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1720 size = pkey->ameth->pkey_size(pkey);
1721 #endif
1722 }
1723 return size < 0 ? 0 : size;
1724 }
1725
1726 const char *EVP_PKEY_description(const EVP_PKEY *pkey)
1727 {
1728 if (!evp_pkey_is_assigned(pkey))
1729 return NULL;
1730
1731 if (evp_pkey_is_provided(pkey) && pkey->keymgmt->description != NULL)
1732 return pkey->keymgmt->description;
1733 #ifndef FIPS_MODULE
1734 if (pkey->ameth != NULL)
1735 return pkey->ameth->info;
1736 #endif
1737 return NULL;
1738 }
1739
1740 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OSSL_LIB_CTX *libctx,
1741 EVP_KEYMGMT **keymgmt,
1742 const char *propquery)
1743 {
1744 EVP_KEYMGMT *allocated_keymgmt = NULL;
1745 EVP_KEYMGMT *tmp_keymgmt = NULL;
1746 void *keydata = NULL;
1747 int check;
1748
1749 if (pk == NULL)
1750 return NULL;
1751
1752 /* No key data => nothing to export */
1753 check = 1;
1754 #ifndef FIPS_MODULE
1755 check = check && pk->pkey.ptr == NULL;
1756 #endif
1757 check = check && pk->keydata == NULL;
1758 if (check)
1759 return NULL;
1760
1761 #ifndef FIPS_MODULE
1762 if (pk->pkey.ptr != NULL) {
1763 /*
1764 * If the legacy key doesn't have an dirty counter or export function,
1765 * give up
1766 */
1767 if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1768 return NULL;
1769 }
1770 #endif
1771
1772 if (keymgmt != NULL) {
1773 tmp_keymgmt = *keymgmt;
1774 *keymgmt = NULL;
1775 }
1776
1777 /*
1778 * If no keymgmt was given or found, get a default keymgmt. We do so by
1779 * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1780 */
1781 if (tmp_keymgmt == NULL) {
1782 EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1783
1784 tmp_keymgmt = ctx->keymgmt;
1785 ctx->keymgmt = NULL;
1786 EVP_PKEY_CTX_free(ctx);
1787 }
1788
1789 /* If there's still no keymgmt to be had, give up */
1790 if (tmp_keymgmt == NULL)
1791 goto end;
1792
1793 #ifndef FIPS_MODULE
1794 if (pk->pkey.ptr != NULL) {
1795 OP_CACHE_ELEM *op;
1796
1797 /*
1798 * If the legacy "origin" hasn't changed since last time, we try
1799 * to find our keymgmt in the operation cache. If it has changed,
1800 * |i| remains zero, and we will clear the cache further down.
1801 */
1802 if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1803 if (!CRYPTO_THREAD_read_lock(pk->lock))
1804 goto end;
1805 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1806
1807 /*
1808 * If |tmp_keymgmt| is present in the operation cache, it means
1809 * that export doesn't need to be redone. In that case, we take
1810 * token copies of the cached pointers, to have token success
1811 * values to return.
1812 */
1813 if (op != NULL && op->keymgmt != NULL) {
1814 keydata = op->keydata;
1815 CRYPTO_THREAD_unlock(pk->lock);
1816 goto end;
1817 }
1818 CRYPTO_THREAD_unlock(pk->lock);
1819 }
1820
1821 /* Make sure that the keymgmt key type matches the legacy NID */
1822 if (!EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type)))
1823 goto end;
1824
1825 if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1826 goto end;
1827
1828 if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1829 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1830 keydata = NULL;
1831 goto end;
1832 }
1833
1834 /*
1835 * If the dirty counter changed since last time, then clear the
1836 * operation cache. In that case, we know that |i| is zero. Just
1837 * in case this is a re-export, we increment then decrement the
1838 * keymgmt reference counter.
1839 */
1840 if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1841 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1842 keydata = NULL;
1843 goto end;
1844 }
1845
1846 if (!CRYPTO_THREAD_write_lock(pk->lock))
1847 goto end;
1848 if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy
1849 && !evp_keymgmt_util_clear_operation_cache(pk, 0)) {
1850 CRYPTO_THREAD_unlock(pk->lock);
1851 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1852 keydata = NULL;
1853 EVP_KEYMGMT_free(tmp_keymgmt);
1854 goto end;
1855 }
1856 EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1857
1858 /* Check to make sure some other thread didn't get there first */
1859 op = evp_keymgmt_util_find_operation_cache(pk, tmp_keymgmt);
1860 if (op != NULL && op->keymgmt != NULL) {
1861 void *tmp_keydata = op->keydata;
1862
1863 CRYPTO_THREAD_unlock(pk->lock);
1864 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1865 keydata = tmp_keydata;
1866 goto end;
1867 }
1868
1869 /* Add the new export to the operation cache */
1870 if (!evp_keymgmt_util_cache_keydata(pk, tmp_keymgmt, keydata)) {
1871 CRYPTO_THREAD_unlock(pk->lock);
1872 evp_keymgmt_freedata(tmp_keymgmt, keydata);
1873 keydata = NULL;
1874 goto end;
1875 }
1876
1877 /* Synchronize the dirty count */
1878 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1879
1880 CRYPTO_THREAD_unlock(pk->lock);
1881 goto end;
1882 }
1883 #endif /* FIPS_MODULE */
1884
1885 keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1886
1887 end:
1888 /*
1889 * If nothing was exported, |tmp_keymgmt| might point at a freed
1890 * EVP_KEYMGMT, so we clear it to be safe. It shouldn't be useful for
1891 * the caller either way in that case.
1892 */
1893 if (keydata == NULL)
1894 tmp_keymgmt = NULL;
1895
1896 if (keymgmt != NULL)
1897 *keymgmt = tmp_keymgmt;
1898
1899 EVP_KEYMGMT_free(allocated_keymgmt);
1900 return keydata;
1901 }
1902
1903 #ifndef FIPS_MODULE
1904 int evp_pkey_copy_downgraded(EVP_PKEY **dest, const EVP_PKEY *src)
1905 {
1906 if (!ossl_assert(dest != NULL))
1907 return 0;
1908
1909 if (evp_pkey_is_assigned(src) && evp_pkey_is_provided(src)) {
1910 EVP_KEYMGMT *keymgmt = src->keymgmt;
1911 void *keydata = src->keydata;
1912 int type = src->type;
1913 const char *keytype = NULL;
1914
1915 keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt),
1916 keymgmt->name_id);
1917
1918 /*
1919 * If the type is EVP_PKEY_NONE, then we have a problem somewhere
1920 * else in our code. If it's not one of the well known EVP_PKEY_xxx
1921 * values, it should at least be EVP_PKEY_KEYMGMT at this point.
1922 * The check is kept as a safety measure.
1923 */
1924 if (!ossl_assert(type != EVP_PKEY_NONE)) {
1925 ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1926 "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1927 keytype);
1928 return 0;
1929 }
1930
1931 /* Prefer the legacy key type name for error reporting */
1932 if (type != EVP_PKEY_KEYMGMT)
1933 keytype = OBJ_nid2sn(type);
1934
1935 /* Make sure we have a clean slate to copy into */
1936 if (*dest == NULL) {
1937 *dest = EVP_PKEY_new();
1938 if (*dest == NULL) {
1939 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1940 return 0;
1941 }
1942 } else {
1943 evp_pkey_free_it(*dest);
1944 }
1945
1946 if (EVP_PKEY_set_type(*dest, type)) {
1947 /* If the key is typed but empty, we're done */
1948 if (keydata == NULL)
1949 return 1;
1950
1951 if ((*dest)->ameth->import_from == NULL) {
1952 ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1953 "key type = %s", keytype);
1954 } else {
1955 /*
1956 * We perform the export in the same libctx as the keymgmt
1957 * that we are using.
1958 */
1959 OSSL_LIB_CTX *libctx =
1960 ossl_provider_libctx(keymgmt->prov);
1961 EVP_PKEY_CTX *pctx =
1962 EVP_PKEY_CTX_new_from_pkey(libctx, *dest, NULL);
1963
1964 if (pctx == NULL)
1965 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1966
1967 if (pctx != NULL
1968 && evp_keymgmt_export(keymgmt, keydata,
1969 OSSL_KEYMGMT_SELECT_ALL,
1970 (*dest)->ameth->import_from,
1971 pctx)) {
1972 /* Synchronize the dirty count */
1973 (*dest)->dirty_cnt_copy = (*dest)->ameth->dirty_cnt(*dest);
1974
1975 EVP_PKEY_CTX_free(pctx);
1976 return 1;
1977 }
1978 EVP_PKEY_CTX_free(pctx);
1979 }
1980
1981 ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1982 "key type = %s", keytype);
1983 }
1984 }
1985
1986 return 0;
1987 }
1988
1989 void *evp_pkey_get_legacy(EVP_PKEY *pk)
1990 {
1991 EVP_PKEY *tmp_copy = NULL;
1992 void *ret = NULL;
1993
1994 if (!ossl_assert(pk != NULL))
1995 return NULL;
1996
1997 /*
1998 * If this isn't an assigned provider side key, we just use any existing
1999 * origin legacy key.
2000 */
2001 if (!evp_pkey_is_assigned(pk))
2002 return NULL;
2003 if (!evp_pkey_is_provided(pk))
2004 return pk->pkey.ptr;
2005
2006 if (!CRYPTO_THREAD_read_lock(pk->lock))
2007 return NULL;
2008
2009 ret = pk->legacy_cache_pkey.ptr;
2010
2011 if (!CRYPTO_THREAD_unlock(pk->lock))
2012 return NULL;
2013
2014 if (ret != NULL)
2015 return ret;
2016
2017 if (!evp_pkey_copy_downgraded(&tmp_copy, pk))
2018 return NULL;
2019
2020 if (!CRYPTO_THREAD_write_lock(pk->lock))
2021 goto err;
2022
2023 /* Check again in case some other thread has updated it in the meantime */
2024 ret = pk->legacy_cache_pkey.ptr;
2025 if (ret == NULL) {
2026 /* Steal the legacy key reference from the temporary copy */
2027 ret = pk->legacy_cache_pkey.ptr = tmp_copy->pkey.ptr;
2028 tmp_copy->pkey.ptr = NULL;
2029 }
2030
2031 if (!CRYPTO_THREAD_unlock(pk->lock)) {
2032 ret = NULL;
2033 goto err;
2034 }
2035
2036 err:
2037 EVP_PKEY_free(tmp_copy);
2038
2039 return ret;
2040 }
2041 #endif /* FIPS_MODULE */
2042
2043 int EVP_PKEY_get_bn_param(const EVP_PKEY *pkey, const char *key_name,
2044 BIGNUM **bn)
2045 {
2046 int ret = 0;
2047 OSSL_PARAM params[2];
2048 unsigned char buffer[2048];
2049 unsigned char *buf = NULL;
2050 size_t buf_sz = 0;
2051
2052 if (key_name == NULL
2053 || bn == NULL)
2054 return 0;
2055
2056 memset(buffer, 0, sizeof(buffer));
2057 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
2058 params[1] = OSSL_PARAM_construct_end();
2059 if (!EVP_PKEY_get_params(pkey, params)) {
2060 if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
2061 return 0;
2062 buf_sz = params[0].return_size;
2063 /*
2064 * If it failed because the buffer was too small then allocate the
2065 * required buffer size and retry.
2066 */
2067 buf = OPENSSL_zalloc(buf_sz);
2068 if (buf == NULL)
2069 return 0;
2070 params[0].data = buf;
2071 params[0].data_size = buf_sz;
2072
2073 if (!EVP_PKEY_get_params(pkey, params))
2074 goto err;
2075 }
2076 /* Fail if the param was not found */
2077 if (!OSSL_PARAM_modified(params))
2078 goto err;
2079 ret = OSSL_PARAM_get_BN(params, bn);
2080 err:
2081 OPENSSL_free(buf);
2082 return ret;
2083 }
2084
2085 int EVP_PKEY_get_octet_string_param(const EVP_PKEY *pkey, const char *key_name,
2086 unsigned char *buf, size_t max_buf_sz,
2087 size_t *out_sz)
2088 {
2089 OSSL_PARAM params[2];
2090 int ret1 = 0, ret2 = 0;
2091
2092 if (key_name == NULL)
2093 return 0;
2094
2095 params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
2096 params[1] = OSSL_PARAM_construct_end();
2097 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2098 ret2 = OSSL_PARAM_modified(params);
2099 if (ret2 && out_sz != NULL)
2100 *out_sz = params[0].return_size;
2101 return ret1 && ret2;
2102 }
2103
2104 int EVP_PKEY_get_utf8_string_param(const EVP_PKEY *pkey, const char *key_name,
2105 char *str, size_t max_buf_sz,
2106 size_t *out_sz)
2107 {
2108 OSSL_PARAM params[2];
2109 int ret1 = 0, ret2 = 0;
2110
2111 if (key_name == NULL)
2112 return 0;
2113
2114 params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
2115 params[1] = OSSL_PARAM_construct_end();
2116 if ((ret1 = EVP_PKEY_get_params(pkey, params)))
2117 ret2 = OSSL_PARAM_modified(params);
2118 if (ret2 && out_sz != NULL)
2119 *out_sz = params[0].return_size;
2120 return ret1 && ret2;
2121 }
2122
2123 int EVP_PKEY_get_int_param(const EVP_PKEY *pkey, const char *key_name,
2124 int *out)
2125 {
2126 OSSL_PARAM params[2];
2127
2128 if (key_name == NULL)
2129 return 0;
2130
2131 params[0] = OSSL_PARAM_construct_int(key_name, out);
2132 params[1] = OSSL_PARAM_construct_end();
2133 return EVP_PKEY_get_params(pkey, params)
2134 && OSSL_PARAM_modified(params);
2135 }
2136
2137 int EVP_PKEY_get_size_t_param(const EVP_PKEY *pkey, const char *key_name,
2138 size_t *out)
2139 {
2140 OSSL_PARAM params[2];
2141
2142 if (key_name == NULL)
2143 return 0;
2144
2145 params[0] = OSSL_PARAM_construct_size_t(key_name, out);
2146 params[1] = OSSL_PARAM_construct_end();
2147 return EVP_PKEY_get_params(pkey, params)
2148 && OSSL_PARAM_modified(params);
2149 }
2150
2151 int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in)
2152 {
2153 OSSL_PARAM params[2];
2154
2155 if (key_name == NULL)
2156 return 0;
2157
2158 params[0] = OSSL_PARAM_construct_int(key_name, &in);
2159 params[1] = OSSL_PARAM_construct_end();
2160 return EVP_PKEY_set_params(pkey, params);
2161 }
2162
2163 int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in)
2164 {
2165 OSSL_PARAM params[2];
2166
2167 if (key_name == NULL)
2168 return 0;
2169
2170 params[0] = OSSL_PARAM_construct_size_t(key_name, &in);
2171 params[1] = OSSL_PARAM_construct_end();
2172 return EVP_PKEY_set_params(pkey, params);
2173 }
2174
2175 int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
2176 const BIGNUM *bn)
2177 {
2178 OSSL_PARAM params[2];
2179 unsigned char buffer[2048];
2180 int bsize = 0;
2181
2182 if (key_name == NULL
2183 || bn == NULL
2184 || pkey == NULL
2185 || !evp_pkey_is_assigned(pkey))
2186 return 0;
2187
2188 bsize = BN_num_bytes(bn);
2189 if (!ossl_assert(bsize <= (int)sizeof(buffer)))
2190 return 0;
2191
2192 if (BN_bn2nativepad(bn, buffer, bsize) < 0)
2193 return 0;
2194 params[0] = OSSL_PARAM_construct_BN(key_name, buffer, bsize);
2195 params[1] = OSSL_PARAM_construct_end();
2196 return EVP_PKEY_set_params(pkey, params);
2197 }
2198
2199 int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
2200 const char *str)
2201 {
2202 OSSL_PARAM params[2];
2203
2204 if (key_name == NULL)
2205 return 0;
2206
2207 params[0] = OSSL_PARAM_construct_utf8_string(key_name, (char *)str, 0);
2208 params[1] = OSSL_PARAM_construct_end();
2209 return EVP_PKEY_set_params(pkey, params);
2210 }
2211
2212 int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
2213 const unsigned char *buf, size_t bsize)
2214 {
2215 OSSL_PARAM params[2];
2216
2217 if (key_name == NULL)
2218 return 0;
2219
2220 params[0] = OSSL_PARAM_construct_octet_string(key_name,
2221 (unsigned char *)buf, bsize);
2222 params[1] = OSSL_PARAM_construct_end();
2223 return EVP_PKEY_set_params(pkey, params);
2224 }
2225
2226 const OSSL_PARAM *EVP_PKEY_settable_params(const EVP_PKEY *pkey)
2227 {
2228 return (pkey != NULL && evp_pkey_is_provided(pkey))
2229 ? EVP_KEYMGMT_settable_params(pkey->keymgmt)
2230 : NULL;
2231 }
2232
2233 int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[])
2234 {
2235 if (pkey != NULL) {
2236 if (evp_pkey_is_provided(pkey)) {
2237 pkey->dirty_cnt++;
2238 return evp_keymgmt_set_params(pkey->keymgmt, pkey->keydata, params);
2239 }
2240 #ifndef FIPS_MODULE
2241 /*
2242 * We will hopefully never find the need to set individual data in
2243 * EVP_PKEYs with a legacy internal key, but we can't be entirely
2244 * sure. This bit of code can be enabled if we find the need. If
2245 * not, it can safely be removed when #legacy support is removed.
2246 */
2247 # if 0
2248 else if (evp_pkey_is_legacy(pkey)) {
2249 return evp_pkey_set_params_to_ctrl(pkey, params);
2250 }
2251 # endif
2252 #endif
2253 }
2254 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2255 return 0;
2256 }
2257
2258 const OSSL_PARAM *EVP_PKEY_gettable_params(const EVP_PKEY *pkey)
2259 {
2260 return (pkey != NULL && evp_pkey_is_provided(pkey))
2261 ? EVP_KEYMGMT_gettable_params(pkey->keymgmt)
2262 : NULL;
2263 }
2264
2265 int EVP_PKEY_get_params(const EVP_PKEY *pkey, OSSL_PARAM params[])
2266 {
2267 if (pkey != NULL) {
2268 if (evp_pkey_is_provided(pkey))
2269 return evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params);
2270 #ifndef FIPS_MODULE
2271 else if (evp_pkey_is_legacy(pkey))
2272 return evp_pkey_get_params_to_ctrl(pkey, params);
2273 #endif
2274 }
2275 ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
2276 return 0;
2277 }
2278
2279 #ifndef FIPS_MODULE
2280 int EVP_PKEY_get_ec_point_conv_form(const EVP_PKEY *pkey)
2281 {
2282 char name[80];
2283 size_t name_len;
2284
2285 if (pkey == NULL)
2286 return 0;
2287
2288 if (pkey->keymgmt == NULL
2289 || pkey->keydata == NULL) {
2290 # ifndef OPENSSL_NO_EC
2291 /* Might work through the legacy route */
2292 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2293
2294 if (ec == NULL)
2295 return 0;
2296
2297 return EC_KEY_get_conv_form(ec);
2298 # else
2299 return 0;
2300 # endif
2301 }
2302
2303 if (!EVP_PKEY_get_utf8_string_param(pkey,
2304 OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
2305 name, sizeof(name), &name_len))
2306 return 0;
2307
2308 if (strcmp(name, "uncompressed") == 0)
2309 return POINT_CONVERSION_UNCOMPRESSED;
2310
2311 if (strcmp(name, "compressed") == 0)
2312 return POINT_CONVERSION_COMPRESSED;
2313
2314 if (strcmp(name, "hybrid") == 0)
2315 return POINT_CONVERSION_HYBRID;
2316
2317 return 0;
2318 }
2319
2320 int EVP_PKEY_get_field_type(const EVP_PKEY *pkey)
2321 {
2322 char fstr[80];
2323 size_t fstrlen;
2324
2325 if (pkey == NULL)
2326 return 0;
2327
2328 if (pkey->keymgmt == NULL
2329 || pkey->keydata == NULL) {
2330 # ifndef OPENSSL_NO_EC
2331 /* Might work through the legacy route */
2332 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
2333 const EC_GROUP *grp;
2334
2335 if (ec == NULL)
2336 return 0;
2337 grp = EC_KEY_get0_group(ec);
2338 if (grp == NULL)
2339 return 0;
2340
2341 return EC_GROUP_get_field_type(grp);
2342 # else
2343 return 0;
2344 # endif
2345 }
2346
2347 if (!EVP_PKEY_get_utf8_string_param(pkey, OSSL_PKEY_PARAM_EC_FIELD_TYPE,
2348 fstr, sizeof(fstr), &fstrlen))
2349 return 0;
2350
2351 if (strcmp(fstr, SN_X9_62_prime_field) == 0)
2352 return NID_X9_62_prime_field;
2353 else if (strcmp(fstr, SN_X9_62_characteristic_two_field))
2354 return NID_X9_62_characteristic_two_field;
2355
2356 return 0;
2357 }
2358 #endif