crypto/evp/keymgmt_meth.c

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