]> git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/evp/p_lib.c
projects / thirdparty / openssl.git / blob
? search:


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