crypto/evp/keymgmt_meth.c

   1 /*
   2  * Copyright 2019-2024 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 #include <openssl/crypto.h>
  11 #include <openssl/core_dispatch.h>
  12 #include <openssl/evp.h>
  13 #include <openssl/err.h>
  14 #include "internal/provider.h"
  15 #include "internal/refcount.h"
  16 #include "internal/core.h"
  17 #include "crypto/evp.h"
  18 #include "evp_local.h"
  19
  20 static void *keymgmt_new(void)
  21 {
  22     EVP_KEYMGMT *keymgmt = NULL;
  23
  24     if ((keymgmt = OPENSSL_zalloc(sizeof(*keymgmt))) == NULL)
  25         return NULL;
  26     if (!CRYPTO_NEW_REF(&keymgmt->refcnt, 1)) {
  27         EVP_KEYMGMT_free(keymgmt);
  28         return NULL;
  29     }
  30     return keymgmt;
  31 }
  32
  33 #ifndef FIPS_MODULE
  34 static void help_get_legacy_alg_type_from_keymgmt(const char *keytype,
  35                                                   void *arg)
  36 {
  37     int *type = arg;
  38
  39     if (*type == NID_undef)
  40         *type = evp_pkey_name2type(keytype);
  41 }
  42
  43 static int get_legacy_alg_type_from_keymgmt(const EVP_KEYMGMT *keymgmt)
  44 {
  45     int type = NID_undef;
  46
  47     EVP_KEYMGMT_names_do_all(keymgmt, help_get_legacy_alg_type_from_keymgmt,
  48                              &type);
  49     return type;
  50 }
  51 #endif
  52
  53 static void *keymgmt_from_algorithm(int name_id,
  54                                     const OSSL_ALGORITHM *algodef,
  55                                     OSSL_PROVIDER *prov)
  56 {
  57     const OSSL_DISPATCH *fns = algodef->implementation;
  58     EVP_KEYMGMT *keymgmt = NULL;
  59     int setparamfncnt = 0, getparamfncnt = 0;
  60     int setgenparamfncnt = 0;
  61     int importfncnt = 0, exportfncnt = 0;
  62     int importtypesfncnt = 0, exporttypesfncnt = 0;
  63
  64     if ((keymgmt = keymgmt_new()) == NULL)
  65         return NULL;
  66
  67     keymgmt->name_id = name_id;
  68     if ((keymgmt->type_name = ossl_algorithm_get1_first_name(algodef)) == NULL) {
  69         EVP_KEYMGMT_free(keymgmt);
  70         return NULL;
  71     }
  72     keymgmt->description = algodef->algorithm_description;
  73
  74     for (; fns->function_id != 0; fns++) {
  75         switch (fns->function_id) {
  76         case OSSL_FUNC_KEYMGMT_NEW:
  77             if (keymgmt->new == NULL)
  78                 keymgmt->new = OSSL_FUNC_keymgmt_new(fns);
  79             break;
  80         case OSSL_FUNC_KEYMGMT_GEN_INIT:
  81             if (keymgmt->gen_init == NULL)
  82                 keymgmt->gen_init = OSSL_FUNC_keymgmt_gen_init(fns);
  83             break;
  84         case OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE:
  85             if (keymgmt->gen_set_template == NULL)
  86                 keymgmt->gen_set_template =
  87                     OSSL_FUNC_keymgmt_gen_set_template(fns);
  88             break;
  89         case OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS:
  90             if (keymgmt->gen_set_params == NULL) {
  91                 setgenparamfncnt++;
  92                 keymgmt->gen_set_params =
  93                     OSSL_FUNC_keymgmt_gen_set_params(fns);
  94             }
  95             break;
  96         case OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS:
  97             if (keymgmt->gen_settable_params == NULL) {
  98                 setgenparamfncnt++;
  99                 keymgmt->gen_settable_params =
 100                     OSSL_FUNC_keymgmt_gen_settable_params(fns);
 101             }
 102             break;
 103         case OSSL_FUNC_KEYMGMT_GEN:
 104             if (keymgmt->gen == NULL)
 105                 keymgmt->gen = OSSL_FUNC_keymgmt_gen(fns);
 106             break;
 107         case OSSL_FUNC_KEYMGMT_GEN_CLEANUP:
 108             if (keymgmt->gen_cleanup == NULL)
 109                 keymgmt->gen_cleanup = OSSL_FUNC_keymgmt_gen_cleanup(fns);
 110             break;
 111         case OSSL_FUNC_KEYMGMT_FREE:
 112             if (keymgmt->free == NULL)
 113                 keymgmt->free = OSSL_FUNC_keymgmt_free(fns);
 114             break;
 115         case OSSL_FUNC_KEYMGMT_LOAD:
 116             if (keymgmt->load == NULL)
 117                 keymgmt->load = OSSL_FUNC_keymgmt_load(fns);
 118             break;
 119         case OSSL_FUNC_KEYMGMT_GET_PARAMS:
 120             if (keymgmt->get_params == NULL) {
 121                 getparamfncnt++;
 122                 keymgmt->get_params = OSSL_FUNC_keymgmt_get_params(fns);
 123             }
 124             break;
 125         case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS:
 126             if (keymgmt->gettable_params == NULL) {
 127                 getparamfncnt++;
 128                 keymgmt->gettable_params =
 129                     OSSL_FUNC_keymgmt_gettable_params(fns);
 130             }
 131             break;
 132          case OSSL_FUNC_KEYMGMT_SET_PARAMS:
 133             if (keymgmt->set_params == NULL) {
 134                 setparamfncnt++;
 135                 keymgmt->set_params = OSSL_FUNC_keymgmt_set_params(fns);
 136             }
 137             break;
 138         case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS:
 139             if (keymgmt->settable_params == NULL) {
 140                 setparamfncnt++;
 141                 keymgmt->settable_params =
 142                     OSSL_FUNC_keymgmt_settable_params(fns);
 143             }
 144             break;
 145         case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME:
 146             if (keymgmt->query_operation_name == NULL)
 147                 keymgmt->query_operation_name =
 148                     OSSL_FUNC_keymgmt_query_operation_name(fns);
 149             break;
 150         case OSSL_FUNC_KEYMGMT_HAS:
 151             if (keymgmt->has == NULL)
 152                 keymgmt->has = OSSL_FUNC_keymgmt_has(fns);
 153             break;
 154         case OSSL_FUNC_KEYMGMT_DUP:
 155             if (keymgmt->dup == NULL)
 156                 keymgmt->dup = OSSL_FUNC_keymgmt_dup(fns);
 157             break;
 158         case OSSL_FUNC_KEYMGMT_VALIDATE:
 159             if (keymgmt->validate == NULL)
 160                 keymgmt->validate = OSSL_FUNC_keymgmt_validate(fns);
 161             break;
 162         case OSSL_FUNC_KEYMGMT_MATCH:
 163             if (keymgmt->match == NULL)
 164                 keymgmt->match = OSSL_FUNC_keymgmt_match(fns);
 165             break;
 166         case OSSL_FUNC_KEYMGMT_IMPORT:
 167             if (keymgmt->import == NULL) {
 168                 importfncnt++;
 169                 keymgmt->import = OSSL_FUNC_keymgmt_import(fns);
 170             }
 171             break;
 172         case OSSL_FUNC_KEYMGMT_IMPORT_TYPES:
 173             if (keymgmt->import_types == NULL) {
 174                 if (importtypesfncnt == 0)
 175                     importfncnt++;
 176                 importtypesfncnt++;
 177                 keymgmt->import_types = OSSL_FUNC_keymgmt_import_types(fns);
 178             }
 179             break;
 180         case OSSL_FUNC_KEYMGMT_IMPORT_TYPES_EX:
 181             if (keymgmt->import_types_ex == NULL) {
 182                 if (importtypesfncnt == 0)
 183                     importfncnt++;
 184                 importtypesfncnt++;
 185                 keymgmt->import_types_ex = OSSL_FUNC_keymgmt_import_types_ex(fns);
 186             }
 187             break;
 188         case OSSL_FUNC_KEYMGMT_EXPORT:
 189             if (keymgmt->export == NULL) {
 190                 exportfncnt++;
 191                 keymgmt->export = OSSL_FUNC_keymgmt_export(fns);
 192             }
 193             break;
 194         case OSSL_FUNC_KEYMGMT_EXPORT_TYPES:
 195             if (keymgmt->export_types == NULL) {
 196                 if (exporttypesfncnt == 0)
 197                     exportfncnt++;
 198                 exporttypesfncnt++;
 199                 keymgmt->export_types = OSSL_FUNC_keymgmt_export_types(fns);
 200             }
 201             break;
 202         case OSSL_FUNC_KEYMGMT_EXPORT_TYPES_EX:
 203             if (keymgmt->export_types_ex == NULL) {
 204                 if (exporttypesfncnt == 0)
 205                     exportfncnt++;
 206                 exporttypesfncnt++;
 207                 keymgmt->export_types_ex = OSSL_FUNC_keymgmt_export_types_ex(fns);
 208             }
 209             break;
 210         }
 211     }
 212     /*
 213      * Try to check that the method is sensible.
 214      * At least one constructor and the destructor are MANDATORY
 215      * The functions 'has' is MANDATORY
 216      * It makes no sense being able to free stuff if you can't create it.
 217      * It makes no sense providing OSSL_PARAM descriptors for import and
 218      * export if you can't import or export.
 219      */
 220     if (keymgmt->free == NULL
 221         || (keymgmt->new == NULL
 222             && keymgmt->gen == NULL
 223             && keymgmt->load == NULL)
 224         || keymgmt->has == NULL
 225         || (getparamfncnt != 0 && getparamfncnt != 2)
 226         || (setparamfncnt != 0 && setparamfncnt != 2)
 227         || (setgenparamfncnt != 0 && setgenparamfncnt != 2)
 228         || (importfncnt != 0 && importfncnt != 2)
 229         || (exportfncnt != 0 && exportfncnt != 2)
 230         || (keymgmt->gen != NULL
 231             && (keymgmt->gen_init == NULL
 232                 || keymgmt->gen_cleanup == NULL))) {
 233         EVP_KEYMGMT_free(keymgmt);
 234         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
 235         return NULL;
 236     }
 237     keymgmt->prov = prov;
 238     if (prov != NULL)
 239         ossl_provider_up_ref(prov);
 240
 241 #ifndef FIPS_MODULE
 242     keymgmt->legacy_alg = get_legacy_alg_type_from_keymgmt(keymgmt);
 243 #endif
 244
 245     return keymgmt;
 246 }
 247
 248 EVP_KEYMGMT *evp_keymgmt_fetch_from_prov(OSSL_PROVIDER *prov,
 249                                          const char *name,
 250                                          const char *properties)
 251 {
 252     return evp_generic_fetch_from_prov(prov, OSSL_OP_KEYMGMT,
 253                                        name, properties,
 254                                        keymgmt_from_algorithm,
 255                                        (int (*)(void *))EVP_KEYMGMT_up_ref,
 256                                        (void (*)(void *))EVP_KEYMGMT_free);
 257 }
 258
 259 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
 260                                const char *properties)
 261 {
 262     return evp_generic_fetch(ctx, OSSL_OP_KEYMGMT, algorithm, properties,
 263                              keymgmt_from_algorithm,
 264                              (int (*)(void *))EVP_KEYMGMT_up_ref,
 265                              (void (*)(void *))EVP_KEYMGMT_free);
 266 }
 267
 268 int EVP_KEYMGMT_up_ref(EVP_KEYMGMT *keymgmt)
 269 {
 270     int ref = 0;
 271
 272     CRYPTO_UP_REF(&keymgmt->refcnt, &ref);
 273     return 1;
 274 }
 275
 276 void EVP_KEYMGMT_free(EVP_KEYMGMT *keymgmt)
 277 {
 278     int ref = 0;
 279
 280     if (keymgmt == NULL)
 281         return;
 282
 283     CRYPTO_DOWN_REF(&keymgmt->refcnt, &ref);
 284     if (ref > 0)
 285         return;
 286     OPENSSL_free(keymgmt->type_name);
 287     ossl_provider_free(keymgmt->prov);
 288     CRYPTO_FREE_REF(&keymgmt->refcnt);
 289     OPENSSL_free(keymgmt);
 290 }
 291
 292 const OSSL_PROVIDER *EVP_KEYMGMT_get0_provider(const EVP_KEYMGMT *keymgmt)
 293 {
 294     return keymgmt->prov;
 295 }
 296
 297 int evp_keymgmt_get_number(const EVP_KEYMGMT *keymgmt)
 298 {
 299     return keymgmt->name_id;
 300 }
 301
 302 int evp_keymgmt_get_legacy_alg(const EVP_KEYMGMT *keymgmt)
 303 {
 304     return keymgmt->legacy_alg;
 305 }
 306
 307 const char *EVP_KEYMGMT_get0_description(const EVP_KEYMGMT *keymgmt)
 308 {
 309     return keymgmt->description;
 310 }
 311
 312 const char *EVP_KEYMGMT_get0_name(const EVP_KEYMGMT *keymgmt)
 313 {
 314     return keymgmt->type_name;
 315 }
 316
 317 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name)
 318 {
 319     return keymgmt != NULL
 320            && evp_is_a(keymgmt->prov, keymgmt->name_id, NULL, name);
 321 }
 322
 323 void EVP_KEYMGMT_do_all_provided(OSSL_LIB_CTX *libctx,
 324                                  void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
 325                                  void *arg)
 326 {
 327     evp_generic_do_all(libctx, OSSL_OP_KEYMGMT,
 328                        (void (*)(void *, void *))fn, arg,
 329                        keymgmt_from_algorithm,
 330                        (int (*)(void *))EVP_KEYMGMT_up_ref,
 331                        (void (*)(void *))EVP_KEYMGMT_free);
 332 }
 333
 334 int EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT *keymgmt,
 335                              void (*fn)(const char *name, void *data),
 336                              void *data)
 337 {
 338     if (keymgmt->prov != NULL)
 339         return evp_names_do_all(keymgmt->prov, keymgmt->name_id, fn, data);
 340
 341     return 1;
 342 }
 343
 344 /*
 345  * Internal API that interfaces with the method function pointers
 346  */
 347 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt)
 348 {
 349     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 350
 351     /*
 352      * 'new' is currently mandatory on its own, but when new
 353      * constructors appear, it won't be quite as mandatory,
 354      * so we have a check for future cases.
 355      */
 356     if (keymgmt->new == NULL)
 357         return NULL;
 358     return keymgmt->new(provctx);
 359 }
 360
 361 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keydata)
 362 {
 363     /* This is mandatory, no need to check for its presence */
 364     keymgmt->free(keydata);
 365 }
 366
 367 void *evp_keymgmt_gen_init(const EVP_KEYMGMT *keymgmt, int selection,
 368                            const OSSL_PARAM params[])
 369 {
 370     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 371
 372     if (keymgmt->gen_init == NULL)
 373         return NULL;
 374     return keymgmt->gen_init(provctx, selection, params);
 375 }
 376
 377 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT *keymgmt, void *genctx,
 378                                  void *templ)
 379 {
 380     /*
 381      * It's arguable if we actually should return success in this case, as
 382      * it allows the caller to set a template key, which is then ignored.
 383      * However, this is how the legacy methods (EVP_PKEY_METHOD) operate,
 384      * so we do this in the interest of backward compatibility.
 385      */
 386     if (keymgmt->gen_set_template == NULL)
 387         return 1;
 388     return keymgmt->gen_set_template(genctx, templ);
 389 }
 390
 391 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT *keymgmt, void *genctx,
 392                                const OSSL_PARAM params[])
 393 {
 394     if (keymgmt->gen_set_params == NULL)
 395         return 0;
 396     return keymgmt->gen_set_params(genctx, params);
 397 }
 398
 399 const OSSL_PARAM *EVP_KEYMGMT_gen_settable_params(const EVP_KEYMGMT *keymgmt)
 400 {
 401     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 402
 403     if (keymgmt->gen_settable_params == NULL)
 404         return NULL;
 405     return keymgmt->gen_settable_params(NULL, provctx);
 406 }
 407
 408 void *evp_keymgmt_gen(const EVP_KEYMGMT *keymgmt, void *genctx,
 409                       OSSL_CALLBACK *cb, void *cbarg)
 410 {
 411     if (keymgmt->gen == NULL)
 412         return NULL;
 413     return keymgmt->gen(genctx, cb, cbarg);
 414 }
 415
 416 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT *keymgmt, void *genctx)
 417 {
 418     if (keymgmt->gen_cleanup != NULL)
 419         keymgmt->gen_cleanup(genctx);
 420 }
 421
 422 int evp_keymgmt_has_load(const EVP_KEYMGMT *keymgmt)
 423 {
 424     return keymgmt != NULL && keymgmt->load != NULL;
 425 }
 426
 427 void *evp_keymgmt_load(const EVP_KEYMGMT *keymgmt,
 428                        const void *objref, size_t objref_sz)
 429 {
 430     if (evp_keymgmt_has_load(keymgmt))
 431         return keymgmt->load(objref, objref_sz);
 432     return NULL;
 433 }
 434
 435 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 436                            OSSL_PARAM params[])
 437 {
 438     if (keymgmt->get_params == NULL)
 439         return 1;
 440     return keymgmt->get_params(keydata, params);
 441 }
 442
 443 const OSSL_PARAM *EVP_KEYMGMT_gettable_params(const EVP_KEYMGMT *keymgmt)
 444 {
 445     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 446
 447     if (keymgmt->gettable_params == NULL)
 448         return NULL;
 449     return keymgmt->gettable_params(provctx);
 450 }
 451
 452 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 453                            const OSSL_PARAM params[])
 454 {
 455     if (keymgmt->set_params == NULL)
 456         return 1;
 457     return keymgmt->set_params(keydata, params);
 458 }
 459
 460 const OSSL_PARAM *EVP_KEYMGMT_settable_params(const EVP_KEYMGMT *keymgmt)
 461 {
 462     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 463
 464     if (keymgmt->settable_params == NULL)
 465         return NULL;
 466     return keymgmt->settable_params(provctx);
 467 }
 468
 469 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keydata, int selection)
 470 {
 471     /* This is mandatory, no need to check for its presence */
 472     return keymgmt->has(keydata, selection);
 473 }
 474
 475 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
 476                          int selection, int checktype)
 477 {
 478     /* We assume valid if the implementation doesn't have a function */
 479     if (keymgmt->validate == NULL)
 480         return 1;
 481     return keymgmt->validate(keydata, selection, checktype);
 482 }
 483
 484 int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
 485                       const void *keydata1, const void *keydata2,
 486                       int selection)
 487 {
 488     /* We assume no match if the implementation doesn't have a function */
 489     if (keymgmt->match == NULL)
 490         return 0;
 491     return keymgmt->match(keydata1, keydata2, selection);
 492 }
 493
 494 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
 495                        int selection, const OSSL_PARAM params[])
 496 {
 497     if (keymgmt->import == NULL)
 498         return 0;
 499     return keymgmt->import(keydata, selection, params);
 500 }
 501
 502 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
 503                                            int selection)
 504 {
 505     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 506
 507     if (keymgmt->import_types_ex != NULL)
 508         return keymgmt->import_types_ex(provctx, selection);
 509     if (keymgmt->import_types == NULL)
 510         return NULL;
 511     return keymgmt->import_types(selection);
 512 }
 513
 514 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
 515                        int selection, OSSL_CALLBACK *param_cb, void *cbarg)
 516 {
 517     if (keymgmt->export == NULL)
 518         return 0;
 519     return keymgmt->export(keydata, selection, param_cb, cbarg);
 520 }
 521
 522 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
 523                                            int selection)
 524 {
 525     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_get0_provider(keymgmt));
 526
 527     if (keymgmt->export_types_ex != NULL)
 528         return keymgmt->export_types_ex(provctx, selection);
 529     if (keymgmt->export_types == NULL)
 530         return NULL;
 531     return keymgmt->export_types(selection);
 532 }
 533
 534 void *evp_keymgmt_dup(const EVP_KEYMGMT *keymgmt, const void *keydata_from,
 535                       int selection)
 536 {
 537     /* We assume no dup if the implementation doesn't have a function */
 538     if (keymgmt->dup == NULL)
 539         return NULL;
 540     return keymgmt->dup(keydata_from, selection);
 541 }