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