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