Make EVP_PKEY_CTX_[get|set]_ec_paramgen_curve_name more generic
[openssl.git] / crypto / evp / pmeth_lib.c
1 /*
2  * Copyright 2006-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  * Low level key APIs (DH etc) 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 <stdlib.h>
18 #include <openssl/engine.h>
19 #include <openssl/evp.h>
20 #include <openssl/x509v3.h>
21 #include <openssl/core_names.h>
22 #include <openssl/dh.h>
23 #include <openssl/rsa.h>
24 #include "internal/cryptlib.h"
25 #include "crypto/asn1.h"
26 #include "crypto/evp.h"
27 #include "crypto/dh.h"
28 #include "internal/ffc.h"
29 #include "internal/numbers.h"
30 #include "internal/provider.h"
31 #include "evp_local.h"
32
33 #ifndef FIPS_MODULE
34
35 typedef const EVP_PKEY_METHOD *(*pmeth_fn)(void);
36 typedef int sk_cmp_fn_type(const char *const *a, const char *const *b);
37
38 static STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
39
40 /* This array needs to be in order of NIDs */
41 static pmeth_fn standard_methods[] = {
42 # ifndef OPENSSL_NO_RSA
43     rsa_pkey_method,
44 # endif
45 # ifndef OPENSSL_NO_DH
46     dh_pkey_method,
47 # endif
48 # ifndef OPENSSL_NO_DSA
49     dsa_pkey_method,
50 # endif
51 # ifndef OPENSSL_NO_EC
52     ec_pkey_method,
53 # endif
54     hmac_pkey_method,
55 # ifndef OPENSSL_NO_CMAC
56     cmac_pkey_method,
57 # endif
58 # ifndef OPENSSL_NO_RSA
59     rsa_pss_pkey_method,
60 # endif
61 # ifndef OPENSSL_NO_DH
62     dhx_pkey_method,
63 # endif
64 # ifndef OPENSSL_NO_SCRYPT
65     scrypt_pkey_method,
66 # endif
67     tls1_prf_pkey_method,
68 # ifndef OPENSSL_NO_EC
69     ecx25519_pkey_method,
70     ecx448_pkey_method,
71 # endif
72     hkdf_pkey_method,
73 # ifndef OPENSSL_NO_POLY1305
74     poly1305_pkey_method,
75 # endif
76 # ifndef OPENSSL_NO_SIPHASH
77     siphash_pkey_method,
78 # endif
79 # ifndef OPENSSL_NO_EC
80     ed25519_pkey_method,
81     ed448_pkey_method,
82 # endif
83 # ifndef OPENSSL_NO_SM2
84     sm2_pkey_method,
85 # endif
86 };
87
88 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
89
90 static int pmeth_func_cmp(const EVP_PKEY_METHOD *const *a, pmeth_fn const *b)
91 {
92     return ((*a)->pkey_id - ((**b)())->pkey_id);
93 }
94
95 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, pmeth_fn, pmeth_func);
96
97 static int pmeth_cmp(const EVP_PKEY_METHOD *const *a,
98                      const EVP_PKEY_METHOD *const *b)
99 {
100     return ((*a)->pkey_id - (*b)->pkey_id);
101 }
102
103 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
104 {
105     pmeth_fn *ret;
106     EVP_PKEY_METHOD tmp;
107     const EVP_PKEY_METHOD *t = &tmp;
108
109     tmp.pkey_id = type;
110     if (app_pkey_methods) {
111         int idx;
112         idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
113         if (idx >= 0)
114             return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
115     }
116     ret = OBJ_bsearch_pmeth_func(&t, standard_methods,
117                                  sizeof(standard_methods) /
118                                  sizeof(pmeth_fn));
119     if (ret == NULL || *ret == NULL)
120         return NULL;
121     return (**ret)();
122 }
123
124 EVP_PKEY_METHOD *EVP_PKEY_meth_new(int id, int flags)
125 {
126     EVP_PKEY_METHOD *pmeth;
127
128     pmeth = OPENSSL_zalloc(sizeof(*pmeth));
129     if (pmeth == NULL) {
130         EVPerr(EVP_F_EVP_PKEY_METH_NEW, ERR_R_MALLOC_FAILURE);
131         return NULL;
132     }
133
134     pmeth->pkey_id = id;
135     pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
136     return pmeth;
137 }
138 #endif /* FIPS_MODULE */
139
140 static int is_legacy_alg(int id, const char *keytype)
141 {
142 #ifndef FIPS_MODULE
143     /* Certain EVP_PKEY keytypes are only available in legacy form */
144     if (id == -1) {
145         id = OBJ_sn2nid(keytype);
146         if (id == NID_undef)
147             id = OBJ_ln2nid(keytype);
148         if (id == NID_undef)
149             return  0;
150     }
151     switch (id) {
152     /*
153      * TODO(3.0): Remove SM2 and DHX when they are converted to have provider
154      * support
155      */
156     case EVP_PKEY_SM2:
157     case EVP_PKEY_DHX:
158     case EVP_PKEY_SCRYPT:
159     case EVP_PKEY_TLS1_PRF:
160     case EVP_PKEY_HKDF:
161     case EVP_PKEY_CMAC:
162     case EVP_PKEY_HMAC:
163     case EVP_PKEY_SIPHASH:
164     case EVP_PKEY_POLY1305:
165         return 1;
166     default:
167         return 0;
168     }
169 #else
170     return 0;
171 #endif
172 }
173
174 static EVP_PKEY_CTX *int_ctx_new(OPENSSL_CTX *libctx,
175                                  EVP_PKEY *pkey, ENGINE *e,
176                                  const char *keytype, const char *propquery,
177                                  int id)
178
179 {
180     EVP_PKEY_CTX *ret;
181     const EVP_PKEY_METHOD *pmeth = NULL;
182     EVP_KEYMGMT *keymgmt = NULL;
183
184     /*
185      * When using providers, the context is bound to the algo implementation
186      * later.
187      */
188     if (pkey == NULL && e == NULL && id == -1)
189         goto common;
190
191     /*
192      * If the internal key is provided, we extract the keytype from its
193      * keymgmt and skip over the legacy code.
194      */
195     if (pkey != NULL && evp_pkey_is_provided(pkey)) {
196         /* If we have an engine, something went wrong somewhere... */
197         if (!ossl_assert(e == NULL))
198             return NULL;
199         keytype = evp_first_name(pkey->keymgmt->prov, pkey->keymgmt->name_id);
200         goto common;
201     }
202 #ifndef FIPS_MODULE
203     /* TODO(3.0) Legacy code should be removed when all is provider based */
204     /* BEGIN legacy */
205     if (id == -1) {
206         if (pkey == NULL)
207             return NULL;
208         id = pkey->type;
209     }
210
211     /*
212      * Here, we extract what information we can for the purpose of
213      * supporting usage with implementations from providers, to make
214      * for a smooth transition from legacy stuff to provider based stuff.
215      *
216      * If an engine is given, this is entirely legacy, and we should not
217      * pretend anything else, so we only set the name when no engine is
218      * given.  If both are already given, someone made a mistake, and
219      * since that can only happen internally, it's safe to make an
220      * assertion.
221      */
222     if (!ossl_assert(e == NULL || keytype == NULL))
223         return NULL;
224     if (e == NULL)
225         keytype = OBJ_nid2sn(id);
226
227 # ifndef OPENSSL_NO_ENGINE
228     if (e == NULL && pkey != NULL)
229         e = pkey->pmeth_engine != NULL ? pkey->pmeth_engine : pkey->engine;
230     /* Try to find an ENGINE which implements this method */
231     if (e) {
232         if (!ENGINE_init(e)) {
233             EVPerr(EVP_F_INT_CTX_NEW, ERR_R_ENGINE_LIB);
234             return NULL;
235         }
236     } else {
237         e = ENGINE_get_pkey_meth_engine(id);
238     }
239
240     /*
241      * If an ENGINE handled this method look it up. Otherwise use internal
242      * tables.
243      */
244     if (e)
245         pmeth = ENGINE_get_pkey_meth(e, id);
246     else
247 # endif
248         pmeth = EVP_PKEY_meth_find(id);
249
250     if (pmeth == NULL) {
251 # ifndef OPENSSL_NO_ENGINE
252         ENGINE_finish(e);
253 # endif
254         EVPerr(EVP_F_INT_CTX_NEW, EVP_R_UNSUPPORTED_ALGORITHM);
255         return NULL;
256     }
257     /* END legacy */
258 #endif /* FIPS_MODULE */
259  common:
260     /*
261      * If there's no engine and there's a name, we try fetching a provider
262      * implementation.
263      */
264     if (e == NULL && keytype != NULL) {
265         int legacy = is_legacy_alg(id, keytype);
266
267         if (legacy) {
268             /* This could fail so ignore errors */
269             ERR_set_mark();
270         }
271
272         keymgmt = EVP_KEYMGMT_fetch(libctx, keytype, propquery);
273         if (legacy) {
274             ERR_pop_to_mark();
275         } else if (keymgmt == NULL) {
276             EVPerr(EVP_F_INT_CTX_NEW, EVP_R_FETCH_FAILED);
277             return NULL;
278         }
279     }
280
281     ret = OPENSSL_zalloc(sizeof(*ret));
282     if (ret == NULL) {
283         EVP_KEYMGMT_free(keymgmt);
284 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
285         ENGINE_finish(e);
286 #endif
287         EVPerr(EVP_F_INT_CTX_NEW, ERR_R_MALLOC_FAILURE);
288         return NULL;
289     }
290     ret->libctx = libctx;
291     ret->propquery = propquery;
292     ret->keytype = keytype;
293     ret->keymgmt = keymgmt;
294     ret->engine = e;
295     ret->pmeth = pmeth;
296     ret->operation = EVP_PKEY_OP_UNDEFINED;
297     ret->pkey = pkey;
298     if (pkey != NULL)
299         EVP_PKEY_up_ref(pkey);
300
301     if (pmeth != NULL && pmeth->init != NULL) {
302         if (pmeth->init(ret) <= 0) {
303             ret->pmeth = NULL;
304             EVP_PKEY_CTX_free(ret);
305             return NULL;
306         }
307     }
308
309     return ret;
310 }
311
312 /*- All methods below can also be used in FIPS_MODULE */
313
314 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_name(OPENSSL_CTX *libctx,
315                                          const char *name,
316                                          const char *propquery)
317 {
318     return int_ctx_new(libctx, NULL, NULL, name, propquery, -1);
319 }
320
321 EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_pkey(OPENSSL_CTX *libctx, EVP_PKEY *pkey,
322                                          const char *propquery)
323 {
324     return int_ctx_new(libctx, pkey, NULL, NULL, propquery, -1);
325 }
326
327 void evp_pkey_ctx_free_old_ops(EVP_PKEY_CTX *ctx)
328 {
329     if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
330         if (ctx->op.sig.sigprovctx != NULL && ctx->op.sig.signature != NULL)
331             ctx->op.sig.signature->freectx(ctx->op.sig.sigprovctx);
332         EVP_SIGNATURE_free(ctx->op.sig.signature);
333         ctx->op.sig.sigprovctx = NULL;
334         ctx->op.sig.signature = NULL;
335     } else if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
336         if (ctx->op.kex.exchprovctx != NULL && ctx->op.kex.exchange != NULL)
337             ctx->op.kex.exchange->freectx(ctx->op.kex.exchprovctx);
338         EVP_KEYEXCH_free(ctx->op.kex.exchange);
339         ctx->op.kex.exchprovctx = NULL;
340         ctx->op.kex.exchange = NULL;
341     }
342 /* TODO(3.0): add dependancies and uncomment this when available for fips mode */
343 #ifndef FIPS_MODULE
344     else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
345         if (ctx->op.ciph.ciphprovctx != NULL && ctx->op.ciph.cipher != NULL)
346             ctx->op.ciph.cipher->freectx(ctx->op.ciph.ciphprovctx);
347         EVP_ASYM_CIPHER_free(ctx->op.ciph.cipher);
348         ctx->op.ciph.ciphprovctx = NULL;
349         ctx->op.ciph.cipher = NULL;
350     } else if (EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
351         if (ctx->op.keymgmt.genctx != NULL && ctx->keymgmt != NULL)
352             evp_keymgmt_gen_cleanup(ctx->keymgmt, ctx->op.keymgmt.genctx);
353     }
354 #endif
355 }
356
357 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
358 {
359     if (ctx == NULL)
360         return;
361     if (ctx->pmeth && ctx->pmeth->cleanup)
362         ctx->pmeth->cleanup(ctx);
363
364     evp_pkey_ctx_free_old_ops(ctx);
365     EVP_KEYMGMT_free(ctx->keymgmt);
366
367     EVP_PKEY_free(ctx->pkey);
368     EVP_PKEY_free(ctx->peerkey);
369 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
370     ENGINE_finish(ctx->engine);
371 #endif
372     OPENSSL_free(ctx);
373 }
374
375 #ifndef FIPS_MODULE
376
377 void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags,
378                              const EVP_PKEY_METHOD *meth)
379 {
380     if (ppkey_id)
381         *ppkey_id = meth->pkey_id;
382     if (pflags)
383         *pflags = meth->flags;
384 }
385
386 void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src)
387 {
388     int pkey_id = dst->pkey_id;
389     int flags = dst->flags;
390
391     *dst = *src;
392
393     /* We only copy the function pointers so restore the other values */
394     dst->pkey_id = pkey_id;
395     dst->flags = flags;
396 }
397
398 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
399 {
400     if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
401         OPENSSL_free(pmeth);
402 }
403
404 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
405 {
406     return int_ctx_new(NULL, pkey, e, NULL, NULL, -1);
407 }
408
409 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
410 {
411     return int_ctx_new(NULL, NULL, e, NULL, NULL, id);
412 }
413
414 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *pctx)
415 {
416     EVP_PKEY_CTX *rctx;
417
418     if (((pctx->pmeth == NULL) || (pctx->pmeth->copy == NULL))
419             && ((EVP_PKEY_CTX_IS_DERIVE_OP(pctx)
420                  && pctx->op.kex.exchprovctx == NULL)
421                 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)
422                     && pctx->op.sig.sigprovctx == NULL)))
423         return NULL;
424 # ifndef OPENSSL_NO_ENGINE
425     /* Make sure it's safe to copy a pkey context using an ENGINE */
426     if (pctx->engine && !ENGINE_init(pctx->engine)) {
427         EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_ENGINE_LIB);
428         return 0;
429     }
430 # endif
431     rctx = OPENSSL_zalloc(sizeof(*rctx));
432     if (rctx == NULL) {
433         EVPerr(EVP_F_EVP_PKEY_CTX_DUP, ERR_R_MALLOC_FAILURE);
434         return NULL;
435     }
436
437     if (pctx->pkey != NULL)
438         EVP_PKEY_up_ref(pctx->pkey);
439     rctx->pkey = pctx->pkey;
440     rctx->operation = pctx->operation;
441     rctx->libctx = pctx->libctx;
442     rctx->keytype = pctx->keytype;
443     rctx->propquery = pctx->propquery;
444
445     if (EVP_PKEY_CTX_IS_DERIVE_OP(pctx)) {
446         if (pctx->op.kex.exchange != NULL) {
447             rctx->op.kex.exchange = pctx->op.kex.exchange;
448             if (!EVP_KEYEXCH_up_ref(rctx->op.kex.exchange)) {
449                 OPENSSL_free(rctx);
450                 return NULL;
451             }
452         }
453         if (pctx->op.kex.exchprovctx != NULL) {
454             if (!ossl_assert(pctx->op.kex.exchange != NULL))
455                 return NULL;
456             rctx->op.kex.exchprovctx
457                 = pctx->op.kex.exchange->dupctx(pctx->op.kex.exchprovctx);
458             if (rctx->op.kex.exchprovctx == NULL) {
459                 EVP_KEYEXCH_free(rctx->op.kex.exchange);
460                 OPENSSL_free(rctx);
461                 return NULL;
462             }
463             return rctx;
464         }
465     } else if (EVP_PKEY_CTX_IS_SIGNATURE_OP(pctx)) {
466         if (pctx->op.sig.signature != NULL) {
467             rctx->op.sig.signature = pctx->op.sig.signature;
468             if (!EVP_SIGNATURE_up_ref(rctx->op.sig.signature)) {
469                 OPENSSL_free(rctx);
470                 return NULL;
471             }
472         }
473         if (pctx->op.sig.sigprovctx != NULL) {
474             if (!ossl_assert(pctx->op.sig.signature != NULL))
475                 return NULL;
476             rctx->op.sig.sigprovctx
477                 = pctx->op.sig.signature->dupctx(pctx->op.sig.sigprovctx);
478             if (rctx->op.sig.sigprovctx == NULL) {
479                 EVP_SIGNATURE_free(rctx->op.sig.signature);
480                 OPENSSL_free(rctx);
481                 return NULL;
482             }
483             return rctx;
484         }
485     } else if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(pctx)) {
486         if (pctx->op.ciph.cipher != NULL) {
487             rctx->op.ciph.cipher = pctx->op.ciph.cipher;
488             if (!EVP_ASYM_CIPHER_up_ref(rctx->op.ciph.cipher)) {
489                 OPENSSL_free(rctx);
490                 return NULL;
491             }
492         }
493         if (pctx->op.ciph.ciphprovctx != NULL) {
494             if (!ossl_assert(pctx->op.ciph.cipher != NULL))
495                 return NULL;
496             rctx->op.ciph.ciphprovctx
497                 = pctx->op.ciph.cipher->dupctx(pctx->op.ciph.ciphprovctx);
498             if (rctx->op.ciph.ciphprovctx == NULL) {
499                 EVP_ASYM_CIPHER_free(rctx->op.ciph.cipher);
500                 OPENSSL_free(rctx);
501                 return NULL;
502             }
503             return rctx;
504         }
505     }
506
507     rctx->pmeth = pctx->pmeth;
508 # ifndef OPENSSL_NO_ENGINE
509     rctx->engine = pctx->engine;
510 # endif
511
512     if (pctx->peerkey)
513         EVP_PKEY_up_ref(pctx->peerkey);
514     rctx->peerkey = pctx->peerkey;
515
516     if (pctx->pmeth->copy(rctx, pctx) > 0)
517         return rctx;
518
519     rctx->pmeth = NULL;
520     EVP_PKEY_CTX_free(rctx);
521     return NULL;
522
523 }
524
525 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
526 {
527     if (app_pkey_methods == NULL) {
528         app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
529         if (app_pkey_methods == NULL){
530             EVPerr(EVP_F_EVP_PKEY_METH_ADD0, ERR_R_MALLOC_FAILURE);
531             return 0;
532         }
533     }
534     if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth)) {
535         EVPerr(EVP_F_EVP_PKEY_METH_ADD0, ERR_R_MALLOC_FAILURE);
536         return 0;
537     }
538     sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
539     return 1;
540 }
541
542 void evp_app_cleanup_int(void)
543 {
544     if (app_pkey_methods != NULL)
545         sk_EVP_PKEY_METHOD_pop_free(app_pkey_methods, EVP_PKEY_meth_free);
546 }
547
548 int EVP_PKEY_meth_remove(const EVP_PKEY_METHOD *pmeth)
549 {
550     const EVP_PKEY_METHOD *ret;
551
552     ret = sk_EVP_PKEY_METHOD_delete_ptr(app_pkey_methods, pmeth);
553
554     return ret == NULL ? 0 : 1;
555 }
556
557 size_t EVP_PKEY_meth_get_count(void)
558 {
559     size_t rv = OSSL_NELEM(standard_methods);
560
561     if (app_pkey_methods)
562         rv += sk_EVP_PKEY_METHOD_num(app_pkey_methods);
563     return rv;
564 }
565
566 const EVP_PKEY_METHOD *EVP_PKEY_meth_get0(size_t idx)
567 {
568     if (idx < OSSL_NELEM(standard_methods))
569         return (standard_methods[idx])();
570     if (app_pkey_methods == NULL)
571         return NULL;
572     idx -= OSSL_NELEM(standard_methods);
573     if (idx >= (size_t)sk_EVP_PKEY_METHOD_num(app_pkey_methods))
574         return NULL;
575     return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
576 }
577 #endif
578
579 int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
580 {
581     if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
582             && ctx->op.kex.exchprovctx != NULL
583             && ctx->op.kex.exchange != NULL
584             && ctx->op.kex.exchange->set_ctx_params != NULL)
585         return ctx->op.kex.exchange->set_ctx_params(ctx->op.kex.exchprovctx,
586                                                     params);
587     if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
588             && ctx->op.sig.sigprovctx != NULL
589             && ctx->op.sig.signature != NULL
590             && ctx->op.sig.signature->set_ctx_params != NULL)
591         return ctx->op.sig.signature->set_ctx_params(ctx->op.sig.sigprovctx,
592                                                      params);
593     if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
594             && ctx->op.ciph.ciphprovctx != NULL
595             && ctx->op.ciph.cipher != NULL
596             && ctx->op.ciph.cipher->set_ctx_params != NULL)
597         return ctx->op.ciph.cipher->set_ctx_params(ctx->op.ciph.ciphprovctx,
598                                                      params);
599     if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
600         && ctx->op.keymgmt.genctx != NULL
601         && ctx->keymgmt != NULL
602         && ctx->keymgmt->gen_set_params != NULL)
603         return evp_keymgmt_gen_set_params(ctx->keymgmt, ctx->op.keymgmt.genctx,
604                                           params);
605     return 0;
606 }
607
608 int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
609 {
610     if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
611             && ctx->op.kex.exchprovctx != NULL
612             && ctx->op.kex.exchange != NULL
613             && ctx->op.kex.exchange->get_ctx_params != NULL)
614         return ctx->op.kex.exchange->get_ctx_params(ctx->op.kex.exchprovctx,
615                                                     params);
616     if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
617             && ctx->op.sig.sigprovctx != NULL
618             && ctx->op.sig.signature != NULL
619             && ctx->op.sig.signature->get_ctx_params != NULL)
620         return ctx->op.sig.signature->get_ctx_params(ctx->op.sig.sigprovctx,
621                                                      params);
622     if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
623             && ctx->op.ciph.ciphprovctx != NULL
624             && ctx->op.ciph.cipher != NULL
625             && ctx->op.ciph.cipher->get_ctx_params != NULL)
626         return ctx->op.ciph.cipher->get_ctx_params(ctx->op.ciph.ciphprovctx,
627                                                    params);
628     return 0;
629 }
630
631 #ifndef FIPS_MODULE
632 const OSSL_PARAM *EVP_PKEY_CTX_gettable_params(EVP_PKEY_CTX *ctx)
633 {
634     if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
635             && ctx->op.kex.exchange != NULL
636             && ctx->op.kex.exchange->gettable_ctx_params != NULL)
637         return ctx->op.kex.exchange->gettable_ctx_params();
638     if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
639             && ctx->op.sig.signature != NULL
640             && ctx->op.sig.signature->gettable_ctx_params != NULL)
641         return ctx->op.sig.signature->gettable_ctx_params();
642     if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
643             && ctx->op.ciph.cipher != NULL
644             && ctx->op.ciph.cipher->gettable_ctx_params != NULL)
645         return ctx->op.ciph.cipher->gettable_ctx_params();
646     return NULL;
647 }
648
649 const OSSL_PARAM *EVP_PKEY_CTX_settable_params(EVP_PKEY_CTX *ctx)
650 {
651     if (EVP_PKEY_CTX_IS_DERIVE_OP(ctx)
652             && ctx->op.kex.exchange != NULL
653             && ctx->op.kex.exchange->settable_ctx_params != NULL)
654         return ctx->op.kex.exchange->settable_ctx_params();
655     if (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
656             && ctx->op.sig.signature != NULL
657             && ctx->op.sig.signature->settable_ctx_params != NULL)
658         return ctx->op.sig.signature->settable_ctx_params();
659     if (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
660             && ctx->op.ciph.cipher != NULL
661             && ctx->op.ciph.cipher->settable_ctx_params != NULL)
662         return ctx->op.ciph.cipher->settable_ctx_params();
663     if (EVP_PKEY_CTX_IS_GEN_OP(ctx)
664             && ctx->keymgmt != NULL)
665         return evp_keymgmt_gen_settable_params(ctx->keymgmt);
666
667     return NULL;
668 }
669
670 /*
671  * Internal helpers for stricter EVP_PKEY_CTX_{set,get}_params().
672  *
673  * Return 1 on success, 0 or negative for errors.
674  *
675  * In particular they return -2 if any of the params is not supported.
676  *
677  * They are not available in FIPS_MODULE as they depend on
678  *      - EVP_PKEY_CTX_{get,set}_params()
679  *      - EVP_PKEY_CTX_{gettable,settable}_params()
680  *
681  */
682 int evp_pkey_ctx_set_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
683 {
684     const OSSL_PARAM *p;
685
686     if (ctx == NULL || params == NULL)
687         return 0;
688
689     for (p = params; p->key != NULL; p++) {
690         /* Check the ctx actually understands this parameter */
691         if (OSSL_PARAM_locate_const(EVP_PKEY_CTX_settable_params(ctx),
692                                     p->key) == NULL )
693             return -2;
694     }
695
696     return EVP_PKEY_CTX_set_params(ctx, params);
697 }
698
699 int evp_pkey_ctx_get_params_strict(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
700 {
701     const OSSL_PARAM *p;
702
703     if (ctx == NULL || params == NULL)
704         return 0;
705
706     for (p = params; p->key != NULL; p++ ) {
707         /* Check the ctx actually understands this parameter */
708         if (OSSL_PARAM_locate_const(EVP_PKEY_CTX_gettable_params(ctx),
709                                     p->key) == NULL )
710             return -2;
711     }
712
713     return EVP_PKEY_CTX_get_params(ctx, params);
714 }
715
716 # ifndef OPENSSL_NO_DH
717 int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad)
718 {
719     OSSL_PARAM dh_pad_params[2];
720     unsigned int upad = pad;
721
722     /* We use EVP_PKEY_CTX_ctrl return values */
723     if (ctx == NULL || !EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
724         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
725         return -2;
726     }
727
728     /* TODO(3.0): Remove this eventually when no more legacy */
729     if (ctx->op.kex.exchprovctx == NULL)
730         return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_DERIVE,
731                                  EVP_PKEY_CTRL_DH_PAD, pad, NULL);
732
733     dh_pad_params[0] = OSSL_PARAM_construct_uint(OSSL_EXCHANGE_PARAM_PAD, &upad);
734     dh_pad_params[1] = OSSL_PARAM_construct_end();
735
736     return EVP_PKEY_CTX_set_params(ctx, dh_pad_params);
737 }
738 # endif
739
740 int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
741 {
742     OSSL_PARAM sig_md_params[3], *p = sig_md_params;
743     /* 80 should be big enough */
744     char name[80] = "";
745     const EVP_MD *tmp;
746
747     if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
748         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
749         /* Uses the same return values as EVP_PKEY_CTX_ctrl */
750         return -2;
751     }
752
753     /* TODO(3.0): Remove this eventually when no more legacy */
754     if (ctx->op.sig.sigprovctx == NULL)
755         return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
756                                  EVP_PKEY_CTRL_GET_MD, 0, (void *)(md));
757
758     *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
759                                             name,
760                                             sizeof(name));
761     *p++ = OSSL_PARAM_construct_end();
762
763     if (!EVP_PKEY_CTX_get_params(ctx, sig_md_params))
764         return 0;
765
766     tmp = evp_get_digestbyname_ex(ctx->libctx, name);
767     if (tmp == NULL)
768         return 0;
769
770     *md = tmp;
771
772     return 1;
773 }
774
775 int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
776 {
777     OSSL_PARAM sig_md_params[2], *p = sig_md_params;
778     const char *name;
779
780     if (ctx == NULL || !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)) {
781         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
782         /* Uses the same return values as EVP_PKEY_CTX_ctrl */
783         return -2;
784     }
785
786     /* TODO(3.0): Remove this eventually when no more legacy */
787     if (ctx->op.sig.sigprovctx == NULL)
788         return EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG,
789                                  EVP_PKEY_CTRL_MD, 0, (void *)(md));
790
791     if (md == NULL) {
792         name = "";
793     } else {
794         name = EVP_MD_name(md);
795     }
796
797     *p++ = OSSL_PARAM_construct_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST,
798                                             /*
799                                              * Cast away the const. This is read
800                                              * only so should be safe
801                                              */
802                                             (char *)name, 0);
803     *p++ = OSSL_PARAM_construct_end();
804
805     return EVP_PKEY_CTX_set_params(ctx, sig_md_params);
806 }
807
808 static int legacy_ctrl_to_param(EVP_PKEY_CTX *ctx, int keytype, int optype,
809                                 int cmd, int p1, void *p2)
810 {
811     /*
812      * GOST CMS format is different for different cipher algorithms.
813      * Most of other algorithms don't have such a difference
814      * so this ctrl is just ignored.
815      */
816     if (cmd == EVP_PKEY_CTRL_CIPHER)
817         return -2;
818
819 # ifndef OPENSSL_NO_DH
820     if (keytype == EVP_PKEY_DH) {
821         switch (cmd) {
822             case EVP_PKEY_CTRL_DH_PAD:
823                 return EVP_PKEY_CTX_set_dh_pad(ctx, p1);
824             case EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN:
825                 return EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, p1);
826             case EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN:
827                 return EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, p1);
828             case EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR:
829                 return EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, p1);
830             case EVP_PKEY_CTRL_DH_PARAMGEN_TYPE:
831                 return EVP_PKEY_CTX_set_dh_paramgen_type(ctx, p1);
832             case EVP_PKEY_CTRL_DH_RFC5114:
833                 return EVP_PKEY_CTX_set_dh_rfc5114(ctx, p1);
834         }
835     }
836 # endif
837 # ifndef OPENSSL_NO_DSA
838     if (keytype == EVP_PKEY_DSA) {
839         switch (cmd) {
840         case EVP_PKEY_CTRL_DSA_PARAMGEN_BITS:
841             return EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, p1);
842         case EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS:
843             return EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, p1);
844         case EVP_PKEY_CTRL_DSA_PARAMGEN_MD:
845             return EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, p2);
846         }
847     }
848 # endif
849 # ifndef OPENSSL_NO_EC
850     if (keytype == EVP_PKEY_EC) {
851         switch (cmd) {
852         case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
853             return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, p1);
854         case EVP_PKEY_CTRL_EC_ECDH_COFACTOR:
855             if (p1 == -2) {
856                 return EVP_PKEY_CTX_get_ecdh_cofactor_mode(ctx);
857             } else if (p1 < -1 || p1 > 1) {
858                 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
859                 return -2;
860             } else {
861                 return EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, p1);
862             }
863         case EVP_PKEY_CTRL_EC_KDF_TYPE:
864             if (p1 == -2) {
865                 return EVP_PKEY_CTX_get_ecdh_kdf_type(ctx);
866             } else {
867                 return EVP_PKEY_CTX_set_ecdh_kdf_type(ctx, p1);
868             }
869         case EVP_PKEY_CTRL_GET_EC_KDF_MD:
870             return EVP_PKEY_CTX_get_ecdh_kdf_md(ctx, p2);
871         case EVP_PKEY_CTRL_EC_KDF_MD:
872             return EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, p2);
873         case EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN:
874             return EVP_PKEY_CTX_get_ecdh_kdf_outlen(ctx, p2);
875         case EVP_PKEY_CTRL_EC_KDF_OUTLEN:
876             return EVP_PKEY_CTX_set_ecdh_kdf_outlen(ctx, p1);
877         case EVP_PKEY_CTRL_GET_EC_KDF_UKM:
878             return EVP_PKEY_CTX_get0_ecdh_kdf_ukm(ctx, p2);
879         case EVP_PKEY_CTRL_EC_KDF_UKM:
880             return EVP_PKEY_CTX_set0_ecdh_kdf_ukm(ctx, p2, p1);
881         }
882     }
883 # endif
884     if (keytype == EVP_PKEY_RSA) {
885         switch (cmd) {
886         case EVP_PKEY_CTRL_RSA_OAEP_MD:
887             return EVP_PKEY_CTX_set_rsa_oaep_md(ctx, p2);
888         case EVP_PKEY_CTRL_GET_RSA_OAEP_MD:
889             return EVP_PKEY_CTX_get_rsa_oaep_md(ctx, p2);
890         case EVP_PKEY_CTRL_RSA_MGF1_MD:
891             return EVP_PKEY_CTX_set_rsa_oaep_md(ctx, p2);
892         case EVP_PKEY_CTRL_RSA_OAEP_LABEL:
893             return EVP_PKEY_CTX_set0_rsa_oaep_label(ctx, p2, p1);
894         case EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL:
895             return EVP_PKEY_CTX_get0_rsa_oaep_label(ctx, (unsigned char **)p2);
896         case EVP_PKEY_CTRL_RSA_KEYGEN_BITS:
897             return EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, p1);
898         case EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP:
899             return EVP_PKEY_CTX_set_rsa_keygen_pubexp(ctx, p2);
900         case EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES:
901             return EVP_PKEY_CTX_set_rsa_keygen_primes(ctx, p1);
902         }
903     }
904     /*
905      * keytype == -1 is used when several key types share the same structure,
906      * or for generic controls that are the same across multiple key types.
907      */
908     if (keytype == -1) {
909         switch (cmd) {
910         case EVP_PKEY_CTRL_MD:
911             return EVP_PKEY_CTX_set_signature_md(ctx, p2);
912         case EVP_PKEY_CTRL_GET_MD:
913             return EVP_PKEY_CTX_get_signature_md(ctx, p2);
914         case EVP_PKEY_CTRL_RSA_PADDING:
915             return EVP_PKEY_CTX_set_rsa_padding(ctx, p1);
916         case EVP_PKEY_CTRL_GET_RSA_PADDING:
917             return EVP_PKEY_CTX_get_rsa_padding(ctx, p2);
918         case EVP_PKEY_CTRL_GET_RSA_MGF1_MD:
919             return EVP_PKEY_CTX_get_rsa_oaep_md(ctx, p2);
920         case EVP_PKEY_CTRL_RSA_PSS_SALTLEN:
921             return EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, p1);
922         case EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN:
923             return EVP_PKEY_CTX_get_rsa_pss_saltlen(ctx, p2);
924         case EVP_PKEY_CTRL_PKCS7_ENCRYPT:
925         case EVP_PKEY_CTRL_PKCS7_DECRYPT:
926 # ifndef OPENSSL_NO_CMS
927         case EVP_PKEY_CTRL_CMS_DECRYPT:
928         case EVP_PKEY_CTRL_CMS_ENCRYPT:
929 # endif
930             /* TODO (3.0) Temporary hack, this should probe */
931             if (!EVP_PKEY_is_a(EVP_PKEY_CTX_get0_pkey(ctx), "RSASSA-PSS"))
932                 return 1;
933             ERR_raise(ERR_LIB_EVP,
934                       EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
935             return -2;
936         }
937     }
938     return 0;
939 }
940
941 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
942                       int cmd, int p1, void *p2)
943 {
944     int ret;
945
946     if (ctx == NULL) {
947         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
948         return -2;
949     }
950
951     if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx) && ctx->op.kex.exchprovctx != NULL)
952             || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
953                 && ctx->op.sig.sigprovctx != NULL)
954             || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
955                 && ctx->op.ciph.ciphprovctx != NULL)
956             || (EVP_PKEY_CTX_IS_GEN_OP(ctx)
957                 && ctx->op.keymgmt.genctx != NULL))
958         return legacy_ctrl_to_param(ctx, keytype, optype, cmd, p1, p2);
959
960     if (ctx->pmeth == NULL || ctx->pmeth->ctrl == NULL) {
961         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
962         return -2;
963     }
964     if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
965         return -1;
966
967     /* Skip the operation checks since this is called in a very early stage */
968     if (ctx->pmeth->digest_custom != NULL)
969         goto doit;
970
971     if (ctx->operation == EVP_PKEY_OP_UNDEFINED) {
972         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
973         return -1;
974     }
975
976     if ((optype != -1) && !(ctx->operation & optype)) {
977         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
978         return -1;
979     }
980
981  doit:
982     ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
983
984     if (ret == -2)
985         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
986
987     return ret;
988 }
989
990 int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
991                              int cmd, uint64_t value)
992 {
993     return EVP_PKEY_CTX_ctrl(ctx, keytype, optype, cmd, 0, &value);
994 }
995
996 static int legacy_ctrl_str_to_param(EVP_PKEY_CTX *ctx, const char *name,
997                                     const char *value)
998 {
999
1000     /* Special cases that we intercept */
1001 # ifndef OPENSSL_NO_EC
1002     /*
1003      * We don't support encoding settings for providers, i.e. the only
1004      * possible encoding is "named_curve", so we simply fail when something
1005      * else is given, and otherwise just pretend all is fine.
1006      */
1007     if (strcmp(name, "ec_param_enc") == 0) {
1008         if (strcmp(value, "named_curve") == 0) {
1009             return 1;
1010         } else {
1011             ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1012             return -2;
1013         }
1014     }
1015 # endif
1016
1017     if (strcmp(name, "rsa_padding_mode") == 0)
1018         name = OSSL_ASYM_CIPHER_PARAM_PAD_MODE;
1019     else if (strcmp(name, "rsa_mgf1_md") == 0)
1020         name = OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST;
1021     else if (strcmp(name, "rsa_oaep_md") == 0)
1022         name = OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST;
1023     else if (strcmp(name, "rsa_oaep_label") == 0)
1024         name = OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL;
1025     else if (strcmp(name, "rsa_pss_saltlen") == 0)
1026         name = OSSL_SIGNATURE_PARAM_PSS_SALTLEN;
1027     else if (strcmp(name, "rsa_keygen_bits") == 0)
1028         name = OSSL_PKEY_PARAM_RSA_BITS;
1029     else if (strcmp(name, "rsa_keygen_pubexp") == 0)
1030         name = OSSL_PKEY_PARAM_RSA_E;
1031     else if (strcmp(name, "rsa_keygen_primes") == 0)
1032         name = OSSL_PKEY_PARAM_RSA_PRIMES;
1033     else if (strcmp(name, "rsa_pss_keygen_md") == 0)
1034         name = OSSL_PKEY_PARAM_RSA_DIGEST;
1035     else if (strcmp(name, "rsa_pss_keygen_mgf1_md") == 0)
1036         name = OSSL_PKEY_PARAM_RSA_MGF1_DIGEST;
1037     else if (strcmp(name, "rsa_pss_keygen_saltlen") == 0)
1038         name = OSSL_PKEY_PARAM_RSA_PSS_SALTLEN;
1039 # ifndef OPENSSL_NO_DSA
1040     else if (strcmp(name, "dsa_paramgen_bits") == 0)
1041         name = OSSL_PKEY_PARAM_FFC_PBITS;
1042     else if (strcmp(name, "dsa_paramgen_q_bits") == 0)
1043         name = OSSL_PKEY_PARAM_FFC_QBITS;
1044     else if (strcmp(name, "dsa_paramgen_md") == 0)
1045         name = OSSL_PKEY_PARAM_FFC_DIGEST;
1046 # endif
1047 # ifndef OPENSSL_NO_DH
1048     else if (strcmp(name, "dh_paramgen_generator") == 0)
1049         name = OSSL_PKEY_PARAM_DH_GENERATOR;
1050     else if (strcmp(name, "dh_paramgen_prime_len") == 0)
1051         name = OSSL_PKEY_PARAM_FFC_PBITS;
1052     else if (strcmp(name, "dh_paramgen_subprime_len") == 0)
1053         name = OSSL_PKEY_PARAM_FFC_QBITS;
1054     else if (strcmp(name, "dh_paramgen_type") == 0) {
1055         name = OSSL_PKEY_PARAM_FFC_TYPE;
1056         value = dh_gen_type_id2name(atoi(value));
1057     } else if (strcmp(name, "dh_param") == 0)
1058         name = OSSL_PKEY_PARAM_DH_GROUP;
1059     else if (strcmp(name, "dh_rfc5114") == 0) {
1060         name = OSSL_PKEY_PARAM_DH_GROUP;
1061         value = ffc_named_group_from_uid(atoi(value));
1062     } else if (strcmp(name, "dh_pad") == 0)
1063         name = OSSL_EXCHANGE_PARAM_PAD;
1064 # endif
1065 # ifndef OPENSSL_NO_EC
1066     else if (strcmp(name, "ec_paramgen_curve") == 0)
1067         name = OSSL_PKEY_PARAM_GROUP_NAME;
1068     else if (strcmp(name, "ecdh_cofactor_mode") == 0)
1069         name = OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE;
1070     else if (strcmp(name, "ecdh_kdf_md") == 0)
1071         name = OSSL_EXCHANGE_PARAM_KDF_DIGEST;
1072 # endif
1073
1074     {
1075         /*
1076          * TODO(3.0) reduce the code above to only translate known legacy
1077          * string to the corresponding core name (see core_names.h), but
1078          * otherwise leave it to this code block to do the actual work.
1079          */
1080         const OSSL_PARAM *settable = EVP_PKEY_CTX_settable_params(ctx);
1081         OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
1082         int rv = 0;
1083         int exists = 0;
1084
1085         if (!OSSL_PARAM_allocate_from_text(&params[0], settable, name, value,
1086                                            strlen(value), &exists)) {
1087             if (!exists) {
1088                 ERR_raise_data(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED,
1089                                "name=%s,value=%s", name, value);
1090                 return -2;
1091             }
1092             return 0;
1093         }
1094         if (EVP_PKEY_CTX_set_params(ctx, params))
1095             rv = 1;
1096         OPENSSL_free(params[0].data);
1097         return rv;
1098     }
1099 }
1100
1101 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
1102                           const char *name, const char *value)
1103 {
1104     if (ctx == NULL) {
1105         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
1106         return -2;
1107     }
1108
1109     if ((EVP_PKEY_CTX_IS_DERIVE_OP(ctx) && ctx->op.kex.exchprovctx != NULL)
1110             || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1111                 && ctx->op.sig.sigprovctx != NULL)
1112             || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1113                 && ctx->op.ciph.ciphprovctx != NULL)
1114             || (EVP_PKEY_CTX_IS_GEN_OP(ctx)
1115                 && ctx->op.keymgmt.genctx != NULL))
1116         return legacy_ctrl_str_to_param(ctx, name, value);
1117
1118     if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str) {
1119         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR, EVP_R_COMMAND_NOT_SUPPORTED);
1120         return -2;
1121     }
1122     if (strcmp(name, "digest") == 0)
1123         return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_TYPE_SIG, EVP_PKEY_CTRL_MD,
1124                                value);
1125     return ctx->pmeth->ctrl_str(ctx, name, value);
1126 }
1127
1128 /* Utility functions to send a string of hex string to a ctrl */
1129
1130 int EVP_PKEY_CTX_str2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *str)
1131 {
1132     size_t len;
1133
1134     len = strlen(str);
1135     if (len > INT_MAX)
1136         return -1;
1137     return ctx->pmeth->ctrl(ctx, cmd, len, (void *)str);
1138 }
1139
1140 int EVP_PKEY_CTX_hex2ctrl(EVP_PKEY_CTX *ctx, int cmd, const char *hex)
1141 {
1142     unsigned char *bin;
1143     long binlen;
1144     int rv = -1;
1145
1146     bin = OPENSSL_hexstr2buf(hex, &binlen);
1147     if (bin == NULL)
1148         return 0;
1149     if (binlen <= INT_MAX)
1150         rv = ctx->pmeth->ctrl(ctx, cmd, binlen, bin);
1151     OPENSSL_free(bin);
1152     return rv;
1153 }
1154
1155 /* Pass a message digest to a ctrl */
1156 int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md)
1157 {
1158     const EVP_MD *m;
1159
1160     if (md == NULL || (m = EVP_get_digestbyname(md)) == NULL) {
1161         EVPerr(EVP_F_EVP_PKEY_CTX_MD, EVP_R_INVALID_DIGEST);
1162         return 0;
1163     }
1164     return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, 0, (void *)m);
1165 }
1166
1167 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
1168 {
1169     return ctx->operation;
1170 }
1171
1172 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
1173 {
1174     ctx->keygen_info = dat;
1175     ctx->keygen_info_count = datlen;
1176 }
1177
1178 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
1179 {
1180     ctx->data = data;
1181 }
1182
1183 void *EVP_PKEY_CTX_get_data(const EVP_PKEY_CTX *ctx)
1184 {
1185     return ctx->data;
1186 }
1187
1188 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
1189 {
1190     return ctx->pkey;
1191 }
1192
1193 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
1194 {
1195     return ctx->peerkey;
1196 }
1197
1198 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
1199 {
1200     ctx->app_data = data;
1201 }
1202
1203 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
1204 {
1205     return ctx->app_data;
1206 }
1207
1208 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
1209                             int (*init) (EVP_PKEY_CTX *ctx))
1210 {
1211     pmeth->init = init;
1212 }
1213
1214 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
1215                             int (*copy) (EVP_PKEY_CTX *dst,
1216                                          const EVP_PKEY_CTX *src))
1217 {
1218     pmeth->copy = copy;
1219 }
1220
1221 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
1222                                void (*cleanup) (EVP_PKEY_CTX *ctx))
1223 {
1224     pmeth->cleanup = cleanup;
1225 }
1226
1227 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
1228                                 int (*paramgen_init) (EVP_PKEY_CTX *ctx),
1229                                 int (*paramgen) (EVP_PKEY_CTX *ctx,
1230                                                  EVP_PKEY *pkey))
1231 {
1232     pmeth->paramgen_init = paramgen_init;
1233     pmeth->paramgen = paramgen;
1234 }
1235
1236 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
1237                               int (*keygen_init) (EVP_PKEY_CTX *ctx),
1238                               int (*keygen) (EVP_PKEY_CTX *ctx,
1239                                              EVP_PKEY *pkey))
1240 {
1241     pmeth->keygen_init = keygen_init;
1242     pmeth->keygen = keygen;
1243 }
1244
1245 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
1246                             int (*sign_init) (EVP_PKEY_CTX *ctx),
1247                             int (*sign) (EVP_PKEY_CTX *ctx,
1248                                          unsigned char *sig, size_t *siglen,
1249                                          const unsigned char *tbs,
1250                                          size_t tbslen))
1251 {
1252     pmeth->sign_init = sign_init;
1253     pmeth->sign = sign;
1254 }
1255
1256 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
1257                               int (*verify_init) (EVP_PKEY_CTX *ctx),
1258                               int (*verify) (EVP_PKEY_CTX *ctx,
1259                                              const unsigned char *sig,
1260                                              size_t siglen,
1261                                              const unsigned char *tbs,
1262                                              size_t tbslen))
1263 {
1264     pmeth->verify_init = verify_init;
1265     pmeth->verify = verify;
1266 }
1267
1268 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
1269                                       int (*verify_recover_init) (EVP_PKEY_CTX
1270                                                                   *ctx),
1271                                       int (*verify_recover) (EVP_PKEY_CTX
1272                                                              *ctx,
1273                                                              unsigned char
1274                                                              *sig,
1275                                                              size_t *siglen,
1276                                                              const unsigned
1277                                                              char *tbs,
1278                                                              size_t tbslen))
1279 {
1280     pmeth->verify_recover_init = verify_recover_init;
1281     pmeth->verify_recover = verify_recover;
1282 }
1283
1284 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
1285                                int (*signctx_init) (EVP_PKEY_CTX *ctx,
1286                                                     EVP_MD_CTX *mctx),
1287                                int (*signctx) (EVP_PKEY_CTX *ctx,
1288                                                unsigned char *sig,
1289                                                size_t *siglen,
1290                                                EVP_MD_CTX *mctx))
1291 {
1292     pmeth->signctx_init = signctx_init;
1293     pmeth->signctx = signctx;
1294 }
1295
1296 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
1297                                  int (*verifyctx_init) (EVP_PKEY_CTX *ctx,
1298                                                         EVP_MD_CTX *mctx),
1299                                  int (*verifyctx) (EVP_PKEY_CTX *ctx,
1300                                                    const unsigned char *sig,
1301                                                    int siglen,
1302                                                    EVP_MD_CTX *mctx))
1303 {
1304     pmeth->verifyctx_init = verifyctx_init;
1305     pmeth->verifyctx = verifyctx;
1306 }
1307
1308 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
1309                                int (*encrypt_init) (EVP_PKEY_CTX *ctx),
1310                                int (*encryptfn) (EVP_PKEY_CTX *ctx,
1311                                                  unsigned char *out,
1312                                                  size_t *outlen,
1313                                                  const unsigned char *in,
1314                                                  size_t inlen))
1315 {
1316     pmeth->encrypt_init = encrypt_init;
1317     pmeth->encrypt = encryptfn;
1318 }
1319
1320 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
1321                                int (*decrypt_init) (EVP_PKEY_CTX *ctx),
1322                                int (*decrypt) (EVP_PKEY_CTX *ctx,
1323                                                unsigned char *out,
1324                                                size_t *outlen,
1325                                                const unsigned char *in,
1326                                                size_t inlen))
1327 {
1328     pmeth->decrypt_init = decrypt_init;
1329     pmeth->decrypt = decrypt;
1330 }
1331
1332 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
1333                               int (*derive_init) (EVP_PKEY_CTX *ctx),
1334                               int (*derive) (EVP_PKEY_CTX *ctx,
1335                                              unsigned char *key,
1336                                              size_t *keylen))
1337 {
1338     pmeth->derive_init = derive_init;
1339     pmeth->derive = derive;
1340 }
1341
1342 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
1343                             int (*ctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1344                                          void *p2),
1345                             int (*ctrl_str) (EVP_PKEY_CTX *ctx,
1346                                              const char *type,
1347                                              const char *value))
1348 {
1349     pmeth->ctrl = ctrl;
1350     pmeth->ctrl_str = ctrl_str;
1351 }
1352
1353 void EVP_PKEY_meth_set_digestsign(EVP_PKEY_METHOD *pmeth,
1354     int (*digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1355                        const unsigned char *tbs, size_t tbslen))
1356 {
1357     pmeth->digestsign = digestsign;
1358 }
1359
1360 void EVP_PKEY_meth_set_digestverify(EVP_PKEY_METHOD *pmeth,
1361     int (*digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1362                          size_t siglen, const unsigned char *tbs,
1363                          size_t tbslen))
1364 {
1365     pmeth->digestverify = digestverify;
1366 }
1367
1368 void EVP_PKEY_meth_set_check(EVP_PKEY_METHOD *pmeth,
1369                              int (*check) (EVP_PKEY *pkey))
1370 {
1371     pmeth->check = check;
1372 }
1373
1374 void EVP_PKEY_meth_set_public_check(EVP_PKEY_METHOD *pmeth,
1375                                     int (*check) (EVP_PKEY *pkey))
1376 {
1377     pmeth->public_check = check;
1378 }
1379
1380 void EVP_PKEY_meth_set_param_check(EVP_PKEY_METHOD *pmeth,
1381                                    int (*check) (EVP_PKEY *pkey))
1382 {
1383     pmeth->param_check = check;
1384 }
1385
1386 void EVP_PKEY_meth_set_digest_custom(EVP_PKEY_METHOD *pmeth,
1387                                      int (*digest_custom) (EVP_PKEY_CTX *ctx,
1388                                                            EVP_MD_CTX *mctx))
1389 {
1390     pmeth->digest_custom = digest_custom;
1391 }
1392
1393 void EVP_PKEY_meth_get_init(const EVP_PKEY_METHOD *pmeth,
1394                             int (**pinit) (EVP_PKEY_CTX *ctx))
1395 {
1396     *pinit = pmeth->init;
1397 }
1398
1399 void EVP_PKEY_meth_get_copy(const EVP_PKEY_METHOD *pmeth,
1400                             int (**pcopy) (EVP_PKEY_CTX *dst,
1401                                            const EVP_PKEY_CTX *src))
1402 {
1403     *pcopy = pmeth->copy;
1404 }
1405
1406 void EVP_PKEY_meth_get_cleanup(const EVP_PKEY_METHOD *pmeth,
1407                                void (**pcleanup) (EVP_PKEY_CTX *ctx))
1408 {
1409     *pcleanup = pmeth->cleanup;
1410 }
1411
1412 void EVP_PKEY_meth_get_paramgen(const EVP_PKEY_METHOD *pmeth,
1413                                 int (**pparamgen_init) (EVP_PKEY_CTX *ctx),
1414                                 int (**pparamgen) (EVP_PKEY_CTX *ctx,
1415                                                    EVP_PKEY *pkey))
1416 {
1417     if (pparamgen_init)
1418         *pparamgen_init = pmeth->paramgen_init;
1419     if (pparamgen)
1420         *pparamgen = pmeth->paramgen;
1421 }
1422
1423 void EVP_PKEY_meth_get_keygen(const EVP_PKEY_METHOD *pmeth,
1424                               int (**pkeygen_init) (EVP_PKEY_CTX *ctx),
1425                               int (**pkeygen) (EVP_PKEY_CTX *ctx,
1426                                                EVP_PKEY *pkey))
1427 {
1428     if (pkeygen_init)
1429         *pkeygen_init = pmeth->keygen_init;
1430     if (pkeygen)
1431         *pkeygen = pmeth->keygen;
1432 }
1433
1434 void EVP_PKEY_meth_get_sign(const EVP_PKEY_METHOD *pmeth,
1435                             int (**psign_init) (EVP_PKEY_CTX *ctx),
1436                             int (**psign) (EVP_PKEY_CTX *ctx,
1437                                            unsigned char *sig, size_t *siglen,
1438                                            const unsigned char *tbs,
1439                                            size_t tbslen))
1440 {
1441     if (psign_init)
1442         *psign_init = pmeth->sign_init;
1443     if (psign)
1444         *psign = pmeth->sign;
1445 }
1446
1447 void EVP_PKEY_meth_get_verify(const EVP_PKEY_METHOD *pmeth,
1448                               int (**pverify_init) (EVP_PKEY_CTX *ctx),
1449                               int (**pverify) (EVP_PKEY_CTX *ctx,
1450                                                const unsigned char *sig,
1451                                                size_t siglen,
1452                                                const unsigned char *tbs,
1453                                                size_t tbslen))
1454 {
1455     if (pverify_init)
1456         *pverify_init = pmeth->verify_init;
1457     if (pverify)
1458         *pverify = pmeth->verify;
1459 }
1460
1461 void EVP_PKEY_meth_get_verify_recover(const EVP_PKEY_METHOD *pmeth,
1462                                       int (**pverify_recover_init) (EVP_PKEY_CTX
1463                                                                     *ctx),
1464                                       int (**pverify_recover) (EVP_PKEY_CTX
1465                                                                *ctx,
1466                                                                unsigned char
1467                                                                *sig,
1468                                                                size_t *siglen,
1469                                                                const unsigned
1470                                                                char *tbs,
1471                                                                size_t tbslen))
1472 {
1473     if (pverify_recover_init)
1474         *pverify_recover_init = pmeth->verify_recover_init;
1475     if (pverify_recover)
1476         *pverify_recover = pmeth->verify_recover;
1477 }
1478
1479 void EVP_PKEY_meth_get_signctx(const EVP_PKEY_METHOD *pmeth,
1480                                int (**psignctx_init) (EVP_PKEY_CTX *ctx,
1481                                                       EVP_MD_CTX *mctx),
1482                                int (**psignctx) (EVP_PKEY_CTX *ctx,
1483                                                  unsigned char *sig,
1484                                                  size_t *siglen,
1485                                                  EVP_MD_CTX *mctx))
1486 {
1487     if (psignctx_init)
1488         *psignctx_init = pmeth->signctx_init;
1489     if (psignctx)
1490         *psignctx = pmeth->signctx;
1491 }
1492
1493 void EVP_PKEY_meth_get_verifyctx(const EVP_PKEY_METHOD *pmeth,
1494                                  int (**pverifyctx_init) (EVP_PKEY_CTX *ctx,
1495                                                           EVP_MD_CTX *mctx),
1496                                  int (**pverifyctx) (EVP_PKEY_CTX *ctx,
1497                                                      const unsigned char *sig,
1498                                                      int siglen,
1499                                                      EVP_MD_CTX *mctx))
1500 {
1501     if (pverifyctx_init)
1502         *pverifyctx_init = pmeth->verifyctx_init;
1503     if (pverifyctx)
1504         *pverifyctx = pmeth->verifyctx;
1505 }
1506
1507 void EVP_PKEY_meth_get_encrypt(const EVP_PKEY_METHOD *pmeth,
1508                                int (**pencrypt_init) (EVP_PKEY_CTX *ctx),
1509                                int (**pencryptfn) (EVP_PKEY_CTX *ctx,
1510                                                    unsigned char *out,
1511                                                    size_t *outlen,
1512                                                    const unsigned char *in,
1513                                                    size_t inlen))
1514 {
1515     if (pencrypt_init)
1516         *pencrypt_init = pmeth->encrypt_init;
1517     if (pencryptfn)
1518         *pencryptfn = pmeth->encrypt;
1519 }
1520
1521 void EVP_PKEY_meth_get_decrypt(const EVP_PKEY_METHOD *pmeth,
1522                                int (**pdecrypt_init) (EVP_PKEY_CTX *ctx),
1523                                int (**pdecrypt) (EVP_PKEY_CTX *ctx,
1524                                                  unsigned char *out,
1525                                                  size_t *outlen,
1526                                                  const unsigned char *in,
1527                                                  size_t inlen))
1528 {
1529     if (pdecrypt_init)
1530         *pdecrypt_init = pmeth->decrypt_init;
1531     if (pdecrypt)
1532         *pdecrypt = pmeth->decrypt;
1533 }
1534
1535 void EVP_PKEY_meth_get_derive(const EVP_PKEY_METHOD *pmeth,
1536                               int (**pderive_init) (EVP_PKEY_CTX *ctx),
1537                               int (**pderive) (EVP_PKEY_CTX *ctx,
1538                                                unsigned char *key,
1539                                                size_t *keylen))
1540 {
1541     if (pderive_init)
1542         *pderive_init = pmeth->derive_init;
1543     if (pderive)
1544         *pderive = pmeth->derive;
1545 }
1546
1547 void EVP_PKEY_meth_get_ctrl(const EVP_PKEY_METHOD *pmeth,
1548                             int (**pctrl) (EVP_PKEY_CTX *ctx, int type, int p1,
1549                                            void *p2),
1550                             int (**pctrl_str) (EVP_PKEY_CTX *ctx,
1551                                                const char *type,
1552                                                const char *value))
1553 {
1554     if (pctrl)
1555         *pctrl = pmeth->ctrl;
1556     if (pctrl_str)
1557         *pctrl_str = pmeth->ctrl_str;
1558 }
1559
1560 void EVP_PKEY_meth_get_digestsign(EVP_PKEY_METHOD *pmeth,
1561     int (**digestsign) (EVP_MD_CTX *ctx, unsigned char *sig, size_t *siglen,
1562                         const unsigned char *tbs, size_t tbslen))
1563 {
1564     if (digestsign)
1565         *digestsign = pmeth->digestsign;
1566 }
1567
1568 void EVP_PKEY_meth_get_digestverify(EVP_PKEY_METHOD *pmeth,
1569     int (**digestverify) (EVP_MD_CTX *ctx, const unsigned char *sig,
1570                           size_t siglen, const unsigned char *tbs,
1571                           size_t tbslen))
1572 {
1573     if (digestverify)
1574         *digestverify = pmeth->digestverify;
1575 }
1576
1577 void EVP_PKEY_meth_get_check(const EVP_PKEY_METHOD *pmeth,
1578                              int (**pcheck) (EVP_PKEY *pkey))
1579 {
1580     if (pcheck != NULL)
1581         *pcheck = pmeth->check;
1582 }
1583
1584 void EVP_PKEY_meth_get_public_check(const EVP_PKEY_METHOD *pmeth,
1585                                     int (**pcheck) (EVP_PKEY *pkey))
1586 {
1587     if (pcheck != NULL)
1588         *pcheck = pmeth->public_check;
1589 }
1590
1591 void EVP_PKEY_meth_get_param_check(const EVP_PKEY_METHOD *pmeth,
1592                                    int (**pcheck) (EVP_PKEY *pkey))
1593 {
1594     if (pcheck != NULL)
1595         *pcheck = pmeth->param_check;
1596 }
1597
1598 void EVP_PKEY_meth_get_digest_custom(EVP_PKEY_METHOD *pmeth,
1599                                      int (**pdigest_custom) (EVP_PKEY_CTX *ctx,
1600                                                              EVP_MD_CTX *mctx))
1601 {
1602     if (pdigest_custom != NULL)
1603         *pdigest_custom = pmeth->digest_custom;
1604 }
1605
1606 #endif /* FIPS_MODULE */