Re-introduce legacy EVP_PKEY types for provided keys
[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 <openssl/bn.h>
20 #include <openssl/err.h>
21 #include <openssl/objects.h>
22 #include <openssl/evp.h>
23 #include <openssl/x509.h>
24 #include <openssl/rsa.h>
25 #include <openssl/dsa.h>
26 #include <openssl/dh.h>
27 #include <openssl/ec.h>
28 #include <openssl/cmac.h>
29 #include <openssl/engine.h>
30 #include <openssl/params.h>
31 #include <openssl/param_build.h>
32 #include <openssl/serializer.h>
33 #include <openssl/core_names.h>
34
35 #include "crypto/asn1.h"
36 #include "crypto/evp.h"
37 #include "internal/evp.h"
38 #include "internal/provider.h"
39 #include "evp_local.h"
40 DEFINE_STACK_OF(X509_ATTRIBUTE)
41
42 #include "crypto/ec.h"
43
44 /* TODO remove this when the EVP_PKEY_is_a() #legacy support hack is removed */
45 #include "e_os.h"                /* strcasecmp on Windows */
46
47 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
48                          int len, EVP_KEYMGMT *keymgmt);
49 static void evp_pkey_free_it(EVP_PKEY *key);
50
51 #ifndef FIPS_MODULE
52
53 /* The type of parameters selected in key parameter functions */
54 # define SELECT_PARAMETERS OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
55
56 int EVP_PKEY_bits(const EVP_PKEY *pkey)
57 {
58     if (pkey != NULL) {
59         if (pkey->ameth == NULL)
60             return pkey->cache.bits;
61         else if (pkey->ameth->pkey_bits)
62             return pkey->ameth->pkey_bits(pkey);
63     }
64     return 0;
65 }
66
67 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
68 {
69     if (pkey == NULL)
70         return 0;
71     if (pkey->ameth == NULL)
72         return pkey->cache.security_bits;
73     if (pkey->ameth->pkey_security_bits == NULL)
74         return -2;
75     return pkey->ameth->pkey_security_bits(pkey);
76 }
77
78 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
79 {
80 # ifndef OPENSSL_NO_DSA
81     if (pkey->type == EVP_PKEY_DSA) {
82         int ret = pkey->save_parameters;
83
84         if (mode >= 0)
85             pkey->save_parameters = mode;
86         return ret;
87     }
88 # endif
89 # ifndef OPENSSL_NO_EC
90     if (pkey->type == EVP_PKEY_EC) {
91         int ret = pkey->save_parameters;
92
93         if (mode >= 0)
94             pkey->save_parameters = mode;
95         return ret;
96     }
97 # endif
98     return 0;
99 }
100
101 int EVP_PKEY_set_ex_data(EVP_PKEY *key, int idx, void *arg)
102 {
103     return CRYPTO_set_ex_data(&key->ex_data, idx, arg);
104 }
105
106 void *EVP_PKEY_get_ex_data(const EVP_PKEY *key, int idx)
107 {
108     return CRYPTO_get_ex_data(&key->ex_data, idx);
109 }
110
111 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
112 {
113     /*
114      * TODO: clean up legacy stuff from this function when legacy support
115      * is gone.
116      */
117
118     /*
119      * If |to| is a legacy key and |from| isn't, we must downgrade |from|.
120      * If that fails, this function fails.
121      */
122     if (evp_pkey_is_legacy(to) && evp_pkey_is_provided(from))
123         if (!evp_pkey_downgrade((EVP_PKEY *)from))
124             return 0;
125
126     /*
127      * Make sure |to| is typed.  Content is less important at this early
128      * stage.
129      *
130      * 1.  If |to| is untyped, assign |from|'s key type to it.
131      * 2.  If |to| contains a legacy key, compare its |type| to |from|'s.
132      *     (|from| was already downgraded above)
133      *
134      * If |to| is a provided key, there's nothing more to do here, functions
135      * like evp_keymgmt_util_copy() and evp_pkey_export_to_provider() called
136      * further down help us find out if they are the same or not.
137      */
138     if (evp_pkey_is_blank(to)) {
139         if (evp_pkey_is_legacy(from)) {
140             if (EVP_PKEY_set_type(to, from->type) == 0)
141                 return 0;
142         } else {
143             if (EVP_PKEY_set_type_by_keymgmt(to, from->keymgmt) == 0)
144                 return 0;
145         }
146     } else if (evp_pkey_is_legacy(to)) {
147         if (to->type != from->type) {
148             EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
149             goto err;
150         }
151     }
152
153     if (EVP_PKEY_missing_parameters(from)) {
154         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
155         goto err;
156     }
157
158     if (!EVP_PKEY_missing_parameters(to)) {
159         if (EVP_PKEY_cmp_parameters(to, from) == 1)
160             return 1;
161         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
162         return 0;
163     }
164
165     /* For purely provided keys, we just call the keymgmt utility */
166     if (to->keymgmt != NULL && from->keymgmt != NULL)
167         return evp_keymgmt_util_copy(to, (EVP_PKEY *)from, SELECT_PARAMETERS);
168
169     /*
170      * If |to| is provided, we know that |from| is legacy at this point.
171      * Try exporting |from| to |to|'s keymgmt, then use evp_keymgmt_copy()
172      * to copy the appropriate data to |to|'s keydata.
173      */
174     if (to->keymgmt != NULL) {
175         EVP_KEYMGMT *to_keymgmt = to->keymgmt;
176         void *from_keydata =
177             evp_pkey_export_to_provider((EVP_PKEY *)from, NULL, &to_keymgmt,
178                                         NULL);
179
180         /*
181          * If we get a NULL, it could be an internal error, or it could be
182          * that there's a key mismatch.  We're pretending the latter...
183          */
184         if (from_keydata == NULL) {
185             ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
186             return 0;
187         }
188         return evp_keymgmt_copy(to->keymgmt, to->keydata, from_keydata,
189                                 SELECT_PARAMETERS);
190     }
191
192     /* Both keys are legacy */
193     if (from->ameth != NULL && from->ameth->param_copy != NULL)
194         return from->ameth->param_copy(to, from);
195  err:
196     return 0;
197 }
198
199 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
200 {
201     if (pkey != NULL) {
202         if (pkey->keymgmt != NULL)
203             return !evp_keymgmt_util_has((EVP_PKEY *)pkey, SELECT_PARAMETERS);
204         else if (pkey->ameth != NULL && pkey->ameth->param_missing != NULL)
205             return pkey->ameth->param_missing(pkey);
206     }
207     return 0;
208 }
209
210 /*
211  * This function is called for any mixture of keys except pure legacy pair.
212  * TODO When legacy keys are gone, we replace a call to this functions with
213  * a call to evp_keymgmt_util_match().
214  */
215 static int evp_pkey_cmp_any(const EVP_PKEY *a, const EVP_PKEY *b,
216                             int selection)
217 {
218     EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
219     void *keydata1 = NULL, *keydata2 = NULL, *tmp_keydata = NULL;
220
221     /* If none of them are provided, this function shouldn't have been called */
222     if (!ossl_assert(a->keymgmt != NULL || b->keymgmt != NULL))
223         return -2;
224
225     /* For purely provided keys, we just call the keymgmt utility */
226     if (a->keymgmt != NULL && b->keymgmt != NULL)
227         return evp_keymgmt_util_match((EVP_PKEY *)a, (EVP_PKEY *)b, selection);
228
229     /*
230      * At this point, one of them is provided, the other not.  This allows
231      * us to compare types using legacy NIDs.
232      */
233     if ((a->type != EVP_PKEY_NONE
234          && (b->keymgmt == NULL
235              || !EVP_KEYMGMT_is_a(b->keymgmt, OBJ_nid2sn(a->type))))
236         || (b->type != EVP_PKEY_NONE
237             && (a->keymgmt == NULL
238                 || !EVP_KEYMGMT_is_a(a->keymgmt, OBJ_nid2sn(b->type)))))
239         return -1;               /* not the same key type */
240
241     /*
242      * We've determined that they both are the same keytype, so the next
243      * step is to do a bit of cross export to ensure we have keydata for
244      * both keys in the same keymgmt.
245      */
246     keymgmt1 = a->keymgmt;
247     keydata1 = a->keydata;
248     keymgmt2 = b->keymgmt;
249     keydata2 = b->keydata;
250
251     if (keymgmt2 != NULL && keymgmt2->match != NULL) {
252         tmp_keydata =
253             evp_pkey_export_to_provider((EVP_PKEY *)a, NULL, &keymgmt2, NULL);
254         if (tmp_keydata != NULL) {
255             keymgmt1 = keymgmt2;
256             keydata1 = tmp_keydata;
257         }
258     }
259     if (tmp_keydata == NULL && keymgmt1 != NULL && keymgmt1->match != NULL) {
260         tmp_keydata =
261             evp_pkey_export_to_provider((EVP_PKEY *)b, NULL, &keymgmt1, NULL);
262         if (tmp_keydata != NULL) {
263             keymgmt2 = keymgmt1;
264             keydata2 = tmp_keydata;
265         }
266     }
267
268     /* If we still don't have matching keymgmt implementations, we give up */
269     if (keymgmt1 != keymgmt2)
270         return -2;
271
272     return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
273 }
274
275 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
276 {
277     /*
278      * TODO: clean up legacy stuff from this function when legacy support
279      * is gone.
280      */
281
282     if (a->keymgmt != NULL || b->keymgmt != NULL)
283         return evp_pkey_cmp_any(a, b, SELECT_PARAMETERS);
284
285     /* All legacy keys */
286     if (a->type != b->type)
287         return -1;
288     if (a->ameth != NULL && a->ameth->param_cmp != NULL)
289         return a->ameth->param_cmp(a, b);
290     return -2;
291 }
292
293 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
294 {
295     /*
296      * TODO: clean up legacy stuff from this function when legacy support
297      * is gone.
298      */
299
300     if (a->keymgmt != NULL || b->keymgmt != NULL)
301         return evp_pkey_cmp_any(a, b, (SELECT_PARAMETERS
302                                        | OSSL_KEYMGMT_SELECT_PUBLIC_KEY));
303
304     /* All legacy keys */
305     if (a->type != b->type)
306         return -1;
307
308     if (a->ameth != NULL) {
309         int ret;
310         /* Compare parameters if the algorithm has them */
311         if (a->ameth->param_cmp != NULL) {
312             ret = a->ameth->param_cmp(a, b);
313             if (ret <= 0)
314                 return ret;
315         }
316
317         if (a->ameth->pub_cmp != NULL)
318             return a->ameth->pub_cmp(a, b);
319     }
320
321     return -2;
322 }
323
324
325 static EVP_PKEY *new_raw_key_int(OPENSSL_CTX *libctx,
326                                  const char *strtype,
327                                  const char *propq,
328                                  int nidtype,
329                                  ENGINE *e,
330                                  const unsigned char *key,
331                                  size_t len,
332                                  int key_is_priv)
333 {
334     EVP_PKEY *pkey = NULL;
335     EVP_PKEY_CTX *ctx = NULL;
336     const EVP_PKEY_ASN1_METHOD *ameth = NULL;
337     int result = 0;
338
339 # ifndef OPENSSL_NO_ENGINE
340     /* Check if there is an Engine for this type */
341     if (e == NULL) {
342         ENGINE *tmpe = NULL;
343
344         if (strtype != NULL)
345             ameth = EVP_PKEY_asn1_find_str(&tmpe, strtype, -1);
346         else if (nidtype != EVP_PKEY_NONE)
347             ameth = EVP_PKEY_asn1_find(&tmpe, nidtype);
348
349         /* If tmpe is NULL then no engine is claiming to support this type */
350         if (tmpe == NULL)
351             ameth = NULL;
352
353         ENGINE_finish(tmpe);
354     }
355 # endif
356
357     if (e == NULL && ameth == NULL) {
358         /*
359          * No engine is claiming to support this type, so lets see if we have
360          * a provider.
361          */
362         ctx = EVP_PKEY_CTX_new_from_name(libctx,
363                                          strtype != NULL ? strtype
364                                                          : OBJ_nid2sn(nidtype),
365                                          propq);
366         if (ctx == NULL) {
367             EVPerr(0, ERR_R_MALLOC_FAILURE);
368             goto err;
369         }
370         /* May fail if no provider available */
371         ERR_set_mark();
372         if (EVP_PKEY_key_fromdata_init(ctx) == 1) {
373             OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
374
375             ERR_clear_last_mark();
376             params[0] = OSSL_PARAM_construct_octet_string(
377                             key_is_priv ? OSSL_PKEY_PARAM_PRIV_KEY
378                                         : OSSL_PKEY_PARAM_PUB_KEY,
379                             (void *)key, len);
380
381             if (EVP_PKEY_fromdata(ctx, &pkey, params) != 1) {
382                 EVPerr(0, EVP_R_KEY_SETUP_FAILED);
383                 goto err;
384             }
385
386             EVP_PKEY_CTX_free(ctx);
387
388             return pkey;
389         }
390         ERR_pop_to_mark();
391         /* else not supported so fallback to legacy */
392     }
393
394     /* Legacy code path */
395
396     pkey = EVP_PKEY_new();
397     if (pkey == NULL) {
398         EVPerr(0, ERR_R_MALLOC_FAILURE);
399         goto err;
400     }
401
402     if (!pkey_set_type(pkey, e, nidtype, strtype, -1, NULL)) {
403         /* EVPerr already called */
404         goto err;
405     }
406
407     if (!ossl_assert(pkey->ameth != NULL))
408         goto err;
409
410     if (key_is_priv) {
411         if (pkey->ameth->set_priv_key == NULL) {
412             EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
413             goto err;
414         }
415
416         if (!pkey->ameth->set_priv_key(pkey, key, len)) {
417             EVPerr(0, EVP_R_KEY_SETUP_FAILED);
418             goto err;
419         }
420     } else {
421         if (pkey->ameth->set_pub_key == NULL) {
422             EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
423             goto err;
424         }
425
426         if (!pkey->ameth->set_pub_key(pkey, key, len)) {
427             EVPerr(0, EVP_R_KEY_SETUP_FAILED);
428             goto err;
429         }
430     }
431
432     result = 1;
433  err:
434     if (!result) {
435         EVP_PKEY_free(pkey);
436         pkey = NULL;
437     }
438     EVP_PKEY_CTX_free(ctx);
439     return pkey;
440 }
441
442 EVP_PKEY *EVP_PKEY_new_raw_private_key_with_libctx(OPENSSL_CTX *libctx,
443                                                    const char *keytype,
444                                                    const char *propq,
445                                                    const unsigned char *priv,
446                                                    size_t len)
447 {
448     return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, priv,
449                            len, 1);
450 }
451
452 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
453                                        const unsigned char *priv,
454                                        size_t len)
455 {
456     return new_raw_key_int(NULL, NULL, NULL, type, e, priv, len, 1);
457 }
458
459 EVP_PKEY *EVP_PKEY_new_raw_public_key_with_libctx(OPENSSL_CTX *libctx,
460                                                   const char *keytype,
461                                                   const char *propq,
462                                                   const unsigned char *pub,
463                                                   size_t len)
464 {
465     return new_raw_key_int(libctx, keytype, propq, EVP_PKEY_NONE, NULL, pub,
466                            len, 0);
467 }
468
469 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
470                                       const unsigned char *pub,
471                                       size_t len)
472 {
473     return new_raw_key_int(NULL, NULL, NULL, type, e, pub, len, 0);
474 }
475
476 struct raw_key_details_st
477 {
478     unsigned char **key;
479     size_t *len;
480     int selection;
481 };
482
483 static OSSL_CALLBACK get_raw_key_details;
484 static int get_raw_key_details(const OSSL_PARAM params[], void *arg)
485 {
486     const OSSL_PARAM *p = NULL;
487     struct raw_key_details_st *raw_key = arg;
488
489     if (raw_key->selection == OSSL_KEYMGMT_SELECT_PRIVATE_KEY) {
490         if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PRIV_KEY))
491                 != NULL)
492             return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
493                                                SIZE_MAX, raw_key->len);
494     } else if (raw_key->selection == OSSL_KEYMGMT_SELECT_PUBLIC_KEY) {
495         if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PUB_KEY))
496                 != NULL)
497             return OSSL_PARAM_get_octet_string(p, (void **)raw_key->key,
498                                                SIZE_MAX, raw_key->len);
499     }
500
501     return 0;
502 }
503
504 int EVP_PKEY_get_raw_private_key(const EVP_PKEY *pkey, unsigned char *priv,
505                                  size_t *len)
506 {
507     if (pkey->keymgmt != NULL) {
508         struct raw_key_details_st raw_key;
509
510         raw_key.key = priv == NULL ? NULL : &priv;
511         raw_key.len = len;
512         raw_key.selection = OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
513
514         return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
515                                   OSSL_KEYMGMT_SELECT_PRIVATE_KEY,
516                                   get_raw_key_details, &raw_key);
517     }
518
519     if (pkey->ameth == NULL) {
520         EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
521         return 0;
522     }
523
524     if (pkey->ameth->get_priv_key == NULL) {
525         EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
526         return 0;
527     }
528
529     if (!pkey->ameth->get_priv_key(pkey, priv, len)) {
530         EVPerr(0, EVP_R_GET_RAW_KEY_FAILED);
531         return 0;
532     }
533
534     return 1;
535 }
536
537 int EVP_PKEY_get_raw_public_key(const EVP_PKEY *pkey, unsigned char *pub,
538                                 size_t *len)
539 {
540     if (pkey->keymgmt != NULL) {
541         struct raw_key_details_st raw_key;
542
543         raw_key.key = pub == NULL ? NULL : &pub;
544         raw_key.len = len;
545         raw_key.selection = OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
546
547         return evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
548                                   OSSL_KEYMGMT_SELECT_PUBLIC_KEY,
549                                   get_raw_key_details, &raw_key);
550     }
551
552     if (pkey->ameth == NULL) {
553         EVPerr(0, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
554         return 0;
555     }
556
557      if (pkey->ameth->get_pub_key == NULL) {
558         EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY,
559                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
560         return 0;
561     }
562
563     if (!pkey->ameth->get_pub_key(pkey, pub, len)) {
564         EVPerr(EVP_F_EVP_PKEY_GET_RAW_PUBLIC_KEY, EVP_R_GET_RAW_KEY_FAILED);
565         return 0;
566     }
567
568     return 1;
569 }
570
571 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
572                                 size_t len, const EVP_CIPHER *cipher)
573 {
574 # ifndef OPENSSL_NO_CMAC
575 #  ifndef OPENSSL_NO_ENGINE
576     const char *engine_id = e != NULL ? ENGINE_get_id(e) : NULL;
577 #  endif
578     const char *cipher_name = EVP_CIPHER_name(cipher);
579     const OSSL_PROVIDER *prov = EVP_CIPHER_provider(cipher);
580     OPENSSL_CTX *libctx =
581         prov == NULL ? NULL : ossl_provider_library_context(prov);
582     EVP_PKEY *ret = EVP_PKEY_new();
583     EVP_MAC *cmac = EVP_MAC_fetch(libctx, OSSL_MAC_NAME_CMAC, NULL);
584     EVP_MAC_CTX *cmctx = cmac != NULL ? EVP_MAC_CTX_new(cmac) : NULL;
585     OSSL_PARAM params[4];
586     size_t paramsn = 0;
587
588     if (ret == NULL
589         || cmctx == NULL
590         || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1, NULL)) {
591         /* EVPerr already called */
592         goto err;
593     }
594
595 #  ifndef OPENSSL_NO_ENGINE
596     if (engine_id != NULL)
597         params[paramsn++] =
598             OSSL_PARAM_construct_utf8_string("engine", (char *)engine_id, 0);
599 #  endif
600
601     params[paramsn++] =
602         OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_CIPHER,
603                                          (char *)cipher_name, 0);
604     params[paramsn++] =
605         OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY,
606                                           (char *)priv, len);
607     params[paramsn] = OSSL_PARAM_construct_end();
608
609     if (!EVP_MAC_CTX_set_params(cmctx, params)) {
610         EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
611         goto err;
612     }
613
614     ret->pkey.ptr = cmctx;
615     return ret;
616
617  err:
618     EVP_PKEY_free(ret);
619     EVP_MAC_CTX_free(cmctx);
620     EVP_MAC_free(cmac);
621     return NULL;
622 # else
623     EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
624            EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
625     return NULL;
626 # endif
627 }
628
629 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
630 {
631     return pkey_set_type(pkey, NULL, type, NULL, -1, NULL);
632 }
633
634 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
635 {
636     return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len, NULL);
637 }
638
639 int EVP_PKEY_set_alias_type(EVP_PKEY *pkey, int type)
640 {
641     if (pkey->type == type) {
642         return 1; /* it already is that type */
643     }
644
645     /*
646      * The application is requesting to alias this to a different pkey type,
647      * but not one that resolves to the base type.
648      */
649     if (EVP_PKEY_type(type) != EVP_PKEY_base_id(pkey)) {
650         EVPerr(EVP_F_EVP_PKEY_SET_ALIAS_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
651         return 0;
652     }
653
654     pkey->type = type;
655     return 1;
656 }
657
658 # ifndef OPENSSL_NO_ENGINE
659 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
660 {
661     if (e != NULL) {
662         if (!ENGINE_init(e)) {
663             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
664             return 0;
665         }
666         if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
667             ENGINE_finish(e);
668             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
669             return 0;
670         }
671     }
672     ENGINE_finish(pkey->pmeth_engine);
673     pkey->pmeth_engine = e;
674     return 1;
675 }
676
677 ENGINE *EVP_PKEY_get0_engine(const EVP_PKEY *pkey)
678 {
679     return pkey->engine;
680 }
681 # endif
682 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
683 {
684     int alias = type;
685
686 #ifndef OPENSSL_NO_EC
687     if (EVP_PKEY_type(type) == EVP_PKEY_EC) {
688         const EC_GROUP *group = EC_KEY_get0_group(key);
689
690         if (group != NULL && EC_GROUP_get_curve_name(group) == NID_sm2)
691             alias = EVP_PKEY_SM2;
692     }
693 #endif
694
695     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
696         return 0;
697     if (!EVP_PKEY_set_alias_type(pkey, alias))
698         return 0;
699     pkey->pkey.ptr = key;
700     return (key != NULL);
701 }
702
703 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
704 {
705     if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
706         ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
707         return NULL;
708     }
709     return pkey->pkey.ptr;
710 }
711
712 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
713 {
714     ASN1_OCTET_STRING *os = NULL;
715     if (pkey->type != EVP_PKEY_HMAC) {
716         EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
717         return NULL;
718     }
719     os = EVP_PKEY_get0(pkey);
720     *len = os->length;
721     return os->data;
722 }
723
724 # ifndef OPENSSL_NO_POLY1305
725 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
726 {
727     ASN1_OCTET_STRING *os = NULL;
728     if (pkey->type != EVP_PKEY_POLY1305) {
729         EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
730         return NULL;
731     }
732     os = EVP_PKEY_get0(pkey);
733     *len = os->length;
734     return os->data;
735 }
736 # endif
737
738 # ifndef OPENSSL_NO_SIPHASH
739 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
740 {
741     ASN1_OCTET_STRING *os = NULL;
742
743     if (pkey->type != EVP_PKEY_SIPHASH) {
744         EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
745         return NULL;
746     }
747     os = EVP_PKEY_get0(pkey);
748     *len = os->length;
749     return os->data;
750 }
751 # endif
752
753 # ifndef OPENSSL_NO_RSA
754 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
755 {
756     int ret = EVP_PKEY_assign_RSA(pkey, key);
757     if (ret)
758         RSA_up_ref(key);
759     return ret;
760 }
761
762 RSA *EVP_PKEY_get0_RSA(const EVP_PKEY *pkey)
763 {
764     if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
765         ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
766         return NULL;
767     }
768     if (pkey->type != EVP_PKEY_RSA && pkey->type != EVP_PKEY_RSA_PSS) {
769         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
770         return NULL;
771     }
772     return pkey->pkey.rsa;
773 }
774
775 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
776 {
777     RSA *ret = EVP_PKEY_get0_RSA(pkey);
778     if (ret != NULL)
779         RSA_up_ref(ret);
780     return ret;
781 }
782 # endif
783
784 # ifndef OPENSSL_NO_DSA
785 DSA *EVP_PKEY_get0_DSA(const EVP_PKEY *pkey)
786 {
787     if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
788         ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
789         return NULL;
790     }
791     if (pkey->type != EVP_PKEY_DSA) {
792         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
793         return NULL;
794     }
795     return pkey->pkey.dsa;
796 }
797
798 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
799 {
800     int ret = EVP_PKEY_assign_DSA(pkey, key);
801     if (ret)
802         DSA_up_ref(key);
803     return ret;
804 }
805 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
806 {
807     DSA *ret = EVP_PKEY_get0_DSA(pkey);
808     if (ret != NULL)
809         DSA_up_ref(ret);
810     return ret;
811 }
812 # endif /*  OPENSSL_NO_DSA */
813 #endif /* FIPS_MODULE */
814
815 #ifndef FIPS_MODULE
816 # ifndef OPENSSL_NO_EC
817 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
818 {
819     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
820     if (ret)
821         EC_KEY_up_ref(key);
822     return ret;
823 }
824
825 EC_KEY *EVP_PKEY_get0_EC_KEY(const EVP_PKEY *pkey)
826 {
827     if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
828         ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
829         return NULL;
830     }
831     if (EVP_PKEY_base_id(pkey) != EVP_PKEY_EC) {
832         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
833         return NULL;
834     }
835     return pkey->pkey.ec;
836 }
837
838 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
839 {
840     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
841     if (ret != NULL)
842         EC_KEY_up_ref(ret);
843     return ret;
844 }
845 # endif
846
847 # ifndef OPENSSL_NO_DH
848
849 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
850 {
851     int type = DH_get0_q(key) == NULL ? EVP_PKEY_DH : EVP_PKEY_DHX;
852     int ret = EVP_PKEY_assign(pkey, type, key);
853
854     if (ret)
855         DH_up_ref(key);
856     return ret;
857 }
858
859 DH *EVP_PKEY_get0_DH(const EVP_PKEY *pkey)
860 {
861     if (!evp_pkey_downgrade((EVP_PKEY *)pkey)) {
862         ERR_raise(ERR_LIB_EVP, EVP_R_INACCESSIBLE_KEY);
863         return NULL;
864     }
865     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
866         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
867         return NULL;
868     }
869     return pkey->pkey.dh;
870 }
871
872 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
873 {
874     DH *ret = EVP_PKEY_get0_DH(pkey);
875     if (ret != NULL)
876         DH_up_ref(ret);
877     return ret;
878 }
879 # endif
880
881 int EVP_PKEY_type(int type)
882 {
883     int ret;
884     const EVP_PKEY_ASN1_METHOD *ameth;
885     ENGINE *e;
886     ameth = EVP_PKEY_asn1_find(&e, type);
887     if (ameth)
888         ret = ameth->pkey_id;
889     else
890         ret = NID_undef;
891 # ifndef OPENSSL_NO_ENGINE
892     ENGINE_finish(e);
893 # endif
894     return ret;
895 }
896
897 int EVP_PKEY_id(const EVP_PKEY *pkey)
898 {
899     return pkey->type;
900 }
901
902 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
903 {
904     return EVP_PKEY_type(pkey->type);
905 }
906
907 int EVP_PKEY_is_a(const EVP_PKEY *pkey, const char *name)
908 {
909 #ifndef FIPS_MODULE
910     if (pkey->keymgmt == NULL) {
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          * TODO Clean this away along with all other #legacy support.
920          */
921         int type;
922
923         if (strcasecmp(name, "RSA") == 0)
924             type = EVP_PKEY_RSA;
925 #ifndef OPENSSL_NO_EC
926         else if (strcasecmp(name, "EC") == 0)
927             type = EVP_PKEY_EC;
928 #endif
929 #ifndef OPENSSL_NO_DSA
930         else if (strcasecmp(name, "DSA") == 0)
931             type = EVP_PKEY_DSA;
932 #endif
933         else
934             type = EVP_PKEY_type(OBJ_sn2nid(name));
935         return EVP_PKEY_type(pkey->type) == type;
936     }
937 #endif
938     return EVP_KEYMGMT_is_a(pkey->keymgmt, name);
939 }
940
941 int EVP_PKEY_can_sign(const EVP_PKEY *pkey)
942 {
943     if (pkey->keymgmt == NULL) {
944         switch (EVP_PKEY_base_id(pkey)) {
945         case EVP_PKEY_RSA:
946             return 1;
947 #ifndef OPENSSL_NO_DSA
948         case EVP_PKEY_DSA:
949             return 1;
950 #endif
951 #ifndef OPENSSL_NO_EC
952         case EVP_PKEY_ED25519:
953         case EVP_PKEY_ED448:
954             return 1;
955         case EVP_PKEY_EC:        /* Including SM2 */
956             return EC_KEY_can_sign(pkey->pkey.ec);
957 #endif
958         default:
959             break;
960         }
961     } else {
962         const OSSL_PROVIDER *prov = EVP_KEYMGMT_provider(pkey->keymgmt);
963         OPENSSL_CTX *libctx = ossl_provider_library_context(prov);
964         const char *supported_sig =
965             pkey->keymgmt->query_operation_name != NULL
966             ? pkey->keymgmt->query_operation_name(OSSL_OP_SIGNATURE)
967             : evp_first_name(prov, pkey->keymgmt->name_id);
968         EVP_SIGNATURE *signature = NULL;
969
970         signature = EVP_SIGNATURE_fetch(libctx, supported_sig, NULL);
971         if (signature != NULL) {
972             EVP_SIGNATURE_free(signature);
973             return 1;
974         }
975     }
976     return 0;
977 }
978
979 #ifndef OPENSSL_NO_EC
980 /*
981  * TODO rewrite when we have proper data extraction functions
982  * Note: an octet pointer would be desirable!
983  */
984 static OSSL_CALLBACK get_ec_curve_name_cb;
985 static int get_ec_curve_name_cb(const OSSL_PARAM params[], void *arg)
986 {
987     const OSSL_PARAM *p = NULL;
988
989     if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_EC_NAME)) != NULL)
990         return OSSL_PARAM_get_utf8_string(p, arg, 0);
991
992     /* If there is no curve name, this is not an EC key */
993     return 0;
994 }
995
996 int evp_pkey_get_EC_KEY_curve_nid(const EVP_PKEY *pkey)
997 {
998     int ret = NID_undef;
999
1000     if (pkey->keymgmt == NULL) {
1001         if (EVP_PKEY_base_id(pkey) == EVP_PKEY_EC) {
1002             EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1003
1004             ret = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1005         }
1006     } else if (EVP_PKEY_is_a(pkey, "EC") || EVP_PKEY_is_a(pkey, "SM2")) {
1007         char *curve_name = NULL;
1008
1009         ret = evp_keymgmt_export(pkey->keymgmt, pkey->keydata,
1010                                  OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
1011                                  get_ec_curve_name_cb, &curve_name);
1012         if (ret)
1013             ret = ec_curve_name2nid(curve_name);
1014         OPENSSL_free(curve_name);
1015     }
1016
1017     return ret;
1018 }
1019 #endif
1020
1021 static int print_reset_indent(BIO **out, int pop_f_prefix, long saved_indent)
1022 {
1023     BIO_set_indent(*out, saved_indent);
1024     if (pop_f_prefix) {
1025         BIO *next = BIO_pop(*out);
1026
1027         BIO_free(*out);
1028         *out = next;
1029     }
1030     return 1;
1031 }
1032
1033 static int print_set_indent(BIO **out, int *pop_f_prefix, long *saved_indent,
1034                             long indent)
1035 {
1036     *pop_f_prefix = 0;
1037     *saved_indent = 0;
1038     if (indent > 0) {
1039         long i = BIO_get_indent(*out);
1040
1041         *saved_indent =  (i < 0 ? 0 : i);
1042         if (BIO_set_indent(*out, indent) <= 0) {
1043             if ((*out = BIO_push(BIO_new(BIO_f_prefix()), *out)) == NULL)
1044                 return 0;
1045             *pop_f_prefix = 1;
1046         }
1047         if (BIO_set_indent(*out, indent) <= 0) {
1048             print_reset_indent(out, *pop_f_prefix, *saved_indent);
1049             return 0;
1050         }
1051     }
1052     return 1;
1053 }
1054
1055 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
1056                      const char *kstr)
1057 {
1058     return BIO_indent(out, indent, 128)
1059         && BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
1060                       kstr, OBJ_nid2ln(pkey->type)) > 0;
1061 }
1062
1063 static int print_pkey(const EVP_PKEY *pkey, BIO *out, int indent,
1064                       const char *propquery /* For provided serialization */,
1065                       int (*legacy_print)(BIO *out, const EVP_PKEY *pkey,
1066                                           int indent, ASN1_PCTX *pctx),
1067                       ASN1_PCTX *legacy_pctx /* For legacy print */)
1068 {
1069     int pop_f_prefix;
1070     long saved_indent;
1071     OSSL_SERIALIZER_CTX *ctx = NULL;
1072     int ret = -2;                /* default to unsupported */
1073
1074     if (!print_set_indent(&out, &pop_f_prefix, &saved_indent, indent))
1075         return 0;
1076
1077     ctx = OSSL_SERIALIZER_CTX_new_by_EVP_PKEY(pkey, propquery);
1078     if (OSSL_SERIALIZER_CTX_get_serializer(ctx) != NULL)
1079         ret = OSSL_SERIALIZER_to_bio(ctx, out);
1080     OSSL_SERIALIZER_CTX_free(ctx);
1081
1082     if (ret != -2)
1083         goto end;
1084
1085     /* legacy fallback */
1086     if (legacy_print != NULL)
1087         ret = legacy_print(out, pkey, 0, legacy_pctx);
1088     else
1089         ret = unsup_alg(out, pkey, 0, "Public Key");
1090
1091  end:
1092     print_reset_indent(&out, pop_f_prefix, saved_indent);
1093     return ret;
1094 }
1095
1096 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
1097                           int indent, ASN1_PCTX *pctx)
1098 {
1099     return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PUBKEY_TO_TEXT_PQ,
1100                       (pkey->ameth != NULL ? pkey->ameth->pub_print : NULL),
1101                       pctx);
1102 }
1103
1104 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
1105                            int indent, ASN1_PCTX *pctx)
1106 {
1107     return print_pkey(pkey, out, indent, OSSL_SERIALIZER_PrivateKey_TO_TEXT_PQ,
1108                       (pkey->ameth != NULL ? pkey->ameth->priv_print : NULL),
1109                       pctx);
1110 }
1111
1112 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
1113                           int indent, ASN1_PCTX *pctx)
1114 {
1115     return print_pkey(pkey, out, indent, OSSL_SERIALIZER_Parameters_TO_TEXT_PQ,
1116                       (pkey->ameth != NULL ? pkey->ameth->param_print : NULL),
1117                       pctx);
1118 }
1119
1120 static int legacy_asn1_ctrl_to_param(EVP_PKEY *pkey, int op,
1121                                      int arg1, void *arg2)
1122 {
1123     if (pkey->keymgmt == NULL)
1124         return 0;
1125     switch (op) {
1126     case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
1127         {
1128             char mdname[80] = "";
1129             int nid;
1130             int rv = EVP_PKEY_get_default_digest_name(pkey, mdname,
1131                                                       sizeof(mdname));
1132
1133             if (rv <= 0)
1134                 return rv;
1135             nid = OBJ_sn2nid(mdname);
1136             if (nid == NID_undef)
1137                 nid = OBJ_ln2nid(mdname);
1138             if (nid == NID_undef)
1139                 return 0;
1140             *(int *)arg2 = nid;
1141             return 1;
1142         }
1143     default:
1144         return -2;
1145     }
1146 }
1147
1148 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
1149 {
1150     if (pkey->ameth == NULL)
1151         return legacy_asn1_ctrl_to_param(pkey, op, arg1, arg2);
1152     if (pkey->ameth->pkey_ctrl == NULL)
1153         return -2;
1154     return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
1155 }
1156
1157 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
1158 {
1159     return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
1160 }
1161
1162 int EVP_PKEY_get_default_digest_name(EVP_PKEY *pkey,
1163                                      char *mdname, size_t mdname_sz)
1164 {
1165     if (pkey->ameth == NULL)
1166         return evp_keymgmt_util_get_deflt_digest_name(pkey->keymgmt,
1167                                                       pkey->keydata,
1168                                                       mdname, mdname_sz);
1169
1170     {
1171         int nid = NID_undef;
1172         int rv = EVP_PKEY_get_default_digest_nid(pkey, &nid);
1173         const char *name = rv > 0 ? OBJ_nid2sn(nid) : NULL;
1174
1175         if (rv > 0)
1176             OPENSSL_strlcpy(mdname, name, mdname_sz);
1177         return rv;
1178     }
1179 }
1180
1181 int EVP_PKEY_supports_digest_nid(EVP_PKEY *pkey, int nid)
1182 {
1183     int rv, default_nid;
1184
1185     rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SUPPORTS_MD_NID, nid, NULL);
1186     if (rv == -2) {
1187         /*
1188          * If there is a mandatory default digest and this isn't it, then
1189          * the answer is 'no'.
1190          */
1191         rv = EVP_PKEY_get_default_digest_nid(pkey, &default_nid);
1192         if (rv == 2)
1193             return (nid == default_nid);
1194         /* zero is an error from EVP_PKEY_get_default_digest_nid() */
1195         if (rv == 0)
1196             return -1;
1197     }
1198     return rv;
1199 }
1200
1201 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
1202                                const unsigned char *pt, size_t ptlen)
1203 {
1204     if (ptlen > INT_MAX)
1205         return 0;
1206     if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
1207                            (void *)pt) <= 0)
1208         return 0;
1209     return 1;
1210 }
1211
1212 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
1213 {
1214     int rv;
1215     rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
1216     if (rv <= 0)
1217         return 0;
1218     return rv;
1219 }
1220
1221 #endif /* FIPS_MODULE */
1222
1223 /*- All methods below can also be used in FIPS_MODULE */
1224
1225 EVP_PKEY *EVP_PKEY_new(void)
1226 {
1227     EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
1228
1229     if (ret == NULL) {
1230         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1231         return NULL;
1232     }
1233     ret->type = EVP_PKEY_NONE;
1234     ret->save_type = EVP_PKEY_NONE;
1235     ret->references = 1;
1236     ret->save_parameters = 1;
1237     ret->lock = CRYPTO_THREAD_lock_new();
1238     if (ret->lock == NULL) {
1239         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1240         goto err;
1241     }
1242 #ifndef FIPS_MODULE
1243     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, ret, &ret->ex_data)) {
1244         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
1245         goto err;
1246     }
1247 #endif
1248     return ret;
1249
1250  err:
1251     CRYPTO_THREAD_lock_free(ret->lock);
1252     OPENSSL_free(ret);
1253     return NULL;
1254 }
1255
1256 /*
1257  * Setup a public key management method.
1258  *
1259  * For legacy keys, either |type| or |str| is expected to have the type
1260  * information.  In this case, the setup consists of finding an ASN1 method
1261  * and potentially an ENGINE, and setting those fields in |pkey|.
1262  *
1263  * For provider side keys, |keymgmt| is expected to be non-NULL.  In this
1264  * case, the setup consists of setting the |keymgmt| field in |pkey|.
1265  *
1266  * If pkey is NULL just return 1 or 0 if the key management method exists.
1267  */
1268
1269 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
1270                          int len, EVP_KEYMGMT *keymgmt)
1271 {
1272 #ifndef FIPS_MODULE
1273     const EVP_PKEY_ASN1_METHOD *ameth = NULL;
1274     ENGINE **eptr = (e == NULL) ? &e :  NULL;
1275 #endif
1276
1277     /*
1278      * The setups can't set both legacy and provider side methods.
1279      * It is forbidden
1280      */
1281     if (!ossl_assert(type == EVP_PKEY_NONE || keymgmt == NULL)
1282         || !ossl_assert(e == NULL || keymgmt == NULL)) {
1283         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1284         return 0;
1285     }
1286
1287     if (pkey != NULL) {
1288         int free_it = 0;
1289
1290 #ifndef FIPS_MODULE
1291         free_it = free_it || pkey->pkey.ptr != NULL;
1292 #endif
1293         free_it = free_it || pkey->keydata != NULL;
1294         if (free_it)
1295             evp_pkey_free_it(pkey);
1296 #ifndef FIPS_MODULE
1297         /*
1298          * If key type matches and a method exists then this lookup has
1299          * succeeded once so just indicate success.
1300          */
1301         if (pkey->type != EVP_PKEY_NONE
1302             && type == pkey->save_type
1303             && pkey->ameth != NULL)
1304             return 1;
1305 # ifndef OPENSSL_NO_ENGINE
1306         /* If we have ENGINEs release them */
1307         ENGINE_finish(pkey->engine);
1308         pkey->engine = NULL;
1309         ENGINE_finish(pkey->pmeth_engine);
1310         pkey->pmeth_engine = NULL;
1311 # endif
1312 #endif
1313     }
1314 #ifndef FIPS_MODULE
1315     if (str != NULL)
1316         ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
1317     else if (type != EVP_PKEY_NONE)
1318         ameth = EVP_PKEY_asn1_find(eptr, type);
1319 # ifndef OPENSSL_NO_ENGINE
1320     if (pkey == NULL && eptr != NULL)
1321         ENGINE_finish(e);
1322 # endif
1323 #endif
1324
1325
1326     {
1327         int check = 1;
1328
1329 #ifndef FIPS_MODULE
1330         check = check && ameth == NULL;
1331 #endif
1332         check = check && keymgmt == NULL;
1333         if (check) {
1334             EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
1335             return 0;
1336         }
1337     }
1338     if (pkey != NULL) {
1339         if (keymgmt != NULL && !EVP_KEYMGMT_up_ref(keymgmt)) {
1340             ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1341             return 0;
1342         }
1343
1344         pkey->keymgmt = keymgmt;
1345
1346         pkey->save_type = type;
1347         pkey->type = type;
1348
1349 #ifndef FIPS_MODULE
1350         /*
1351          * If the internal "origin" key is provider side, don't save |ameth|.
1352          * The main reason is that |ameth| is one factor to detect that the
1353          * internal "origin" key is a legacy one.
1354          */
1355         if (keymgmt == NULL)
1356             pkey->ameth = ameth;
1357         pkey->engine = e;
1358
1359         /*
1360          * The EVP_PKEY_ASN1_METHOD |pkey_id| retains its legacy key purpose
1361          * for any key type that has a legacy implementation, regardless of
1362          * if the internal key is a legacy or a provider side one.  When
1363          * there is no legacy implementation for the key, the type becomes
1364          * EVP_PKEY_KEYMGMT, which indicates that one should be cautious
1365          * with functions that expect legacy internal keys.
1366          */
1367         if (ameth != NULL)
1368             pkey->type = ameth->pkey_id;
1369         else
1370             pkey->type = EVP_PKEY_KEYMGMT;
1371 #endif
1372     }
1373     return 1;
1374 }
1375
1376 #ifndef FIPS_MODULE
1377 static void find_ameth(const char *name, void *data)
1378 {
1379     const char **str = data;
1380
1381     /*
1382      * The error messages from pkey_set_type() are uninteresting here,
1383      * and misleading.
1384      */
1385     ERR_set_mark();
1386
1387     if (pkey_set_type(NULL, NULL, EVP_PKEY_NONE, name, strlen(name),
1388                       NULL)) {
1389         if (str[0] == NULL)
1390             str[0] = name;
1391         else if (str[1] == NULL)
1392             str[1] = name;
1393     }
1394
1395     ERR_pop_to_mark();
1396 }
1397 #endif
1398
1399 int EVP_PKEY_set_type_by_keymgmt(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt)
1400 {
1401 #ifndef FIPS_MODULE
1402 # define EVP_PKEY_TYPE_STR str[0]
1403 # define EVP_PKEY_TYPE_STRLEN (str[0] == NULL ? -1 : (int)strlen(str[0]))
1404     /*
1405      * Find at most two strings that have an associated EVP_PKEY_ASN1_METHOD
1406      * Ideally, only one should be found.  If two (or more) are found, the
1407      * match is ambiguous.  This should never happen, but...
1408      */
1409     const char *str[2] = { NULL, NULL };
1410
1411     EVP_KEYMGMT_names_do_all(keymgmt, find_ameth, &str);
1412     if (str[1] != NULL) {
1413         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1414         return 0;
1415     }
1416 #else
1417 # define EVP_PKEY_TYPE_STR NULL
1418 # define EVP_PKEY_TYPE_STRLEN -1
1419 #endif
1420     return pkey_set_type(pkey, NULL, EVP_PKEY_NONE,
1421                          EVP_PKEY_TYPE_STR, EVP_PKEY_TYPE_STRLEN,
1422                          keymgmt);
1423
1424 #undef EVP_PKEY_TYPE_STR
1425 #undef EVP_PKEY_TYPE_STRLEN
1426 }
1427
1428 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
1429 {
1430     int i;
1431
1432     if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
1433         return 0;
1434
1435     REF_PRINT_COUNT("EVP_PKEY", pkey);
1436     REF_ASSERT_ISNT(i < 2);
1437     return ((i > 1) ? 1 : 0);
1438 }
1439
1440 #ifndef FIPS_MODULE
1441 void evp_pkey_free_legacy(EVP_PKEY *x)
1442 {
1443     if (x->ameth != NULL) {
1444         if (x->ameth->pkey_free != NULL)
1445             x->ameth->pkey_free(x);
1446         x->pkey.ptr = NULL;
1447     }
1448 # ifndef OPENSSL_NO_ENGINE
1449     ENGINE_finish(x->engine);
1450     x->engine = NULL;
1451     ENGINE_finish(x->pmeth_engine);
1452     x->pmeth_engine = NULL;
1453 # endif
1454 }
1455 #endif  /* FIPS_MODULE */
1456
1457 static void evp_pkey_free_it(EVP_PKEY *x)
1458 {
1459     /* internal function; x is never NULL */
1460
1461     evp_keymgmt_util_clear_operation_cache(x);
1462 #ifndef FIPS_MODULE
1463     evp_pkey_free_legacy(x);
1464 #endif
1465
1466     if (x->keymgmt != NULL) {
1467         evp_keymgmt_freedata(x->keymgmt, x->keydata);
1468         EVP_KEYMGMT_free(x->keymgmt);
1469         x->keymgmt = NULL;
1470         x->keydata = NULL;
1471     }
1472     x->type = EVP_PKEY_NONE;
1473 }
1474
1475 void EVP_PKEY_free(EVP_PKEY *x)
1476 {
1477     int i;
1478
1479     if (x == NULL)
1480         return;
1481
1482     CRYPTO_DOWN_REF(&x->references, &i, x->lock);
1483     REF_PRINT_COUNT("EVP_PKEY", x);
1484     if (i > 0)
1485         return;
1486     REF_ASSERT_ISNT(i < 0);
1487     evp_pkey_free_it(x);
1488 #ifndef FIPS_MODULE
1489     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_EVP_PKEY, x, &x->ex_data);
1490 #endif
1491     CRYPTO_THREAD_lock_free(x->lock);
1492 #ifndef FIPS_MODULE
1493     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
1494 #endif
1495     OPENSSL_free(x);
1496 }
1497
1498 int EVP_PKEY_size(const EVP_PKEY *pkey)
1499 {
1500     int size = 0;
1501
1502     if (pkey != NULL) {
1503         size = pkey->cache.size;
1504 #ifndef FIPS_MODULE
1505         if (pkey->ameth != NULL && pkey->ameth->pkey_size != NULL)
1506             size = pkey->ameth->pkey_size(pkey);
1507 #endif
1508     }
1509     return size;
1510 }
1511
1512 void *evp_pkey_export_to_provider(EVP_PKEY *pk, OPENSSL_CTX *libctx,
1513                                   EVP_KEYMGMT **keymgmt,
1514                                   const char *propquery)
1515 {
1516     EVP_KEYMGMT *allocated_keymgmt = NULL;
1517     EVP_KEYMGMT *tmp_keymgmt = NULL;
1518     void *keydata = NULL;
1519     int check;
1520
1521     if (pk == NULL)
1522         return NULL;
1523
1524     /* No key data => nothing to export */
1525     check = 1;
1526 #ifndef FIPS_MODULE
1527     check = check && pk->pkey.ptr == NULL;
1528 #endif
1529     check = check && pk->keydata == NULL;
1530     if (check)
1531         return NULL;
1532
1533 #ifndef FIPS_MODULE
1534     if (pk->pkey.ptr != NULL) {
1535         /*
1536          * If the legacy key doesn't have an dirty counter or export function,
1537          * give up
1538          */
1539         if (pk->ameth->dirty_cnt == NULL || pk->ameth->export_to == NULL)
1540             return NULL;
1541     }
1542 #endif
1543
1544     if (keymgmt != NULL) {
1545         tmp_keymgmt = *keymgmt;
1546         *keymgmt = NULL;
1547     }
1548
1549     /*
1550      * If no keymgmt was given or found, get a default keymgmt.  We do so by
1551      * letting EVP_PKEY_CTX_new_from_pkey() do it for us, then we steal it.
1552      */
1553     if (tmp_keymgmt == NULL) {
1554         EVP_PKEY_CTX *ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, propquery);
1555
1556         tmp_keymgmt = ctx->keymgmt;
1557         ctx->keymgmt = NULL;
1558         EVP_PKEY_CTX_free(ctx);
1559     }
1560
1561     /* If there's still no keymgmt to be had, give up */
1562     if (tmp_keymgmt == NULL)
1563         goto end;
1564
1565 #ifndef FIPS_MODULE
1566     if (pk->pkey.ptr != NULL) {
1567         size_t i = 0;
1568
1569         /*
1570          * If the legacy "origin" hasn't changed since last time, we try
1571          * to find our keymgmt in the operation cache.  If it has changed,
1572          * |i| remains zero, and we will clear the cache further down.
1573          */
1574         if (pk->ameth->dirty_cnt(pk) == pk->dirty_cnt_copy) {
1575             i = evp_keymgmt_util_find_operation_cache_index(pk, tmp_keymgmt);
1576
1577             /*
1578              * If |tmp_keymgmt| is present in the operation cache, it means
1579              * that export doesn't need to be redone.  In that case, we take
1580              * token copies of the cached pointers, to have token success
1581              * values to return.
1582              */
1583             if (i < OSSL_NELEM(pk->operation_cache)
1584                 && pk->operation_cache[i].keymgmt != NULL) {
1585                 keydata = pk->operation_cache[i].keydata;
1586                 goto end;
1587             }
1588         }
1589
1590         /*
1591          * TODO(3.0) Right now, we assume we have ample space.  We will have
1592          * to think about a cache aging scheme, though, if |i| indexes outside
1593          * the array.
1594          */
1595         if (!ossl_assert(i < OSSL_NELEM(pk->operation_cache)))
1596             goto end;
1597
1598         /* Make sure that the keymgmt key type matches the legacy NID */
1599         if (!ossl_assert(EVP_KEYMGMT_is_a(tmp_keymgmt, OBJ_nid2sn(pk->type))))
1600             goto end;
1601
1602         if ((keydata = evp_keymgmt_newdata(tmp_keymgmt)) == NULL)
1603             goto end;
1604
1605         if (!pk->ameth->export_to(pk, keydata, tmp_keymgmt, libctx, propquery)) {
1606             evp_keymgmt_freedata(tmp_keymgmt, keydata);
1607             keydata = NULL;
1608             goto end;
1609         }
1610
1611         /*
1612          * If the dirty counter changed since last time, then clear the
1613          * operation cache.  In that case, we know that |i| is zero.  Just
1614          * in case this is a re-export, we increment then decrement the
1615          * keymgmt reference counter.
1616          */
1617         if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) { /* refcnt++ */
1618             evp_keymgmt_freedata(tmp_keymgmt, keydata);
1619             keydata = NULL;
1620             goto end;
1621         }
1622         if (pk->ameth->dirty_cnt(pk) != pk->dirty_cnt_copy)
1623             evp_keymgmt_util_clear_operation_cache(pk);
1624         EVP_KEYMGMT_free(tmp_keymgmt); /* refcnt-- */
1625
1626         /* Add the new export to the operation cache */
1627         if (!evp_keymgmt_util_cache_keydata(pk, i, tmp_keymgmt, keydata)) {
1628             evp_keymgmt_freedata(tmp_keymgmt, keydata);
1629             keydata = NULL;
1630             goto end;
1631         }
1632
1633         /* Synchronize the dirty count */
1634         pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1635         goto end;
1636     }
1637 #endif  /* FIPS_MODULE */
1638
1639     keydata = evp_keymgmt_util_export_to_provider(pk, tmp_keymgmt);
1640
1641  end:
1642     /*
1643      * If nothing was exported, |tmp_keymgmt| might point at a freed
1644      * EVP_KEYMGMT, so we clear it to be safe.  It shouldn't be useful for
1645      * the caller either way in that case.
1646      */
1647     if (keydata == NULL)
1648         tmp_keymgmt = NULL;
1649
1650     if (keymgmt != NULL)
1651         *keymgmt = tmp_keymgmt;
1652
1653     EVP_KEYMGMT_free(allocated_keymgmt);
1654     return keydata;
1655 }
1656
1657 #ifndef FIPS_MODULE
1658 int evp_pkey_downgrade(EVP_PKEY *pk)
1659 {
1660     EVP_KEYMGMT *keymgmt = pk->keymgmt;
1661     void *keydata = pk->keydata;
1662     int type = pk->type;
1663     const char *keytype = NULL;
1664
1665     /* If this isn't a provider side key, we're done */
1666     if (keymgmt == NULL)
1667         return 1;
1668
1669     keytype = evp_first_name(EVP_KEYMGMT_provider(keymgmt), keymgmt->name_id);
1670
1671     /*
1672      * If the type is EVP_PKEY_NONE, then we have a problem somewhere else
1673      * in our code.  If it's not one of the well known EVP_PKEY_xxx values,
1674      * it should at least be EVP_PKEY_KEYMGMT at this point.
1675      * TODO(3.0) remove this check when we're confident that the rest of the
1676      * code treats this correctly.
1677      */
1678     if (!ossl_assert(type != EVP_PKEY_NONE)) {
1679         ERR_raise_data(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR,
1680                        "keymgmt key type = %s but legacy type = EVP_PKEY_NONE",
1681                        keytype);
1682         return 0;
1683     }
1684
1685     /* Prefer the legacy key type name for error reporting */
1686     if (type != EVP_PKEY_KEYMGMT)
1687         keytype = OBJ_nid2sn(type);
1688
1689     /*
1690      * To be able to downgrade, we steal the provider side "origin" keymgmt
1691      * and keydata.  We've already grabbed the pointers, so all we need to
1692      * do is clear those pointers in |pk| and then call evp_pkey_free_it().
1693      * That way, we can restore |pk| if we need to.
1694      */
1695     pk->keymgmt = NULL;
1696     pk->keydata = NULL;
1697     evp_pkey_free_it(pk);
1698     if (EVP_PKEY_set_type(pk, type)) {
1699         /* If the key is typed but empty, we're done */
1700         if (keydata == NULL) {
1701             /* We're dropping the EVP_KEYMGMT */
1702             EVP_KEYMGMT_free(keymgmt);
1703             return 1;
1704         }
1705
1706         if (pk->ameth->import_from == NULL) {
1707             ERR_raise_data(ERR_LIB_EVP, EVP_R_NO_IMPORT_FUNCTION,
1708                            "key type = %s", keytype);
1709         } else {
1710             /*
1711              * We perform the export in the same libctx as the keymgmt that we
1712              * are using.
1713              */
1714             OPENSSL_CTX *libctx = ossl_provider_library_context(keymgmt->prov);
1715             EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_from_pkey(libctx, pk, NULL);
1716             if (pctx == NULL)
1717                 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
1718
1719             if (pctx != NULL
1720                     && evp_keymgmt_export(keymgmt, keydata,
1721                                           OSSL_KEYMGMT_SELECT_ALL,
1722                                           pk->ameth->import_from, pctx)) {
1723                 /*
1724                  * Save the provider side data in the operation cache, so they'll
1725                  * find it again.  evp_pkey_free_it() cleared the cache, so it's
1726                  * safe to assume slot zero is free.
1727                  * Note that evp_keymgmt_util_cache_keydata() increments keymgmt's
1728                  * reference count.
1729                  */
1730                 evp_keymgmt_util_cache_keydata(pk, 0, keymgmt, keydata);
1731                 EVP_PKEY_CTX_free(pctx);
1732
1733                 /* Synchronize the dirty count */
1734                 pk->dirty_cnt_copy = pk->ameth->dirty_cnt(pk);
1735
1736                 /* evp_keymgmt_export() increased the refcount... */
1737                 EVP_KEYMGMT_free(keymgmt);
1738                 return 1;
1739             }
1740             EVP_PKEY_CTX_free(pctx);
1741         }
1742
1743         ERR_raise_data(ERR_LIB_EVP, EVP_R_KEYMGMT_EXPORT_FAILURE,
1744                        "key type = %s", keytype);
1745     }
1746
1747     /*
1748      * Something went wrong.  This could for example happen if the keymgmt
1749      * turns out to be an HSM implementation that refuses to let go of some
1750      * of the key data, typically the private bits.  In this case, we restore
1751      * the provider side internal "origin" and leave it at that.
1752      */
1753     if (!ossl_assert(EVP_PKEY_set_type_by_keymgmt(pk, keymgmt))) {
1754         /* This should not be impossible */
1755         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
1756         return 0;
1757     }
1758     /* EVP_PKEY_set_type_by_keymgmt() increased the refcount... */
1759     EVP_KEYMGMT_free(keymgmt);
1760     pk->keydata = keydata;
1761     evp_keymgmt_util_cache_keyinfo(pk);
1762     return 0;     /* No downgrade, but at least the key is restored */
1763 }
1764 #endif  /* FIPS_MODULE */
1765
1766 const OSSL_PARAM *EVP_PKEY_gettable_params(EVP_PKEY *pkey)
1767 {
1768     if (pkey == NULL
1769         || pkey->keymgmt == NULL
1770         || pkey->keydata == NULL)
1771         return 0;
1772     return evp_keymgmt_gettable_params(pkey->keymgmt);
1773 }
1774
1775 int EVP_PKEY_get_bn_param(EVP_PKEY *pkey, const char *key_name, BIGNUM **bn)
1776 {
1777     int ret = 0;
1778     OSSL_PARAM params[2];
1779     unsigned char buffer[2048];
1780     unsigned char *buf = NULL;
1781     size_t buf_sz = 0;
1782
1783     if (pkey == NULL
1784         || pkey->keymgmt == NULL
1785         || pkey->keydata == NULL
1786         || key_name == NULL
1787         || bn == NULL)
1788         return 0;
1789
1790     memset(buffer, 0, sizeof(buffer));
1791     params[0] = OSSL_PARAM_construct_BN(key_name, buffer, sizeof(buffer));
1792     params[1] = OSSL_PARAM_construct_end();
1793     if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)) {
1794         if (!OSSL_PARAM_modified(params) || params[0].return_size == 0)
1795             return 0;
1796         buf_sz = params[0].return_size;
1797         /*
1798          * If it failed because the buffer was too small then allocate the
1799          * required buffer size and retry.
1800          */
1801         buf = OPENSSL_zalloc(buf_sz);
1802         if (buf == NULL)
1803             return 0;
1804         params[0].data = buf;
1805         params[0].data_size = buf_sz;
1806
1807         if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params))
1808             goto err;
1809     }
1810     /* Fail if the param was not found */
1811     if (!OSSL_PARAM_modified(params))
1812         goto err;
1813     ret = OSSL_PARAM_get_BN(params, bn);
1814 err:
1815     OPENSSL_free(buf);
1816     return ret;
1817 }
1818
1819 int EVP_PKEY_get_octet_string_param(EVP_PKEY *pkey, const char *key_name,
1820                                     unsigned char *buf, size_t max_buf_sz,
1821                                     size_t *out_sz)
1822 {
1823     OSSL_PARAM params[2];
1824
1825     if (pkey == NULL
1826         || pkey->keymgmt == NULL
1827         || pkey->keydata == NULL
1828         || key_name == NULL)
1829         return 0;
1830
1831     params[0] = OSSL_PARAM_construct_octet_string(key_name, buf, max_buf_sz);
1832     params[1] = OSSL_PARAM_construct_end();
1833     if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1834         || !OSSL_PARAM_modified(params))
1835         return 0;
1836     if (out_sz != NULL)
1837         *out_sz = params[0].return_size;
1838     return 1;
1839 }
1840
1841 int EVP_PKEY_get_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
1842                                     char *str, size_t max_buf_sz,
1843                                     size_t *out_sz)
1844 {
1845     OSSL_PARAM params[2];
1846
1847     if (pkey == NULL
1848         || pkey->keymgmt == NULL
1849         || pkey->keydata == NULL
1850         || key_name == NULL)
1851         return 0;
1852
1853     params[0] = OSSL_PARAM_construct_utf8_string(key_name, str, max_buf_sz);
1854     params[1] = OSSL_PARAM_construct_end();
1855     if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1856         || !OSSL_PARAM_modified(params))
1857         return 0;
1858     if (out_sz != NULL)
1859         *out_sz = params[0].return_size;
1860     return 1;
1861 }
1862
1863 int EVP_PKEY_get_int_param(EVP_PKEY *pkey, const char *key_name, int *out)
1864 {
1865     OSSL_PARAM params[2];
1866
1867     if (pkey == NULL
1868         || pkey->keymgmt == NULL
1869         || pkey->keydata == NULL
1870         || key_name == NULL)
1871         return 0;
1872
1873     params[0] = OSSL_PARAM_construct_int(key_name, out);
1874     params[1] = OSSL_PARAM_construct_end();
1875     if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1876         || !OSSL_PARAM_modified(params))
1877         return 0;
1878     return 1;
1879 }
1880
1881 int EVP_PKEY_get_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t *out)
1882 {
1883     OSSL_PARAM params[2];
1884
1885     if (pkey == NULL
1886         || pkey->keymgmt == NULL
1887         || pkey->keydata == NULL
1888         || key_name == NULL)
1889         return 0;
1890
1891     params[0] = OSSL_PARAM_construct_size_t(key_name, out);
1892     params[1] = OSSL_PARAM_construct_end();
1893     if (!evp_keymgmt_get_params(pkey->keymgmt, pkey->keydata, params)
1894         || !OSSL_PARAM_modified(params))
1895         return 0;
1896     return 1;
1897 }