2 * Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
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
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.
16 #include "internal/deprecated.h"
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>
27 /* This include gets us all the OSSL_PARAM key string macros */
28 #include <openssl/core_names.h>
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"
40 #include "e_os.h" /* strcasecmp() for Windows */
42 struct translation_ctx_st; /* Forwarding */
43 struct translation_st; /* Forwarding */
46 * The fixup_args functions are called with the following parameters:
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
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().
58 * The |state| tells the fixup_args function something about the caller and
59 * what they may expect:
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
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
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, ...)
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|.
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().
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.
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:
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, ...)
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
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
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:
130 * 1. fixup_args(PRE_PARAMS_TO_CTRL, ...)
131 * 2. EVP_PKEY_CTX_ctrl()
132 * 3. fixup_args(POST_PARAMS_TO_CTRL, ...)
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|.
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.
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,
155 NONE = 0, GET = 1, SET = 2
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);
164 struct translation_ctx_st {
166 * The EVP_PKEY_CTX, for calls on that structure, to be pilfered for data
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.
175 enum action action_type;
177 * For ctrl to params translation, the actual ctrl command number used.
178 * For params to ctrl translation, 0.
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
188 const char *ctrl_str;
190 /* the ctrl-style int argument. */
192 /* the ctrl-style void* argument. */
194 /* a size, for passing back the |p2| size where applicable */
196 /* pointer to the OSSL_PARAM-style params array. */
200 * The following are used entirely internally by the fixup_args functions
201 * and should not be touched by the callers, at all.
205 * Copy of the ctrl-style void* argument, if the the fixup_args function
206 * needs to manipulate |p2| but wants to remember original.
209 /* Diverse types of storage for the needy. */
210 char name_buf[OSSL_MAX_NAME_SIZE];
216 struct translation_st {
218 * What this table item does.
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).
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.
229 enum action action_type;
232 * Conditions, for params->ctrl translations.
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.
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 */
244 * Lookup and translation attributes
246 * |ctrl_num|, |ctrl_str|, |ctrl_hexstr| and |param_key| are lookup
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
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.
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.
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 */
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
271 unsigned int param_data_type;
276 * |fixup_args| is always called before (for SET) or after (for GET)
277 * the actual ctrl / OSSL_PARAM function.
279 fixup_args_fn *fixup_args;
283 * Fixer function implementations
284 * ==============================
288 * default_check isn't a fixer per se, but rather a helper function to
289 * perform certain standard checks.
291 static int default_check(enum state state,
292 const struct translation_st *translation,
293 const struct translation_ctx_st *ctx)
298 case PRE_CTRL_TO_PARAMS:
299 if (!ossl_assert(translation != NULL)) {
300 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
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);
309 case PRE_CTRL_STR_TO_PARAMS:
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.
316 if (translation != NULL) {
317 if (!ossl_assert(translation->action_type != GET)) {
318 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
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);
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);
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);
341 /* Nothing else to check */
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.
353 * The following states and action type combinations have standard handling
354 * done in this function:
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
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
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.
386 static int default_fixup_args(enum state state,
387 const struct translation_st *translation,
388 struct translation_ctx_st *ctx)
392 if ((ret = default_check(state, translation, ctx)) < 0)
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);
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.
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) {
412 * No action type is an error here. That's a case for a
413 * special fixup function.
415 ERR_raise_data(ERR_LIB_EVP, ERR_R_UNSUPPORTED,
416 "[action:%d, state:%d]", ctx->action_type, state);
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)
430 * The following may be unnecessary, but we have them
431 * for good measure...
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 */
444 * OSSL_PARAM_construct_TYPE() works equally well for both SET and GET.
446 switch (translation->param_data_type) {
447 case OSSL_PARAM_INTEGER:
448 *ctx->params = OSSL_PARAM_construct_int(translation->param_key,
451 case OSSL_PARAM_UNSIGNED_INTEGER:
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
457 * Note that this allocates a buffer, which the cleanup function
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);
468 if (!BN_bn2nativepad(ctx->p2,
469 ctx->allocated_buf, ctx->buflen)) {
470 OPENSSL_free(ctx->allocated_buf);
471 ctx->allocated_buf = NULL;
475 OSSL_PARAM_construct_BN(translation->param_key,
480 * No support for getting a BIGNUM by ctrl, this needs
481 * fixup_args function support.
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);
491 OSSL_PARAM_construct_uint(translation->param_key,
492 (unsigned int *)&ctx->p1);
495 case OSSL_PARAM_UTF8_STRING:
497 OSSL_PARAM_construct_utf8_string(translation->param_key,
498 ctx->p2, (size_t)ctx->p1);
500 case OSSL_PARAM_UTF8_PTR:
502 OSSL_PARAM_construct_utf8_ptr(translation->param_key,
503 ctx->p2, (size_t)ctx->p1);
505 case OSSL_PARAM_OCTET_STRING:
507 OSSL_PARAM_construct_octet_string(translation->param_key,
508 ctx->p2, (size_t)ctx->p1);
510 case OSSL_PARAM_OCTET_PTR:
512 OSSL_PARAM_construct_octet_ptr(translation->param_key,
513 ctx->p2, (size_t)ctx->p1);
517 case POST_CTRL_TO_PARAMS:
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.
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;
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.
541 case PRE_CTRL_STR_TO_PARAMS:
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;
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);
559 * If no translation exists, we simply pass the control string
562 if (translation != NULL) {
563 tmp_ctrl_str = ctx->ctrl_str = translation->param_key;
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);
572 tmp_ctrl_str = ctx->name_buf;
576 settable = EVP_PKEY_CTX_settable_params(ctx->pctx);
577 if (!OSSL_PARAM_allocate_from_text(ctx->params, settable,
579 ctx->p2, strlen(ctx->p2),
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);
590 ctx->allocated_buf = ctx->params->data;
591 ctx->buflen = ctx->params->data_size;
594 case POST_CTRL_STR_TO_PARAMS:
595 /* Nothing to be done */
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
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.
611 case POST_PARAMS_TO_CTRL:
614 case PRE_PARAMS_TO_CTRL:
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 */
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))
630 /* Normal C unsigned int passed down */
631 if (!OSSL_PARAM_get_uint(ctx->params,
632 (unsigned int *)&ctx->p1))
636 case OSSL_PARAM_UTF8_STRING:
637 return OSSL_PARAM_get_utf8_string(ctx->params,
639 case OSSL_PARAM_OCTET_STRING:
640 return OSSL_PARAM_get_octet_string(ctx->params,
643 case OSSL_PARAM_OCTET_PTR:
644 return OSSL_PARAM_get_octet_ptr(ctx->params,
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);
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 */
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);
667 /* Normal C unsigned int passed back */
668 return OSSL_PARAM_set_uint(ctx->params,
669 (unsigned int)ctx->p1);
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,
677 case OSSL_PARAM_OCTET_PTR:
678 return OSSL_PARAM_set_octet_ptr(ctx->params, ctx->p2,
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);
690 /* Any other combination is simply pass-through */
697 cleanup_translation_ctx(enum state state,
698 const struct translation_st *translation,
699 struct translation_ctx_st *ctx)
701 if (ctx->allocated_buf != NULL)
702 OPENSSL_free(ctx->allocated_buf);
703 ctx->allocated_buf = NULL;
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.
711 static const char *get_cipher_name(void *cipher)
713 return EVP_CIPHER_name(cipher);
716 static const char *get_md_name(void *md)
718 return EVP_MD_name(md);
721 static const void *get_cipher_by_name(OSSL_LIB_CTX *libctx, const char *name)
723 return evp_get_cipherbyname_ex(libctx, name);
726 static const void *get_md_by_name(OSSL_LIB_CTX *libctx, const char *name)
728 return evp_get_digestbyname_ex(libctx, name);
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,
740 if ((ret = default_check(state, translation, ctx)) <= 0)
743 if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
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
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) {
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...
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);
769 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
772 if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
774 * Here's how we re-use |ctx->orig_p2| that was set in the
775 * PRE_CTRL_TO_PARAMS state above.
777 *(void **)ctx->orig_p2 =
778 (void *)get_algo_by_name(ctx->pctx->libctx, ctx->p2);
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);
788 static int fix_cipher(enum state state,
789 const struct translation_st *translation,
790 struct translation_ctx_st *ctx)
792 return fix_cipher_md(state, translation, ctx,
793 get_cipher_name, get_cipher_by_name);
796 static int fix_md(enum state state,
797 const struct translation_st *translation,
798 struct translation_ctx_st *ctx)
800 return fix_cipher_md(state, translation, ctx,
801 get_md_name, get_md_by_name);
804 static int fix_distid_len(enum state state,
805 const struct translation_st *translation,
806 struct translation_ctx_st *ctx)
808 int ret = default_fixup_args(state, translation, ctx);
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;
821 struct kdf_type_map_st {
823 const char *kdf_type_str;
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)
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.
840 if ((ret = default_check(state, translation, ctx)) <= 0)
843 if (state == PRE_CTRL_TO_PARAMS) {
845 * In |translations|, the initial value for |ctx->action_type| must
848 if (!ossl_assert(ctx->action_type == NONE))
851 /* The action type depends on the value of *p1 */
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
858 * (this wouldn't be needed if the OSSL_xxx_PARAM_KDF_TYPE
859 * had the data type OSSL_PARAM_UTF8_PTR)
861 ctx->p2 = ctx->name_buf;
862 ctx->p1 = sizeof(ctx->name_buf);
863 ctx->action_type = GET;
865 ctx->action_type = SET;
869 if ((ret = default_check(state, translation, ctx)) <= 0)
872 if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
873 || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
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;
884 ctx->p1 = strlen(ctx->p2);
887 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
890 if ((state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)
891 || (state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)) {
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;
902 } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
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)
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 },
920 return fix_kdf_type(state, translation, ctx, kdf_type_map);
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)
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 },
934 return fix_kdf_type(state, translation, ctx, kdf_type_map);
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)
944 if ((ret = default_check(state, translation, ctx)) <= 0)
947 if ((state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET)
948 || (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET)) {
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.
957 ctx->p2 = (char *)OBJ_nid2sn(OBJ_obj2nid(ctx->p2));
958 ctx->p1 = 0; /* let default_fixup_args() figure out the length */
961 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
964 if ((state == PRE_PARAMS_TO_CTRL && ctx->action_type == SET)
965 || (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET)) {
967 * We're translating from ctrl to params and setting the OID name,
968 * or we're translating from params to ctrl and getting the OID
969 * name. Either way, default_fixup_args() has placed the OID name
970 * in |ctx->p2|, all we need to do now is to replace that with the
971 * corresponding ASN1_OBJECT.
973 ctx->p2 = (ASN1_OBJECT *)OBJ_txt2obj(ctx->p2, 0);
979 /* EVP_PKEY_CTRL_DH_NID, ...??? */
980 static int fix_dh_nid(enum state state,
981 const struct translation_st *translation,
982 struct translation_ctx_st *ctx)
986 if ((ret = default_check(state, translation, ctx)) <= 0)
989 /* This is currently only settable */
990 if (ctx->action_type != SET)
993 if (state == PRE_CTRL_TO_PARAMS) {
994 ctx->p2 = (char *)ossl_ffc_named_group_get_name
995 (ossl_ffc_uid_to_dh_named_group(ctx->p1));
999 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1002 if (state == PRE_PARAMS_TO_CTRL) {
1004 ossl_ffc_named_group_get_uid(ossl_ffc_name_to_dh_named_group(ctx->p2));
1011 /* EVP_PKEY_CTRL_DH_PARAMGEN_TYPE */
1012 static int fix_dh_paramgen_type(enum state state,
1013 const struct translation_st *translation,
1014 struct translation_ctx_st *ctx)
1018 if ((ret = default_check(state, translation, ctx)) <= 0)
1021 /* This is currently only settable */
1022 if (ctx->action_type != SET)
1025 if (state == PRE_CTRL_TO_PARAMS) {
1026 ctx->p2 = (char *)dh_gen_type_id2name(ctx->p1);
1030 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1033 if (state == PRE_PARAMS_TO_CTRL) {
1034 ctx->p1 = dh_gen_type_name2id(ctx->p2);
1041 /* EVP_PKEY_CTRL_EC_PARAM_ENC */
1042 static int fix_ec_param_enc(enum state state,
1043 const struct translation_st *translation,
1044 struct translation_ctx_st *ctx)
1048 if ((ret = default_check(state, translation, ctx)) <= 0)
1051 /* This is currently only settable */
1052 if (ctx->action_type != SET)
1055 if (state == PRE_CTRL_TO_PARAMS) {
1057 case OPENSSL_EC_EXPLICIT_CURVE:
1058 ctx->p2 = OSSL_PKEY_EC_ENCODING_EXPLICIT;
1060 case OPENSSL_EC_NAMED_CURVE:
1061 ctx->p2 = OSSL_PKEY_EC_ENCODING_GROUP;
1070 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1073 if (state == PRE_PARAMS_TO_CTRL) {
1074 if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_EXPLICIT) == 0)
1075 ctx->p1 = OPENSSL_EC_EXPLICIT_CURVE;
1076 else if (strcmp(ctx->p2, OSSL_PKEY_EC_ENCODING_GROUP) == 0)
1077 ctx->p1 = OPENSSL_EC_NAMED_CURVE;
1085 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1089 /* EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID */
1090 static int fix_ec_paramgen_curve_nid(enum state state,
1091 const struct translation_st *translation,
1092 struct translation_ctx_st *ctx)
1096 if ((ret = default_check(state, translation, ctx)) <= 0)
1099 /* This is currently only settable */
1100 if (ctx->action_type != SET)
1103 if (state == PRE_CTRL_TO_PARAMS) {
1104 ctx->p2 = (char *)OBJ_nid2sn(ctx->p1);
1108 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1111 if (state == PRE_PARAMS_TO_CTRL) {
1112 ctx->p1 = OBJ_sn2nid(ctx->p2);
1119 /* EVP_PKEY_CTRL_EC_ECDH_COFACTOR */
1120 static int fix_ecdh_cofactor(enum state state,
1121 const struct translation_st *translation,
1122 struct translation_ctx_st *ctx)
1125 * The EVP_PKEY_CTRL_EC_ECDH_COFACTOR ctrl command is a bit special, in
1126 * that it's used both for setting a value, and for getting it, all
1127 * depending on the value if |ctx->p1|; if |ctx->p1| is -2, the backend is
1128 * supposed to place the current cofactor mode in |ctx->p2|, and if not,
1129 * |ctx->p1| is interpreted as the new cofactor mode.
1133 if (state == PRE_CTRL_TO_PARAMS) {
1135 * The initial value for |ctx->action_type| must be zero.
1136 * evp_pkey_ctrl_to_params() takes it from the translation item.
1138 if (!ossl_assert(ctx->action_type == NONE))
1141 /* The action type depends on the value of ctx->p1 */
1143 ctx->action_type = GET;
1145 ctx->action_type = SET;
1146 } else if (state == PRE_CTRL_STR_TO_PARAMS) {
1147 ctx->action_type = SET;
1148 } else if (state == PRE_PARAMS_TO_CTRL) {
1149 /* The initial value for |ctx->action_type| must not be zero. */
1150 if (!ossl_assert(ctx->action_type != NONE))
1154 if ((ret = default_check(state, translation, ctx)) <= 0)
1157 if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == SET) {
1158 if (ctx->p1 < -1 || ctx->p1 > 1) {
1159 /* Uses the same return value of pkey_ec_ctrl() */
1164 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1167 if (state == POST_CTRL_TO_PARAMS && ctx->action_type == GET) {
1168 if (ctx->p1 < 0 || ctx->p1 > 1) {
1170 * The provider should return either 0 or 1, any other value is a
1175 } else if (state == PRE_PARAMS_TO_CTRL && ctx->action_type == GET) {
1182 /* EVP_PKEY_CTRL_RSA_PADDING, EVP_PKEY_CTRL_GET_RSA_PADDING */
1183 static int fix_rsa_padding_mode(enum state state,
1184 const struct translation_st *translation,
1185 struct translation_ctx_st *ctx)
1187 static const OSSL_ITEM str_value_map[] = {
1188 { RSA_PKCS1_PADDING, "pkcs1" },
1189 { RSA_SSLV23_PADDING, "sslv23" },
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 }
1200 if ((ret = default_check(state, translation, ctx)) <= 0)
1203 if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
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.
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) {
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.
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.
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.
1236 ctx->params[0] = OSSL_PARAM_construct_int(translation->param_key,
1239 } else if (state == POST_PARAMS_TO_CTRL && ctx->action_type == GET) {
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.
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);
1257 for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1258 if (ctx->p1 == (int)str_value_map[i].id)
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);
1268 * If we don't have a string, we can't do anything. The caller
1269 * should have asked for a number...
1271 if (str_value_map[i].ptr == NULL) {
1272 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1275 ctx->p2 = str_value_map[i].ptr;
1276 ctx->p1 = strlen(ctx->p2);
1279 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1282 if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1283 || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1286 for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1287 if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
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);
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;
1300 ctx->p1 = str_value_map[i].id;
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)
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" }
1320 if ((ret = default_check(state, translation, ctx)) <= 0)
1323 if (state == PRE_CTRL_TO_PARAMS && ctx->action_type == GET) {
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
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.
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)) {
1343 for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1344 if (ctx->p1 == (int)str_value_map[i].id)
1347 if (i == OSSL_NELEM(str_value_map)) {
1348 BIO_snprintf(ctx->name_buf, 5, "%d", ctx->p1);
1350 strcpy(ctx->name_buf, str_value_map[i].ptr);
1352 ctx->p2 = ctx->name_buf;
1353 ctx->p1 = strlen(ctx->p2);
1356 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1359 if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1360 || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1363 for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1364 if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1367 if (i == OSSL_NELEM(str_value_map)) {
1368 ctx->p1 = atoi(ctx->p2);
1369 } else if (state == POST_CTRL_TO_PARAMS) {
1371 * EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN weirdness explained further
1374 *(int *)ctx->orig_p2 = str_value_map[i].id;
1376 ctx->p1 = (int)str_value_map[i].id;
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)
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" }
1396 if ((ret = default_check(state, translation, ctx)) <= 0)
1399 if ((ctx->action_type == SET && state == PRE_CTRL_TO_PARAMS)
1400 || (ctx->action_type == GET && state == POST_PARAMS_TO_CTRL)) {
1403 for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1404 if (ctx->p1 == (int)str_value_map[i].id)
1407 if (i == OSSL_NELEM(str_value_map))
1409 ctx->p2 = str_value_map[i].ptr;
1410 ctx->p1 = strlen(ctx->p2);
1413 if ((ret = default_fixup_args(state, translation, ctx)) <= 0)
1416 if ((ctx->action_type == SET && state == PRE_PARAMS_TO_CTRL)
1417 || (ctx->action_type == GET && state == POST_CTRL_TO_PARAMS)) {
1420 for (i = 0; i < OSSL_NELEM(str_value_map); i++) {
1421 if (strcmp(ctx->p2, str_value_map[i].ptr) == 0)
1424 if (i == OSSL_NELEM(str_value_map))
1426 if (state == POST_CTRL_TO_PARAMS)
1427 ret = str_value_map[i].id;
1429 ctx->p1 = str_value_map[i].id;
1436 static int hack_pkcs7_cms(enum state state,
1437 const struct translation_st *translation,
1438 struct translation_ctx_st *ctx)
1442 /* Make sure that this has no further effect */
1443 ctx->action_type = 0;
1446 case PRE_CTRL_TO_PARAMS:
1447 /* TODO (3.0) Temporary hack, this should probe */
1448 if (EVP_PKEY_is_a(EVP_PKEY_CTX_get0_pkey(ctx->pctx), "RSASSA-PSS")) {
1449 ERR_raise(ERR_LIB_EVP,
1450 EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
1454 case POST_CTRL_TO_PARAMS:
1457 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1468 * These all get the data they want, then call default_fixup_args() as
1469 * a post-ctrl GET fixup. They all get NULL ctx, ctrl_cmd, ctrl_str,
1473 /* Pilfering DH, DSA and EC_KEY */
1474 static int get_payload_group_name(enum state state,
1475 const struct translation_st *translation,
1476 struct translation_ctx_st *ctx)
1478 EVP_PKEY *pkey = ctx->p2;
1481 switch (EVP_PKEY_base_id(pkey)) {
1482 #ifndef OPENSSL_NO_DH
1485 DH *dh = EVP_PKEY_get0_DH(pkey);
1486 int uid = DH_get_nid(dh);
1488 if (uid != NID_undef) {
1489 const DH_NAMED_GROUP *dh_group =
1490 ossl_ffc_uid_to_dh_named_group(uid);
1492 ctx->p2 = (char *)ossl_ffc_named_group_get_name(dh_group);
1497 #ifndef OPENSSL_NO_EC
1500 const EC_GROUP *grp =
1501 EC_KEY_get0_group(EVP_PKEY_get0_EC_KEY(pkey));
1502 int nid = NID_undef;
1505 nid = EC_GROUP_get_curve_name(grp);
1506 if (nid != NID_undef)
1507 ctx->p2 = (char *)ec_curve_nid2name(nid);
1512 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1516 if (ctx->p2 != NULL)
1517 ctx->p1 = strlen(ctx->p2);
1518 return default_fixup_args(state, translation, ctx);
1521 static int get_payload_private_key(enum state state,
1522 const struct translation_st *translation,
1523 struct translation_ctx_st *ctx)
1525 EVP_PKEY *pkey = ctx->p2;
1528 if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1531 switch (EVP_PKEY_base_id(pkey)) {
1532 #ifndef OPENSSL_NO_DH
1535 DH *dh = EVP_PKEY_get0_DH(pkey);
1537 ctx->p2 = (BIGNUM *)DH_get0_priv_key(dh);
1541 #ifndef OPENSSL_NO_EC
1544 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1546 ctx->p2 = (BIGNUM *)EC_KEY_get0_private_key(ec);
1551 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1555 return default_fixup_args(state, translation, ctx);
1558 static int get_payload_public_key(enum state state,
1559 const struct translation_st *translation,
1560 struct translation_ctx_st *ctx)
1562 EVP_PKEY *pkey = ctx->p2;
1563 unsigned char *buf = NULL;
1567 switch (EVP_PKEY_base_id(pkey)) {
1568 #ifndef OPENSSL_NO_DH
1570 switch (ctx->params->data_type) {
1571 case OSSL_PARAM_OCTET_STRING:
1572 ctx->sz = dh_key2buf(EVP_PKEY_get0_DH(pkey), &buf, 0, 1);
1575 case OSSL_PARAM_UNSIGNED_INTEGER:
1576 ctx->p2 = (void *)DH_get0_pub_key(EVP_PKEY_get0_DH(pkey));
1583 #ifndef OPENSSL_NO_DSA
1585 if (ctx->params->data_type == OSSL_PARAM_UNSIGNED_INTEGER) {
1586 ctx->p2 = (void *)DSA_get0_pub_key(EVP_PKEY_get0_DSA(pkey));
1591 #ifndef OPENSSL_NO_EC
1593 if (ctx->params->data_type == OSSL_PARAM_OCTET_STRING) {
1594 EC_KEY *eckey = EVP_PKEY_get0_EC_KEY(pkey);
1595 BN_CTX *bnctx = BN_CTX_new_ex(ec_key_get_libctx(eckey));
1596 const EC_GROUP *ecg = EC_KEY_get0_group(eckey);
1597 const EC_POINT *point = EC_KEY_get0_public_key(eckey);
1599 ctx->sz = EC_POINT_point2buf(ecg, point,
1600 POINT_CONVERSION_COMPRESSED,
1608 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1612 ret = default_fixup_args(state, translation, ctx);
1617 static int get_payload_bn(enum state state,
1618 const struct translation_st *translation,
1619 struct translation_ctx_st *ctx, const BIGNUM *bn)
1623 if (ctx->params->data_type != OSSL_PARAM_UNSIGNED_INTEGER)
1625 ctx->p2 = (BIGNUM *)bn;
1627 return default_fixup_args(state, translation, ctx);
1630 static int get_dh_dsa_payload_p(enum state state,
1631 const struct translation_st *translation,
1632 struct translation_ctx_st *ctx)
1634 const BIGNUM *bn = NULL;
1635 EVP_PKEY *pkey = ctx->p2;
1637 switch (EVP_PKEY_base_id(pkey)) {
1638 #ifndef OPENSSL_NO_DH
1640 bn = DH_get0_p(EVP_PKEY_get0_DH(pkey));
1643 #ifndef OPENSSL_NO_DSA
1645 bn = DSA_get0_p(EVP_PKEY_get0_DSA(pkey));
1649 ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEY_TYPE);
1652 return get_payload_bn(state, translation, ctx, bn);
1655 static int get_dh_dsa_payload_q(enum state state,
1656 const struct translation_st *translation,
1657 struct translation_ctx_st *ctx)
1659 const BIGNUM *bn = NULL;
1661 switch (EVP_PKEY_base_id(ctx->p2)) {
1662 #ifndef OPENSSL_NO_DH
1664 bn = DH_get0_q(EVP_PKEY_get0_DH(ctx->p2));
1667 #ifndef OPENSSL_NO_DSA
1669 bn = DSA_get0_q(EVP_PKEY_get0_DSA(ctx->p2));
1674 return get_payload_bn(state, translation, ctx, bn);
1677 static int get_dh_dsa_payload_g(enum state state,
1678 const struct translation_st *translation,
1679 struct translation_ctx_st *ctx)
1681 const BIGNUM *bn = NULL;
1683 switch (EVP_PKEY_base_id(ctx->p2)) {
1684 #ifndef OPENSSL_NO_DH
1686 bn = DH_get0_g(EVP_PKEY_get0_DH(ctx->p2));
1689 #ifndef OPENSSL_NO_DSA
1691 bn = DSA_get0_g(EVP_PKEY_get0_DSA(ctx->p2));
1696 return get_payload_bn(state, translation, ctx, bn);
1699 static int get_rsa_payload_n(enum state state,
1700 const struct translation_st *translation,
1701 struct translation_ctx_st *ctx)
1703 const BIGNUM *bn = NULL;
1705 if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)
1707 bn = RSA_get0_n(EVP_PKEY_get0_RSA(ctx->p2));
1709 return get_payload_bn(state, translation, ctx, bn);
1712 static int get_rsa_payload_e(enum state state,
1713 const struct translation_st *translation,
1714 struct translation_ctx_st *ctx)
1716 const BIGNUM *bn = NULL;
1718 if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)
1720 bn = RSA_get0_e(EVP_PKEY_get0_RSA(ctx->p2));
1722 return get_payload_bn(state, translation, ctx, bn);
1725 static int get_rsa_payload_d(enum state state,
1726 const struct translation_st *translation,
1727 struct translation_ctx_st *ctx)
1729 const BIGNUM *bn = NULL;
1731 if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA)
1733 bn = RSA_get0_d(EVP_PKEY_get0_RSA(ctx->p2));
1735 return get_payload_bn(state, translation, ctx, bn);
1738 static int get_rsa_payload_factor(enum state state,
1739 const struct translation_st *translation,
1740 struct translation_ctx_st *ctx,
1743 const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1744 const BIGNUM *bn = NULL;
1746 switch (factornum) {
1755 size_t pnum = RSA_get_multi_prime_extra_count(r);
1756 const BIGNUM *factors[10];
1758 if (factornum - 2 < pnum
1759 && RSA_get0_multi_prime_factors(r, factors))
1760 bn = factors[factornum - 2];
1765 return get_payload_bn(state, translation, ctx, bn);
1768 static int get_rsa_payload_exponent(enum state state,
1769 const struct translation_st *translation,
1770 struct translation_ctx_st *ctx,
1773 const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1774 const BIGNUM *bn = NULL;
1776 switch (exponentnum) {
1778 bn = RSA_get0_dmp1(r);
1781 bn = RSA_get0_dmq1(r);
1785 size_t pnum = RSA_get_multi_prime_extra_count(r);
1786 const BIGNUM *exps[10], *coeffs[10];
1788 if (exponentnum - 2 < pnum
1789 && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1790 bn = exps[exponentnum - 2];
1795 return get_payload_bn(state, translation, ctx, bn);
1798 static int get_rsa_payload_coefficient(enum state state,
1799 const struct translation_st *translation,
1800 struct translation_ctx_st *ctx,
1801 size_t coefficientnum)
1803 const RSA *r = EVP_PKEY_get0_RSA(ctx->p2);
1804 const BIGNUM *bn = NULL;
1806 switch (coefficientnum) {
1808 bn = RSA_get0_iqmp(r);
1812 size_t pnum = RSA_get_multi_prime_extra_count(r);
1813 const BIGNUM *exps[10], *coeffs[10];
1815 if (coefficientnum - 1 < pnum
1816 && RSA_get0_multi_prime_crt_params(r, exps, coeffs))
1817 bn = coeffs[coefficientnum - 1];
1822 return get_payload_bn(state, translation, ctx, bn);
1825 #define IMPL_GET_RSA_PAYLOAD_FACTOR(n) \
1827 get_rsa_payload_f##n(enum state state, \
1828 const struct translation_st *translation, \
1829 struct translation_ctx_st *ctx) \
1831 if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA) \
1833 return get_rsa_payload_factor(state, translation, ctx, n - 1); \
1836 #define IMPL_GET_RSA_PAYLOAD_EXPONENT(n) \
1838 get_rsa_payload_e##n(enum state state, \
1839 const struct translation_st *translation, \
1840 struct translation_ctx_st *ctx) \
1842 if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA) \
1844 return get_rsa_payload_exponent(state, translation, ctx, \
1848 #define IMPL_GET_RSA_PAYLOAD_COEFFICIENT(n) \
1850 get_rsa_payload_c##n(enum state state, \
1851 const struct translation_st *translation, \
1852 struct translation_ctx_st *ctx) \
1854 if (EVP_PKEY_base_id(ctx->p2) != EVP_PKEY_RSA) \
1856 return get_rsa_payload_coefficient(state, translation, ctx, \
1860 IMPL_GET_RSA_PAYLOAD_FACTOR(1)
1861 IMPL_GET_RSA_PAYLOAD_FACTOR(2)
1862 IMPL_GET_RSA_PAYLOAD_FACTOR(3)
1863 IMPL_GET_RSA_PAYLOAD_FACTOR(4)
1864 IMPL_GET_RSA_PAYLOAD_FACTOR(5)
1865 IMPL_GET_RSA_PAYLOAD_FACTOR(6)
1866 IMPL_GET_RSA_PAYLOAD_FACTOR(7)
1867 IMPL_GET_RSA_PAYLOAD_FACTOR(8)
1868 IMPL_GET_RSA_PAYLOAD_FACTOR(9)
1869 IMPL_GET_RSA_PAYLOAD_FACTOR(10)
1870 IMPL_GET_RSA_PAYLOAD_EXPONENT(1)
1871 IMPL_GET_RSA_PAYLOAD_EXPONENT(2)
1872 IMPL_GET_RSA_PAYLOAD_EXPONENT(3)
1873 IMPL_GET_RSA_PAYLOAD_EXPONENT(4)
1874 IMPL_GET_RSA_PAYLOAD_EXPONENT(5)
1875 IMPL_GET_RSA_PAYLOAD_EXPONENT(6)
1876 IMPL_GET_RSA_PAYLOAD_EXPONENT(7)
1877 IMPL_GET_RSA_PAYLOAD_EXPONENT(8)
1878 IMPL_GET_RSA_PAYLOAD_EXPONENT(9)
1879 IMPL_GET_RSA_PAYLOAD_EXPONENT(10)
1880 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(1)
1881 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(2)
1882 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(3)
1883 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(4)
1884 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(5)
1885 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(6)
1886 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(7)
1887 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(8)
1888 IMPL_GET_RSA_PAYLOAD_COEFFICIENT(9)
1891 * The translation table itself
1892 * ============================
1895 static const struct translation_st evp_pkey_ctx_translations[] = {
1897 * DistID: we pass it to the backend as an octet string,
1898 * but get it back as a pointer to an octet string.
1900 * Note that the EVP_PKEY_CTRL_GET1_ID_LEN is purely for legacy purposes
1901 * that has no separate counterpart in OSSL_PARAM terms, since we get
1902 * the length of the DistID automatically when getting the DistID itself.
1904 { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
1905 EVP_PKEY_CTRL_SET1_ID, "distid", "hexdistid",
1906 OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_STRING, NULL },
1908 EVP_PKEY_CTRL_GET1_ID, "distid", "hexdistid",
1909 OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, NULL },
1911 EVP_PKEY_CTRL_GET1_ID_LEN, NULL, NULL,
1912 OSSL_PKEY_PARAM_DIST_ID, OSSL_PARAM_OCTET_PTR, fix_distid_len },
1920 * EVP_PKEY_CTRL_DH_KDF_TYPE is used both for setting and getting. The
1921 * fixup function has to handle this...
1923 { NONE, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1924 EVP_PKEY_CTRL_DH_KDF_TYPE, NULL, NULL,
1925 OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING,
1927 { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1928 EVP_PKEY_CTRL_DH_KDF_MD, NULL, NULL,
1929 OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1930 { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1931 EVP_PKEY_CTRL_GET_DH_KDF_MD, NULL, NULL,
1932 OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
1933 { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1934 EVP_PKEY_CTRL_DH_KDF_OUTLEN, NULL, NULL,
1935 OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1936 { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1937 EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, NULL, NULL,
1938 OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1939 { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1940 EVP_PKEY_CTRL_DH_KDF_UKM, NULL, NULL,
1941 OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
1942 { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1943 EVP_PKEY_CTRL_GET_DH_KDF_UKM, NULL, NULL,
1944 OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
1945 { SET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1946 EVP_PKEY_CTRL_DH_KDF_OID, NULL, NULL,
1947 OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
1948 { GET, EVP_PKEY_DHX, 0, EVP_PKEY_OP_DERIVE,
1949 EVP_PKEY_CTRL_GET_DH_KDF_OID, NULL, NULL,
1950 OSSL_KDF_PARAM_CEK_ALG, OSSL_PARAM_UTF8_STRING, fix_oid },
1952 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_DERIVE,
1953 EVP_PKEY_CTRL_DH_PAD, "dh_pad", NULL,
1954 OSSL_EXCHANGE_PARAM_PAD, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1956 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
1957 EVP_PKEY_CTRL_DH_NID, "dh_param", NULL,
1958 OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING, fix_dh_nid },
1959 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1960 EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, NULL, NULL,
1961 OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1962 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1963 EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, "dh_paramgen_subprime_len", NULL,
1964 OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1965 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1966 EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, "dh_paramgen_generator", NULL,
1967 OSSL_PKEY_PARAM_DH_GENERATOR, OSSL_PARAM_INTEGER, NULL },
1968 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1969 EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, "dh_paramgen_type", NULL,
1970 OSSL_PKEY_PARAM_FFC_TYPE, OSSL_PARAM_UTF8_STRING, fix_dh_paramgen_type },
1972 * This is know to be incorrect, will be fixed and enabled when the
1973 * underlying code is corrected.
1974 * Until then, we simply don't support it here.
1977 { SET, EVP_PKEY_DH, 0, EVP_PKEY_OP_PARAMGEN,
1978 EVP_PKEY_CTRL_DH_RFC5114, "dh_rfc5114", NULL,
1979 OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_INTEGER, NULL },
1986 { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
1987 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, "dsa_paramgen_bits", NULL,
1988 OSSL_PKEY_PARAM_FFC_PBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1989 { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
1990 EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, "dsa_paramgen_q_bits", NULL,
1991 OSSL_PKEY_PARAM_FFC_QBITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
1992 { SET, EVP_PKEY_DSA, 0, EVP_PKEY_OP_PARAMGEN,
1993 EVP_PKEY_CTRL_DSA_PARAMGEN_MD, "dsa_paramgen_md", NULL,
1994 OSSL_PKEY_PARAM_FFC_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2000 { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2001 EVP_PKEY_CTRL_EC_PARAM_ENC, "ec_param_enc", NULL,
2002 OSSL_PKEY_PARAM_EC_ENCODING, OSSL_PARAM_UTF8_STRING, fix_ec_param_enc },
2003 { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN,
2004 EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, "ec_paramgen_curve", NULL,
2005 OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2006 fix_ec_paramgen_curve_nid },
2008 * EVP_PKEY_CTRL_EC_ECDH_COFACTOR and EVP_PKEY_CTRL_EC_KDF_TYPE are used
2009 * both for setting and getting. The fixup function has to handle this...
2011 { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2012 EVP_PKEY_CTRL_EC_ECDH_COFACTOR, "ecdh_cofactor_mode", NULL,
2013 OSSL_EXCHANGE_PARAM_EC_ECDH_COFACTOR_MODE, OSSL_PARAM_INTEGER,
2014 fix_ecdh_cofactor },
2015 { NONE, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2016 EVP_PKEY_CTRL_EC_KDF_TYPE, NULL, NULL,
2017 OSSL_EXCHANGE_PARAM_KDF_TYPE, OSSL_PARAM_UTF8_STRING, fix_ec_kdf_type },
2018 { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2019 EVP_PKEY_CTRL_EC_KDF_MD, "ecdh_kdf_md", NULL,
2020 OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2021 { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2022 EVP_PKEY_CTRL_GET_EC_KDF_MD, NULL, NULL,
2023 OSSL_EXCHANGE_PARAM_KDF_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2024 { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2025 EVP_PKEY_CTRL_EC_KDF_OUTLEN, NULL, NULL,
2026 OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2027 { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2028 EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN, NULL, NULL,
2029 OSSL_EXCHANGE_PARAM_KDF_OUTLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2030 { SET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2031 EVP_PKEY_CTRL_EC_KDF_UKM, NULL, NULL,
2032 OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_STRING, NULL },
2033 { GET, EVP_PKEY_EC, 0, EVP_PKEY_OP_DERIVE,
2034 EVP_PKEY_CTRL_GET_EC_KDF_UKM, NULL, NULL,
2035 OSSL_EXCHANGE_PARAM_KDF_UKM, OSSL_PARAM_OCTET_PTR, NULL },
2043 * RSA padding modes are numeric with ctrls, strings with ctrl_strs,
2044 * and can be both with OSSL_PARAM. We standardise on strings here,
2045 * fix_rsa_padding_mode() does the work when the caller has a different
2048 { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2049 EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2050 EVP_PKEY_CTRL_RSA_PADDING, "rsa_padding_mode", NULL,
2051 OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2052 { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2053 EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2054 EVP_PKEY_CTRL_GET_RSA_PADDING, NULL, NULL,
2055 OSSL_PKEY_PARAM_PAD_MODE, OSSL_PARAM_UTF8_STRING, fix_rsa_padding_mode },
2057 { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2058 EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2059 EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_mgf1_md", NULL,
2060 OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2061 { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS,
2062 EVP_PKEY_OP_TYPE_CRYPT | EVP_PKEY_OP_TYPE_SIG,
2063 EVP_PKEY_CTRL_GET_RSA_MGF1_MD, NULL, NULL,
2064 OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2067 * RSA-PSS saltlen is essentially numeric, but certain values can be
2068 * expressed as keywords (strings) with ctrl_str. The corresponding
2069 * OSSL_PARAM allows both forms.
2070 * fix_rsa_pss_saltlen() takes care of the distinction.
2072 { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2073 EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_saltlen", NULL,
2074 OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2075 fix_rsa_pss_saltlen },
2076 { GET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_TYPE_SIG,
2077 EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN, NULL, NULL,
2078 OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, OSSL_PARAM_UTF8_STRING,
2079 fix_rsa_pss_saltlen },
2081 { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2082 EVP_PKEY_CTRL_RSA_OAEP_MD, "rsa_oaep_md", NULL,
2083 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2084 { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2085 EVP_PKEY_CTRL_GET_RSA_OAEP_MD, NULL, NULL,
2086 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2088 * The "rsa_oaep_label" ctrl_str expects the value to always be hex.
2089 * This is accomodated by default_fixup_args() above, which mimics that
2090 * expectation for any translation item where |ctrl_str| is NULL and
2091 * |ctrl_hexstr| is non-NULL.
2093 { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2094 EVP_PKEY_CTRL_RSA_OAEP_LABEL, NULL, "rsa_oaep_label",
2095 OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2096 { GET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_TYPE_CRYPT,
2097 EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL, NULL, NULL,
2098 OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_STRING, NULL },
2100 { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2101 EVP_PKEY_CTRL_MD, "rsa_pss_keygen_md", NULL,
2102 OSSL_ALG_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2103 { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2104 EVP_PKEY_CTRL_RSA_MGF1_MD, "rsa_pss_keygen_mgf1_md", NULL,
2105 OSSL_PKEY_PARAM_MGF1_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2106 { SET, EVP_PKEY_RSA_PSS, 0, EVP_PKEY_OP_TYPE_GEN,
2107 EVP_PKEY_CTRL_RSA_PSS_SALTLEN, "rsa_pss_keygen_saltlen", NULL,
2108 OSSL_SIGNATURE_PARAM_PSS_SALTLEN, OSSL_PARAM_INTEGER, NULL },
2109 { SET, EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_OP_KEYGEN,
2110 EVP_PKEY_CTRL_RSA_KEYGEN_BITS, "rsa_keygen_bits", NULL,
2111 OSSL_PKEY_PARAM_RSA_BITS, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2112 { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_KEYGEN,
2113 EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, "rsa_keygen_pubexp", NULL,
2114 OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2115 { SET, EVP_PKEY_RSA, 0, EVP_PKEY_OP_KEYGEN,
2116 EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES, "rsa_keygen_primes", NULL,
2117 OSSL_PKEY_PARAM_RSA_PRIMES, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2119 /* PKCS#7 and CMS hacks */
2120 { SET, -1, -1, EVP_PKEY_OP_ENCRYPT,
2121 EVP_PKEY_CTRL_PKCS7_ENCRYPT, NULL, NULL, NULL, 0, hack_pkcs7_cms },
2122 { SET, -1, -1, EVP_PKEY_OP_DECRYPT,
2123 EVP_PKEY_CTRL_PKCS7_DECRYPT, NULL, NULL, NULL, 0, hack_pkcs7_cms },
2124 { SET, -1, -1, EVP_PKEY_OP_ENCRYPT,
2125 EVP_PKEY_CTRL_CMS_ENCRYPT, NULL, NULL, NULL, 0, hack_pkcs7_cms },
2126 { SET, -1, -1, EVP_PKEY_OP_DECRYPT,
2127 EVP_PKEY_CTRL_CMS_DECRYPT, NULL, NULL, NULL, 0, hack_pkcs7_cms },
2133 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2134 EVP_PKEY_CTRL_TLS_MD, "md", NULL,
2135 OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2136 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2137 EVP_PKEY_CTRL_TLS_SECRET, "secret", "hexsecret",
2138 OSSL_KDF_PARAM_SECRET, OSSL_PARAM_OCTET_STRING, NULL },
2139 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2140 EVP_PKEY_CTRL_TLS_SEED, "seed", "hexseed",
2141 OSSL_KDF_PARAM_SEED, OSSL_PARAM_OCTET_STRING, NULL },
2147 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2148 EVP_PKEY_CTRL_HKDF_MD, "md", NULL,
2149 OSSL_KDF_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2150 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2151 EVP_PKEY_CTRL_HKDF_SALT, "salt", "hexsalt",
2152 OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2153 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2154 EVP_PKEY_CTRL_HKDF_KEY, "key", "hexkey",
2155 OSSL_KDF_PARAM_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2156 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2157 EVP_PKEY_CTRL_HKDF_INFO, "info", "hexinfo",
2158 OSSL_KDF_PARAM_INFO, OSSL_PARAM_OCTET_STRING, NULL },
2159 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2160 EVP_PKEY_CTRL_HKDF_MODE, "mode", NULL,
2161 OSSL_KDF_PARAM_MODE, OSSL_PARAM_INTEGER, fix_hkdf_mode },
2167 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2168 EVP_PKEY_CTRL_PASS, "pass", "hexpass",
2169 OSSL_KDF_PARAM_PASSWORD, OSSL_PARAM_OCTET_STRING, NULL },
2170 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2171 EVP_PKEY_CTRL_SCRYPT_SALT, "salt", "hexsalt",
2172 OSSL_KDF_PARAM_SALT, OSSL_PARAM_OCTET_STRING, NULL },
2173 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2174 EVP_PKEY_CTRL_SCRYPT_N, "N", NULL,
2175 OSSL_KDF_PARAM_SCRYPT_N, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2176 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2177 EVP_PKEY_CTRL_SCRYPT_R, "r", NULL,
2178 OSSL_KDF_PARAM_SCRYPT_R, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2179 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2180 EVP_PKEY_CTRL_SCRYPT_P, "p", NULL,
2181 OSSL_KDF_PARAM_SCRYPT_P, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2182 { SET, -1, -1, EVP_PKEY_OP_DERIVE,
2183 EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES, "maxmem_bytes", NULL,
2184 OSSL_KDF_PARAM_SCRYPT_MAXMEM, OSSL_PARAM_UNSIGNED_INTEGER, NULL },
2186 { SET, -1, -1, EVP_PKEY_OP_KEYGEN,
2187 EVP_PKEY_CTRL_CIPHER, NULL, NULL,
2188 OSSL_PKEY_PARAM_CIPHER, OSSL_PARAM_UTF8_STRING, fix_cipher },
2189 { SET, -1, -1, EVP_PKEY_OP_KEYGEN,
2190 EVP_PKEY_CTRL_SET_MAC_KEY, NULL, NULL,
2191 OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_OCTET_STRING, NULL },
2193 { SET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2194 EVP_PKEY_CTRL_MD, NULL, NULL,
2195 OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2196 { GET, -1, -1, EVP_PKEY_OP_TYPE_SIG,
2197 EVP_PKEY_CTRL_GET_MD, NULL, NULL,
2198 OSSL_SIGNATURE_PARAM_DIGEST, OSSL_PARAM_UTF8_STRING, fix_md },
2201 static const struct translation_st evp_pkey_translations[] = {
2203 * The following contain no ctrls, they are exclusively here to extract
2204 * key payloads from legacy keys, using OSSL_PARAMs, and rely entirely
2205 * on |fixup_args| to pass the actual data. The |fixup_args| should
2206 * expect to get the EVP_PKEY pointer through |ctx->p2|.
2210 { GET, -1, -1, -1, 0, NULL, NULL,
2211 OSSL_PKEY_PARAM_GROUP_NAME, OSSL_PARAM_UTF8_STRING,
2212 get_payload_group_name },
2213 { GET, -1, -1, -1, 0, NULL, NULL,
2214 OSSL_PKEY_PARAM_PRIV_KEY, OSSL_PARAM_UNSIGNED_INTEGER,
2215 get_payload_private_key },
2216 { GET, -1, -1, -1, 0, NULL, NULL,
2217 OSSL_PKEY_PARAM_PUB_KEY,
2218 0 /* no data type, let get_payload_pub_key() handle that */,
2219 get_payload_public_key },
2222 { GET, -1, -1, -1, 0, NULL, NULL,
2223 OSSL_PKEY_PARAM_FFC_P, OSSL_PARAM_UNSIGNED_INTEGER,
2224 get_dh_dsa_payload_p },
2225 { GET, -1, -1, -1, 0, NULL, NULL,
2226 OSSL_PKEY_PARAM_FFC_G, OSSL_PARAM_UNSIGNED_INTEGER,
2227 get_dh_dsa_payload_g },
2228 { GET, -1, -1, -1, 0, NULL, NULL,
2229 OSSL_PKEY_PARAM_FFC_Q, OSSL_PARAM_UNSIGNED_INTEGER,
2230 get_dh_dsa_payload_q },
2233 { GET, -1, -1, -1, 0, NULL, NULL,
2234 OSSL_PKEY_PARAM_RSA_N, OSSL_PARAM_UNSIGNED_INTEGER,
2235 get_rsa_payload_n },
2236 { GET, -1, -1, -1, 0, NULL, NULL,
2237 OSSL_PKEY_PARAM_RSA_E, OSSL_PARAM_UNSIGNED_INTEGER,
2238 get_rsa_payload_e },
2239 { GET, -1, -1, -1, 0, NULL, NULL,
2240 OSSL_PKEY_PARAM_RSA_D, OSSL_PARAM_UNSIGNED_INTEGER,
2241 get_rsa_payload_d },
2242 { GET, -1, -1, -1, 0, NULL, NULL,
2243 OSSL_PKEY_PARAM_RSA_FACTOR1, OSSL_PARAM_UNSIGNED_INTEGER,
2244 get_rsa_payload_f1 },
2245 { GET, -1, -1, -1, 0, NULL, NULL,
2246 OSSL_PKEY_PARAM_RSA_FACTOR2, OSSL_PARAM_UNSIGNED_INTEGER,
2247 get_rsa_payload_f2 },
2248 { GET, -1, -1, -1, 0, NULL, NULL,
2249 OSSL_PKEY_PARAM_RSA_FACTOR3, OSSL_PARAM_UNSIGNED_INTEGER,
2250 get_rsa_payload_f3 },
2251 { GET, -1, -1, -1, 0, NULL, NULL,
2252 OSSL_PKEY_PARAM_RSA_FACTOR4, OSSL_PARAM_UNSIGNED_INTEGER,
2253 get_rsa_payload_f4 },
2254 { GET, -1, -1, -1, 0, NULL, NULL,
2255 OSSL_PKEY_PARAM_RSA_FACTOR5, OSSL_PARAM_UNSIGNED_INTEGER,
2256 get_rsa_payload_f5 },
2257 { GET, -1, -1, -1, 0, NULL, NULL,
2258 OSSL_PKEY_PARAM_RSA_FACTOR6, OSSL_PARAM_UNSIGNED_INTEGER,
2259 get_rsa_payload_f6 },
2260 { GET, -1, -1, -1, 0, NULL, NULL,
2261 OSSL_PKEY_PARAM_RSA_FACTOR7, OSSL_PARAM_UNSIGNED_INTEGER,
2262 get_rsa_payload_f7 },
2263 { GET, -1, -1, -1, 0, NULL, NULL,
2264 OSSL_PKEY_PARAM_RSA_FACTOR8, OSSL_PARAM_UNSIGNED_INTEGER,
2265 get_rsa_payload_f8 },
2266 { GET, -1, -1, -1, 0, NULL, NULL,
2267 OSSL_PKEY_PARAM_RSA_FACTOR9, OSSL_PARAM_UNSIGNED_INTEGER,
2268 get_rsa_payload_f9 },
2269 { GET, -1, -1, -1, 0, NULL, NULL,
2270 OSSL_PKEY_PARAM_RSA_FACTOR10, OSSL_PARAM_UNSIGNED_INTEGER,
2271 get_rsa_payload_f10 },
2272 { GET, -1, -1, -1, 0, NULL, NULL,
2273 OSSL_PKEY_PARAM_RSA_EXPONENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2274 get_rsa_payload_e1 },
2275 { GET, -1, -1, -1, 0, NULL, NULL,
2276 OSSL_PKEY_PARAM_RSA_EXPONENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2277 get_rsa_payload_e2 },
2278 { GET, -1, -1, -1, 0, NULL, NULL,
2279 OSSL_PKEY_PARAM_RSA_EXPONENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2280 get_rsa_payload_e3 },
2281 { GET, -1, -1, -1, 0, NULL, NULL,
2282 OSSL_PKEY_PARAM_RSA_EXPONENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2283 get_rsa_payload_e4 },
2284 { GET, -1, -1, -1, 0, NULL, NULL,
2285 OSSL_PKEY_PARAM_RSA_EXPONENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2286 get_rsa_payload_e5 },
2287 { GET, -1, -1, -1, 0, NULL, NULL,
2288 OSSL_PKEY_PARAM_RSA_EXPONENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2289 get_rsa_payload_e6 },
2290 { GET, -1, -1, -1, 0, NULL, NULL,
2291 OSSL_PKEY_PARAM_RSA_EXPONENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2292 get_rsa_payload_e7 },
2293 { GET, -1, -1, -1, 0, NULL, NULL,
2294 OSSL_PKEY_PARAM_RSA_EXPONENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2295 get_rsa_payload_e8 },
2296 { GET, -1, -1, -1, 0, NULL, NULL,
2297 OSSL_PKEY_PARAM_RSA_EXPONENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2298 get_rsa_payload_e9 },
2299 { GET, -1, -1, -1, 0, NULL, NULL,
2300 OSSL_PKEY_PARAM_RSA_EXPONENT10, OSSL_PARAM_UNSIGNED_INTEGER,
2301 get_rsa_payload_e10 },
2302 { GET, -1, -1, -1, 0, NULL, NULL,
2303 OSSL_PKEY_PARAM_RSA_COEFFICIENT1, OSSL_PARAM_UNSIGNED_INTEGER,
2304 get_rsa_payload_c1 },
2305 { GET, -1, -1, -1, 0, NULL, NULL,
2306 OSSL_PKEY_PARAM_RSA_COEFFICIENT2, OSSL_PARAM_UNSIGNED_INTEGER,
2307 get_rsa_payload_c2 },
2308 { GET, -1, -1, -1, 0, NULL, NULL,
2309 OSSL_PKEY_PARAM_RSA_COEFFICIENT3, OSSL_PARAM_UNSIGNED_INTEGER,
2310 get_rsa_payload_c3 },
2311 { GET, -1, -1, -1, 0, NULL, NULL,
2312 OSSL_PKEY_PARAM_RSA_COEFFICIENT4, OSSL_PARAM_UNSIGNED_INTEGER,
2313 get_rsa_payload_c4 },
2314 { GET, -1, -1, -1, 0, NULL, NULL,
2315 OSSL_PKEY_PARAM_RSA_COEFFICIENT5, OSSL_PARAM_UNSIGNED_INTEGER,
2316 get_rsa_payload_c5 },
2317 { GET, -1, -1, -1, 0, NULL, NULL,
2318 OSSL_PKEY_PARAM_RSA_COEFFICIENT6, OSSL_PARAM_UNSIGNED_INTEGER,
2319 get_rsa_payload_c6 },
2320 { GET, -1, -1, -1, 0, NULL, NULL,
2321 OSSL_PKEY_PARAM_RSA_COEFFICIENT7, OSSL_PARAM_UNSIGNED_INTEGER,
2322 get_rsa_payload_c7 },
2323 { GET, -1, -1, -1, 0, NULL, NULL,
2324 OSSL_PKEY_PARAM_RSA_COEFFICIENT8, OSSL_PARAM_UNSIGNED_INTEGER,
2325 get_rsa_payload_c8 },
2326 { GET, -1, -1, -1, 0, NULL, NULL,
2327 OSSL_PKEY_PARAM_RSA_COEFFICIENT9, OSSL_PARAM_UNSIGNED_INTEGER,
2328 get_rsa_payload_c9 },
2331 static const struct translation_st *
2332 lookup_translation(struct translation_st *tmpl,
2333 const struct translation_st *translations,
2334 size_t translations_num)
2338 for (i = 0; i < translations_num; i++) {
2339 const struct translation_st *item = &translations[i];
2342 * Sanity check the translation table item.
2344 * 1. Either both keytypes are -1, or neither of them are.
2347 if (!ossl_assert((item->keytype1 == -1) == (item->keytype2 == -1)))
2352 * Base search criteria: check that the optype and keytypes match,
2353 * if relevant. All callers must synthesise these bits somehow.
2355 if (item->optype != -1 && (tmpl->optype & item->optype) == 0)
2358 * This expression is stunningly simple thanks to the sanity check
2361 if (item->keytype1 != -1
2362 && tmpl->keytype1 != item->keytype1
2363 && tmpl->keytype2 != item->keytype2)
2367 * Done with the base search criteria, now we check the criteria for
2368 * the individual types of translations:
2369 * ctrl->params, ctrl_str->params, and params->ctrl
2371 if (tmpl->ctrl_num != 0) {
2372 if (tmpl->ctrl_num != item->ctrl_num)
2374 } else if (tmpl->ctrl_str != NULL) {
2375 const char *ctrl_str = NULL;
2376 const char *ctrl_hexstr = NULL;
2379 * Search criteria that originates from a ctrl_str is only used
2380 * for setting, never for getting. Therefore, we only look at
2383 if (item->action_type != NONE
2384 && item->action_type != SET)
2387 * At least one of the ctrl cmd names must be match the ctrl
2388 * cmd name in the template.
2390 if (item->ctrl_str != NULL
2391 && strcasecmp(tmpl->ctrl_str, item->ctrl_str) == 0)
2392 ctrl_str = tmpl->ctrl_str;
2393 else if (item->ctrl_hexstr != NULL
2394 && strcasecmp(tmpl->ctrl_hexstr, item->ctrl_hexstr) == 0)
2395 ctrl_hexstr = tmpl->ctrl_hexstr;
2399 /* Modify the template to signal which string matched */
2400 tmpl->ctrl_str = ctrl_str;
2401 tmpl->ctrl_hexstr = ctrl_hexstr;
2402 } else if (tmpl->param_key != NULL) {
2404 * Search criteria that originates from a OSSL_PARAM setter or
2407 * Ctrls were fundamentally bidirectional, with only the ctrl
2408 * command macro name implying direction (if you're lucky).
2409 * A few ctrl commands were even taking advantage of the
2410 * bidirectional nature, making the direction depend in the
2411 * value of the numeric argument.
2413 * OSSL_PARAM functions are fundamentally different, in that
2414 * setters and getters are separated, so the data direction is
2415 * implied by the function that's used. The same OSSL_PARAM
2416 * key name can therefore be used in both directions. We must
2417 * therefore take the action type into account in this case.
2419 if ((item->action_type != NONE
2420 && tmpl->action_type != item->action_type)
2421 || (item->param_key != NULL
2422 && strcasecmp(tmpl->param_key, item->param_key) != 0))
2434 static const struct translation_st *
2435 lookup_evp_pkey_ctx_translation(struct translation_st *tmpl)
2437 return lookup_translation(tmpl, evp_pkey_ctx_translations,
2438 OSSL_NELEM(evp_pkey_ctx_translations));
2441 static const struct translation_st *
2442 lookup_evp_pkey_translation(struct translation_st *tmpl)
2444 return lookup_translation(tmpl, evp_pkey_translations,
2445 OSSL_NELEM(evp_pkey_translations));
2448 /* This must ONLY be called for provider side operations */
2449 int evp_pkey_ctx_ctrl_to_param(EVP_PKEY_CTX *pctx,
2450 int keytype, int optype,
2451 int cmd, int p1, void *p2)
2453 struct translation_ctx_st ctx = { 0, };
2454 struct translation_st tmpl = { 0, };
2455 const struct translation_st *translation = NULL;
2456 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2458 fixup_args_fn *fixup = default_fixup_args;
2461 keytype = pctx->legacy_keytype;
2462 tmpl.ctrl_num = cmd;
2463 tmpl.keytype1 = tmpl.keytype2 = keytype;
2464 tmpl.optype = optype;
2465 translation = lookup_evp_pkey_ctx_translation(&tmpl);
2467 if (translation == NULL) {
2468 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
2472 if (pctx->pmeth != NULL
2473 && pctx->pmeth->pkey_id != translation->keytype1
2474 && pctx->pmeth->pkey_id != translation->keytype2)
2477 if (translation->fixup_args != NULL)
2478 fixup = translation->fixup_args;
2479 ctx.action_type = translation->action_type;
2484 ctx.params = params;
2486 ret = fixup(PRE_CTRL_TO_PARAMS, translation, &ctx);
2489 switch (ctx.action_type) {
2491 /* fixup_args is expected to make sure this is dead code */
2494 ret = evp_pkey_ctx_get_params_strict(pctx, ctx.params);
2497 ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2503 * In POST, we pass the return value as p1, allowing the fixup_args
2504 * function to affect it by changing its value.
2508 fixup(POST_CTRL_TO_PARAMS, translation, &ctx);
2512 cleanup_translation_ctx(POST_CTRL_TO_PARAMS, translation, &ctx);
2517 /* This must ONLY be called for provider side operations */
2518 int evp_pkey_ctx_ctrl_str_to_param(EVP_PKEY_CTX *pctx,
2519 const char *name, const char *value)
2521 struct translation_ctx_st ctx = { 0, };
2522 struct translation_st tmpl = { 0, };
2523 const struct translation_st *translation = NULL;
2524 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
2525 int keytype = pctx->legacy_keytype;
2526 int optype = pctx->operation == 0 ? -1 : pctx->operation;
2528 fixup_args_fn *fixup = default_fixup_args;
2530 tmpl.action_type = SET;
2531 tmpl.keytype1 = tmpl.keytype2 = keytype;
2532 tmpl.optype = optype;
2533 tmpl.ctrl_str = name;
2534 tmpl.ctrl_hexstr = name;
2535 translation = lookup_evp_pkey_ctx_translation(&tmpl);
2537 if (translation != NULL) {
2538 if (translation->fixup_args != NULL)
2539 fixup = translation->fixup_args;
2540 ctx.action_type = translation->action_type;
2541 ctx.ishex = (tmpl.ctrl_hexstr != NULL);
2543 /* String controls really only support setting */
2544 ctx.action_type = SET;
2546 ctx.ctrl_str = name;
2547 ctx.p1 = (int)strlen(value);
2548 ctx.p2 = (char *)value;
2550 ctx.params = params;
2552 ret = fixup(PRE_CTRL_STR_TO_PARAMS, translation, &ctx);
2555 switch (ctx.action_type) {
2557 /* fixup_args is expected to make sure this is dead code */
2561 * this is dead code, but must be present, or some compilers
2566 ret = evp_pkey_ctx_set_params_strict(pctx, ctx.params);
2572 ret = fixup(POST_CTRL_STR_TO_PARAMS, translation, &ctx);
2574 cleanup_translation_ctx(CLEANUP_CTRL_STR_TO_PARAMS, translation, &ctx);
2579 /* This must ONLY be called for legacy operations */
2580 static int evp_pkey_ctx_setget_params_to_ctrl(EVP_PKEY_CTX *pctx,
2581 enum action action_type,
2584 int keytype = pctx->legacy_keytype;
2585 int optype = pctx->operation == 0 ? -1 : pctx->operation;
2587 for (; params != NULL && params->key != NULL; params++) {
2588 struct translation_ctx_st ctx = { 0, };
2589 struct translation_st tmpl = { 0, };
2590 const struct translation_st *translation = NULL;
2591 fixup_args_fn *fixup = default_fixup_args;
2594 tmpl.action_type = action_type;
2595 tmpl.keytype1 = tmpl.keytype2 = keytype;
2596 tmpl.optype = optype;
2597 tmpl.param_key = params->key;
2598 translation = lookup_evp_pkey_ctx_translation(&tmpl);
2600 if (translation != NULL) {
2601 if (translation->fixup_args != NULL)
2602 fixup = translation->fixup_args;
2603 ctx.action_type = translation->action_type;
2606 ctx.params = params;
2608 ret = fixup(PRE_PARAMS_TO_CTRL, translation, &ctx);
2610 if (ret > 0 && action_type != NONE)
2611 ret = EVP_PKEY_CTX_ctrl(pctx, keytype, optype,
2612 ctx.ctrl_cmd, ctx.p1, ctx.p2);
2615 * In POST, we pass the return value as p1, allowing the fixup_args
2616 * function to put it to good use, or maybe affect it.
2620 fixup(POST_PARAMS_TO_CTRL, translation, &ctx);
2624 cleanup_translation_ctx(CLEANUP_PARAMS_TO_CTRL, translation, &ctx);
2632 int evp_pkey_ctx_set_params_to_ctrl(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
2634 return evp_pkey_ctx_setget_params_to_ctrl(ctx, SET, params);
2637 int evp_pkey_ctx_get_params_to_ctrl(EVP_PKEY_CTX *ctx, OSSL_PARAM *params)
2639 return evp_pkey_ctx_setget_params_to_ctrl(ctx, GET, params);
2642 /* This must ONLY be called for legacy EVP_PKEYs */
2643 static int evp_pkey_setget_params_to_ctrl(const EVP_PKEY *pkey,
2644 enum action action_type,
2649 for (; params != NULL && params->key != NULL; params++) {
2650 struct translation_ctx_st ctx = { 0, };
2651 struct translation_st tmpl = { 0, };
2652 const struct translation_st *translation = NULL;
2653 fixup_args_fn *fixup = default_fixup_args;
2655 tmpl.action_type = action_type;
2656 tmpl.param_key = params->key;
2657 translation = lookup_evp_pkey_translation(&tmpl);
2659 if (translation != NULL) {
2660 if (translation->fixup_args != NULL)
2661 fixup = translation->fixup_args;
2662 ctx.action_type = translation->action_type;
2664 ctx.p2 = (void *)pkey;
2665 ctx.params = params;
2668 * EVP_PKEY doesn't have any ctrl function, so we rely completely
2669 * on fixup_args to do the whole work. Also, we currently only
2672 if (!ossl_assert(translation != NULL)
2673 || !ossl_assert(translation->action_type == GET)
2674 || !ossl_assert(translation->fixup_args != NULL)) {
2678 ret = fixup(PKEY, translation, &ctx);
2680 cleanup_translation_ctx(PKEY, translation, &ctx);
2685 int evp_pkey_get_params_to_ctrl(const EVP_PKEY *pkey, OSSL_PARAM *params)
2687 return evp_pkey_setget_params_to_ctrl(pkey, GET, params);