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