Reduce optimization in hppa builds
[openssl.git] / crypto / evp / ctrl_params_translate.c
1 /*
2  * Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /*
11  * Some ctrls depend on deprecated functionality.  We trust that this is
12  * functionality that remains internally even when 'no-deprecated' is
13  * configured.  When we drop #legacy EVP_PKEYs, this source should be
14  * possible to drop as well.
15  */
16 #include "internal/deprecated.h"
17
18 #include <string.h>
19
20 /* The following includes get us all the EVP_PKEY_CTRL macros */
21 #include <openssl/dh.h>
22 #include <openssl/dsa.h>
23 #include <openssl/ec.h>
24 #include <openssl/rsa.h>
25 #include <openssl/kdf.h>
26
27 /* This include gets us all the OSSL_PARAM key string macros */
28 #include <openssl/core_names.h>
29
30 #include <openssl/err.h>
31 #include <openssl/evperr.h>
32 #include <openssl/params.h>
33 #include "internal/nelem.h"
34 #include "internal/cryptlib.h"
35 #include "internal/ffc.h"
36 #include "crypto/evp.h"
37 #include "crypto/dh.h"
38 #include "crypto/ec.h"
39
40 #include "e_os.h"                /* strcasecmp() for Windows */
41
42 struct translation_ctx_st;       /* Forwarding */
43 struct translation_st;           /* Forwarding */
44
45 /*
46  * The fixup_args functions are called with the following parameters:
47  *
48  * |state|              The state we're called in, explained further at the
49  *                      end of this comment.
50  * |translation|        The translation item, to be pilfered for data as
51  *                      necessary.
52  * |ctx|                The translation context, which contains copies of
53  *                      the following arguments, applicable according to
54  *                      the caller.  All of the attributes in this context
55  *                      may be freely modified by the fixup_args function.
56  *                      For cleanup, call cleanup_translation_ctx().
57  *
58  * The |state| tells the fixup_args function something about the caller and
59  * what they may expect:
60  *
61  * PKEY                         The fixup_args function has been called
62  *                              from an EVP_PKEY payload getter / setter,
63  *                              and is fully responsible for getting or
64  *                              setting the requested data.  With this
65  *                              state, the fixup_args function is expected
66  *                              to use or modify |*params|, depending on
67  *                              |action_type|.
68  *
69  * PRE_CTRL_TO_PARAMS           The fixup_args function has been called
70  * POST_CTRL_TO_PARAMS          from EVP_PKEY_CTX_ctrl(), to help with
71  *                              translating the ctrl data to an OSSL_PARAM
72  *                              element or back.  The calling sequence is
73  *                              as follows:
74  *
75  *                              1. fixup_args(PRE_CTRL_TO_PARAMS, ...)
76  *                              2. EVP_PKEY_CTX_set_params() or
77  *                                 EVP_PKEY_CTX_get_params()
78  *                              3. fixup_args(POST_CTRL_TO_PARAMS, ...)
79  *
80  *                              With the PRE_CTRL_TO_PARAMS state, the
81  *                              fixup_args function is expected to modify
82  *                              the passed |*params| in whatever way
83  *                              necessary, when |action_type == SET|.
84  *                              With the POST_CTRL_TO_PARAMS state, the
85  *                              fixup_args function is expected to modify
86  *                              the passed |p2| in whatever way necessary,
87  *                              when |action_type == GET|.
88  *
89  *                              The return value from the fixup_args call
90  *                              with the POST_CTRL_TO_PARAMS state becomes
91  *                              the return value back to EVP_PKEY_CTX_ctrl().
92  *
93  * CLEANUP_CTRL_TO_PARAMS       The cleanup_args functions has been called
94  *                              from EVP_PKEY_CTX_ctrl(), to clean up what
95  *                              the fixup_args function has done, if needed.
96  *
97  *
98  * PRE_CTRL_STR_TO_PARAMS       The fixup_args function has been called
99  * POST_CTRL_STR_TO_PARAMS      from EVP_PKEY_CTX_ctrl_str(), to help with
100  *                              translating the ctrl_str data to an
101  *                              OSSL_PARAM element or back.  The calling
102  *                              sequence is as follows:
103  *
104  *                              1. fixup_args(PRE_CTRL_STR_TO_PARAMS, ...)
105  *                              2. EVP_PKEY_CTX_set_params() or
106  *                                 EVP_PKEY_CTX_get_params()
107  *                              3. fixup_args(POST_CTRL_STR_TO_PARAMS, ...)
108  *
109  *                              With the PRE_CTRL_STR_TO_PARAMS state,
110  *                              the fixup_args function is expected to
111  *                              modify the passed |*params| in whatever
112  *                              way necessary, when |action_type == SET|.
113  *                              With the POST_CTRL_STR_TO_PARAMS state,
114  *                              the fixup_args function is only expected
115  *                              to return a value.
116  *
117  * CLEANUP_CTRL_STR_TO_PARAMS   The cleanup_args functions has been called
118  *                              from EVP_PKEY_CTX_ctrl_str(), to clean up
119  *                              what the fixup_args function has done, if
120  *                              needed.
121  *
122  * PRE_PARAMS_TO_CTRL           The fixup_args function has been called
123  * POST_PARAMS_TO_CTRL          from EVP_PKEY_CTX_get_params() or
124  *                              EVP_PKEY_CTX_set_params(), to help with
125  *                              translating the OSSL_PARAM data to the
126  *                              corresponding EVP_PKEY_CTX_ctrl() arguments
127  *                              or the other way around.  The calling
128  *                              sequence is as follows:
129  *
130  *                              1. fixup_args(PRE_PARAMS_TO_CTRL, ...)
131  *                              2. EVP_PKEY_CTX_ctrl()
132  *                              3. fixup_args(POST_PARAMS_TO_CTRL, ...)
133  *
134  *                              With the PRE_PARAMS_TO_CTRL state, the
135  *                              fixup_args function is expected to modify
136  *                              the passed |p1| and |p2| in whatever way
137  *                              necessary, when |action_type == SET|.
138  *                              With the POST_PARAMS_TO_CTRL state, the
139  *                              fixup_args function is expected to
140  *                              modify the passed |*params| in whatever
141  *                              way necessary, when |action_type == GET|.
142  *
143  * CLEANUP_PARAMS_TO_CTRL       The cleanup_args functions has been called
144  *                              from EVP_PKEY_CTX_get_params() or
145  *                              EVP_PKEY_CTX_set_params(), to clean up what
146  *                              the fixup_args function has done, if needed.
147  */
148 enum state {
149     PKEY,
150     PRE_CTRL_TO_PARAMS, POST_CTRL_TO_PARAMS, CLEANUP_CTRL_TO_PARAMS,
151     PRE_CTRL_STR_TO_PARAMS, POST_CTRL_STR_TO_PARAMS, CLEANUP_CTRL_STR_TO_PARAMS,
152     PRE_PARAMS_TO_CTRL, POST_PARAMS_TO_CTRL, CLEANUP_PARAMS_TO_CTRL
153 };
154 enum action {
155     NONE = 0, GET = 1, SET = 2
156 };
157 typedef int fixup_args_fn(enum state state,
158                           const struct translation_st *translation,
159                           struct translation_ctx_st *ctx);
160 typedef int cleanup_args_fn(enum state state,
161                             const struct translation_st *translation,
162                             struct translation_ctx_st *ctx);
163
164 struct translation_ctx_st {
165     /*
166      * The EVP_PKEY_CTX, for calls on that structure, to be pilfered for data
167      * as necessary.
168      */
169     EVP_PKEY_CTX *pctx;
170     /*
171      * The action type (GET or SET).  This may be 0 in some cases, and should
172      * be modified by the fixup_args function in the PRE states.  It should
173      * otherwise remain untouched once set.
174      */
175     enum action action_type;
176     /*
177      * For ctrl to params translation, the actual ctrl command number used.
178      * For params to ctrl translation, 0.
179      */
180     int ctrl_cmd;
181     /*
182      * For ctrl_str to params translation, the actual ctrl command string
183      * used.  In this case, the (string) value is always passed as |p2|.
184      * For params to ctrl translation, this is NULL.  Along with it is also
185      * and indicator whether it matched |ctrl_str| or |ctrl_hexstr| in the
186      * translation item.
187      */
188     const char *ctrl_str;
189     int ishex;
190     /* the ctrl-style int argument. */
191     int p1;
192     /* the ctrl-style void* argument. */
193     void *p2;
194     /* a size, for passing back the |p2| size where applicable */
195     size_t sz;
196     /* pointer to the OSSL_PARAM-style params array. */
197     OSSL_PARAM *params;
198
199     /*-
200      * The following are used entirely internally by the fixup_args functions
201      * and should not be touched by the callers, at all.
202      */
203
204     /*
205      * Copy of the ctrl-style void* argument, if the fixup_args function
206      * needs to manipulate |p2| but wants to remember original.
207      */
208     void *orig_p2;
209     /* Diverse types of storage for the needy. */
210     char name_buf[OSSL_MAX_NAME_SIZE];
211     void *allocated_buf;
212     void *bufp;
213     size_t buflen;
214 };
215
216 struct translation_st {
217     /*-
218      * What this table item does.
219      *
220      * If the item has this set to 0, it means that both GET and SET are
221      * supported, and |fixup_args| will determine which it is.  This is to
222      * support translations of ctrls where the action type depends on the
223      * value of |p1| or |p2| (ctrls are really bi-directional, but are
224      * seldom used that way).
225      *
226      * This can be also used in the lookup template when it looks up by
227      * OSSL_PARAM key, to indicate if a setter or a getter called.
228      */
229     enum action action_type;
230
231     /*-
232      * Conditions, for params->ctrl translations.
233      *
234      * In table item, |keytype1| and |keytype2| can be set to -1 to indicate
235      * that this item supports all key types (or rather, that |fixup_args|
236      * will check and return an error if it's not supported).
237      * Any of these may be set to 0 to indicate that they are unset.
238      */
239     int keytype1;    /* The EVP_PKEY_XXX type, i.e. NIDs. #legacy */
240     int keytype2;    /* Another EVP_PKEY_XXX type, used for aliases */
241     int optype;      /* The operation type */
242
243     /*
244      * Lookup and translation attributes
245      *
246      * |ctrl_num|, |ctrl_str|, |ctrl_hexstr| and |param_key| are lookup
247      * attributes.
248      *
249      * |ctrl_num| may be 0 or that |param_key| may be NULL in the table item,
250      * but not at the same time.  If they are, they are simply not used for
251      * lookup.
252      * When |ctrl_num| == 0, no ctrl will be called.  Likewise, when
253      * |param_key| == NULL, no OSSL_PARAM setter/getter will be called.
254      * In that case the treatment of the translation item relies entirely on
255      * |fixup_args|, which is then assumed to have side effects.
256      *
257      * As a special case, it's possible to set |ctrl_hexstr| and assign NULL
258      * to |ctrl_str|.  That will signal to default_fixup_args() that the
259      * value must always be interpreted as hex.
260      */
261     int ctrl_num;            /* EVP_PKEY_CTRL_xxx */
262     const char *ctrl_str;    /* The corresponding ctrl string */
263     const char *ctrl_hexstr; /* The alternative "hex{str}" ctrl string */
264     const char *param_key;   /* The corresponding OSSL_PARAM key */
265     /*
266      * The appropriate OSSL_PARAM data type.  This may be 0 to indicate that
267      * this OSSL_PARAM may have more than one data type, depending on input
268      * material.  In this case, |fixup_args| is expected to check and handle
269      * it.
270      */
271     unsigned int param_data_type;
272
273     /*
274      * Fixer functions
275      *
276      * |fixup_args| is always called before (for SET) or after (for GET)
277      * the actual ctrl / OSSL_PARAM function.
278      */
279     fixup_args_fn *fixup_args;
280 };
281
282 /*-
283  * Fixer function implementations
284  * ==============================
285  */
286
287 /*
288  * default_check isn't a fixer per se, but rather a helper function to
289  * perform certain standard checks.
290  */
291 static int default_check(enum state state,
292                          const struct translation_st *translation,
293                          const struct translation_ctx_st *ctx)
294 {
295     switch (state) {
296     default:
297         break;
298     case PRE_CTRL_TO_PARAMS:
299         if (!ossl_assert(translation != NULL)) {
300             ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
301             return -2;
302         }
303         if (!ossl_assert(translation->param_key != 0)
304             || !ossl_assert(translation->param_data_type != 0)) {
305             ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
306             return -1;
307         }
308         break;
309     case PRE_CTRL_STR_TO_PARAMS:
310         /*
311          * For ctrl_str to params translation, we allow direct use of
312          * OSSL_PARAM keys as ctrl_str keys.  Therefore, it's possible that
313          * we end up with |translation == NULL|, which is fine.  The fixup
314          * function will have to deal with it carefully.
315          */
316         if (translation != NULL) {
317             if (!ossl_assert(translation->action_type != GET)) {
318                 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
319                 return -2;
320             }
321             if (!ossl_assert(translation->param_key != NULL)
322                 || !ossl_assert(translation->param_data_type != 0)) {
323                 ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
324                 return 0;
325             }
326         }
327         break;
328     case PRE_PARAMS_TO_CTRL:
329     case POST_PARAMS_TO_CTRL:
330         if (!ossl_assert(translation != NULL)) {
331             ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
332             return -2;
333         }
334         if (!ossl_assert(translation->ctrl_num != 0)
335             || !ossl_assert(translation->param_data_type != 0)) {
336             ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
337             return -1;
338         }
339     }
340
341     /* Nothing else to check */
342     return 1;
343 }
344
345 /*-
346  * default_fixup_args fixes up all sorts of arguments, governed by the
347  * diverse attributes in the translation item.  It covers all "standard"
348  * base ctrl functionality, meaning it can handle basic conversion of
349  * data between p1+p2 (SET) or return value+p2 (GET) as long as the values
350  * don't have extra semantics (such as NIDs, OIDs, that sort of stuff).
351  * Extra semantics must be handled via specific fixup_args functions.
352  *
353  * The following states and action type combinations have standard handling
354  * done in this function:
355  *
356  * PRE_CTRL_TO_PARAMS, 0                - ERROR.  action type must be
357  *                                        determined by a fixup function.
358  * PRE_CTRL_TO_PARAMS, SET | GET        - |p1| and |p2| are converted to an
359  *                                        OSSL_PARAM according to the data
360  *                                        type given in |translattion|.
361  *                                        For OSSL_PARAM_UNSIGNED_INTEGER,
362  *                                        a BIGNUM passed as |p2| is accepted.
363  * POST_CTRL_TO_PARAMS, GET             - If the OSSL_PARAM data type is a
364  *                                        STRING or PTR type, |p1| is set
365  *                                        to the OSSL_PARAM return size, and
366  *                                        |p2| is set to the string.
367  * PRE_CTRL_STR_TO_PARAMS, !SET         - ERROR.  That combination is not
368  *                                        supported.
369  * PRE_CTRL_STR_TO_PARAMS, SET          - |p2| is taken as a string, and is
370  *                                        converted to an OSSL_PARAM in a
371  *                                        standard manner, guided by the
372  *                                        param key and data type from
373  *                                        |translation|.
374  * PRE_PARAMS_TO_CTRL, SET              - the OSSL_PARAM is converted to
375  *                                        |p1| and |p2| according to the
376  *                                        data type given in |translation|
377  *                                        For OSSL_PARAM_UNSIGNED_INTEGER,
378  *                                        if |p2| is non-NULL, then |*p2|
379  *                                        is assigned a BIGNUM, otherwise
380  *                                        |p1| is assigned an unsigned int.
381  * POST_PARAMS_TO_CTRL, GET             - |p1| and |p2| are converted to
382  *                                        an OSSL_PARAM, in the same manner
383  *                                        as for the combination of
384  *                                        PRE_CTRL_TO_PARAMS, SET.
385  */
386 static int default_fixup_args(enum state state,
387                               const struct translation_st *translation,
388                               struct translation_ctx_st *ctx)
389 {
390     int ret;
391
392     if ((ret = default_check(state, translation, ctx)) < 0)
393         return ret;
394
395     switch (state) {
396     default:
397         /* For states this function should never have been called with */
398         ERR_raise_data(ERR_LIB_EVP, ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
399                        "[action:%d, state:%d]", ctx->action_type, state);
400         return 0;
401
402     /*
403      * PRE_CTRL_TO_PARAMS and POST_CTRL_TO_PARAMS handle ctrl to params
404      * translations.  PRE_CTRL_TO_PARAMS is responsible for preparing
405      * |*params|, and POST_CTRL_TO_PARAMS is responsible for bringing the
406      * result back to |*p2| and the return value.
407      */
408     case PRE_CTRL_TO_PARAMS:
409         /* This is ctrl to params translation, so we need an OSSL_PARAM key */
410         if (ctx->action_type == NONE) {
411             /*
412              * No action type is an error here.  That's a case for a
413              * special fixup function.
414              */
415             ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
416                            "[action:%d, state:%d]", ctx->action_type, state);
417             return 0;
418         }
419
420         if (translation->optype != 0) {
421             if ((EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx->pctx)
422                  && ctx->pctx->op.sig.algctx == NULL)
423                 || (EVP_PKEY_CTX_IS_DERIVE_OP(ctx->pctx)
424                     && ctx->pctx->op.kex.algctx == NULL)
425                 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx->pctx)
426                     && ctx->pctx->op.ciph.algctx == NULL)
427                 || (EVP_PKEY_CTX_IS_KEM_OP(ctx->pctx)
428                     && ctx->pctx->op.encap.algctx == NULL)
429                 /*
430                  * The following may be unnecessary, but we have them
431                  * for good measure...
432                  */
433                 || (EVP_PKEY_CTX_IS_GEN_OP(ctx->pctx)
434                     && ctx->pctx->op.keymgmt.genctx == NULL)
435                 || (EVP_PKEY_CTX_IS_FROMDATA_OP(ctx->pctx)
436                     && ctx->pctx->op.keymgmt.genctx == NULL)) {
437                 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
438                 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
439                 return -2;
440             }
441         }
442
443         /*
444          * OSSL_PARAM_construct_TYPE() works equally well for both SET and GET.
445          */
446         switch (translation->param_data_type) {
447         case OSSL_PARAM_INTEGER:
448             *ctx->params = OSSL_PARAM_construct_int(translation->param_key,
449                                                     &ctx->p1);
450             break;
451         case OSSL_PARAM_UNSIGNED_INTEGER:
452             /*
453              * BIGNUMs are passed via |p2|.  For all ctrl's that just want
454              * to pass a simple integer via |p1|, |p2| is expected to be
455              * NULL.
456              *
457              * Note that this allocates a buffer, which the cleanup function
458              * must deallocate.
459              */
460             if (ctx->p2 != NULL) {
461                 if (ctx->action_type == SET) {
462                     ctx->buflen = BN_num_bytes(ctx->p2);
463                     if ((ctx->allocated_buf =
464                          OPENSSL_malloc(ctx->buflen)) == NULL) {
465                         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
466                         return 0;
467                     }
468                     if (!BN_bn2nativepad(ctx->p2,
469                                          ctx->allocated_buf, ctx->buflen)) {
470                         OPENSSL_free(ctx->allocated_buf);
471                         ctx->allocated_buf = NULL;
472                         return 0;
473                     }
474                     *ctx->params =
475                         OSSL_PARAM_construct_BN(translation->param_key,
476                                                 ctx->allocated_buf,
477                                                 ctx->buflen);
478                 } else {
479                     /*
480                      * No support for getting a BIGNUM by ctrl, this needs
481                      * fixup_args function support.
482                      */
483                     ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
484                                    "[action:%d, state:%d] trying to get a "
485                                    "BIGNUM via ctrl call",
486                                    ctx->action_type, state);
487                     return 0;
488                 }
489             } else {
490                 *ctx->params =
491                     OSSL_PARAM_construct_uint(translation->param_key,
492                                               (unsigned int *)&ctx->p1);
493             }
494             break;
495         case OSSL_PARAM_UTF8_STRING:
496             *ctx->params =
497                 OSSL_PARAM_construct_utf8_string(translation->param_key,
498                                                  ctx->p2, (size_t)ctx->p1);
499             break;
500         case OSSL_PARAM_UTF8_PTR:
501             *ctx->params =
502                 OSSL_PARAM_construct_utf8_ptr(translation->param_key,
503                                               ctx->p2, (size_t)ctx->p1);
504             break;
505         case OSSL_PARAM_OCTET_STRING:
506             *ctx->params =
507                 OSSL_PARAM_construct_octet_string(translation->param_key,
508                                                   ctx->p2, (size_t)ctx->p1);
509             break;
510         case OSSL_PARAM_OCTET_PTR:
511             *ctx->params =
512                 OSSL_PARAM_construct_octet_ptr(translation->param_key,
513                                                ctx->p2, (size_t)ctx->p1);
514             break;
515         }
516         break;
517     case POST_CTRL_TO_PARAMS:
518         /*
519          * Because EVP_PKEY_CTX_ctrl() returns the length of certain objects
520          * as its return value, we need to ensure that we do it here as well,
521          * for the OSSL_PARAM data types where this makes sense.
522          */
523         if (ctx->action_type == GET) {
524             switch (translation->param_data_type) {
525             case OSSL_PARAM_UTF8_STRING:
526             case OSSL_PARAM_UTF8_PTR:
527             case OSSL_PARAM_OCTET_STRING:
528             case OSSL_PARAM_OCTET_PTR:
529                 ctx->p1 = (int)ctx->params[0].return_size;
530                 break;
531             }
532         }
533         break;
534
535     /*
536      * PRE_CTRL_STR_TO_PARAMS and POST_CTRL_STR_TO_PARAMS handle ctrl_str to
537      * params translations.  PRE_CTRL_TO_PARAMS is responsible for preparing
538      * |*params|, and POST_CTRL_TO_PARAMS currently has nothing to do, since
539      * there's no support for getting data via ctrl_str calls.
540      */
541     case PRE_CTRL_STR_TO_PARAMS:
542         {
543             /* This is ctrl_str to params translation */
544             const char *tmp_ctrl_str = ctx->ctrl_str;
545             const char *orig_ctrl_str = ctx->ctrl_str;
546             const char *orig_value = ctx->p2;
547             const OSSL_PARAM *settable = NULL;
548             int exists = 0;
549
550             /* Only setting is supported here */
551             if (ctx->action_type != SET) {
552                 ERR_raise_data(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED,
553                                    "[action:%d, state:%d] only setting allowed",
554                                    ctx->action_type, state);
555                 return 0;
556             }
557
558             /*
559              * If no translation exists, we simply pass the control string
560              * unmodified.
561              */
562             if (translation != NULL) {
563                 tmp_ctrl_str = ctx->ctrl_str = translation->param_key;
564
565                 if (ctx->ishex) {
566                     strcpy(ctx->name_buf, "hex");
567                     if (OPENSSL_strlcat(ctx->name_buf, tmp_ctrl_str,
568                                         sizeof(ctx->name_buf)) <= 3) {
569                         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
570                         return -1;
571                     }
572                     tmp_ctrl_str = ctx->name_buf;
573                 }
574             }
575
576             settable = EVP_PKEY_CTX_settable_params(ctx->pctx);
577             if (!OSSL_PARAM_allocate_from_text(ctx->params, settable,
578                                                tmp_ctrl_str,
579                                                ctx->p2, strlen(ctx->p2),
580                                                &exists)) {
581                 if (!exists) {
582                     ERR_raise_data(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED,
583                                    "[action:%d, state:%d] name=%s, value=%s",
584                                    ctx->action_type, state,
585                                    orig_ctrl_str, orig_value);
586                     return -2;
587                 }
588                 return 0;
589             }
590             ctx->allocated_buf = ctx->params->data;
591             ctx->buflen = ctx->params->data_size;
592         }
593         break;
594     case POST_CTRL_STR_TO_PARAMS:
595         /* Nothing to be done */
596         break;
597
598     /*
599      * PRE_PARAMS_TO_CTRL and POST_PARAMS_TO_CTRL handle params to ctrl
600      * translations.  PRE_PARAMS_TO_CTRL is responsible for preparing
601      * |p1| and |p2|, and POST_PARAMS_TO_CTRL is responsible for bringing
602      * the EVP_PKEY_CTX_ctrl() return value (passed as |p1|) and |p2| back
603      * to |*params|.
604      *
605      * PKEY is treated just like POST_PARAMS_TO_CTRL, making it easy
606      * for the related fixup_args functions to just set |p1| and |p2|
607      * appropriately and leave it to this section of code to fix up
608      * |ctx->params| accordingly.
609      */
610     case PKEY:
611     case POST_PARAMS_TO_CTRL:
612         ret = ctx->p1;
613         /* FALLTHRU */
614     case PRE_PARAMS_TO_CTRL:
615         {
616             /* This is params to ctrl translation */
617             if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET) {
618                 /* For the PRE state, only setting needs some work to be done */
619
620                 /* When setting, we populate |p1| and |p2| from |*params| */
621                 switch (translation->param_data_type) {
622                 case OSSL_PARAM_INTEGER:
623                     return OSSL_PARAM_get_int(ctx->params, &ctx->p1);
624                 case OSSL_PARAM_UNSIGNED_INTEGER:
625                     if (ctx->p2 != NULL) {
626                         /* BIGNUM passed down with p2 */
627                         if (!OSSL_PARAM_get_BN(ctx->params, ctx->p2))
628                             return 0;
629                     } else {
630                         /* Normal C unsigned int passed down */
631                         if (!OSSL_PARAM_get_uint(ctx->params,
632                                                  (unsigned int *)&ctx->p1))
633                             return 0;
634                     }
635                     return 1;
636                 case OSSL_PARAM_UTF8_STRING:
637                     return OSSL_PARAM_get_utf8_string(ctx->params,
638                                                       ctx->p2, ctx->sz);
639                 case OSSL_PARAM_OCTET_STRING:
640                     return OSSL_PARAM_get_octet_string(ctx->params,
641                                                        ctx->p2, ctx->sz,
642                                                        &ctx->sz);
643                 case OSSL_PARAM_OCTET_PTR:
644                     return OSSL_PARAM_get_octet_ptr(ctx->params,
645                                                     ctx->p2, &ctx->sz);
646                 default:
647                     ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
648                                    "[action:%d, state:%d] "
649                                    "unknown OSSL_PARAM data type %d",
650                                    ctx->action_type, state,
651                                    translation->param_data_type);
652                     return 0;
653                 }
654             } else if ((state == POST_PARAMS_TO_CTRL || state == PKEY)
655                        && ctx->action_type == GET) {
656                 /* For the POST state, only getting needs some work to be done */
657                 unsigned int param_data_type = translation->param_data_type;
658                 size_t size = (size_t)ctx->p1;
659
660                 if (state == PKEY)
661                     size = ctx->sz;
662                 if (param_data_type == 0) {
663                     /* we must have a fixup_args function to work */
664                     if (!ossl_assert(translation->fixup_args != NULL)) {
665                         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
666                         return 0;
667                     }
668                     param_data_type = ctx->params->data_type;
669                 }
670                 /* When getting, we populate |*params| from |p1| and |p2| */
671                 switch (param_data_type) {
672                 case OSSL_PARAM_INTEGER:
673                     return OSSL_PARAM_set_int(ctx->params, ctx->p1);
674                 case OSSL_PARAM_UNSIGNED_INTEGER:
675                     if (ctx->p2 != NULL) {
676                         /* BIGNUM passed back */
677                         return OSSL_PARAM_set_BN(ctx->params, ctx->p2);
678                     } else {
679                         /* Normal C unsigned int passed back */
680                         return OSSL_PARAM_set_uint(ctx->params,
681                                                    (unsigned int)ctx->p1);
682                     }
683                     return 0;
684                 case OSSL_PARAM_UTF8_STRING:
685                     return OSSL_PARAM_set_utf8_string(ctx->params, ctx->p2);
686                 case OSSL_PARAM_OCTET_STRING:
687                     return OSSL_PARAM_set_octet_string(ctx->params, ctx->p2,
688                                                        size);
689                 case OSSL_PARAM_OCTET_PTR:
690                     return OSSL_PARAM_set_octet_ptr(ctx->params, ctx->p2,
691                                                     size);
692                 default:
693                     ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
694                                    "[action:%d, state:%d] "
695                                    "unsupported OSSL_PARAM data type %d",
696                                    ctx->action_type, state,
697                                    translation->param_data_type);
698                     return 0;
699                 }
700             }
701         }
702         /* Any other combination is simply pass-through */
703         break;
704     }
705     return ret;
706 }
707
708 static int
709 cleanup_translation_ctx(enum state state,
710                         const struct translation_st *translation,
711                         struct translation_ctx_st *ctx)
712 {
713     if (ctx->allocated_buf != NULL)
714         OPENSSL_free(ctx->allocated_buf);
715     ctx->allocated_buf = NULL;
716     return 1;
717 }
718
719 /*
720  * fix_cipher_md fixes up an EVP_CIPHER / EVP_MD to its name on SET,
721  * and cipher / md name to EVP_MD on GET.
722  */
723 static const char *get_cipher_name(void *cipher)
724 {
725     return EVP_CIPHER_get0_name(cipher);
726 }
727
728 static const char *get_md_name(void *md)
729 {
730     return EVP_MD_get0_name(md);
731 }
732
733 static const void *get_cipher_by_name(OSSL_LIB_CTX *libctx, const char *name)
734 {
735     return evp_get_cipherbyname_ex(libctx, name);
736 }
737
738 static const void *get_md_by_name(OSSL_LIB_CTX *libctx, const char *name)
739 {
740     return evp_get_digestbyname_ex(libctx, name);
741 }
742
743 static int fix_cipher_md(enum state state,
744                          const struct translation_st *translation,
745                          struct translation_ctx_st *ctx,
746                          const char *(*get_name)(void *algo),
747                          const void *(*get_algo_by_name)(OSSL_LIB_CTX *libctx,
748                                                          const char *name))
749 {
750     int ret = 1;
751
752     if ((ret = default_check(state, translation, ctx)) <= 0)
753         return ret;
754
755     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
756         /*
757          * |ctx->p2| contains the address to an EVP_CIPHER or EVP_MD pointer
758          * to be filled in.  We need to remember it, then make |ctx->p2|
759          * point at a buffer to be filled in with the name, and |ctx->p1|
760          * with its size.  default_fixup_args() will take care of the rest
761          * for us.
762          */
763         ctx->orig_p2 = ctx->p2;
764         ctx->p2 = ctx->name_buf;
765         ctx->p1 = sizeof(ctx->name_buf);
766     } else if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
767         /*
768          * In different parts of OpenSSL, this ctrl command is used
769          * differently.  Some calls pass a NID as p1, others pass an
770          * EVP_CIPHER pointer as p2...
771          */
772         ctx->p2 = (char *)(ctx->p2 == NULL
773                            ? OBJ_nid2sn(ctx->p1)
774                            : get_name(ctx->p2));
775         ctx->p1 = strlen(ctx->p2);
776     } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
777         ctx->p2 = (ctx->p2 == NULL ? "" : (char *)get_name(ctx->p2));
778         ctx->p1 = strlen(ctx->p2);
779     }
780
781     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
782         return ret;
783
784     if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
785         /*
786          * Here's how we re-use |ctx->orig_p2| that was set in the
787          * PRE_CTRL_TO_PARAMS state above.
788          */
789         *(void **)ctx->orig_p2 =
790             (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
791         ctx->p1 = 1;
792     } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET) {
793         ctx->p2 = (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
794         ctx->p1 = 0;
795     }
796
797     return ret;
798 }
799
800 static int fix_cipher(enum state state,
801                       const struct translation_st *translation,
802                       struct translation_ctx_st *ctx)
803 {
804     return fix_cipher_md(state, translation, ctx,
805                          get_cipher_name, get_cipher_by_name);
806 }
807
808 static int fix_md(enum state state,
809                   const struct translation_st *translation,
810                   struct translation_ctx_st *ctx)
811 {
812     return fix_cipher_md(state, translation, ctx,
813                          get_md_name, get_md_by_name);
814 }
815
816 static int fix_distid_len(enum state state,
817                           const struct translation_st *translation,
818                           struct translation_ctx_st *ctx)
819 {
820     int ret = default_fixup_args(state, translation, ctx);
821
822     if (ret > 0) {
823         ret = 0;
824         if ((state == POST_CTRL_TO_PARAMS
825              || state == POST_CTRL_STR_TO_PARAMS) && ctx->action_type == GET) {
826             *(size_t *)ctx->p2 = ctx->sz;
827             ret = 1;
828         }
829     }
830     return ret;
831 }
832
833 struct kdf_type_map_st {
834     int kdf_type_num;
835     const char *kdf_type_str;
836 };
837
838 static int fix_kdf_type(enum state state,
839                         const struct translation_st *translation,
840                         struct translation_ctx_st *ctx,
841                         const struct kdf_type_map_st *kdf_type_map)
842 {
843     /*
844      * The EVP_PKEY_CTRL_DH_KDF_TYPE ctrl command is a bit special, in
845      * that it's used both for setting a value, and for getting it, all
846      * depending on the value if |p1|; if |p1| is -2, the backend is
847      * supposed to place the current kdf type in |p2|, and if not, |p1|
848      * is interpreted as the new kdf type.
849      */
850     int ret = 0;
851
852     if ((ret = default_check(state, translation, ctx)) <= 0)
853         return ret;
854
855     if (state == PRE_CTRL_TO_PARAMS) {
856         /*
857          * In |translations|, the initial value for |ctx->action_type| must
858          * be NONE.
859          */
860         if (!ossl_assert(ctx->action_type == NONE))
861             return 0;
862
863         /* The action type depends on the value of *p1 */
864         if (ctx->p1 == -2) {
865             /*
866              * The OSSL_PARAMS getter needs space to store a copy of the kdf
867              * type string.  We use |ctx->name_buf|, which has enough space
868              * allocated.
869              *
870              * (this wouldn't be needed if the OSSL_xxx_PARAM_KDF_TYPE
871              * had the data type OSSL_PARAM_UTF8_PTR)
872              */
873             ctx->p2 = ctx->name_buf;
874             ctx->p1 = sizeof(ctx->name_buf);
875             ctx->action_type = GET;
876         } else {
877             ctx->action_type = SET;
878         }
879     }
880
881     if ((ret = default_check(state, translation, ctx)) <= 0)
882         return ret;
883
884     if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
885         || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
886         ret = -2;
887         /* Convert KDF type numbers to strings */
888         for (; kdf_type_map->kdf_type_str != NULL; kdf_type_map++)
889             if (ctx->p1 == kdf_type_map->kdf_type_num) {
890                 ctx->p2 = (char *)kdf_type_map->kdf_type_str;
891                 ret = 1;
892                 break;
893             }
894         if (ret <= 0)
895             goto end;
896         ctx->p1 = strlen(ctx->p2);
897     }
898
899     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
900         return ret;
901
902     if ((state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)
903         || (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)) {
904         ctx->p1 = ret = -1;
905
906         /* Convert KDF type strings to numbers */
907         for (; kdf_type_map->kdf_type_str != NULL; kdf_type_map++)
908             if (strcasecmp(ctx->p2, kdf_type_map->kdf_type_str) == 0) {
909                 ctx->p1 = kdf_type_map->kdf_type_num;
910                 ret = 1;
911                 break;
912             }
913         ctx->p2 = NULL;
914     } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
915         ctx->p1 = -2;
916     }
917  end:
918     return ret;
919 }
920
921 /* EVP_PKEY_CTRL_DH_KDF_TYPE */
922 static int fix_dh_kdf_type(enum state state,
923                            const struct translation_st *translation,
924                            struct translation_ctx_st *ctx)
925 {
926     static const struct kdf_type_map_st kdf_type_map[] = {
927         { EVP_PKEY_DH_KDF_NONE, "" },
928         { EVP_PKEY_DH_KDF_X9_42, OSSL_KDF_NAME_X942KDF_ASN1 },
929         { 0, NULL }
930     };
931
932     return fix_kdf_type(state, translation, ctx, kdf_type_map);
933 }
934
935 /* EVP_PKEY_CTRL_EC_KDF_TYPE */
936 static int fix_ec_kdf_type(enum state state,
937                            const struct translation_st *translation,
938                            struct translation_ctx_st *ctx)
939 {
940     static const struct kdf_type_map_st kdf_type_map[] = {
941         { EVP_PKEY_ECDH_KDF_NONE, "" },
942         { EVP_PKEY_ECDH_KDF_X9_63, OSSL_KDF_NAME_X963KDF },
943         { 0, NULL }
944     };
945
946     return fix_kdf_type(state, translation, ctx, kdf_type_map);
947 }
948
949 /* EVP_PKEY_CTRL_DH_KDF_OID, EVP_PKEY_CTRL_GET_DH_KDF_OID, ...??? */
950 static int fix_oid(enum state state,
951                    const struct translation_st *translation,
952                    struct translation_ctx_st *ctx)
953 {
954     int ret;
955
956     if ((ret = default_check(state, translation, ctx)) <= 0)
957         return ret;
958
959     if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
960         || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
961         /*
962          * We're translating from ctrl to params and setting the OID, or
963          * we're translating from params to ctrl and getting the OID.
964          * Either way, |ctx->p2| points at an ASN1_OBJECT, and needs to have
965          * that replaced with the corresponding name.
966          * default_fixup_args() will then be able to convert that to the
967          * corresponding OSSL_PARAM.
968          */
969         OBJ_obj2txt(ctx->name_buf, sizeof(ctx->name_buf), ctx->p2, 0);
970         ctx->p2 = (char *)ctx->name_buf;
971         ctx->p1 = 0; /* let default_fixup_args() figure out the length */
972     }
973
974     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
975         return ret;
976
977     if ((state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)
978         || (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)) {
979         /*
980          * We're translating from ctrl to params and setting the OID name,
981          * or we're translating from params to ctrl and getting the OID
982          * name.  Either way, default_fixup_args() has placed the OID name
983          * in |ctx->p2|, all we need to do now is to replace that with the
984          * corresponding ASN1_OBJECT.
985          */
986         ctx->p2 = (ASN1_OBJECT *)OBJ_txt2obj(ctx->p2, 0);
987     }
988
989     return ret;
990 }
991
992 /* EVP_PKEY_CTRL_DH_NID */
993 static int fix_dh_nid(enum state state,
994                       const struct translation_st *translation,
995                       struct translation_ctx_st *ctx)
996 {
997     int ret;
998
999     if ((ret = default_check(state, translation, ctx)) <= 0)
1000         return ret;
1001
1002     /* This is only settable */
1003     if (ctx->action_type != SET)
1004         return 0;
1005
1006     if (state == PRE_CTRL_TO_PARAMS) {
1007         ctx->p2 = (char *)ossl_ffc_named_group_get_name
1008             (ossl_ffc_uid_to_dh_named_group(ctx->p1));
1009         ctx->p1 = 0;
1010     }
1011
1012     return default_fixup_args(state, translation, ctx);
1013 }
1014
1015 /* EVP_PKEY_CTRL_DH_RFC5114 */
1016 static int fix_dh_nid5114(enum state state,
1017                           const struct translation_st *translation,
1018                           struct translation_ctx_st *ctx)
1019 {
1020     int ret;
1021
1022     if ((ret = default_check(state, translation, ctx)) <= 0)
1023         return ret;
1024
1025     /* This is only settable */
1026     if (ctx->action_type != SET)
1027         return 0;
1028
1029     if (state == PRE_CTRL_STR_TO_PARAMS) {
1030         ctx->p2 = (char *)ossl_ffc_named_group_get_name
1031             (ossl_ffc_uid_to_dh_named_group(atoi(ctx->p2)));
1032         ctx->p1 = 0;
1033     }
1034
1035     return default_fixup_args(state, translation, ctx);
1036 }
1037
1038 /* EVP_PKEY_CTRL_DH_PARAMGEN_TYPE */
1039 static int fix_dh_paramgen_type(enum state state,
1040                                 const struct translation_st *translation,
1041                                 struct translation_ctx_st *ctx)
1042 {
1043     int ret;
1044
1045     if ((ret = default_check(state, translation, ctx)) <= 0)
1046         return ret;
1047
1048     /* This is only settable */
1049     if (ctx->action_type != SET)
1050         return 0;
1051
1052     if (state == PRE_CTRL_STR_TO_PARAMS) {
1053         ctx->p2 = (char *)ossl_dh_gen_type_id2name(atoi(ctx->p2));
1054         ctx->p1 = strlen(ctx->p2);
1055     }
1056
1057     return default_fixup_args(state, translation, ctx);
1058 }
1059
1060 /* EVP_PKEY_CTRL_EC_PARAM_ENC */
1061 static int fix_ec_param_enc(enum state state,
1062                             const struct translation_st *translation,
1063                             struct translation_ctx_st *ctx)
1064 {
1065     int ret;
1066
1067     if ((ret = default_check(state, translation, ctx)) <= 0)
1068         return ret;
1069
1070     /* This is currently only settable */
1071     if (ctx->action_type != SET)
1072         return 0;
1073
1074     if (state == PRE_CTRL_TO_PARAMS) {
1075         switch (ctx->p1) {
1076         case OPENSSL_EC_EXPLICIT_CURVE:
1077             ctx->p2 = OSSL_PKEY_EC_ENCODING_EXPLICIT;
1078             break;
1079         case OPENSSL_EC_NAMED_CURVE:
1080             ctx->p2 = OSSL_PKEY_EC_ENCODING_GROUP;
1081             break;
1082         default:
1083             ret = -2;
1084             goto end;
1085         }
1086         ctx->p1 = 0;
1087     }
1088
1089     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1090         return ret;
1091
1092     if (state == PRE_PARAMS_TO_CTRL) {
1093         if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_EXPLICIT) == 0)
1094             ctx->p1 = OPENSSL_EC_EXPLICIT_CURVE;
1095         else if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_GROUP) == 0)
1096             ctx->p1 = OPENSSL_EC_NAMED_CURVE;
1097         else
1098             ctx->p1 = ret = -2;
1099         ctx->p2 = NULL;
1100     }
1101
1102  end:
1103     if (ret == -2)
1104         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1105     return ret;
1106 }
1107
1108 /* EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID */
1109 static int fix_ec_paramgen_curve_nid(enum state state,
1110                                      const struct translation_st *translation,
1111                                      struct translation_ctx_st *ctx)
1112 {
1113     int ret;
1114
1115     if ((ret = default_check(state, translation, ctx)) <= 0)
1116         return ret;
1117
1118     /* This is currently only settable */
1119     if (ctx->action_type != SET)
1120         return 0;
1121
1122     if (state == PRE_CTRL_TO_PARAMS) {
1123         ctx->p2 = (char *)OBJ_nid2sn(ctx->p1);
1124         ctx->p1 = 0;
1125     }
1126
1127     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1128         return ret;
1129
1130     if (state == PRE_PARAMS_TO_CTRL) {
1131         ctx->p1 = OBJ_sn2nid(ctx->p2);
1132         ctx->p2 = NULL;
1133     }
1134
1135     return ret;
1136 }
1137
1138 /* EVP_PKEY_CTRL_EC_ECDH_COFACTOR */
1139 static int fix_ecdh_cofactor(enum state state,
1140                              const struct translation_st *translation,
1141                              struct translation_ctx_st *ctx)
1142 {
1143     /*
1144      * The EVP_PKEY_CTRL_EC_ECDH_COFACTOR ctrl command is a bit special, in
1145      * that it's used both for setting a value, and for getting it, all
1146      * depending on the value if |ctx->p1|; if |ctx->p1| is -2, the backend is
1147      * supposed to place the current cofactor mode in |ctx->p2|, and if not,
1148      * |ctx->p1| is interpreted as the new cofactor mode.
1149      */
1150     int ret = 0;
1151
1152     if (state == PRE_CTRL_TO_PARAMS) {
1153         /*
1154          * The initial value for |ctx->action_type| must be zero.
1155          * evp_pkey_ctrl_to_params() takes it from the translation item.
1156          */
1157         if (!ossl_assert(ctx->action_type == NONE))
1158             return 0;
1159
1160         /* The action type depends on the value of ctx->p1 */
1161         if (ctx->p1 == -2)
1162             ctx->action_type = GET;
1163         else
1164             ctx->action_type = SET;
1165     } else if (state == PRE_CTRL_STR_TO_PARAMS) {
1166         ctx->action_type = SET;
1167     } else if (state == PRE_PARAMS_TO_CTRL) {
1168         /* The initial value for |ctx->action_type| must not be zero. */
1169         if (!ossl_assert(ctx->action_type != NONE))
1170             return 0;
1171     }
1172
1173     if ((ret = default_check(state, translation, ctx)) <= 0)
1174         return ret;
1175
1176     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1177         if (ctx->p1 < -1 || ctx->p1 > 1) {
1178             /* Uses the same return value of pkey_ec_ctrl() */
1179             return -2;
1180         }
1181     }
1182
1183     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1184         return ret;
1185
1186     if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
1187         if (ctx->p1 < 0 || ctx->p1 > 1) {
1188             /*
1189              * The provider should return either 0 or 1, any other value is a
1190              * provider error.
1191              */
1192             ctx->p1 = ret = -1;
1193         }
1194     } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
1195         ctx->p1 = -2;
1196     }
1197
1198     return ret;
1199 }
1200
1201 /* EVP_PKEY_CTRL_RSA_PADDING, EVP_PKEY_CTRL_GET_RSA_PADDING */
1202 static int fix_rsa_padding_mode(enum state state,
1203                                 const struct translation_st *translation,
1204                                 struct translation_ctx_st *ctx)
1205 {
1206     static const OSSL_ITEM str_value_map[] = {
1207         { RSA_PKCS1_PADDING,            "pkcs1"  },
1208         { RSA_NO_PADDING,               "none"   },
1209         { RSA_PKCS1_OAEP_PADDING,       "oaep"   },
1210         { RSA_PKCS1_OAEP_PADDING,       "oeap"   },
1211         { RSA_X931_PADDING,             "x931"   },
1212         { RSA_PKCS1_PSS_PADDING,        "pss"    },
1213         /* Special case, will pass directly as an integer */
1214         { RSA_PKCS1_WITH_TLS_PADDING,   NULL     }
1215     };
1216     int ret;
1217
1218     if ((ret = default_check(state, translation, ctx)) <= 0)
1219         return ret;
1220
1221     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
1222         /*
1223          * EVP_PKEY_CTRL_GET_RSA_PADDING returns the padding mode in the
1224          * weirdest way for a ctrl.  Instead of doing like all other ctrls
1225          * that return a simple, i.e. just have that as a return value,
1226          * this particular ctrl treats p2 as the address for the int to be
1227          * returned.  We must therefore remember |ctx->p2|, then make
1228          * |ctx->p2| point at a buffer to be filled in with the name, and
1229          * |ctx->p1| with its size.  default_fixup_args() will take care
1230          * of the rest for us, along with the POST_CTRL_TO_PARAMS && GET
1231          * code section further down.
1232          */
1233         ctx->orig_p2 = ctx->p2;
1234         ctx->p2 = ctx->name_buf;
1235         ctx->p1 = sizeof(ctx->name_buf);
1236     } else if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1237         /*
1238          * Ideally, we should use utf8 strings for the diverse padding modes.
1239          * We only came here because someone called EVP_PKEY_CTX_ctrl(),
1240          * though, and since that can reasonably be seen as legacy code
1241          * that uses the diverse RSA macros for the padding mode, and we
1242          * know that at least our providers can handle the numeric modes,
1243          * we take the cheap route for now.
1244          *
1245          * The other solution would be to match |ctx->p1| against entries
1246          * in str_value_map and pass the corresponding string.  However,
1247          * since we don't have a string for RSA_PKCS1_WITH_TLS_PADDING,
1248          * we have to do this same hack at least for that one.
1249          *
1250          * Since the "official" data type for the RSA padding mode is utf8
1251          * string, we cannot count on default_fixup_args().  Instead, we
1252          * build the OSSL_PARAM item ourselves and return immediately.
1253          */
1254         ctx->params[0] = OSSL_PARAM_construct_int(translation->param_key,
1255                                                   &ctx->p1);
1256         return 1;
1257     } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
1258         size_t i;
1259
1260         /*
1261          * The EVP_PKEY_CTX_get_params() caller may have asked for a utf8
1262          * string, or may have asked for an integer of some sort.  If they
1263          * ask for an integer, we respond directly.  If not, we translate
1264          * the response from the ctrl function into a string.
1265          */
1266         switch (ctx->params->data_type) {
1267         case OSSL_PARAM_INTEGER:
1268             return OSSL_PARAM_get_int(ctx->params, &ctx->p1);
1269         case OSSL_PARAM_UNSIGNED_INTEGER:
1270             return OSSL_PARAM_get_uint(ctx->params, (unsigned int *)&ctx->p1);
1271         default:
1272             break;
1273         }
1274
1275         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1276             if (ctx->p1 == (int)str_value_map[i].id)
1277                 break;
1278         }
1279         if (i == OSSL_NELEM(str_value_map)) {
1280             ERR_raise_data(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE,
1281                            "[action:%d, state:%d] padding number %d",
1282                            ctx->action_type, state, ctx->p1);
1283             return -2;
1284         }
1285         /*
1286          * If we don't have a string, we can't do anything.  The caller
1287          * should have asked for a number...
1288          */
1289         if (str_value_map[i].ptr == NULL) {
1290             ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1291             return -2;
1292         }
1293         ctx->p2 = str_value_map[i].ptr;
1294         ctx->p1 = strlen(ctx->p2);
1295     }
1296
1297     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1298         return ret;
1299
1300     if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1301         || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1302         size_t i;
1303
1304         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1305             if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1306                 break;
1307         }
1308
1309         if (i == OSSL_NELEM(str_value_map)) {
1310             ERR_raise_data(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE,
1311                            "[action:%d, state:%d] padding name %s",
1312                            ctx->action_type, state, ctx->p1);
1313             ctx->p1 = ret = -2;
1314         } else if (state == POST_CTRL_TO_PARAMS) {
1315             /* EVP_PKEY_CTRL_GET_RSA_PADDING weirdness explained further up */
1316             *(int *)ctx->orig_p2 = str_value_map[i].id;
1317         } else {
1318             ctx->p1 = str_value_map[i].id;
1319         }
1320         ctx->p2 = NULL;
1321     }
1322
1323     return ret;
1324 }
1325
1326 /* EVP_PKEY_CTRL_RSA_PSS_SALTLEN, EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN */
1327 static int fix_rsa_pss_saltlen(enum state state,
1328                                const struct translation_st *translation,
1329                                struct translation_ctx_st *ctx)
1330 {
1331     static const OSSL_ITEM str_value_map[] = {
1332         { (unsigned int)RSA_PSS_SALTLEN_DIGEST, "digest" },
1333         { (unsigned int)RSA_PSS_SALTLEN_MAX,    "max"    },
1334         { (unsigned int)RSA_PSS_SALTLEN_AUTO,   "auto"   }
1335     };
1336     int ret;
1337
1338     if ((ret = default_check(state, translation, ctx)) <= 0)
1339         return ret;
1340
1341     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
1342         /*
1343          * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN returns the saltlen by filling
1344          * in the int pointed at by p2.  This is potentially as weird as
1345          * the way EVP_PKEY_CTRL_GET_RSA_PADDING works, except that saltlen
1346          * might be a negative value, so it wouldn't work as a legitimate
1347          * return value.
1348          * In any case, we must therefore remember |ctx->p2|, then make
1349          * |ctx->p2| point at a buffer to be filled in with the name, and
1350          * |ctx->p1| with its size.  default_fixup_args() will take care
1351          * of the rest for us, along with the POST_CTRL_TO_PARAMS && GET
1352          * code section further down.
1353          */
1354         ctx->orig_p2 = ctx->p2;
1355         ctx->p2 = ctx->name_buf;
1356         ctx->p1 = sizeof(ctx->name_buf);
1357     } else if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1358         || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1359         size_t i;
1360
1361         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1362             if (ctx->p1 == (int)str_value_map[i].id)
1363                 break;
1364         }
1365         if (i == OSSL_NELEM(str_value_map)) {
1366             BIO_snprintf(ctx->name_buf, sizeof(ctx->name_buf), "%d", ctx->p1);
1367         } else {
1368             /* This won't truncate but it will quiet static analysers */
1369             strncpy(ctx->name_buf, str_value_map[i].ptr, sizeof(ctx->name_buf) - 1);
1370             ctx->name_buf[sizeof(ctx->name_buf) - 1] = '\0';
1371         }
1372         ctx->p2 = ctx->name_buf;
1373         ctx->p1 = strlen(ctx->p2);
1374     }
1375
1376     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1377         return ret;
1378
1379     if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1380         || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1381         size_t i;
1382
1383         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1384             if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1385                 break;
1386         }
1387         if (i == OSSL_NELEM(str_value_map)) {
1388             ctx->p1 = atoi(ctx->p2);
1389         } else if (state == POST_CTRL_TO_PARAMS) {
1390             /*
1391              * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN weirdness explained further
1392              * up
1393              */
1394             *(int *)ctx->orig_p2 = str_value_map[i].id;
1395         } else {
1396             ctx->p1 = (int)str_value_map[i].id;
1397         }
1398         ctx->p2 = NULL;
1399     }
1400
1401     return ret;
1402 }
1403
1404 /* EVP_PKEY_CTRL_HKDF_MODE */
1405 static int fix_hkdf_mode(enum state state,
1406                          const struct translation_st *translation,
1407                          struct translation_ctx_st *ctx)
1408 {
1409     static const OSSL_ITEM str_value_map[] = {
1410         { EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND, "EXTRACT_AND_EXPAND" },
1411         { EVP_KDF_HKDF_MODE_EXTRACT_ONLY,       "EXTRACT_ONLY"       },
1412         { EVP_KDF_HKDF_MODE_EXPAND_ONLY,        "EXPAND_ONLY"        }
1413     };
1414     int ret;
1415
1416     if ((ret = default_check(state, translation, ctx)) <= 0)
1417         return ret;
1418
1419     if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1420         || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1421         size_t i;
1422
1423         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1424             if (ctx->p1 == (int)str_value_map[i].id)
1425                 break;
1426         }
1427         if (i == OSSL_NELEM(str_value_map))
1428             return 0;
1429         ctx->p2 = str_value_map[i].ptr;
1430         ctx->p1 = strlen(ctx->p2);
1431     }
1432
1433     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1434         return ret;
1435
1436     if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1437         || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1438         size_t i;
1439
1440         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1441             if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1442                 break;
1443         }
1444         if (i == OSSL_NELEM(str_value_map))
1445             return 0;
1446         if (state == POST_CTRL_TO_PARAMS)
1447             ret = str_value_map[i].id;
1448         else
1449             ctx->p1 = str_value_map[i].id;
1450         ctx->p2 = NULL;
1451     }
1452
1453     return 1;
1454 }
1455
1456 /*-
1457  * Payload getters
1458  * ===============
1459  *
1460  * These all get the data they want, then call default_fixup_args() as
1461  * a post-ctrl GET fixup.  They all get NULL ctx, ctrl_cmd, ctrl_str,
1462  * p1, sz
1463  */
1464
1465 /* Pilfering DH, DSA and EC_KEY */
1466 static int get_payload_group_name(enum state state,
1467                                   const struct translation_st *translation,
1468                                   struct translation_ctx_st *ctx)
1469 {
1470     EVP_PKEY *pkey = ctx->p2;
1471
1472     ctx->p2 = NULL;
1473     switch (EVP_PKEY_get_base_id(pkey)) {
1474 #ifndef OPENSSL_NO_DH
1475     case EVP_PKEY_DH:
1476         {
1477             const DH *dh = EVP_PKEY_get0_DH(pkey);
1478             int uid = DH_get_nid(dh);
1479
1480             if (uid != NID_undef) {
1481                 const DH_NAMED_GROUP *dh_group =
1482                     ossl_ffc_uid_to_dh_named_group(uid);
1483
1484                 ctx->p2 = (char *)ossl_ffc_named_group_get_name(dh_group);
1485             }
1486         }
1487         break;
1488 #endif
1489 #ifndef OPENSSL_NO_EC
1490     case EVP_PKEY_EC:
1491         {
1492             const EC_GROUP *grp =
1493                 EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
1494             int nid = NID_undef;
1495
1496             if (grp != NULL)
1497                 nid = EC_GROUP_get_curve_name(grp);
1498             if (nid != NID_undef)
1499                 ctx->p2 = (char *)OSSL_EC_curve_nid2name(nid);
1500         }
1501         break;
1502 #endif
1503     default:
1504         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1505         return 0;
1506     }
1507
1508     /*
1509      * Quietly ignoring unknown groups matches the behaviour on the provider
1510      * side.
1511      */
1512     if (ctx->p2 == NULL)
1513         return 1;
1514
1515     ctx->p1 = strlen(ctx->p2);
1516     return default_fixup_args(state, translation, ctx);
1517 }
1518
1519 static int get_payload_private_key(enum state state,
1520                                    const struct translation_st *translation,
1521                                    struct translation_ctx_st *ctx)
1522 {
1523     EVP_PKEY *pkey = ctx->p2;
1524
1525     ctx->p2 = NULL;
1526     if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1527         return 0;
1528
1529     switch (EVP_PKEY_get_base_id(pkey)) {
1530 #ifndef OPENSSL_NO_DH
1531     case EVP_PKEY_DH:
1532         {
1533             const DH *dh = EVP_PKEY_get0_DH(pkey);
1534
1535             ctx->p2 = (BIGNUM *)DH_get0_priv_key(dh);
1536         }
1537         break;
1538 #endif
1539 #ifndef OPENSSL_NO_EC
1540     case EVP_PKEY_EC:
1541         {
1542             const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1543
1544             ctx->p2 = (BIGNUM *)EC_KEY_get0_private_key(ec);
1545         }
1546         break;
1547 #endif
1548     default:
1549         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1550         return 0;
1551     }
1552
1553     return default_fixup_args(state, translation, ctx);
1554 }
1555
1556 static int get_payload_public_key(enum state state,
1557                                   const struct translation_st *translation,
1558                                   struct translation_ctx_st *ctx)
1559 {
1560     EVP_PKEY *pkey = ctx->p2;
1561     unsigned char *buf = NULL;
1562     int ret;
1563
1564     ctx->p2 = NULL;
1565     switch (EVP_PKEY_get_base_id(pkey)) {
1566 #ifndef OPENSSL_NO_DH
1567     case EVP_PKEY_DHX:
1568     case EVP_PKEY_DH:
1569         switch (ctx->params->data_type) {
1570         case OSSL_PARAM_OCTET_STRING:
1571             ctx->sz = ossl_dh_key2buf(EVP_PKEY_get0_DH(pkey), &buf, 0, 1);
1572             ctx->p2 = buf;
1573             break;
1574         case OSSL_PARAM_UNSIGNED_INTEGER:
1575             ctx->p2 = (void *)DH_get0_pub_key(EVP_PKEY_get0_DH(pkey));
1576             break;
1577         default:
1578             return 0;
1579         }
1580         break;
1581 #endif
1582 #ifndef OPENSSL_NO_DSA
1583     case EVP_PKEY_DSA:
1584         if (ctx->params->data_type == OSSL_PARAM_UNSIGNED_INTEGER) {
1585             ctx->p2 = (void *)DSA_get0_pub_key(EVP_PKEY_get0_DSA(pkey));
1586             break;
1587         }
1588         return 0;
1589 #endif
1590 #ifndef OPENSSL_NO_EC
1591     case EVP_PKEY_EC:
1592         if (ctx->params->data_type == OSSL_PARAM_OCTET_STRING) {
1593             const EC_KEY *eckey = EVP_PKEY_get0_EC_KEY(pkey);
1594             BN_CTX *bnctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eckey));
1595             const EC_GROUP *ecg = EC_KEY_get0_group(eckey);
1596             const EC_POINT *point = EC_KEY_get0_public_key(eckey);
1597
1598             if (bnctx == NULL)
1599                 return 0;
1600             ctx->sz = EC_POINT_point2buf(ecg, point,
1601                                          POINT_CONVERSION_COMPRESSED,
1602                                          &buf, bnctx);
1603             ctx->p2 = buf;
1604             BN_CTX_free(bnctx);
1605             break;
1606         }
1607         return 0;
1608 #endif
1609     default:
1610         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1611         return 0;
1612     }
1613
1614     ret = default_fixup_args(state, translation, ctx);
1615     OPENSSL_free(buf);
1616     return ret;
1617 }
1618
1619 static int get_payload_bn(enum state state,
1620                           const struct translation_st *translation,
1621                           struct translation_ctx_st *ctx, const BIGNUM *bn)
1622 {
1623     if (bn == NULL)
1624         return 0;
1625     if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1626         return 0;
1627     ctx->p2 = (BIGNUM *)bn;
1628
1629     return default_fixup_args(state, translation, ctx);
1630 }
1631
1632 static int get_dh_dsa_payload_p(enum state state,
1633                                 const struct translation_st *translation,
1634                                 struct translation_ctx_st *ctx)
1635 {
1636     const BIGNUM *bn = NULL;
1637     EVP_PKEY *pkey = ctx->p2;
1638
1639     switch (EVP_PKEY_get_base_id(pkey)) {
1640 #ifndef OPENSSL_NO_DH
1641     case EVP_PKEY_DH:
1642         bn = DH_get0_p(EVP_PKEY_get0_DH(pkey));
1643         break;
1644 #endif
1645 #ifndef OPENSSL_NO_DSA
1646     case EVP_PKEY_DSA:
1647         bn = DSA_get0_p(EVP_PKEY_get0_DSA(pkey));
1648         break;
1649 #endif
1650     default:
1651         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1652     }
1653
1654     return get_payload_bn(state, translation, ctx, bn);
1655 }
1656
1657 static int get_dh_dsa_payload_q(enum state state,
1658                                 const struct translation_st *translation,
1659                                 struct translation_ctx_st *ctx)
1660 {
1661     const BIGNUM *bn = NULL;
1662
1663     switch (EVP_PKEY_get_base_id(ctx->p2)) {
1664 #ifndef OPENSSL_NO_DH
1665     case EVP_PKEY_DH:
1666         bn = DH_get0_q(EVP_PKEY_get0_DH(ctx->p2));
1667         break;
1668 #endif
1669 #ifndef OPENSSL_NO_DSA
1670     case EVP_PKEY_DSA:
1671         bn = DSA_get0_q(EVP_PKEY_get0_DSA(ctx->p2));
1672         break;
1673 #endif
1674     }
1675
1676     return get_payload_bn(state, translation, ctx, bn);
1677 }
1678
1679 static int get_dh_dsa_payload_g(enum state state,
1680                                 const struct translation_st *translation,
1681                                 struct translation_ctx_st *ctx)
1682 {
1683     const BIGNUM *bn = NULL;
1684
1685     switch (EVP_PKEY_get_base_id(ctx->p2)) {
1686 #ifndef OPENSSL_NO_DH
1687     case EVP_PKEY_DH:
1688         bn = DH_get0_g(EVP_PKEY_get0_DH(ctx->p2));
1689         break;
1690 #endif
1691 #ifndef OPENSSL_NO_DSA
1692     case EVP_PKEY_DSA:
1693         bn = DSA_get0_g(EVP_PKEY_get0_DSA(ctx->p2));
1694         break;
1695 #endif
1696     }
1697
1698     return get_payload_bn(state, translation, ctx, bn);
1699 }
1700
1701 static int get_payload_int(enum state state,
1702                            const struct translation_st *translation,
1703                            struct translation_ctx_st *ctx,
1704                            const int val)
1705 {
1706     if (ctx->params->data_type != OSSL_PARAM_INTEGER)
1707         return 0;
1708     ctx->p1 = val;
1709     ctx->p2 = NULL;
1710
1711     return default_fixup_args(state, translation, ctx);
1712 }
1713
1714 static int get_ec_decoded_from_explicit_params(enum state state,
1715                                                const struct translation_st *translation,
1716                                                struct translation_ctx_st *ctx)
1717 {
1718     int val = 0;
1719     EVP_PKEY *pkey = ctx->p2;
1720
1721     switch (EVP_PKEY_base_id(pkey)) {
1722 #ifndef OPENSSL_NO_EC
1723     case EVP_PKEY_EC:
1724         val = EC_KEY_decoded_from_explicit_params(EVP_PKEY_get0_EC_KEY(pkey));
1725         if (val < 0) {
1726             ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY);
1727             return 0;
1728         }
1729         break;
1730 #endif
1731     default:
1732         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1733         return 0;
1734     }
1735
1736     return get_payload_int(state, translation, ctx, val);
1737 }
1738
1739 static int get_rsa_payload_n(enum state state,
1740                              const struct translation_st *translation,
1741                              struct translation_ctx_st *ctx)
1742 {
1743     const BIGNUM *bn = NULL;
1744
1745     if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA)
1746         return 0;
1747     bn = RSA_get0_n(EVP_PKEY_get0_RSA(ctx->p2));
1748
1749     return get_payload_bn(state, translation, ctx, bn);
1750 }
1751
1752 static int get_rsa_payload_e(enum state state,
1753                              const struct translation_st *translation,
1754                              struct translation_ctx_st *ctx)
1755 {
1756     const BIGNUM *bn = NULL;
1757
1758     if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA)
1759         return 0;
1760     bn = RSA_get0_e(EVP_PKEY_get0_RSA(ctx->p2));
1761
1762     return get_payload_bn(state, translation, ctx, bn);
1763 }
1764
1765 static int get_rsa_payload_d(enum state state,
1766                              const struct translation_st *translation,
1767                              struct translation_ctx_st *ctx)
1768 {
1769     const BIGNUM *bn = NULL;
1770
1771     if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA)
1772         return 0;
1773     bn = RSA_get0_d(EVP_PKEY_get0_RSA(ctx->p2));
1774
1775     return get_payload_bn(state, translation, ctx, bn);
1776 }
1777
1778 static int get_rsa_payload_factor(enum state state,
1779                                   const struct translation_st *translation,
1780                                   struct translation_ctx_st *ctx,
1781                                   size_t factornum)
1782 {
1783     const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1784     const BIGNUM *bn = NULL;
1785
1786     switch (factornum) {
1787     case 0:
1788         bn = RSA_get0_p(r);
1789         break;
1790     case 1:
1791         bn = RSA_get0_q(r);
1792         break;
1793     default:
1794         {
1795             size_t pnum = RSA_get_multi_prime_extra_count(r);
1796             const BIGNUM *factors[10];
1797
1798             if (factornum - 2 < pnum
1799                 && RSA_get0_multi_prime_factors(r, factors))
1800                 bn = factors[factornum - 2];
1801         }
1802         break;
1803     }
1804
1805     return get_payload_bn(state, translation, ctx, bn);
1806 }
1807
1808 static int get_rsa_payload_exponent(enum state state,
1809                                     const struct translation_st *translation,
1810                                     struct translation_ctx_st *ctx,
1811                                     size_t exponentnum)
1812 {
1813     const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1814     const BIGNUM *bn = NULL;
1815
1816     switch (exponentnum) {
1817     case 0:
1818         bn = RSA_get0_dmp1(r);
1819         break;
1820     case 1:
1821         bn = RSA_get0_dmq1(r);
1822         break;
1823     default:
1824         {
1825             size_t pnum = RSA_get_multi_prime_extra_count(r);
1826             const BIGNUM *exps[10], *coeffs[10];
1827
1828             if (exponentnum - 2 < pnum
1829                 && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1830                 bn = exps[exponentnum - 2];
1831         }
1832         break;
1833     }
1834
1835     return get_payload_bn(state, translation, ctx, bn);
1836 }
1837
1838 static int get_rsa_payload_coefficient(enum state state,
1839                                        const struct translation_st *translation,
1840                                        struct translation_ctx_st *ctx,
1841                                        size_t coefficientnum)
1842 {
1843     const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1844     const BIGNUM *bn = NULL;
1845
1846     switch (coefficientnum) {
1847     case 0:
1848         bn = RSA_get0_iqmp(r);
1849         break;
1850     default:
1851         {
1852             size_t pnum = RSA_get_multi_prime_extra_count(r);
1853             const BIGNUM *exps[10], *coeffs[10];
1854
1855             if (coefficientnum - 1 < pnum
1856                 && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1857                 bn = coeffs[coefficientnum - 1];
1858         }
1859         break;
1860     }
1861
1862     return get_payload_bn(state, translation, ctx, bn);
1863 }
1864
1865 #define IMPL_GET_RSA_PAYLOAD_FACTOR(n)                                  \
1866     static int                                                          \
1867     get_rsa_payload_f##n(enum state state,                              \
1868                          const struct translation_st *translation,      \
1869                          struct translation_ctx_st *ctx)                \
1870     {                                                                   \
1871         if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA)              \
1872             return 0;                                                   \
1873         return get_rsa_payload_factor(state, translation, ctx, n - 1);  \
1874     }
1875
1876 #define IMPL_GET_RSA_PAYLOAD_EXPONENT(n)                                \
1877     static int                                                          \
1878     get_rsa_payload_e##n(enum state state,                              \
1879                          const struct translation_st *translation,      \
1880                          struct translation_ctx_st *ctx)                \
1881     {                                                                   \
1882         if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA)              \
1883             return 0;                                                   \
1884         return get_rsa_payload_exponent(state, translation, ctx,        \
1885                                         n - 1);                         \
1886     }
1887
1888 #define IMPL_GET_RSA_PAYLOAD_COEFFICIENT(n)                             \
1889     static int                                                          \
1890     get_rsa_payload_c##n(enum state state,                              \
1891                          const struct translation_st *translation,      \
1892                          struct translation_ctx_st *ctx)                \
1893     {                                                                   \
1894         if (EVP_PKEY_get_base_id(ctx->p2) != EVP_PKEY_RSA)              \
1895             return 0;                                                   \
1896         return get_rsa_payload_coefficient(state, translation, ctx,     \
1897                                            n - 1);                      \
1898     }
1899
1900 IMPL_GET_RSA_PAYLOAD_FACTOR(1)
1901 IMPL_GET_RSA_PAYLOAD_FACTOR(2)
1902 IMPL_GET_RSA_PAYLOAD_FACTOR(3)
1903 IMPL_GET_RSA_PAYLOAD_FACTOR(4)
1904 IMPL_GET_RSA_PAYLOAD_FACTOR(5)
1905 IMPL_GET_RSA_PAYLOAD_FACTOR(6)
1906 IMPL_GET_RSA_PAYLOAD_FACTOR(7)
1907 IMPL_GET_RSA_PAYLOAD_FACTOR(8)
1908 IMPL_GET_RSA_PAYLOAD_FACTOR(9)
1909 IMPL_GET_RSA_PAYLOAD_FACTOR(10)
1910 IMPL_GET_RSA_PAYLOAD_EXPONENT(1)
1911 IMPL_GET_RSA_PAYLOAD_EXPONENT(2)
1912 IMPL_GET_RSA_PAYLOAD_EXPONENT(3)
1913 IMPL_GET_RSA_PAYLOAD_EXPONENT(4)
1914 IMPL_GET_RSA_PAYLOAD_EXPONENT(5)
1915 IMPL_GET_RSA_PAYLOAD_EXPONENT(6)
1916 IMPL_GET_RSA_PAYLOAD_EXPONENT(7)
1917 IMPL_GET_RSA_PAYLOAD_EXPONENT(8)
1918 IMPL_GET_RSA_PAYLOAD_EXPONENT(9)
1919 IMPL_GET_RSA_PAYLOAD_EXPONENT(10)
1920 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(1)
1921 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(2)
1922 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(3)
1923 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(4)
1924 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(5)
1925 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(6)
1926 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(7)
1927 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(8)
1928 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(9)
1929
1930 /*-
1931  * The translation table itself
1932  * ============================
1933  */
1934
1935 static const struct translation_st evp_pkey_ctx_translations[] = {
1936     /*
1937      * DistID: we pass it to the backend as an octet string,
1938      * but get it back as a pointer to an octet string.
1939      *
1940      * Note that the EVP_PKEY_CTRL_GET1_ID_LEN is purely for legacy purposes
1941      * that has no separate counterpart in OSSL_PARAM terms, since we get
1942      * the length of the DistID automatically when getting the DistID itself.
1943      */
1944     { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
1945       EVP_PKEY_CTRL_SET1_ID, "distid", "hexdistid",
1946       OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_STRING, NULL },
1947     { GET, -1, -1, -1,
1948       EVP_PKEY_CTRL_GET1_ID, "distid", "hexdistid",
1949       OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, NULL },
1950     { GET, -1, -1, -1,
1951       EVP_PKEY_CTRL_GET1_ID_LEN, NULL, NULL,
1952       OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, fix_distid_len },
1953
1954     /*-
1955      * DH & DHX
1956      * ========
1957      */
1958
1959     /*
1960      * EVP_PKEY_CTRL_DH_KDF_TYPE is used both for setting and getting.  The
1961      * fixup function has to handle this...
1962      */
1963     { NONE, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1964       EVP_PKEY_CTRL_DH_KDF_TYPE, NULL, NULL,
1965       OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING,
1966       fix_dh_kdf_type },
1967     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1968       EVP_PKEY_CTRL_DH_KDF_MD, NULL, NULL,
1969       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1970     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1971       EVP_PKEY_CTRL_GET_DH_KDF_MD, NULL, NULL,
1972       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1973     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1974       EVP_PKEY_CTRL_DH_KDF_OUTLEN, NULL, NULL,
1975       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1976     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1977       EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, NULL, NULL,
1978       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1979     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1980       EVP_PKEY_CTRL_DH_KDF_UKM, NULL, NULL,
1981       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
1982     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1983       EVP_PKEY_CTRL_GET_DH_KDF_UKM, NULL, NULL,
1984       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
1985     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1986       EVP_PKEY_CTRL_DH_KDF_OID, NULL, NULL,
1987       OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
1988     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1989       EVP_PKEY_CTRL_GET_DH_KDF_OID, NULL, NULL,
1990       OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
1991
1992     /* DHX Keygen Parameters that are shared with DH */
1993     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN,
1994       EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, "dh_paramgen_type", NULL,
1995       OSSL_PKEY_PARAM_FFC_TYPE, OSSL_PARAM_UTF8_STRING, fix_dh_paramgen_type },
1996     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN,
1997       EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, "dh_paramgen_prime_len", NULL,
1998       OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1999     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN  | EVP_PKEY_OP_KEYGEN,
2000       EVP_PKEY_CTRL_DH_NID, "dh_param", NULL,
2001       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, NULL },
2002     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN  | EVP_PKEY_OP_KEYGEN,
2003       EVP_PKEY_CTRL_DH_RFC5114, "dh_rfc5114", NULL,
2004       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid5114 },
2005
2006     /* DH Keygen Parameters that are shared with DHX */
2007     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
2008       EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, "dh_paramgen_type", NULL,
2009       OSSL_PKEY_PARAM_FFC_TYPE, OSSL_PARAM_UTF8_STRING, fix_dh_paramgen_type },
2010     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
2011       EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, "dh_paramgen_prime_len", NULL,
2012       OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2013     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2014       EVP_PKEY_CTRL_DH_NID, "dh_param", NULL,
2015       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid },
2016     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN  | EVP_PKEY_OP_KEYGEN,
2017       EVP_PKEY_CTRL_DH_RFC5114, "dh_rfc5114", NULL,
2018       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid5114 },
2019
2020     /* DH specific Keygen Parameters */
2021     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
2022       EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, "dh_paramgen_generator", NULL,
2023       OSSL_PKEY_PARAM_DH_GENERATOR, OSSL_PARAM_INTEGER, NULL },
2024
2025     /* DHX specific Keygen Parameters */
2026     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_PARAMGEN,
2027       EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, "dh_paramgen_subprime_len", NULL,
2028       OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2029
2030     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_DERIVE,
2031       EVP_PKEY_CTRL_DH_PAD, "dh_pad", NULL,
2032       OSSL_EXCHANGE_PARAM_PAD, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2033
2034     /*-
2035      * DSA
2036      * ===
2037      */
2038     { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
2039       EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, "dsa_paramgen_bits", NULL,
2040       OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2041     { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
2042       EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, "dsa_paramgen_q_bits", NULL,
2043       OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2044     { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
2045       EVP_PKEY_CTRL_DSA_PARAMGEN_MD, "dsa_paramgen_md", NULL,
2046       OSSL_PKEY_PARAM_FFC_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2047
2048     /*-
2049      * EC
2050      * ==
2051      */
2052     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2053       EVP_PKEY_CTRL_EC_PARAM_ENC, "ec_param_enc", NULL,
2054       OSSL_PKEY_PARAM_EC_ENCODING, OSSL_PARAM_UTF8_STRING, fix_ec_param_enc },
2055     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2056       EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, "ec_paramgen_curve", NULL,
2057       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2058       fix_ec_paramgen_curve_nid },
2059     /*
2060      * EVP_PKEY_CTRL_EC_ECDH_COFACTOR and EVP_PKEY_CTRL_EC_KDF_TYPE are used
2061      * both for setting and getting.  The fixup function has to handle this...
2062      */
2063     { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2064       EVP_PKEY_CTRL_EC_ECDH_COFACTOR, "ecdh_cofactor_mode", NULL,
2065       OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE, OSSL_PARAM_INTEGER,
2066       fix_ecdh_cofactor },
2067     { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2068       EVP_PKEY_CTRL_EC_KDF_TYPE, NULL, NULL,
2069       OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING, fix_ec_kdf_type },
2070     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2071       EVP_PKEY_CTRL_EC_KDF_MD, "ecdh_kdf_md", NULL,
2072       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2073     { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2074       EVP_PKEY_CTRL_GET_EC_KDF_MD, NULL, NULL,
2075       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2076     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2077       EVP_PKEY_CTRL_EC_KDF_OUTLEN, NULL, NULL,
2078       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2079     { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2080       EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, NULL, NULL,
2081       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2082     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2083       EVP_PKEY_CTRL_EC_KDF_UKM, NULL, NULL,
2084       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
2085     { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2086       EVP_PKEY_CTRL_GET_EC_KDF_UKM, NULL, NULL,
2087       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
2088
2089     /*-
2090      * RSA
2091      * ===
2092      */
2093
2094     /*
2095      * RSA padding modes are numeric with ctrls, strings with ctrl_strs,
2096      * and can be both with OSSL_PARAM.  We standardise on strings here,
2097      * fix_rsa_padding_mode() does the work when the caller has a different
2098      * idea.
2099      */
2100     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2101       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2102       EVP_PKEY_CTRL_RSA_PADDING, "rsa_padding_mode", NULL,
2103       OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2104     { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2105       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2106       EVP_PKEY_CTRL_GET_RSA_PADDING, NULL, NULL,
2107       OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2108
2109     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2110       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2111       EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_mgf1_md", NULL,
2112       OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2113     { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2114       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2115       EVP_PKEY_CTRL_GET_RSA_MGF1_MD, NULL, NULL,
2116       OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2117
2118     /*
2119      * RSA-PSS saltlen is essentially numeric, but certain values can be
2120      * expressed as keywords (strings) with ctrl_str.  The corresponding
2121      * OSSL_PARAM allows both forms.
2122      * fix_rsa_pss_saltlen() takes care of the distinction.
2123      */
2124     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2125       EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_saltlen", NULL,
2126       OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2127       fix_rsa_pss_saltlen },
2128     { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2129       EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN, NULL, NULL,
2130       OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2131       fix_rsa_pss_saltlen },
2132
2133     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2134       EVP_PKEY_CTRL_RSA_OAEP_MD, "rsa_oaep_md", NULL,
2135       OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2136     { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2137       EVP_PKEY_CTRL_GET_RSA_OAEP_MD, NULL, NULL,
2138       OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2139     /*
2140      * The "rsa_oaep_label" ctrl_str expects the value to always be hex.
2141      * This is accomodated by default_fixup_args() above, which mimics that
2142      * expectation for any translation item where |ctrl_str| is NULL and
2143      * |ctrl_hexstr| is non-NULL.
2144      */
2145     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2146       EVP_PKEY_CTRL_RSA_OAEP_LABEL, NULL, "rsa_oaep_label",
2147       OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2148     { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2149       EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL, NULL, NULL,
2150       OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2151
2152     { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2153       EVP_PKEY_CTRL_MD, "rsa_pss_keygen_md", NULL,
2154       OSSL_ALG_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2155     { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2156       EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_pss_keygen_mgf1_md", NULL,
2157       OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2158     { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2159       EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_keygen_saltlen", NULL,
2160       OSSL_SIGNATURE_PARAM_PSS_SALTLEN, OSSL_PARAM_INTEGER, NULL },
2161     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN,
2162       EVP_PKEY_CTRL_RSA_KEYGEN_BITS, "rsa_keygen_bits", NULL,
2163       OSSL_PKEY_PARAM_RSA_BITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2164     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_KEYGEN,
2165       EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, "rsa_keygen_pubexp", NULL,
2166       OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2167     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_KEYGEN,
2168       EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES, "rsa_keygen_primes", NULL,
2169       OSSL_PKEY_PARAM_RSA_PRIMES, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2170
2171     /*-
2172      * SipHash
2173      * ======
2174      */
2175     { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2176       EVP_PKEY_CTRL_SET_DIGEST_SIZE, "digestsize", NULL,
2177       OSSL_MAC_PARAM_SIZE, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2178
2179     /*-
2180      * TLS1-PRF
2181      * ========
2182      */
2183     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2184       EVP_PKEY_CTRL_TLS_MD, "md", NULL,
2185       OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2186     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2187       EVP_PKEY_CTRL_TLS_SECRET, "secret", "hexsecret",
2188       OSSL_KDF_PARAM_SECRET, OSSL_PARAM_OCTET_STRING, NULL },
2189     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2190       EVP_PKEY_CTRL_TLS_SEED, "seed", "hexseed",
2191       OSSL_KDF_PARAM_SEED, OSSL_PARAM_OCTET_STRING, NULL },
2192
2193     /*-
2194      * HKDF
2195      * ====
2196      */
2197     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2198       EVP_PKEY_CTRL_HKDF_MD, "md", NULL,
2199       OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2200     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2201       EVP_PKEY_CTRL_HKDF_SALT, "salt", "hexsalt",
2202       OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2203     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2204       EVP_PKEY_CTRL_HKDF_KEY, "key", "hexkey",
2205       OSSL_KDF_PARAM_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2206     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2207       EVP_PKEY_CTRL_HKDF_INFO, "info", "hexinfo",
2208       OSSL_KDF_PARAM_INFO, OSSL_PARAM_OCTET_STRING, NULL },
2209     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2210       EVP_PKEY_CTRL_HKDF_MODE, "mode", NULL,
2211       OSSL_KDF_PARAM_MODE, OSSL_PARAM_INTEGER, fix_hkdf_mode },
2212
2213     /*-
2214      * Scrypt
2215      * ======
2216      */
2217     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2218       EVP_PKEY_CTRL_PASS, "pass", "hexpass",
2219       OSSL_KDF_PARAM_PASSWORD, OSSL_PARAM_OCTET_STRING, NULL },
2220     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2221       EVP_PKEY_CTRL_SCRYPT_SALT, "salt", "hexsalt",
2222       OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2223     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2224       EVP_PKEY_CTRL_SCRYPT_N, "N", NULL,
2225       OSSL_KDF_PARAM_SCRYPT_N, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2226     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2227       EVP_PKEY_CTRL_SCRYPT_R, "r", NULL,
2228       OSSL_KDF_PARAM_SCRYPT_R, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2229     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2230       EVP_PKEY_CTRL_SCRYPT_P, "p", NULL,
2231       OSSL_KDF_PARAM_SCRYPT_P, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2232     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2233       EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, "maxmem_bytes", NULL,
2234       OSSL_KDF_PARAM_SCRYPT_MAXMEM, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2235
2236     { SET, -1, -1, EVP_PKEY_OP_KEYGEN | EVP_PKEY_OP_TYPE_CRYPT,
2237       EVP_PKEY_CTRL_CIPHER, NULL, NULL,
2238       OSSL_PKEY_PARAM_CIPHER, OSSL_PARAM_UTF8_STRING, fix_cipher },
2239     { SET, -1, -1, EVP_PKEY_OP_KEYGEN,
2240       EVP_PKEY_CTRL_SET_MAC_KEY, "key", "hexkey",
2241       OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2242
2243     { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2244       EVP_PKEY_CTRL_MD, NULL, NULL,
2245       OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2246     { GET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2247       EVP_PKEY_CTRL_GET_MD, NULL, NULL,
2248       OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2249 };
2250
2251 static const struct translation_st evp_pkey_translations[] = {
2252     /*
2253      * The following contain no ctrls, they are exclusively here to extract
2254      * key payloads from legacy keys, using OSSL_PARAMs, and rely entirely
2255      * on |fixup_args| to pass the actual data.  The |fixup_args| should
2256      * expect to get the EVP_PKEY pointer through |ctx->p2|.
2257      */
2258
2259     /* DH, DSA & EC */
2260     { GET, -1, -1, -1, 0, NULL, NULL,
2261       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2262       get_payload_group_name },
2263     { GET, -1, -1, -1, 0, NULL, NULL,
2264       OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_UNSIGNED_INTEGER,
2265       get_payload_private_key },
2266     { GET, -1, -1, -1, 0, NULL, NULL,
2267       OSSL_PKEY_PARAM_PUB_KEY,
2268       0 /* no data type, let get_payload_public_key() handle that */,
2269       get_payload_public_key },
2270
2271     /* DH and DSA */
2272     { GET, -1, -1, -1, 0, NULL, NULL,
2273       OSSL_PKEY_PARAM_FFC_P, OSSL_PARAM_UNSIGNED_INTEGER,
2274       get_dh_dsa_payload_p },
2275     { GET, -1, -1, -1, 0, NULL, NULL,
2276       OSSL_PKEY_PARAM_FFC_G, OSSL_PARAM_UNSIGNED_INTEGER,
2277       get_dh_dsa_payload_g },
2278     { GET, -1, -1, -1, 0, NULL, NULL,
2279       OSSL_PKEY_PARAM_FFC_Q, OSSL_PARAM_UNSIGNED_INTEGER,
2280       get_dh_dsa_payload_q },
2281
2282     /* RSA */
2283     { GET, -1, -1, -1, 0, NULL, NULL,
2284       OSSL_PKEY_PARAM_RSA_N, OSSL_PARAM_UNSIGNED_INTEGER,
2285       get_rsa_payload_n },
2286     { GET, -1, -1, -1, 0, NULL, NULL,
2287       OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER,
2288       get_rsa_payload_e },
2289     { GET, -1, -1, -1, 0, NULL, NULL,
2290       OSSL_PKEY_PARAM_RSA_D, OSSL_PARAM_UNSIGNED_INTEGER,
2291       get_rsa_payload_d },
2292     { GET, -1, -1, -1, 0, NULL, NULL,
2293       OSSL_PKEY_PARAM_RSA_FACTOR1, OSSL_PARAM_UNSIGNED_INTEGER,
2294       get_rsa_payload_f1 },
2295     { GET, -1, -1, -1, 0, NULL, NULL,
2296       OSSL_PKEY_PARAM_RSA_FACTOR2, OSSL_PARAM_UNSIGNED_INTEGER,
2297       get_rsa_payload_f2 },
2298     { GET, -1, -1, -1, 0, NULL, NULL,
2299       OSSL_PKEY_PARAM_RSA_FACTOR3, OSSL_PARAM_UNSIGNED_INTEGER,
2300       get_rsa_payload_f3 },
2301     { GET, -1, -1, -1, 0, NULL, NULL,
2302       OSSL_PKEY_PARAM_RSA_FACTOR4, OSSL_PARAM_UNSIGNED_INTEGER,
2303       get_rsa_payload_f4 },
2304     { GET, -1, -1, -1, 0, NULL, NULL,
2305       OSSL_PKEY_PARAM_RSA_FACTOR5, OSSL_PARAM_UNSIGNED_INTEGER,
2306       get_rsa_payload_f5 },
2307     { GET, -1, -1, -1, 0, NULL, NULL,
2308       OSSL_PKEY_PARAM_RSA_FACTOR6, OSSL_PARAM_UNSIGNED_INTEGER,
2309       get_rsa_payload_f6 },
2310     { GET, -1, -1, -1, 0, NULL, NULL,
2311       OSSL_PKEY_PARAM_RSA_FACTOR7, OSSL_PARAM_UNSIGNED_INTEGER,
2312       get_rsa_payload_f7 },
2313     { GET, -1, -1, -1, 0, NULL, NULL,
2314       OSSL_PKEY_PARAM_RSA_FACTOR8, OSSL_PARAM_UNSIGNED_INTEGER,
2315       get_rsa_payload_f8 },
2316     { GET, -1, -1, -1, 0, NULL, NULL,
2317       OSSL_PKEY_PARAM_RSA_FACTOR9, OSSL_PARAM_UNSIGNED_INTEGER,
2318       get_rsa_payload_f9 },
2319     { GET, -1, -1, -1, 0, NULL, NULL,
2320       OSSL_PKEY_PARAM_RSA_FACTOR10, OSSL_PARAM_UNSIGNED_INTEGER,
2321       get_rsa_payload_f10 },
2322     { GET, -1, -1, -1, 0, NULL, NULL,
2323       OSSL_PKEY_PARAM_RSA_EXPONENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2324       get_rsa_payload_e1 },
2325     { GET, -1, -1, -1, 0, NULL, NULL,
2326       OSSL_PKEY_PARAM_RSA_EXPONENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2327       get_rsa_payload_e2 },
2328     { GET, -1, -1, -1, 0, NULL, NULL,
2329       OSSL_PKEY_PARAM_RSA_EXPONENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2330       get_rsa_payload_e3 },
2331     { GET, -1, -1, -1, 0, NULL, NULL,
2332       OSSL_PKEY_PARAM_RSA_EXPONENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2333       get_rsa_payload_e4 },
2334     { GET, -1, -1, -1, 0, NULL, NULL,
2335       OSSL_PKEY_PARAM_RSA_EXPONENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2336       get_rsa_payload_e5 },
2337     { GET, -1, -1, -1, 0, NULL, NULL,
2338       OSSL_PKEY_PARAM_RSA_EXPONENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2339       get_rsa_payload_e6 },
2340     { GET, -1, -1, -1, 0, NULL, NULL,
2341       OSSL_PKEY_PARAM_RSA_EXPONENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2342       get_rsa_payload_e7 },
2343     { GET, -1, -1, -1, 0, NULL, NULL,
2344       OSSL_PKEY_PARAM_RSA_EXPONENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2345       get_rsa_payload_e8 },
2346     { GET, -1, -1, -1, 0, NULL, NULL,
2347       OSSL_PKEY_PARAM_RSA_EXPONENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2348       get_rsa_payload_e9 },
2349     { GET, -1, -1, -1, 0, NULL, NULL,
2350       OSSL_PKEY_PARAM_RSA_EXPONENT10, OSSL_PARAM_UNSIGNED_INTEGER,
2351       get_rsa_payload_e10 },
2352     { GET, -1, -1, -1, 0, NULL, NULL,
2353       OSSL_PKEY_PARAM_RSA_COEFFICIENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2354       get_rsa_payload_c1 },
2355     { GET, -1, -1, -1, 0, NULL, NULL,
2356       OSSL_PKEY_PARAM_RSA_COEFFICIENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2357       get_rsa_payload_c2 },
2358     { GET, -1, -1, -1, 0, NULL, NULL,
2359       OSSL_PKEY_PARAM_RSA_COEFFICIENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2360       get_rsa_payload_c3 },
2361     { GET, -1, -1, -1, 0, NULL, NULL,
2362       OSSL_PKEY_PARAM_RSA_COEFFICIENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2363       get_rsa_payload_c4 },
2364     { GET, -1, -1, -1, 0, NULL, NULL,
2365       OSSL_PKEY_PARAM_RSA_COEFFICIENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2366       get_rsa_payload_c5 },
2367     { GET, -1, -1, -1, 0, NULL, NULL,
2368       OSSL_PKEY_PARAM_RSA_COEFFICIENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2369       get_rsa_payload_c6 },
2370     { GET, -1, -1, -1, 0, NULL, NULL,
2371       OSSL_PKEY_PARAM_RSA_COEFFICIENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2372       get_rsa_payload_c7 },
2373     { GET, -1, -1, -1, 0, NULL, NULL,
2374       OSSL_PKEY_PARAM_RSA_COEFFICIENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2375       get_rsa_payload_c8 },
2376     { GET, -1, -1, -1, 0, NULL, NULL,
2377       OSSL_PKEY_PARAM_RSA_COEFFICIENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2378       get_rsa_payload_c9 },
2379
2380     /* EC */
2381     { GET, -1, -1, -1, 0, NULL, NULL,
2382       OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS, OSSL_PARAM_INTEGER,
2383       get_ec_decoded_from_explicit_params },
2384 };
2385
2386 static const struct translation_st *
2387 lookup_translation(struct translation_st *tmpl,
2388                    const struct translation_st *translations,
2389                    size_t translations_num)
2390 {
2391     size_t i;
2392
2393     for (i = 0; i < translations_num; i++) {
2394         const struct translation_st *item = &translations[i];
2395
2396         /*
2397          * Sanity check the translation table item.
2398          *
2399          * 1.  Either both keytypes are -1, or neither of them are.
2400          * 2.  TBA...
2401          */
2402         if (!ossl_assert((item->keytype1 == -1) == (item->keytype2 == -1)))
2403             continue;
2404
2405
2406         /*
2407          * Base search criteria: check that the optype and keytypes match,
2408          * if relevant.  All callers must synthesise these bits somehow.
2409          */
2410         if (item->optype != -1 && (tmpl->optype & item->optype) == 0)
2411             continue;
2412         /*
2413          * This expression is stunningly simple thanks to the sanity check
2414          * above.
2415          */
2416         if (item->keytype1 != -1
2417             && tmpl->keytype1 != item->keytype1
2418             && tmpl->keytype2 != item->keytype2)
2419             continue;
2420
2421         /*
2422          * Done with the base search criteria, now we check the criteria for
2423          * the individual types of translations:
2424          * ctrl->params, ctrl_str->params, and params->ctrl
2425          */
2426         if (tmpl->ctrl_num != 0) {
2427             if (tmpl->ctrl_num != item->ctrl_num)
2428                 continue;
2429         } else if (tmpl->ctrl_str != NULL) {
2430             const char *ctrl_str = NULL;
2431             const char *ctrl_hexstr = NULL;
2432
2433             /*
2434              * Search criteria that originates from a ctrl_str is only used
2435              * for setting, never for getting.  Therefore, we only look at
2436              * the setter items.
2437              */
2438             if (item->action_type != NONE
2439                 && item->action_type != SET)
2440                 continue;
2441             /*
2442              * At least one of the ctrl cmd names must be match the ctrl
2443              * cmd name in the template.
2444              */
2445             if (item->ctrl_str != NULL
2446                 && strcasecmp(tmpl->ctrl_str, item->ctrl_str) == 0)
2447                 ctrl_str = tmpl->ctrl_str;
2448             else if (item->ctrl_hexstr != NULL
2449                      && strcasecmp(tmpl->ctrl_hexstr, item->ctrl_hexstr) == 0)
2450                 ctrl_hexstr = tmpl->ctrl_hexstr;
2451             else
2452                 continue;
2453
2454             /* Modify the template to signal which string matched */
2455             tmpl->ctrl_str = ctrl_str;
2456             tmpl->ctrl_hexstr = ctrl_hexstr;
2457         } else if (tmpl->param_key != NULL) {
2458             /*
2459              * Search criteria that originates from a OSSL_PARAM setter or
2460              * getter.
2461              *
2462              * Ctrls were fundamentally bidirectional, with only the ctrl
2463              * command macro name implying direction (if you're lucky).
2464              * A few ctrl commands were even taking advantage of the
2465              * bidirectional nature, making the direction depend in the
2466              * value of the numeric argument.
2467              *
2468              * OSSL_PARAM functions are fundamentally different, in that
2469              * setters and getters are separated, so the data direction is
2470              * implied by the function that's used.  The same OSSL_PARAM
2471              * key name can therefore be used in both directions.  We must
2472              * therefore take the action type into account in this case.
2473              */
2474             if ((item->action_type != NONE
2475                  && tmpl->action_type != item->action_type)
2476                 || (item->param_key != NULL
2477                     && strcasecmp(tmpl->param_key, item->param_key) != 0))
2478                 continue;
2479         } else {
2480             return NULL;
2481         }
2482
2483         return item;
2484     }
2485
2486     return NULL;
2487 }
2488
2489 static const struct translation_st *
2490 lookup_evp_pkey_ctx_translation(struct translation_st *tmpl)
2491 {
2492     return lookup_translation(tmpl, evp_pkey_ctx_translations,
2493                               OSSL_NELEM(evp_pkey_ctx_translations));
2494 }
2495
2496 static const struct translation_st *
2497 lookup_evp_pkey_translation(struct translation_st *tmpl)
2498 {
2499     return lookup_translation(tmpl, evp_pkey_translations,
2500                               OSSL_NELEM(evp_pkey_translations));
2501 }
2502
2503 /* This must ONLY be called for provider side operations */
2504 int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX *pctx,
2505                                int keytype, int optype,
2506                                int cmd, int p1, void *p2)
2507 {
2508     struct translation_ctx_st ctx = { 0, };
2509     struct translation_st tmpl = { 0, };
2510     const struct translation_st *translation = NULL;
2511     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2512     int ret;
2513     fixup_args_fn *fixup = default_fixup_args;
2514
2515     if (keytype == -1)
2516         keytype = pctx->legacy_keytype;
2517     tmpl.ctrl_num = cmd;
2518     tmpl.keytype1 = tmpl.keytype2 = keytype;
2519     tmpl.optype = optype;
2520     translation = lookup_evp_pkey_ctx_translation(&tmpl);
2521
2522     if (translation == NULL) {
2523         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
2524         return -2;
2525     }
2526
2527     if (pctx->pmeth != NULL
2528         && pctx->pmeth->pkey_id != translation->keytype1
2529         && pctx->pmeth->pkey_id != translation->keytype2)
2530         return -1;
2531
2532     if (translation->fixup_args != NULL)
2533         fixup = translation->fixup_args;
2534     ctx.action_type = translation->action_type;
2535     ctx.ctrl_cmd = cmd;
2536     ctx.p1 = p1;
2537     ctx.p2 = p2;
2538     ctx.pctx = pctx;
2539     ctx.params = params;
2540
2541     ret = fixup(PRE_CTRL_TO_PARAMS, translation, &ctx);
2542
2543     if (ret > 0) {
2544         switch (ctx.action_type) {
2545         default:
2546             /* fixup_args is expected to make sure this is dead code */
2547             break;
2548         case GET:
2549             ret = evp_pkey_ctx_get_params_strict(pctx, ctx.params);
2550             break;
2551         case SET:
2552             ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2553             break;
2554         }
2555     }
2556
2557     /*
2558      * In POST, we pass the return value as p1, allowing the fixup_args
2559      * function to affect it by changing its value.
2560      */
2561     if (ret > 0) {
2562         ctx.p1 = ret;
2563         fixup(POST_CTRL_TO_PARAMS, translation, &ctx);
2564         ret = ctx.p1;
2565     }
2566
2567     cleanup_translation_ctx(POST_CTRL_TO_PARAMS, translation, &ctx);
2568
2569     return ret;
2570 }
2571
2572 /* This must ONLY be called for provider side operations */
2573 int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX *pctx,
2574                                    const char *name, const char *value)
2575 {
2576     struct translation_ctx_st ctx = { 0, };
2577     struct translation_st tmpl = { 0, };
2578     const struct translation_st *translation = NULL;
2579     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2580     int keytype = pctx->legacy_keytype;
2581     int optype = pctx->operation == 0 ? -1 : pctx->operation;
2582     int ret;
2583     fixup_args_fn *fixup = default_fixup_args;
2584
2585     tmpl.action_type = SET;
2586     tmpl.keytype1 = tmpl.keytype2 = keytype;
2587     tmpl.optype = optype;
2588     tmpl.ctrl_str = name;
2589     tmpl.ctrl_hexstr = name;
2590     translation = lookup_evp_pkey_ctx_translation(&tmpl);
2591
2592     if (translation != NULL) {
2593         if (translation->fixup_args != NULL)
2594             fixup = translation->fixup_args;
2595         ctx.action_type = translation->action_type;
2596         ctx.ishex = (tmpl.ctrl_hexstr != NULL);
2597     } else {
2598         /* String controls really only support setting */
2599         ctx.action_type = SET;
2600     }
2601     ctx.ctrl_str = name;
2602     ctx.p1 = (int)strlen(value);
2603     ctx.p2 = (char *)value;
2604     ctx.pctx = pctx;
2605     ctx.params = params;
2606
2607     ret = fixup(PRE_CTRL_STR_TO_PARAMS, translation, &ctx);
2608
2609     if (ret > 0) {
2610         switch (ctx.action_type) {
2611         default:
2612             /* fixup_args is expected to make sure this is dead code */
2613             break;
2614         case GET:
2615             /*
2616              * this is dead code, but must be present, or some compilers
2617              * will complain
2618              */
2619             break;
2620         case SET:
2621             ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2622             break;
2623         }
2624     }
2625
2626     if (ret > 0)
2627         ret = fixup(POST_CTRL_STR_TO_PARAMS, translation, &ctx);
2628
2629     cleanup_translation_ctx(CLEANUP_CTRL_STR_TO_PARAMS, translation, &ctx);
2630
2631     return ret;
2632 }
2633
2634 /* This must ONLY be called for legacy operations */
2635 static int evp_pkey_ctx_setget_params_to_ctrl(EVP_PKEY_CTX *pctx,
2636                                               enum action action_type,
2637                                               OSSL_PARAM *params)
2638 {
2639     int keytype = pctx->legacy_keytype;
2640     int optype = pctx->operation == 0 ? -1 : pctx->operation;
2641
2642     for (; params != NULL && params->key != NULL; params++) {
2643         struct translation_ctx_st ctx = { 0, };
2644         struct translation_st tmpl = { 0, };
2645         const struct translation_st *translation = NULL;
2646         fixup_args_fn *fixup = default_fixup_args;
2647         int ret;
2648
2649         tmpl.action_type = action_type;
2650         tmpl.keytype1 = tmpl.keytype2 = keytype;
2651         tmpl.optype = optype;
2652         tmpl.param_key = params->key;
2653         translation = lookup_evp_pkey_ctx_translation(&tmpl);
2654
2655         if (translation != NULL) {
2656             if (translation->fixup_args != NULL)
2657                 fixup = translation->fixup_args;
2658             ctx.action_type = translation->action_type;
2659         }
2660         ctx.pctx = pctx;
2661         ctx.params = params;
2662
2663         ret = fixup(PRE_PARAMS_TO_CTRL, translation, &ctx);
2664
2665         if (ret > 0 && action_type != NONE)
2666             ret = EVP_PKEY_CTX_ctrl(pctx, keytype, optype,
2667                                     ctx.ctrl_cmd, ctx.p1, ctx.p2);
2668
2669         /*
2670          * In POST, we pass the return value as p1, allowing the fixup_args
2671          * function to put it to good use, or maybe affect it.
2672          */
2673         if (ret > 0) {
2674             ctx.p1 = ret;
2675             fixup(POST_PARAMS_TO_CTRL, translation, &ctx);
2676             ret = ctx.p1;
2677         }
2678
2679         cleanup_translation_ctx(CLEANUP_PARAMS_TO_CTRL, translation, &ctx);
2680
2681         if (ret <= 0)
2682             return 0;
2683     }
2684     return 1;
2685 }
2686
2687 int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX *ctx, const OSSL_PARAM *params)
2688 {
2689     return evp_pkey_ctx_setget_params_to_ctrl(ctx, SET, (OSSL_PARAM *)params);
2690 }
2691
2692 int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
2693 {
2694     return evp_pkey_ctx_setget_params_to_ctrl(ctx, GET, params);
2695 }
2696
2697 /* This must ONLY be called for legacy EVP_PKEYs */
2698 static int evp_pkey_setget_params_to_ctrl(const EVP_PKEY *pkey,
2699                                           enum action action_type,
2700                                           OSSL_PARAM *params)
2701 {
2702     int ret = 1;
2703
2704     for (; params != NULL && params->key != NULL; params++) {
2705         struct translation_ctx_st ctx = { 0, };
2706         struct translation_st tmpl = { 0, };
2707         const struct translation_st *translation = NULL;
2708         fixup_args_fn *fixup = default_fixup_args;
2709
2710         tmpl.action_type = action_type;
2711         tmpl.param_key = params->key;
2712         translation = lookup_evp_pkey_translation(&tmpl);
2713
2714         if (translation != NULL) {
2715             if (translation->fixup_args != NULL)
2716                 fixup = translation->fixup_args;
2717             ctx.action_type = translation->action_type;
2718         }
2719         ctx.p2 = (void *)pkey;
2720         ctx.params = params;
2721
2722         /*
2723          * EVP_PKEY doesn't have any ctrl function, so we rely completely
2724          * on fixup_args to do the whole work.  Also, we currently only
2725          * support getting.
2726          */
2727         if (!ossl_assert(translation != NULL)
2728             || !ossl_assert(translation->action_type == GET)
2729             || !ossl_assert(translation->fixup_args != NULL)) {
2730             return -2;
2731         }
2732
2733         ret = fixup(PKEY, translation, &ctx);
2734
2735         cleanup_translation_ctx(PKEY, translation, &ctx);
2736     }
2737     return ret;
2738 }
2739
2740 int evp_pkey_get_params_to_ctrl(const EVP_PKEY *pkey, OSSL_PARAM *params)
2741 {
2742     return evp_pkey_setget_params_to_ctrl(pkey, GET, params);
2743 }
2744