Modify OBJ_nid2sn(OBJ_obj2nid(...)) occurences to use OBJ_obj2txt()
[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.sigprovctx == NULL)
423                 || (EVP_PKEY_CTX_IS_DERIVE_OP(ctx->pctx)
424                     && ctx->pctx->op.kex.exchprovctx == NULL)
425                 || (EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx->pctx)
426                     && ctx->pctx->op.ciph.ciphprovctx == NULL)
427                 || (EVP_PKEY_CTX_IS_KEM_OP(ctx->pctx)
428                     && ctx->pctx->op.encap.kemprovctx == 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
658                 /* When getting, we populate |*params| from |p1| and |p2| */
659                 switch (translation->param_data_type) {
660                 case OSSL_PARAM_INTEGER:
661                     return OSSL_PARAM_set_int(ctx->params, ctx->p1);
662                 case OSSL_PARAM_UNSIGNED_INTEGER:
663                     if (ctx->p2 != NULL) {
664                         /* BIGNUM passed back */
665                         return OSSL_PARAM_set_BN(ctx->params, ctx->p2);
666                     } else {
667                         /* Normal C unsigned int passed back */
668                         return OSSL_PARAM_set_uint(ctx->params,
669                                                    (unsigned int)ctx->p1);
670                     }
671                     return 0;
672                 case OSSL_PARAM_UTF8_STRING:
673                     return OSSL_PARAM_set_utf8_string(ctx->params, ctx->p2);
674                 case OSSL_PARAM_OCTET_STRING:
675                     return OSSL_PARAM_set_octet_string(ctx->params, ctx->p2,
676                                                        (size_t)ctx->p1);
677                 case OSSL_PARAM_OCTET_PTR:
678                     return OSSL_PARAM_set_octet_ptr(ctx->params, ctx->p2,
679                                                     (size_t)ctx->p1);
680                 default:
681                     ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
682                                    "[action:%d, state:%d] "
683                                    "unsupported OSSL_PARAM data type %d",
684                                    ctx->action_type, state,
685                                    translation->param_data_type);
686                     return 0;
687                 }
688             }
689         }
690         /* Any other combination is simply pass-through */
691         break;
692     }
693     return ret;
694 }
695
696 static int
697 cleanup_translation_ctx(enum state state,
698                         const struct translation_st *translation,
699                         struct translation_ctx_st *ctx)
700 {
701     if (ctx->allocated_buf != NULL)
702         OPENSSL_free(ctx->allocated_buf);
703     ctx->allocated_buf = NULL;
704     return 1;
705 }
706
707 /*
708  * fix_cipher_md fixes up an EVP_CIPHER / EVP_MD to its name on SET,
709  * and cipher / md name to EVP_MD on GET.
710  */
711 static const char *get_cipher_name(void *cipher)
712 {
713     return EVP_CIPHER_name(cipher);
714 }
715
716 static const char *get_md_name(void *md)
717 {
718     return EVP_MD_name(md);
719 }
720
721 static const void *get_cipher_by_name(OSSL_LIB_CTX *libctx, const char *name)
722 {
723     return evp_get_cipherbyname_ex(libctx, name);
724 }
725
726 static const void *get_md_by_name(OSSL_LIB_CTX *libctx, const char *name)
727 {
728     return evp_get_digestbyname_ex(libctx, name);
729 }
730
731 static int fix_cipher_md(enum state state,
732                          const struct translation_st *translation,
733                          struct translation_ctx_st *ctx,
734                          const char *(*get_name)(void *algo),
735                          const void *(*get_algo_by_name)(OSSL_LIB_CTX *libctx,
736                                                          const char *name))
737 {
738     int ret = 1;
739
740     if ((ret = default_check(state, translation, ctx)) <= 0)
741         return ret;
742
743     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
744         /*
745          * |ctx->p2| contains the address to an EVP_CIPHER or EVP_MD pointer
746          * to be filled in.  We need to remember it, then make |ctx->p2|
747          * point at a buffer to be filled in with the name, and |ctx->p1|
748          * with its size.  default_fixup_args() will take care of the rest
749          * for us.
750          */
751         ctx->orig_p2 = ctx->p2;
752         ctx->p2 = ctx->name_buf;
753         ctx->p1 = sizeof(ctx->name_buf);
754     } else if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
755         /*
756          * In different parts of OpenSSL, this ctrl command is used
757          * differently.  Some calls pass a NID as p1, others pass an
758          * EVP_CIPHER pointer as p2...
759          */
760         ctx->p2 = (char *)(ctx->p2 == NULL
761                            ? OBJ_nid2sn(ctx->p1)
762                            : get_name(ctx->p2));
763         ctx->p1 = strlen(ctx->p2);
764     } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
765         ctx->p2 = (ctx->p2 == NULL ? "" : (char *)get_name(ctx->p2));
766         ctx->p1 = strlen(ctx->p2);
767     }
768
769     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
770         return ret;
771
772     if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
773         /*
774          * Here's how we re-use |ctx->orig_p2| that was set in the
775          * PRE_CTRL_TO_PARAMS state above.
776          */
777         *(void **)ctx->orig_p2 =
778             (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
779         ctx->p1 = 1;
780     } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET) {
781         ctx->p2 = (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
782         ctx->p1 = 0;
783     }
784
785     return ret;
786 }
787
788 static int fix_cipher(enum state state,
789                       const struct translation_st *translation,
790                       struct translation_ctx_st *ctx)
791 {
792     return fix_cipher_md(state, translation, ctx,
793                          get_cipher_name, get_cipher_by_name);
794 }
795
796 static int fix_md(enum state state,
797                   const struct translation_st *translation,
798                   struct translation_ctx_st *ctx)
799 {
800     return fix_cipher_md(state, translation, ctx,
801                          get_md_name, get_md_by_name);
802 }
803
804 static int fix_distid_len(enum state state,
805                           const struct translation_st *translation,
806                           struct translation_ctx_st *ctx)
807 {
808     int ret = default_fixup_args(state, translation, ctx);
809
810     if (ret > 0) {
811         ret = 0;
812         if ((state == POST_CTRL_TO_PARAMS
813              || state == POST_CTRL_STR_TO_PARAMS) && ctx->action_type == GET) {
814             *(size_t *)ctx->p2 = ctx->sz;
815             ret = 1;
816         }
817     }
818     return ret;
819 }
820
821 struct kdf_type_map_st {
822     int kdf_type_num;
823     const char *kdf_type_str;
824 };
825
826 static int fix_kdf_type(enum state state,
827                         const struct translation_st *translation,
828                         struct translation_ctx_st *ctx,
829                         const struct kdf_type_map_st *kdf_type_map)
830 {
831     /*
832      * The EVP_PKEY_CTRL_DH_KDF_TYPE ctrl command is a bit special, in
833      * that it's used both for setting a value, and for getting it, all
834      * depending on the value if |p1|; if |p1| is -2, the backend is
835      * supposed to place the current kdf type in |p2|, and if not, |p1|
836      * is interpreted as the new kdf type.
837      */
838     int ret = 0;
839
840     if ((ret = default_check(state, translation, ctx)) <= 0)
841         return ret;
842
843     if (state == PRE_CTRL_TO_PARAMS) {
844         /*
845          * In |translations|, the initial value for |ctx->action_type| must
846          * be NONE.
847          */
848         if (!ossl_assert(ctx->action_type == NONE))
849             return 0;
850
851         /* The action type depends on the value of *p1 */
852         if (ctx->p1 == -2) {
853             /*
854              * The OSSL_PARAMS getter needs space to store a copy of the kdf
855              * type string.  We use |ctx->name_buf|, which has enough space
856              * allocated.
857              *
858              * (this wouldn't be needed if the OSSL_xxx_PARAM_KDF_TYPE
859              * had the data type OSSL_PARAM_UTF8_PTR)
860              */
861             ctx->p2 = ctx->name_buf;
862             ctx->p1 = sizeof(ctx->name_buf);
863             ctx->action_type = GET;
864         } else {
865             ctx->action_type = SET;
866         }
867     }
868
869     if ((ret = default_check(state, translation, ctx)) <= 0)
870         return ret;
871
872     if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
873         || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
874         ret = -2;
875         /* Convert KDF type numbers to strings */
876         for (; kdf_type_map->kdf_type_str != NULL; kdf_type_map++)
877             if (ctx->p1 == kdf_type_map->kdf_type_num) {
878                 ctx->p2 = (char *)kdf_type_map->kdf_type_str;
879                 ret = 1;
880                 break;
881             }
882         if (ret <= 0)
883             goto end;
884         ctx->p1 = strlen(ctx->p2);
885     }
886
887     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
888         return ret;
889
890     if ((state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)
891         || (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)) {
892         ctx->p1 = ret = -1;
893
894         /* Convert KDF type strings to numbers */
895         for (; kdf_type_map->kdf_type_str != NULL; kdf_type_map++)
896             if (strcasecmp(ctx->p2, kdf_type_map->kdf_type_str) == 0) {
897                 ctx->p1 = kdf_type_map->kdf_type_num;
898                 ret = 1;
899                 break;
900             }
901         ctx->p2 = NULL;
902     } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
903         ctx->p1 = -2;
904     }
905  end:
906     return ret;
907 }
908
909 /* EVP_PKEY_CTRL_DH_KDF_TYPE */
910 static int fix_dh_kdf_type(enum state state,
911                            const struct translation_st *translation,
912                            struct translation_ctx_st *ctx)
913 {
914     static const struct kdf_type_map_st kdf_type_map[] = {
915         { EVP_PKEY_DH_KDF_NONE, "" },
916         { EVP_PKEY_DH_KDF_X9_42, OSSL_KDF_NAME_X942KDF_ASN1 },
917         { 0, NULL }
918     };
919
920     return fix_kdf_type(state, translation, ctx, kdf_type_map);
921 }
922
923 /* EVP_PKEY_CTRL_EC_KDF_TYPE */
924 static int fix_ec_kdf_type(enum state state,
925                            const struct translation_st *translation,
926                            struct translation_ctx_st *ctx)
927 {
928     static const struct kdf_type_map_st kdf_type_map[] = {
929         { EVP_PKEY_ECDH_KDF_NONE, "" },
930         { EVP_PKEY_ECDH_KDF_X9_63, OSSL_KDF_NAME_X963KDF },
931         { 0, NULL }
932     };
933
934     return fix_kdf_type(state, translation, ctx, kdf_type_map);
935 }
936
937 /* EVP_PKEY_CTRL_DH_KDF_OID, EVP_PKEY_CTRL_GET_DH_KDF_OID, ...??? */
938 static int fix_oid(enum state state,
939                    const struct translation_st *translation,
940                    struct translation_ctx_st *ctx)
941 {
942     int ret;
943
944     if ((ret = default_check(state, translation, ctx)) <= 0)
945         return ret;
946
947     if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
948         || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
949         /*
950          * We're translating from ctrl to params and setting the OID, or
951          * we're translating from params to ctrl and getting the OID.
952          * Either way, |ctx->p2| points at an ASN1_OBJECT, and needs to have
953          * that replaced with the corresponding name.
954          * default_fixup_args() will then be able to convert that to the
955          * corresponding OSSL_PARAM.
956          */
957         OBJ_obj2txt(ctx->name_buf, sizeof(ctx->name_buf), ctx->p2, 0);
958         ctx->p2 = (char *)ctx->name_buf;
959         ctx->p1 = 0; /* let default_fixup_args() figure out the length */
960     }
961
962     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
963         return ret;
964
965     if ((state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)
966         || (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)) {
967         /*
968          * We're translating from ctrl to params and setting the OID name,
969          * or we're translating from params to ctrl and getting the OID
970          * name.  Either way, default_fixup_args() has placed the OID name
971          * in |ctx->p2|, all we need to do now is to replace that with the
972          * corresponding ASN1_OBJECT.
973          */
974         ctx->p2 = (ASN1_OBJECT *)OBJ_txt2obj(ctx->p2, 0);
975     }
976
977     return ret;
978 }
979
980 /* EVP_PKEY_CTRL_DH_NID, ...??? */
981 static int fix_dh_nid(enum state state,
982                       const struct translation_st *translation,
983                       struct translation_ctx_st *ctx)
984 {
985     int ret;
986
987     if ((ret = default_check(state, translation, ctx)) <= 0)
988         return ret;
989
990     /* This is currently only settable */
991     if (ctx->action_type != SET)
992         return 0;
993
994     if (state == PRE_CTRL_TO_PARAMS) {
995         ctx->p2 = (char *)ossl_ffc_named_group_get_name
996             (ossl_ffc_uid_to_dh_named_group(ctx->p1));
997         ctx->p1 = 0;
998     }
999
1000     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1001         return ret;
1002
1003     if (state == PRE_PARAMS_TO_CTRL) {
1004         ctx->p1 =
1005             ossl_ffc_named_group_get_uid(ossl_ffc_name_to_dh_named_group(ctx->p2));
1006         ctx->p2 = NULL;
1007     }
1008
1009     return ret;
1010 }
1011
1012 /* EVP_PKEY_CTRL_DH_PARAMGEN_TYPE */
1013 static int fix_dh_paramgen_type(enum state state,
1014                                 const struct translation_st *translation,
1015                                 struct translation_ctx_st *ctx)
1016 {
1017     int ret;
1018
1019     if ((ret = default_check(state, translation, ctx)) <= 0)
1020         return ret;
1021
1022     /* This is currently only settable */
1023     if (ctx->action_type != SET)
1024         return 0;
1025
1026     if (state == PRE_CTRL_TO_PARAMS) {
1027         ctx->p2 = (char *)ossl_dh_gen_type_id2name(ctx->p1);
1028         ctx->p1 = 0;
1029     }
1030
1031     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1032         return ret;
1033
1034     if (state == PRE_PARAMS_TO_CTRL) {
1035         ctx->p1 = ossl_dh_gen_type_name2id(ctx->p2);
1036         ctx->p2 = NULL;
1037     }
1038
1039     return ret;
1040 }
1041
1042 /* EVP_PKEY_CTRL_EC_PARAM_ENC */
1043 static int fix_ec_param_enc(enum state state,
1044                             const struct translation_st *translation,
1045                             struct translation_ctx_st *ctx)
1046 {
1047     int ret;
1048
1049     if ((ret = default_check(state, translation, ctx)) <= 0)
1050         return ret;
1051
1052     /* This is currently only settable */
1053     if (ctx->action_type != SET)
1054         return 0;
1055
1056     if (state == PRE_CTRL_TO_PARAMS) {
1057         switch (ctx->p1) {
1058         case OPENSSL_EC_EXPLICIT_CURVE:
1059             ctx->p2 = OSSL_PKEY_EC_ENCODING_EXPLICIT;
1060             break;
1061         case OPENSSL_EC_NAMED_CURVE:
1062             ctx->p2 = OSSL_PKEY_EC_ENCODING_GROUP;
1063             break;
1064         default:
1065             ret = -2;
1066             goto end;
1067         }
1068         ctx->p1 = 0;
1069     }
1070
1071     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1072         return ret;
1073
1074     if (state == PRE_PARAMS_TO_CTRL) {
1075         if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_EXPLICIT) == 0)
1076             ctx->p1 = OPENSSL_EC_EXPLICIT_CURVE;
1077         else if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_GROUP) == 0)
1078             ctx->p1 = OPENSSL_EC_NAMED_CURVE;
1079         else
1080             ctx->p1 = ret = -2;
1081         ctx->p2 = NULL;
1082     }
1083
1084  end:
1085     if (ret == -2)
1086         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1087     return ret;
1088 }
1089
1090 /* EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID */
1091 static int fix_ec_paramgen_curve_nid(enum state state,
1092                                      const struct translation_st *translation,
1093                                      struct translation_ctx_st *ctx)
1094 {
1095     int ret;
1096
1097     if ((ret = default_check(state, translation, ctx)) <= 0)
1098         return ret;
1099
1100     /* This is currently only settable */
1101     if (ctx->action_type != SET)
1102         return 0;
1103
1104     if (state == PRE_CTRL_TO_PARAMS) {
1105         ctx->p2 = (char *)OBJ_nid2sn(ctx->p1);
1106         ctx->p1 = 0;
1107     }
1108
1109     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1110         return ret;
1111
1112     if (state == PRE_PARAMS_TO_CTRL) {
1113         ctx->p1 = OBJ_sn2nid(ctx->p2);
1114         ctx->p2 = NULL;
1115     }
1116
1117     return ret;
1118 }
1119
1120 /* EVP_PKEY_CTRL_EC_ECDH_COFACTOR */
1121 static int fix_ecdh_cofactor(enum state state,
1122                              const struct translation_st *translation,
1123                              struct translation_ctx_st *ctx)
1124 {
1125     /*
1126      * The EVP_PKEY_CTRL_EC_ECDH_COFACTOR ctrl command is a bit special, in
1127      * that it's used both for setting a value, and for getting it, all
1128      * depending on the value if |ctx->p1|; if |ctx->p1| is -2, the backend is
1129      * supposed to place the current cofactor mode in |ctx->p2|, and if not,
1130      * |ctx->p1| is interpreted as the new cofactor mode.
1131      */
1132     int ret = 0;
1133
1134     if (state == PRE_CTRL_TO_PARAMS) {
1135         /*
1136          * The initial value for |ctx->action_type| must be zero.
1137          * evp_pkey_ctrl_to_params() takes it from the translation item.
1138          */
1139         if (!ossl_assert(ctx->action_type == NONE))
1140             return 0;
1141
1142         /* The action type depends on the value of ctx->p1 */
1143         if (ctx->p1 == -2)
1144             ctx->action_type = GET;
1145         else
1146             ctx->action_type = SET;
1147     } else if (state == PRE_CTRL_STR_TO_PARAMS) {
1148         ctx->action_type = SET;
1149     } else if (state == PRE_PARAMS_TO_CTRL) {
1150         /* The initial value for |ctx->action_type| must not be zero. */
1151         if (!ossl_assert(ctx->action_type != NONE))
1152             return 0;
1153     }
1154
1155     if ((ret = default_check(state, translation, ctx)) <= 0)
1156         return ret;
1157
1158     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1159         if (ctx->p1 < -1 || ctx->p1 > 1) {
1160             /* Uses the same return value of pkey_ec_ctrl() */
1161             return -2;
1162         }
1163     }
1164
1165     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1166         return ret;
1167
1168     if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
1169         if (ctx->p1 < 0 || ctx->p1 > 1) {
1170             /*
1171              * The provider should return either 0 or 1, any other value is a
1172              * provider error.
1173              */
1174             ctx->p1 = ret = -1;
1175         }
1176     } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
1177         ctx->p1 = -2;
1178     }
1179
1180     return ret;
1181 }
1182
1183 /* EVP_PKEY_CTRL_RSA_PADDING, EVP_PKEY_CTRL_GET_RSA_PADDING */
1184 static int fix_rsa_padding_mode(enum state state,
1185                                 const struct translation_st *translation,
1186                                 struct translation_ctx_st *ctx)
1187 {
1188     static const OSSL_ITEM str_value_map[] = {
1189         { RSA_PKCS1_PADDING,            "pkcs1"  },
1190         { RSA_NO_PADDING,               "none"   },
1191         { RSA_PKCS1_OAEP_PADDING,       "oaep"   },
1192         { RSA_PKCS1_OAEP_PADDING,       "oeap"   },
1193         { RSA_X931_PADDING,             "x931"   },
1194         { RSA_PKCS1_PSS_PADDING,        "pss"    },
1195         /* Special case, will pass directly as an integer */
1196         { RSA_PKCS1_WITH_TLS_PADDING,   NULL     }
1197     };
1198     int ret;
1199
1200     if ((ret = default_check(state, translation, ctx)) <= 0)
1201         return ret;
1202
1203     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
1204         /*
1205          * EVP_PKEY_CTRL_GET_RSA_PADDING returns the padding mode in the
1206          * weirdest way for a ctrl.  Instead of doing like all other ctrls
1207          * that return a simple, i.e. just have that as a return value,
1208          * this particular ctrl treats p2 as the address for the int to be
1209          * returned.  We must therefore remember |ctx->p2|, then make
1210          * |ctx->p2| point at a buffer to be filled in with the name, and
1211          * |ctx->p1| with its size.  default_fixup_args() will take care
1212          * of the rest for us, along with the POST_CTRL_TO_PARAMS && GET
1213          * code section further down.
1214          */
1215         ctx->orig_p2 = ctx->p2;
1216         ctx->p2 = ctx->name_buf;
1217         ctx->p1 = sizeof(ctx->name_buf);
1218     } else if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1219         /*
1220          * Ideally, we should use utf8 strings for the diverse padding modes.
1221          * We only came here because someone called EVP_PKEY_CTX_ctrl(),
1222          * though, and since that can reasonably be seen as legacy code
1223          * that uses the diverse RSA macros for the padding mode, and we
1224          * know that at least our providers can handle the numeric modes,
1225          * we take the cheap route for now.
1226          *
1227          * The other solution would be to match |ctx->p1| against entries
1228          * in str_value_map and pass the corresponding string.  However,
1229          * since we don't have a string for RSA_PKCS1_WITH_TLS_PADDING,
1230          * we have to do this same hack at least for that one.
1231          *
1232          * Since the "official" data type for the RSA padding mode is utf8
1233          * string, we cannot count on default_fixup_args().  Instead, we
1234          * build the OSSL_PARAM item ourselves and return immediately.
1235          */
1236         ctx->params[0] = OSSL_PARAM_construct_int(translation->param_key,
1237                                                   &ctx->p1);
1238         return 1;
1239     } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
1240         size_t i;
1241
1242         /*
1243          * The EVP_PKEY_CTX_get_params() caller may have asked for a utf8
1244          * string, or may have asked for an integer of some sort.  If they
1245          * ask for an integer, we respond directly.  If not, we translate
1246          * the response from the ctrl function into a string.
1247          */
1248         switch (ctx->params->data_type) {
1249         case OSSL_PARAM_INTEGER:
1250             return OSSL_PARAM_get_int(ctx->params, &ctx->p1);
1251         case OSSL_PARAM_UNSIGNED_INTEGER:
1252             return OSSL_PARAM_get_uint(ctx->params, (unsigned int *)&ctx->p1);
1253         default:
1254             break;
1255         }
1256
1257         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1258             if (ctx->p1 == (int)str_value_map[i].id)
1259                 break;
1260         }
1261         if (i == OSSL_NELEM(str_value_map)) {
1262             ERR_raise_data(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE,
1263                            "[action:%d, state:%d] padding number %d",
1264                            ctx->action_type, state, ctx->p1);
1265             return -2;
1266         }
1267         /*
1268          * If we don't have a string, we can't do anything.  The caller
1269          * should have asked for a number...
1270          */
1271         if (str_value_map[i].ptr == NULL) {
1272             ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1273             return -2;
1274         }
1275         ctx->p2 = str_value_map[i].ptr;
1276         ctx->p1 = strlen(ctx->p2);
1277     }
1278
1279     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1280         return ret;
1281
1282     if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1283         || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1284         size_t i;
1285
1286         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1287             if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1288                 break;
1289         }
1290
1291         if (i == OSSL_NELEM(str_value_map)) {
1292             ERR_raise_data(ERR_LIB_RSA, RSA_R_UNKNOWN_PADDING_TYPE,
1293                            "[action:%d, state:%d] padding name %s",
1294                            ctx->action_type, state, ctx->p1);
1295             ctx->p1 = ret = -2;
1296         } else if (state == POST_CTRL_TO_PARAMS) {
1297             /* EVP_PKEY_CTRL_GET_RSA_PADDING weirdness explained further up */
1298             *(int *)ctx->orig_p2 = str_value_map[i].id;
1299         } else {
1300             ctx->p1 = str_value_map[i].id;
1301         }
1302         ctx->p2 = NULL;
1303     }
1304
1305     return ret;
1306 }
1307
1308 /* EVP_PKEY_CTRL_RSA_PSS_SALTLEN, EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN */
1309 static int fix_rsa_pss_saltlen(enum state state,
1310                                const struct translation_st *translation,
1311                                struct translation_ctx_st *ctx)
1312 {
1313     static const OSSL_ITEM str_value_map[] = {
1314         { (unsigned int)RSA_PSS_SALTLEN_DIGEST, "digest" },
1315         { (unsigned int)RSA_PSS_SALTLEN_MAX,    "max"    },
1316         { (unsigned int)RSA_PSS_SALTLEN_AUTO,   "auto"   }
1317     };
1318     int ret;
1319
1320     if ((ret = default_check(state, translation, ctx)) <= 0)
1321         return ret;
1322
1323     if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
1324         /*
1325          * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN returns the saltlen by filling
1326          * in the int pointed at by p2.  This is potentially as weird as
1327          * the way EVP_PKEY_CTRL_GET_RSA_PADDING works, except that saltlen
1328          * might be a negative value, so it wouldn't work as a legitimate
1329          * return value.
1330          * In any case, we must therefore remember |ctx->p2|, then make
1331          * |ctx->p2| point at a buffer to be filled in with the name, and
1332          * |ctx->p1| with its size.  default_fixup_args() will take care
1333          * of the rest for us, along with the POST_CTRL_TO_PARAMS && GET
1334          * code section further down.
1335          */
1336         ctx->orig_p2 = ctx->p2;
1337         ctx->p2 = ctx->name_buf;
1338         ctx->p1 = sizeof(ctx->name_buf);
1339     } else if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1340         || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1341         size_t i;
1342
1343         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1344             if (ctx->p1 == (int)str_value_map[i].id)
1345                 break;
1346         }
1347         if (i == OSSL_NELEM(str_value_map)) {
1348             BIO_snprintf(ctx->name_buf, sizeof(ctx->name_buf), "%d", ctx->p1);
1349         } else {
1350             strcpy(ctx->name_buf, str_value_map[i].ptr);
1351         }
1352         ctx->p2 = ctx->name_buf;
1353         ctx->p1 = strlen(ctx->p2);
1354     }
1355
1356     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1357         return ret;
1358
1359     if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1360         || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1361         size_t i;
1362
1363         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1364             if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1365                 break;
1366         }
1367         if (i == OSSL_NELEM(str_value_map)) {
1368             ctx->p1 = atoi(ctx->p2);
1369         } else if (state == POST_CTRL_TO_PARAMS) {
1370             /*
1371              * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN weirdness explained further
1372              * up
1373              */
1374             *(int *)ctx->orig_p2 = str_value_map[i].id;
1375         } else {
1376             ctx->p1 = (int)str_value_map[i].id;
1377         }
1378         ctx->p2 = NULL;
1379     }
1380
1381     return ret;
1382 }
1383
1384 /* EVP_PKEY_CTRL_HKDF_MODE */
1385 static int fix_hkdf_mode(enum state state,
1386                          const struct translation_st *translation,
1387                          struct translation_ctx_st *ctx)
1388 {
1389     static const OSSL_ITEM str_value_map[] = {
1390         { EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND, "EXTRACT_AND_EXPAND" },
1391         { EVP_KDF_HKDF_MODE_EXTRACT_ONLY,       "EXTRACT_ONLY"       },
1392         { EVP_KDF_HKDF_MODE_EXPAND_ONLY,        "EXPAND_ONLY"        }
1393     };
1394     int ret;
1395
1396     if ((ret = default_check(state, translation, ctx)) <= 0)
1397         return ret;
1398
1399     if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1400         || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1401         size_t i;
1402
1403         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1404             if (ctx->p1 == (int)str_value_map[i].id)
1405                 break;
1406         }
1407         if (i == OSSL_NELEM(str_value_map))
1408             return 0;
1409         ctx->p2 = str_value_map[i].ptr;
1410         ctx->p1 = strlen(ctx->p2);
1411     }
1412
1413     if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1414         return ret;
1415
1416     if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1417         || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1418         size_t i;
1419
1420         for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1421             if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1422                 break;
1423         }
1424         if (i == OSSL_NELEM(str_value_map))
1425             return 0;
1426         if (state == POST_CTRL_TO_PARAMS)
1427             ret = str_value_map[i].id;
1428         else
1429             ctx->p1 = str_value_map[i].id;
1430         ctx->p2 = NULL;
1431     }
1432
1433     return 1;
1434 }
1435
1436 /*-
1437  * Payload getters
1438  * ===============
1439  *
1440  * These all get the data they want, then call default_fixup_args() as
1441  * a post-ctrl GET fixup.  They all get NULL ctx, ctrl_cmd, ctrl_str,
1442  * p1, sz
1443  */
1444
1445 /* Pilfering DH, DSA and EC_KEY */
1446 static int get_payload_group_name(enum state state,
1447                                   const struct translation_st *translation,
1448                                   struct translation_ctx_st *ctx)
1449 {
1450     EVP_PKEY *pkey = ctx->p2;
1451
1452     ctx->p2 = NULL;
1453     switch (EVP_PKEY_base_id(pkey)) {
1454 #ifndef OPENSSL_NO_DH
1455     case EVP_PKEY_DH:
1456         {
1457             const DH *dh = EVP_PKEY_get0_DH(pkey);
1458             int uid = DH_get_nid(dh);
1459
1460             if (uid != NID_undef) {
1461                 const DH_NAMED_GROUP *dh_group =
1462                     ossl_ffc_uid_to_dh_named_group(uid);
1463
1464                 ctx->p2 = (char *)ossl_ffc_named_group_get_name(dh_group);
1465             }
1466         }
1467         break;
1468 #endif
1469 #ifndef OPENSSL_NO_EC
1470     case EVP_PKEY_EC:
1471         {
1472             const EC_GROUP *grp =
1473                 EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
1474             int nid = NID_undef;
1475
1476             if (grp != NULL)
1477                 nid = EC_GROUP_get_curve_name(grp);
1478             if (nid != NID_undef)
1479                 ctx->p2 = (char *)ossl_ec_curve_nid2name(nid);
1480         }
1481         break;
1482 #endif
1483     default:
1484         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1485         return 0;
1486     }
1487
1488     /*
1489      * Quietly ignoring unknown groups matches the behaviour on the provider
1490      * side.
1491      */
1492     if (ctx->p2 == NULL)
1493         return 1;
1494
1495     ctx->p1 = strlen(ctx->p2);
1496     return default_fixup_args(state, translation, ctx);
1497 }
1498
1499 static int get_payload_private_key(enum state state,
1500                                    const struct translation_st *translation,
1501                                    struct translation_ctx_st *ctx)
1502 {
1503     EVP_PKEY *pkey = ctx->p2;
1504
1505     ctx->p2 = NULL;
1506     if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1507         return 0;
1508
1509     switch (EVP_PKEY_base_id(pkey)) {
1510 #ifndef OPENSSL_NO_DH
1511     case EVP_PKEY_DH:
1512         {
1513             const DH *dh = EVP_PKEY_get0_DH(pkey);
1514
1515             ctx->p2 = (BIGNUM *)DH_get0_priv_key(dh);
1516         }
1517         break;
1518 #endif
1519 #ifndef OPENSSL_NO_EC
1520     case EVP_PKEY_EC:
1521         {
1522             const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1523
1524             ctx->p2 = (BIGNUM *)EC_KEY_get0_private_key(ec);
1525         }
1526         break;
1527 #endif
1528     default:
1529         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1530         return 0;
1531     }
1532
1533     return default_fixup_args(state, translation, ctx);
1534 }
1535
1536 static int get_payload_public_key(enum state state,
1537                                   const struct translation_st *translation,
1538                                   struct translation_ctx_st *ctx)
1539 {
1540     EVP_PKEY *pkey = ctx->p2;
1541     unsigned char *buf = NULL;
1542     int ret;
1543
1544     ctx->p2 = NULL;
1545     switch (EVP_PKEY_base_id(pkey)) {
1546 #ifndef OPENSSL_NO_DH
1547     case EVP_PKEY_DH:
1548         switch (ctx->params->data_type) {
1549         case OSSL_PARAM_OCTET_STRING:
1550             ctx->sz = ossl_dh_key2buf(EVP_PKEY_get0_DH(pkey), &buf, 0, 1);
1551             ctx->p2 = buf;
1552             break;
1553         case OSSL_PARAM_UNSIGNED_INTEGER:
1554             ctx->p2 = (void *)DH_get0_pub_key(EVP_PKEY_get0_DH(pkey));
1555             break;
1556         default:
1557             return 0;
1558         }
1559         break;
1560 #endif
1561 #ifndef OPENSSL_NO_DSA
1562     case EVP_PKEY_DSA:
1563         if (ctx->params->data_type == OSSL_PARAM_UNSIGNED_INTEGER) {
1564             ctx->p2 = (void *)DSA_get0_pub_key(EVP_PKEY_get0_DSA(pkey));
1565             break;
1566         }
1567         return 0;
1568 #endif
1569 #ifndef OPENSSL_NO_EC
1570     case EVP_PKEY_EC:
1571         if (ctx->params->data_type == OSSL_PARAM_OCTET_STRING) {
1572             const EC_KEY *eckey = EVP_PKEY_get0_EC_KEY(pkey);
1573             BN_CTX *bnctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eckey));
1574             const EC_GROUP *ecg = EC_KEY_get0_group(eckey);
1575             const EC_POINT *point = EC_KEY_get0_public_key(eckey);
1576
1577             ctx->sz = EC_POINT_point2buf(ecg, point,
1578                                          POINT_CONVERSION_COMPRESSED,
1579                                          &buf, bnctx);
1580             ctx->p2 = buf;
1581             break;
1582         }
1583         return 0;
1584 #endif
1585     default:
1586         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1587         return 0;
1588     }
1589
1590     ret = default_fixup_args(state, translation, ctx);
1591     OPENSSL_free(buf);
1592     return ret;
1593 }
1594
1595 static int get_payload_bn(enum state state,
1596                           const struct translation_st *translation,
1597                           struct translation_ctx_st *ctx, const BIGNUM *bn)
1598 {
1599     if (bn == NULL)
1600         return 0;
1601     if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1602         return 0;
1603     ctx->p2 = (BIGNUM *)bn;
1604
1605     return default_fixup_args(state, translation, ctx);
1606 }
1607
1608 static int get_dh_dsa_payload_p(enum state state,
1609                                 const struct translation_st *translation,
1610                                 struct translation_ctx_st *ctx)
1611 {
1612     const BIGNUM *bn = NULL;
1613     EVP_PKEY *pkey = ctx->p2;
1614
1615     switch (EVP_PKEY_base_id(pkey)) {
1616 #ifndef OPENSSL_NO_DH
1617     case EVP_PKEY_DH:
1618         bn = DH_get0_p(EVP_PKEY_get0_DH(pkey));
1619         break;
1620 #endif
1621 #ifndef OPENSSL_NO_DSA
1622     case EVP_PKEY_DSA:
1623         bn = DSA_get0_p(EVP_PKEY_get0_DSA(pkey));
1624         break;
1625 #endif
1626     default:
1627         ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1628     }
1629
1630     return get_payload_bn(state, translation, ctx, bn);
1631 }
1632
1633 static int get_dh_dsa_payload_q(enum state state,
1634                                 const struct translation_st *translation,
1635                                 struct translation_ctx_st *ctx)
1636 {
1637     const BIGNUM *bn = NULL;
1638
1639     switch (EVP_PKEY_base_id(ctx->p2)) {
1640 #ifndef OPENSSL_NO_DH
1641     case EVP_PKEY_DH:
1642         bn = DH_get0_q(EVP_PKEY_get0_DH(ctx->p2));
1643         break;
1644 #endif
1645 #ifndef OPENSSL_NO_DSA
1646     case EVP_PKEY_DSA:
1647         bn = DSA_get0_q(EVP_PKEY_get0_DSA(ctx->p2));
1648         break;
1649 #endif
1650     }
1651
1652     return get_payload_bn(state, translation, ctx, bn);
1653 }
1654
1655 static int get_dh_dsa_payload_g(enum state state,
1656                                 const struct translation_st *translation,
1657                                 struct translation_ctx_st *ctx)
1658 {
1659     const BIGNUM *bn = NULL;
1660
1661     switch (EVP_PKEY_base_id(ctx->p2)) {
1662 #ifndef OPENSSL_NO_DH
1663     case EVP_PKEY_DH:
1664         bn = DH_get0_g(EVP_PKEY_get0_DH(ctx->p2));
1665         break;
1666 #endif
1667 #ifndef OPENSSL_NO_DSA
1668     case EVP_PKEY_DSA:
1669         bn = DSA_get0_g(EVP_PKEY_get0_DSA(ctx->p2));
1670         break;
1671 #endif
1672     }
1673
1674     return get_payload_bn(state, translation, ctx, bn);
1675 }
1676
1677 static int get_rsa_payload_n(enum state state,
1678                              const struct translation_st *translation,
1679                              struct translation_ctx_st *ctx)
1680 {
1681     const BIGNUM *bn = NULL;
1682
1683     if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)
1684         return 0;
1685     bn = RSA_get0_n(EVP_PKEY_get0_RSA(ctx->p2));
1686
1687     return get_payload_bn(state, translation, ctx, bn);
1688 }
1689
1690 static int get_rsa_payload_e(enum state state,
1691                              const struct translation_st *translation,
1692                              struct translation_ctx_st *ctx)
1693 {
1694     const BIGNUM *bn = NULL;
1695
1696     if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)
1697         return 0;
1698     bn = RSA_get0_e(EVP_PKEY_get0_RSA(ctx->p2));
1699
1700     return get_payload_bn(state, translation, ctx, bn);
1701 }
1702
1703 static int get_rsa_payload_d(enum state state,
1704                              const struct translation_st *translation,
1705                              struct translation_ctx_st *ctx)
1706 {
1707     const BIGNUM *bn = NULL;
1708
1709     if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)
1710         return 0;
1711     bn = RSA_get0_d(EVP_PKEY_get0_RSA(ctx->p2));
1712
1713     return get_payload_bn(state, translation, ctx, bn);
1714 }
1715
1716 static int get_rsa_payload_factor(enum state state,
1717                                   const struct translation_st *translation,
1718                                   struct translation_ctx_st *ctx,
1719                                   size_t factornum)
1720 {
1721     const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1722     const BIGNUM *bn = NULL;
1723
1724     switch (factornum) {
1725     case 0:
1726         bn = RSA_get0_p(r);
1727         break;
1728     case 1:
1729         bn = RSA_get0_q(r);
1730         break;
1731     default:
1732         {
1733             size_t pnum = RSA_get_multi_prime_extra_count(r);
1734             const BIGNUM *factors[10];
1735
1736             if (factornum - 2 < pnum
1737                 && RSA_get0_multi_prime_factors(r, factors))
1738                 bn = factors[factornum - 2];
1739         }
1740         break;
1741     }
1742
1743     return get_payload_bn(state, translation, ctx, bn);
1744 }
1745
1746 static int get_rsa_payload_exponent(enum state state,
1747                                     const struct translation_st *translation,
1748                                     struct translation_ctx_st *ctx,
1749                                     size_t exponentnum)
1750 {
1751     const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1752     const BIGNUM *bn = NULL;
1753
1754     switch (exponentnum) {
1755     case 0:
1756         bn = RSA_get0_dmp1(r);
1757         break;
1758     case 1:
1759         bn = RSA_get0_dmq1(r);
1760         break;
1761     default:
1762         {
1763             size_t pnum = RSA_get_multi_prime_extra_count(r);
1764             const BIGNUM *exps[10], *coeffs[10];
1765
1766             if (exponentnum - 2 < pnum
1767                 && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1768                 bn = exps[exponentnum - 2];
1769         }
1770         break;
1771     }
1772
1773     return get_payload_bn(state, translation, ctx, bn);
1774 }
1775
1776 static int get_rsa_payload_coefficient(enum state state,
1777                                        const struct translation_st *translation,
1778                                        struct translation_ctx_st *ctx,
1779                                        size_t coefficientnum)
1780 {
1781     const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1782     const BIGNUM *bn = NULL;
1783
1784     switch (coefficientnum) {
1785     case 0:
1786         bn = RSA_get0_iqmp(r);
1787         break;
1788     default:
1789         {
1790             size_t pnum = RSA_get_multi_prime_extra_count(r);
1791             const BIGNUM *exps[10], *coeffs[10];
1792
1793             if (coefficientnum - 1 < pnum
1794                 && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1795                 bn = coeffs[coefficientnum - 1];
1796         }
1797         break;
1798     }
1799
1800     return get_payload_bn(state, translation, ctx, bn);
1801 }
1802
1803 #define IMPL_GET_RSA_PAYLOAD_FACTOR(n)                                  \
1804     static int                                                          \
1805     get_rsa_payload_f##n(enum state state,                              \
1806                          const struct translation_st *translation,      \
1807                          struct translation_ctx_st *ctx)                \
1808     {                                                                   \
1809         if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)                  \
1810             return 0;                                                   \
1811         return get_rsa_payload_factor(state, translation, ctx, n - 1);  \
1812     }
1813
1814 #define IMPL_GET_RSA_PAYLOAD_EXPONENT(n)                                \
1815     static int                                                          \
1816     get_rsa_payload_e##n(enum state state,                              \
1817                          const struct translation_st *translation,      \
1818                          struct translation_ctx_st *ctx)                \
1819     {                                                                   \
1820         if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)                  \
1821             return 0;                                                   \
1822         return get_rsa_payload_exponent(state, translation, ctx,        \
1823                                         n - 1);                         \
1824     }
1825
1826 #define IMPL_GET_RSA_PAYLOAD_COEFFICIENT(n)                             \
1827     static int                                                          \
1828     get_rsa_payload_c##n(enum state state,                              \
1829                          const struct translation_st *translation,      \
1830                          struct translation_ctx_st *ctx)                \
1831     {                                                                   \
1832         if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)                  \
1833             return 0;                                                   \
1834         return get_rsa_payload_coefficient(state, translation, ctx,     \
1835                                            n - 1);                      \
1836     }
1837
1838 IMPL_GET_RSA_PAYLOAD_FACTOR(1)
1839 IMPL_GET_RSA_PAYLOAD_FACTOR(2)
1840 IMPL_GET_RSA_PAYLOAD_FACTOR(3)
1841 IMPL_GET_RSA_PAYLOAD_FACTOR(4)
1842 IMPL_GET_RSA_PAYLOAD_FACTOR(5)
1843 IMPL_GET_RSA_PAYLOAD_FACTOR(6)
1844 IMPL_GET_RSA_PAYLOAD_FACTOR(7)
1845 IMPL_GET_RSA_PAYLOAD_FACTOR(8)
1846 IMPL_GET_RSA_PAYLOAD_FACTOR(9)
1847 IMPL_GET_RSA_PAYLOAD_FACTOR(10)
1848 IMPL_GET_RSA_PAYLOAD_EXPONENT(1)
1849 IMPL_GET_RSA_PAYLOAD_EXPONENT(2)
1850 IMPL_GET_RSA_PAYLOAD_EXPONENT(3)
1851 IMPL_GET_RSA_PAYLOAD_EXPONENT(4)
1852 IMPL_GET_RSA_PAYLOAD_EXPONENT(5)
1853 IMPL_GET_RSA_PAYLOAD_EXPONENT(6)
1854 IMPL_GET_RSA_PAYLOAD_EXPONENT(7)
1855 IMPL_GET_RSA_PAYLOAD_EXPONENT(8)
1856 IMPL_GET_RSA_PAYLOAD_EXPONENT(9)
1857 IMPL_GET_RSA_PAYLOAD_EXPONENT(10)
1858 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(1)
1859 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(2)
1860 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(3)
1861 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(4)
1862 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(5)
1863 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(6)
1864 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(7)
1865 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(8)
1866 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(9)
1867
1868 /*-
1869  * The translation table itself
1870  * ============================
1871  */
1872
1873 static const struct translation_st evp_pkey_ctx_translations[] = {
1874     /*
1875      * DistID: we pass it to the backend as an octet string,
1876      * but get it back as a pointer to an octet string.
1877      *
1878      * Note that the EVP_PKEY_CTRL_GET1_ID_LEN is purely for legacy purposes
1879      * that has no separate counterpart in OSSL_PARAM terms, since we get
1880      * the length of the DistID automatically when getting the DistID itself.
1881      */
1882     { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
1883       EVP_PKEY_CTRL_SET1_ID, "distid", "hexdistid",
1884       OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_STRING, NULL },
1885     { GET, -1, -1, -1,
1886       EVP_PKEY_CTRL_GET1_ID, "distid", "hexdistid",
1887       OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, NULL },
1888     { GET, -1, -1, -1,
1889       EVP_PKEY_CTRL_GET1_ID_LEN, NULL, NULL,
1890       OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, fix_distid_len },
1891
1892     /*-
1893      * DH & DHX
1894      * ========
1895      */
1896
1897     /*
1898      * EVP_PKEY_CTRL_DH_KDF_TYPE is used both for setting and getting.  The
1899      * fixup function has to handle this...
1900      */
1901     { NONE, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1902       EVP_PKEY_CTRL_DH_KDF_TYPE, NULL, NULL,
1903       OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING,
1904       fix_dh_kdf_type },
1905     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1906       EVP_PKEY_CTRL_DH_KDF_MD, NULL, NULL,
1907       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1908     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1909       EVP_PKEY_CTRL_GET_DH_KDF_MD, NULL, NULL,
1910       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1911     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1912       EVP_PKEY_CTRL_DH_KDF_OUTLEN, NULL, NULL,
1913       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1914     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1915       EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, NULL, NULL,
1916       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1917     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1918       EVP_PKEY_CTRL_DH_KDF_UKM, NULL, NULL,
1919       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
1920     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1921       EVP_PKEY_CTRL_GET_DH_KDF_UKM, NULL, NULL,
1922       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
1923     { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1924       EVP_PKEY_CTRL_DH_KDF_OID, NULL, NULL,
1925       OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
1926     { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1927       EVP_PKEY_CTRL_GET_DH_KDF_OID, NULL, NULL,
1928       OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
1929
1930     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_DERIVE,
1931       EVP_PKEY_CTRL_DH_PAD, "dh_pad", NULL,
1932       OSSL_EXCHANGE_PARAM_PAD, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1933
1934     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
1935       EVP_PKEY_CTRL_DH_NID, "dh_param", NULL,
1936       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid },
1937     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1938       EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, NULL, NULL,
1939       OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1940     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1941       EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, "dh_paramgen_subprime_len", NULL,
1942       OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1943     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1944       EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, "dh_paramgen_generator", NULL,
1945       OSSL_PKEY_PARAM_DH_GENERATOR, OSSL_PARAM_INTEGER, NULL },
1946     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1947       EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, "dh_paramgen_type", NULL,
1948       OSSL_PKEY_PARAM_FFC_TYPE, OSSL_PARAM_UTF8_STRING, fix_dh_paramgen_type },
1949  /*
1950   * This is know to be incorrect, will be fixed and enabled when the
1951   * underlying code is corrected.
1952   * Until then, we simply don't support it here.
1953   */
1954 #if 0
1955     { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1956       EVP_PKEY_CTRL_DH_RFC5114, "dh_rfc5114", NULL,
1957       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_INTEGER, NULL },
1958 #endif
1959
1960     /*-
1961      * DSA
1962      * ===
1963      */
1964     { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
1965       EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, "dsa_paramgen_bits", NULL,
1966       OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1967     { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
1968       EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, "dsa_paramgen_q_bits", NULL,
1969       OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1970     { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
1971       EVP_PKEY_CTRL_DSA_PARAMGEN_MD, "dsa_paramgen_md", NULL,
1972       OSSL_PKEY_PARAM_FFC_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1973
1974     /*-
1975      * EC
1976      * ==
1977      */
1978     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
1979       EVP_PKEY_CTRL_EC_PARAM_ENC, "ec_param_enc", NULL,
1980       OSSL_PKEY_PARAM_EC_ENCODING, OSSL_PARAM_UTF8_STRING, fix_ec_param_enc },
1981     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
1982       EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, "ec_paramgen_curve", NULL,
1983       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
1984       fix_ec_paramgen_curve_nid },
1985     /*
1986      * EVP_PKEY_CTRL_EC_ECDH_COFACTOR and EVP_PKEY_CTRL_EC_KDF_TYPE are used
1987      * both for setting and getting.  The fixup function has to handle this...
1988      */
1989     { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
1990       EVP_PKEY_CTRL_EC_ECDH_COFACTOR, "ecdh_cofactor_mode", NULL,
1991       OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE, OSSL_PARAM_INTEGER,
1992       fix_ecdh_cofactor },
1993     { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
1994       EVP_PKEY_CTRL_EC_KDF_TYPE, NULL, NULL,
1995       OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING, fix_ec_kdf_type },
1996     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
1997       EVP_PKEY_CTRL_EC_KDF_MD, "ecdh_kdf_md", NULL,
1998       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1999     { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2000       EVP_PKEY_CTRL_GET_EC_KDF_MD, NULL, NULL,
2001       OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2002     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2003       EVP_PKEY_CTRL_EC_KDF_OUTLEN, NULL, NULL,
2004       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2005     { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2006       EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, NULL, NULL,
2007       OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2008     { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2009       EVP_PKEY_CTRL_EC_KDF_UKM, NULL, NULL,
2010       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
2011     { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2012       EVP_PKEY_CTRL_GET_EC_KDF_UKM, NULL, NULL,
2013       OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
2014
2015     /*-
2016      * RSA
2017      * ===
2018      */
2019
2020     /*
2021      * RSA padding modes are numeric with ctrls, strings with ctrl_strs,
2022      * and can be both with OSSL_PARAM.  We standardise on strings here,
2023      * fix_rsa_padding_mode() does the work when the caller has a different
2024      * idea.
2025      */
2026     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2027       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2028       EVP_PKEY_CTRL_RSA_PADDING, "rsa_padding_mode", NULL,
2029       OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2030     { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2031       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2032       EVP_PKEY_CTRL_GET_RSA_PADDING, NULL, NULL,
2033       OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2034
2035     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2036       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2037       EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_mgf1_md", NULL,
2038       OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2039     { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2040       EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2041       EVP_PKEY_CTRL_GET_RSA_MGF1_MD, NULL, NULL,
2042       OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2043
2044     /*
2045      * RSA-PSS saltlen is essentially numeric, but certain values can be
2046      * expressed as keywords (strings) with ctrl_str.  The corresponding
2047      * OSSL_PARAM allows both forms.
2048      * fix_rsa_pss_saltlen() takes care of the distinction.
2049      */
2050     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2051       EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_saltlen", NULL,
2052       OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2053       fix_rsa_pss_saltlen },
2054     { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2055       EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN, NULL, NULL,
2056       OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2057       fix_rsa_pss_saltlen },
2058
2059     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2060       EVP_PKEY_CTRL_RSA_OAEP_MD, "rsa_oaep_md", NULL,
2061       OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2062     { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2063       EVP_PKEY_CTRL_GET_RSA_OAEP_MD, NULL, NULL,
2064       OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2065     /*
2066      * The "rsa_oaep_label" ctrl_str expects the value to always be hex.
2067      * This is accomodated by default_fixup_args() above, which mimics that
2068      * expectation for any translation item where |ctrl_str| is NULL and
2069      * |ctrl_hexstr| is non-NULL.
2070      */
2071     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2072       EVP_PKEY_CTRL_RSA_OAEP_LABEL, NULL, "rsa_oaep_label",
2073       OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2074     { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2075       EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL, NULL, NULL,
2076       OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2077
2078     { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2079       EVP_PKEY_CTRL_MD, "rsa_pss_keygen_md", NULL,
2080       OSSL_ALG_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2081     { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2082       EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_pss_keygen_mgf1_md", NULL,
2083       OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2084     { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2085       EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_keygen_saltlen", NULL,
2086       OSSL_SIGNATURE_PARAM_PSS_SALTLEN, OSSL_PARAM_INTEGER, NULL },
2087     { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN,
2088       EVP_PKEY_CTRL_RSA_KEYGEN_BITS, "rsa_keygen_bits", NULL,
2089       OSSL_PKEY_PARAM_RSA_BITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2090     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_KEYGEN,
2091       EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, "rsa_keygen_pubexp", NULL,
2092       OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2093     { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_KEYGEN,
2094       EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES, "rsa_keygen_primes", NULL,
2095       OSSL_PKEY_PARAM_RSA_PRIMES, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2096
2097     /*-
2098      * SipHash
2099      * ======
2100      */
2101     { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2102       EVP_PKEY_CTRL_SET_DIGEST_SIZE, "digestsize", NULL,
2103       OSSL_MAC_PARAM_SIZE, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2104
2105     /*-
2106      * TLS1-PRF
2107      * ========
2108      */
2109     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2110       EVP_PKEY_CTRL_TLS_MD, "md", NULL,
2111       OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2112     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2113       EVP_PKEY_CTRL_TLS_SECRET, "secret", "hexsecret",
2114       OSSL_KDF_PARAM_SECRET, OSSL_PARAM_OCTET_STRING, NULL },
2115     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2116       EVP_PKEY_CTRL_TLS_SEED, "seed", "hexseed",
2117       OSSL_KDF_PARAM_SEED, OSSL_PARAM_OCTET_STRING, NULL },
2118
2119     /*-
2120      * HKDF
2121      * ====
2122      */
2123     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2124       EVP_PKEY_CTRL_HKDF_MD, "md", NULL,
2125       OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2126     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2127       EVP_PKEY_CTRL_HKDF_SALT, "salt", "hexsalt",
2128       OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2129     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2130       EVP_PKEY_CTRL_HKDF_KEY, "key", "hexkey",
2131       OSSL_KDF_PARAM_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2132     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2133       EVP_PKEY_CTRL_HKDF_INFO, "info", "hexinfo",
2134       OSSL_KDF_PARAM_INFO, OSSL_PARAM_OCTET_STRING, NULL },
2135     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2136       EVP_PKEY_CTRL_HKDF_MODE, "mode", NULL,
2137       OSSL_KDF_PARAM_MODE, OSSL_PARAM_INTEGER, fix_hkdf_mode },
2138
2139     /*-
2140      * Scrypt
2141      * ======
2142      */
2143     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2144       EVP_PKEY_CTRL_PASS, "pass", "hexpass",
2145       OSSL_KDF_PARAM_PASSWORD, OSSL_PARAM_OCTET_STRING, NULL },
2146     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2147       EVP_PKEY_CTRL_SCRYPT_SALT, "salt", "hexsalt",
2148       OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2149     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2150       EVP_PKEY_CTRL_SCRYPT_N, "N", NULL,
2151       OSSL_KDF_PARAM_SCRYPT_N, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2152     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2153       EVP_PKEY_CTRL_SCRYPT_R, "r", NULL,
2154       OSSL_KDF_PARAM_SCRYPT_R, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2155     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2156       EVP_PKEY_CTRL_SCRYPT_P, "p", NULL,
2157       OSSL_KDF_PARAM_SCRYPT_P, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2158     { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2159       EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, "maxmem_bytes", NULL,
2160       OSSL_KDF_PARAM_SCRYPT_MAXMEM, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2161
2162     { SET, -1, -1, EVP_PKEY_OP_KEYGEN | EVP_PKEY_OP_TYPE_CRYPT,
2163       EVP_PKEY_CTRL_CIPHER, NULL, NULL,
2164       OSSL_PKEY_PARAM_CIPHER, OSSL_PARAM_UTF8_STRING, fix_cipher },
2165     { SET, -1, -1, EVP_PKEY_OP_KEYGEN,
2166       EVP_PKEY_CTRL_SET_MAC_KEY, NULL, NULL,
2167       OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2168
2169     { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2170       EVP_PKEY_CTRL_MD, NULL, NULL,
2171       OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2172     { GET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2173       EVP_PKEY_CTRL_GET_MD, NULL, NULL,
2174       OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2175 };
2176
2177 static const struct translation_st evp_pkey_translations[] = {
2178     /*
2179      * The following contain no ctrls, they are exclusively here to extract
2180      * key payloads from legacy keys, using OSSL_PARAMs, and rely entirely
2181      * on |fixup_args| to pass the actual data.  The |fixup_args| should
2182      * expect to get the EVP_PKEY pointer through |ctx->p2|.
2183      */
2184
2185     /* DH, DSA & EC */
2186     { GET, -1, -1, -1, 0, NULL, NULL,
2187       OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2188       get_payload_group_name },
2189     { GET, -1, -1, -1, 0, NULL, NULL,
2190       OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_UNSIGNED_INTEGER,
2191       get_payload_private_key },
2192     { GET, -1, -1, -1, 0, NULL, NULL,
2193       OSSL_PKEY_PARAM_PUB_KEY,
2194       0 /* no data type, let get_payload_pub_key() handle that */,
2195       get_payload_public_key },
2196
2197     /* DH and DSA */
2198     { GET, -1, -1, -1, 0, NULL, NULL,
2199       OSSL_PKEY_PARAM_FFC_P, OSSL_PARAM_UNSIGNED_INTEGER,
2200       get_dh_dsa_payload_p },
2201     { GET, -1, -1, -1, 0, NULL, NULL,
2202       OSSL_PKEY_PARAM_FFC_G, OSSL_PARAM_UNSIGNED_INTEGER,
2203       get_dh_dsa_payload_g },
2204     { GET, -1, -1, -1, 0, NULL, NULL,
2205       OSSL_PKEY_PARAM_FFC_Q, OSSL_PARAM_UNSIGNED_INTEGER,
2206       get_dh_dsa_payload_q },
2207
2208     /* RSA */
2209     { GET, -1, -1, -1, 0, NULL, NULL,
2210       OSSL_PKEY_PARAM_RSA_N, OSSL_PARAM_UNSIGNED_INTEGER,
2211       get_rsa_payload_n },
2212     { GET, -1, -1, -1, 0, NULL, NULL,
2213       OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER,
2214       get_rsa_payload_e },
2215     { GET, -1, -1, -1, 0, NULL, NULL,
2216       OSSL_PKEY_PARAM_RSA_D, OSSL_PARAM_UNSIGNED_INTEGER,
2217       get_rsa_payload_d },
2218     { GET, -1, -1, -1, 0, NULL, NULL,
2219       OSSL_PKEY_PARAM_RSA_FACTOR1, OSSL_PARAM_UNSIGNED_INTEGER,
2220       get_rsa_payload_f1 },
2221     { GET, -1, -1, -1, 0, NULL, NULL,
2222       OSSL_PKEY_PARAM_RSA_FACTOR2, OSSL_PARAM_UNSIGNED_INTEGER,
2223       get_rsa_payload_f2 },
2224     { GET, -1, -1, -1, 0, NULL, NULL,
2225       OSSL_PKEY_PARAM_RSA_FACTOR3, OSSL_PARAM_UNSIGNED_INTEGER,
2226       get_rsa_payload_f3 },
2227     { GET, -1, -1, -1, 0, NULL, NULL,
2228       OSSL_PKEY_PARAM_RSA_FACTOR4, OSSL_PARAM_UNSIGNED_INTEGER,
2229       get_rsa_payload_f4 },
2230     { GET, -1, -1, -1, 0, NULL, NULL,
2231       OSSL_PKEY_PARAM_RSA_FACTOR5, OSSL_PARAM_UNSIGNED_INTEGER,
2232       get_rsa_payload_f5 },
2233     { GET, -1, -1, -1, 0, NULL, NULL,
2234       OSSL_PKEY_PARAM_RSA_FACTOR6, OSSL_PARAM_UNSIGNED_INTEGER,
2235       get_rsa_payload_f6 },
2236     { GET, -1, -1, -1, 0, NULL, NULL,
2237       OSSL_PKEY_PARAM_RSA_FACTOR7, OSSL_PARAM_UNSIGNED_INTEGER,
2238       get_rsa_payload_f7 },
2239     { GET, -1, -1, -1, 0, NULL, NULL,
2240       OSSL_PKEY_PARAM_RSA_FACTOR8, OSSL_PARAM_UNSIGNED_INTEGER,
2241       get_rsa_payload_f8 },
2242     { GET, -1, -1, -1, 0, NULL, NULL,
2243       OSSL_PKEY_PARAM_RSA_FACTOR9, OSSL_PARAM_UNSIGNED_INTEGER,
2244       get_rsa_payload_f9 },
2245     { GET, -1, -1, -1, 0, NULL, NULL,
2246       OSSL_PKEY_PARAM_RSA_FACTOR10, OSSL_PARAM_UNSIGNED_INTEGER,
2247       get_rsa_payload_f10 },
2248     { GET, -1, -1, -1, 0, NULL, NULL,
2249       OSSL_PKEY_PARAM_RSA_EXPONENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2250       get_rsa_payload_e1 },
2251     { GET, -1, -1, -1, 0, NULL, NULL,
2252       OSSL_PKEY_PARAM_RSA_EXPONENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2253       get_rsa_payload_e2 },
2254     { GET, -1, -1, -1, 0, NULL, NULL,
2255       OSSL_PKEY_PARAM_RSA_EXPONENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2256       get_rsa_payload_e3 },
2257     { GET, -1, -1, -1, 0, NULL, NULL,
2258       OSSL_PKEY_PARAM_RSA_EXPONENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2259       get_rsa_payload_e4 },
2260     { GET, -1, -1, -1, 0, NULL, NULL,
2261       OSSL_PKEY_PARAM_RSA_EXPONENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2262       get_rsa_payload_e5 },
2263     { GET, -1, -1, -1, 0, NULL, NULL,
2264       OSSL_PKEY_PARAM_RSA_EXPONENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2265       get_rsa_payload_e6 },
2266     { GET, -1, -1, -1, 0, NULL, NULL,
2267       OSSL_PKEY_PARAM_RSA_EXPONENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2268       get_rsa_payload_e7 },
2269     { GET, -1, -1, -1, 0, NULL, NULL,
2270       OSSL_PKEY_PARAM_RSA_EXPONENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2271       get_rsa_payload_e8 },
2272     { GET, -1, -1, -1, 0, NULL, NULL,
2273       OSSL_PKEY_PARAM_RSA_EXPONENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2274       get_rsa_payload_e9 },
2275     { GET, -1, -1, -1, 0, NULL, NULL,
2276       OSSL_PKEY_PARAM_RSA_EXPONENT10, OSSL_PARAM_UNSIGNED_INTEGER,
2277       get_rsa_payload_e10 },
2278     { GET, -1, -1, -1, 0, NULL, NULL,
2279       OSSL_PKEY_PARAM_RSA_COEFFICIENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2280       get_rsa_payload_c1 },
2281     { GET, -1, -1, -1, 0, NULL, NULL,
2282       OSSL_PKEY_PARAM_RSA_COEFFICIENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2283       get_rsa_payload_c2 },
2284     { GET, -1, -1, -1, 0, NULL, NULL,
2285       OSSL_PKEY_PARAM_RSA_COEFFICIENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2286       get_rsa_payload_c3 },
2287     { GET, -1, -1, -1, 0, NULL, NULL,
2288       OSSL_PKEY_PARAM_RSA_COEFFICIENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2289       get_rsa_payload_c4 },
2290     { GET, -1, -1, -1, 0, NULL, NULL,
2291       OSSL_PKEY_PARAM_RSA_COEFFICIENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2292       get_rsa_payload_c5 },
2293     { GET, -1, -1, -1, 0, NULL, NULL,
2294       OSSL_PKEY_PARAM_RSA_COEFFICIENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2295       get_rsa_payload_c6 },
2296     { GET, -1, -1, -1, 0, NULL, NULL,
2297       OSSL_PKEY_PARAM_RSA_COEFFICIENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2298       get_rsa_payload_c7 },
2299     { GET, -1, -1, -1, 0, NULL, NULL,
2300       OSSL_PKEY_PARAM_RSA_COEFFICIENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2301       get_rsa_payload_c8 },
2302     { GET, -1, -1, -1, 0, NULL, NULL,
2303       OSSL_PKEY_PARAM_RSA_COEFFICIENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2304       get_rsa_payload_c9 },
2305 };
2306
2307 static const struct translation_st *
2308 lookup_translation(struct translation_st *tmpl,
2309                    const struct translation_st *translations,
2310                    size_t translations_num)
2311 {
2312     size_t i;
2313
2314     for (i = 0; i < translations_num; i++) {
2315         const struct translation_st *item = &translations[i];
2316
2317         /*
2318          * Sanity check the translation table item.
2319          *
2320          * 1.  Either both keytypes are -1, or neither of them are.
2321          * 2.  TBA...
2322          */
2323         if (!ossl_assert((item->keytype1 == -1) == (item->keytype2 == -1)))
2324             continue;
2325
2326
2327         /*
2328          * Base search criteria: check that the optype and keytypes match,
2329          * if relevant.  All callers must synthesise these bits somehow.
2330          */
2331         if (item->optype != -1 && (tmpl->optype & item->optype) == 0)
2332             continue;
2333         /*
2334          * This expression is stunningly simple thanks to the sanity check
2335          * above.
2336          */
2337         if (item->keytype1 != -1
2338             && tmpl->keytype1 != item->keytype1
2339             && tmpl->keytype2 != item->keytype2)
2340             continue;
2341
2342         /*
2343          * Done with the base search criteria, now we check the criteria for
2344          * the individual types of translations:
2345          * ctrl->params, ctrl_str->params, and params->ctrl
2346          */
2347         if (tmpl->ctrl_num != 0) {
2348             if (tmpl->ctrl_num != item->ctrl_num)
2349                 continue;
2350         } else if (tmpl->ctrl_str != NULL) {
2351             const char *ctrl_str = NULL;
2352             const char *ctrl_hexstr = NULL;
2353
2354             /*
2355              * Search criteria that originates from a ctrl_str is only used
2356              * for setting, never for getting.  Therefore, we only look at
2357              * the setter items.
2358              */
2359             if (item->action_type != NONE
2360                 && item->action_type != SET)
2361                 continue;
2362             /*
2363              * At least one of the ctrl cmd names must be match the ctrl
2364              * cmd name in the template.
2365              */
2366             if (item->ctrl_str != NULL
2367                 && strcasecmp(tmpl->ctrl_str, item->ctrl_str) == 0)
2368                 ctrl_str = tmpl->ctrl_str;
2369             else if (item->ctrl_hexstr != NULL
2370                      && strcasecmp(tmpl->ctrl_hexstr, item->ctrl_hexstr) == 0)
2371                 ctrl_hexstr = tmpl->ctrl_hexstr;
2372             else
2373                 continue;
2374
2375             /* Modify the template to signal which string matched */
2376             tmpl->ctrl_str = ctrl_str;
2377             tmpl->ctrl_hexstr = ctrl_hexstr;
2378         } else if (tmpl->param_key != NULL) {
2379             /*
2380              * Search criteria that originates from a OSSL_PARAM setter or
2381              * getter.
2382              *
2383              * Ctrls were fundamentally bidirectional, with only the ctrl
2384              * command macro name implying direction (if you're lucky).
2385              * A few ctrl commands were even taking advantage of the
2386              * bidirectional nature, making the direction depend in the
2387              * value of the numeric argument.
2388              *
2389              * OSSL_PARAM functions are fundamentally different, in that
2390              * setters and getters are separated, so the data direction is
2391              * implied by the function that's used.  The same OSSL_PARAM
2392              * key name can therefore be used in both directions.  We must
2393              * therefore take the action type into account in this case.
2394              */
2395             if ((item->action_type != NONE
2396                  && tmpl->action_type != item->action_type)
2397                 || (item->param_key != NULL
2398                     && strcasecmp(tmpl->param_key, item->param_key) != 0))
2399                 continue;
2400         } else {
2401             return NULL;
2402         }
2403
2404         return item;
2405     }
2406
2407     return NULL;
2408 }
2409
2410 static const struct translation_st *
2411 lookup_evp_pkey_ctx_translation(struct translation_st *tmpl)
2412 {
2413     return lookup_translation(tmpl, evp_pkey_ctx_translations,
2414                               OSSL_NELEM(evp_pkey_ctx_translations));
2415 }
2416
2417 static const struct translation_st *
2418 lookup_evp_pkey_translation(struct translation_st *tmpl)
2419 {
2420     return lookup_translation(tmpl, evp_pkey_translations,
2421                               OSSL_NELEM(evp_pkey_translations));
2422 }
2423
2424 /* This must ONLY be called for provider side operations */
2425 int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX *pctx,
2426                                int keytype, int optype,
2427                                int cmd, int p1, void *p2)
2428 {
2429     struct translation_ctx_st ctx = { 0, };
2430     struct translation_st tmpl = { 0, };
2431     const struct translation_st *translation = NULL;
2432     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2433     int ret;
2434     fixup_args_fn *fixup = default_fixup_args;
2435
2436     if (keytype == -1)
2437         keytype = pctx->legacy_keytype;
2438     tmpl.ctrl_num = cmd;
2439     tmpl.keytype1 = tmpl.keytype2 = keytype;
2440     tmpl.optype = optype;
2441     translation = lookup_evp_pkey_ctx_translation(&tmpl);
2442
2443     if (translation == NULL) {
2444         ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
2445         return -2;
2446     }
2447
2448     if (pctx->pmeth != NULL
2449         && pctx->pmeth->pkey_id != translation->keytype1
2450         && pctx->pmeth->pkey_id != translation->keytype2)
2451         return -1;
2452
2453     if (translation->fixup_args != NULL)
2454         fixup = translation->fixup_args;
2455     ctx.action_type = translation->action_type;
2456     ctx.ctrl_cmd = cmd;
2457     ctx.p1 = p1;
2458     ctx.p2 = p2;
2459     ctx.pctx = pctx;
2460     ctx.params = params;
2461
2462     ret = fixup(PRE_CTRL_TO_PARAMS, translation, &ctx);
2463
2464     if (ret > 0) {
2465         switch (ctx.action_type) {
2466         default:
2467             /* fixup_args is expected to make sure this is dead code */
2468             break;
2469         case GET:
2470             ret = evp_pkey_ctx_get_params_strict(pctx, ctx.params);
2471             break;
2472         case SET:
2473             ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2474             break;
2475         }
2476     }
2477
2478     /*
2479      * In POST, we pass the return value as p1, allowing the fixup_args
2480      * function to affect it by changing its value.
2481      */
2482     if (ret > 0) {
2483         ctx.p1 = ret;
2484         fixup(POST_CTRL_TO_PARAMS, translation, &ctx);
2485         ret = ctx.p1;
2486     }
2487
2488     cleanup_translation_ctx(POST_CTRL_TO_PARAMS, translation, &ctx);
2489
2490     return ret;
2491 }
2492
2493 /* This must ONLY be called for provider side operations */
2494 int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX *pctx,
2495                                    const char *name, const char *value)
2496 {
2497     struct translation_ctx_st ctx = { 0, };
2498     struct translation_st tmpl = { 0, };
2499     const struct translation_st *translation = NULL;
2500     OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2501     int keytype = pctx->legacy_keytype;
2502     int optype = pctx->operation == 0 ? -1 : pctx->operation;
2503     int ret;
2504     fixup_args_fn *fixup = default_fixup_args;
2505
2506     tmpl.action_type = SET;
2507     tmpl.keytype1 = tmpl.keytype2 = keytype;
2508     tmpl.optype = optype;
2509     tmpl.ctrl_str = name;
2510     tmpl.ctrl_hexstr = name;
2511     translation = lookup_evp_pkey_ctx_translation(&tmpl);
2512
2513     if (translation != NULL) {
2514         if (translation->fixup_args != NULL)
2515             fixup = translation->fixup_args;
2516         ctx.action_type = translation->action_type;
2517         ctx.ishex = (tmpl.ctrl_hexstr != NULL);
2518     } else {
2519         /* String controls really only support setting */
2520         ctx.action_type = SET;
2521     }
2522     ctx.ctrl_str = name;
2523     ctx.p1 = (int)strlen(value);
2524     ctx.p2 = (char *)value;
2525     ctx.pctx = pctx;
2526     ctx.params = params;
2527
2528     ret = fixup(PRE_CTRL_STR_TO_PARAMS, translation, &ctx);
2529
2530     if (ret > 0) {
2531         switch (ctx.action_type) {
2532         default:
2533             /* fixup_args is expected to make sure this is dead code */
2534             break;
2535         case GET:
2536             /*
2537              * this is dead code, but must be present, or some compilers
2538              * will complain
2539              */
2540             break;
2541         case SET:
2542             ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2543             break;
2544         }
2545     }
2546
2547     if (ret > 0)
2548         ret = fixup(POST_CTRL_STR_TO_PARAMS, translation, &ctx);
2549
2550     cleanup_translation_ctx(CLEANUP_CTRL_STR_TO_PARAMS, translation, &ctx);
2551
2552     return ret;
2553 }
2554
2555 /* This must ONLY be called for legacy operations */
2556 static int evp_pkey_ctx_setget_params_to_ctrl(EVP_PKEY_CTX *pctx,
2557                                               enum action action_type,
2558                                               OSSL_PARAM *params)
2559 {
2560     int keytype = pctx->legacy_keytype;
2561     int optype = pctx->operation == 0 ? -1 : pctx->operation;
2562
2563     for (; params != NULL && params->key != NULL; params++) {
2564         struct translation_ctx_st ctx = { 0, };
2565         struct translation_st tmpl = { 0, };
2566         const struct translation_st *translation = NULL;
2567         fixup_args_fn *fixup = default_fixup_args;
2568         int ret;
2569
2570         tmpl.action_type = action_type;
2571         tmpl.keytype1 = tmpl.keytype2 = keytype;
2572         tmpl.optype = optype;
2573         tmpl.param_key = params->key;
2574         translation = lookup_evp_pkey_ctx_translation(&tmpl);
2575
2576         if (translation != NULL) {
2577             if (translation->fixup_args != NULL)
2578                 fixup = translation->fixup_args;
2579             ctx.action_type = translation->action_type;
2580         }
2581         ctx.pctx = pctx;
2582         ctx.params = params;
2583
2584         ret = fixup(PRE_PARAMS_TO_CTRL, translation, &ctx);
2585
2586         if (ret > 0 && action_type != NONE)
2587             ret = EVP_PKEY_CTX_ctrl(pctx, keytype, optype,
2588                                     ctx.ctrl_cmd, ctx.p1, ctx.p2);
2589
2590         /*
2591          * In POST, we pass the return value as p1, allowing the fixup_args
2592          * function to put it to good use, or maybe affect it.
2593          */
2594         if (ret > 0) {
2595             ctx.p1 = ret;
2596             fixup(POST_PARAMS_TO_CTRL, translation, &ctx);
2597             ret = ctx.p1;
2598         }
2599
2600         cleanup_translation_ctx(CLEANUP_PARAMS_TO_CTRL, translation, &ctx);
2601
2602         if (ret <= 0)
2603             return 0;
2604     }
2605     return 1;
2606 }
2607
2608 int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
2609 {
2610     return evp_pkey_ctx_setget_params_to_ctrl(ctx, SET, params);
2611 }
2612
2613 int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
2614 {
2615     return evp_pkey_ctx_setget_params_to_ctrl(ctx, GET, params);
2616 }
2617
2618 /* This must ONLY be called for legacy EVP_PKEYs */
2619 static int evp_pkey_setget_params_to_ctrl(const EVP_PKEY *pkey,
2620                                           enum action action_type,
2621                                           OSSL_PARAM *params)
2622 {
2623     int ret = 1;
2624
2625     for (; params != NULL && params->key != NULL; params++) {
2626         struct translation_ctx_st ctx = { 0, };
2627         struct translation_st tmpl = { 0, };
2628         const struct translation_st *translation = NULL;
2629         fixup_args_fn *fixup = default_fixup_args;
2630
2631         tmpl.action_type = action_type;
2632         tmpl.param_key = params->key;
2633         translation = lookup_evp_pkey_translation(&tmpl);
2634
2635         if (translation != NULL) {
2636             if (translation->fixup_args != NULL)
2637                 fixup = translation->fixup_args;
2638             ctx.action_type = translation->action_type;
2639         }
2640         ctx.p2 = (void *)pkey;
2641         ctx.params = params;
2642
2643         /*
2644          * EVP_PKEY doesn't have any ctrl function, so we rely completely
2645          * on fixup_args to do the whole work.  Also, we currently only
2646          * support getting.
2647          */
2648         if (!ossl_assert(translation != NULL)
2649             || !ossl_assert(translation->action_type == GET)
2650             || !ossl_assert(translation->fixup_args != NULL)) {
2651             return -2;
2652         }
2653
2654         ret = fixup(PKEY, translation, &ctx);
2655
2656         cleanup_translation_ctx(PKEY, translation, &ctx);
2657     }
2658     return ret;
2659 }
2660
2661 int evp_pkey_get_params_to_ctrl(const EVP_PKEY *pkey, OSSL_PARAM *params)
2662 {
2663     return evp_pkey_setget_params_to_ctrl(pkey, GET, params);
2664 }
2665