crypto/evp/keymgmt_meth.c

   1 /*
   2  * Copyright 2019-2020 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_numbers.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
  20 static void *keymgmt_new(void)
  21 {
  22     EVP_KEYMGMT *keymgmt = NULL;
  23
  24     if ((keymgmt = OPENSSL_zalloc(sizeof(*keymgmt))) == NULL
  25         || (keymgmt->lock = CRYPTO_THREAD_lock_new()) == NULL) {
  26         EVP_KEYMGMT_free(keymgmt);
  27         EVPerr(0, ERR_R_MALLOC_FAILURE);
  28         return NULL;
  29     }
  30
  31     keymgmt->refcnt = 1;
  32
  33     return keymgmt;
  34 }
  35
  36 static void *keymgmt_from_dispatch(int name_id,
  37                                    const OSSL_DISPATCH *fns,
  38                                    OSSL_PROVIDER *prov)
  39 {
  40     EVP_KEYMGMT *keymgmt = NULL;
  41     int setparamfncnt = 0, getparamfncnt = 0;
  42     int setgenparamfncnt = 0, getgenparamfncnt = 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
  51     for (; fns->function_id != 0; fns++) {
  52         switch (fns->function_id) {
  53         case OSSL_FUNC_KEYMGMT_NEW:
  54             if (keymgmt->new == NULL)
  55                 keymgmt->new = OSSL_get_OP_keymgmt_new(fns);
  56             break;
  57         case OSSL_FUNC_KEYMGMT_GEN_INIT:
  58             if (keymgmt->gen_init == NULL)
  59                 keymgmt->gen_init = OSSL_get_OP_keymgmt_gen_init(fns);
  60             break;
  61         case OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE:
  62             if (keymgmt->gen_set_template == NULL)
  63                 keymgmt->gen_set_template =
  64                     OSSL_get_OP_keymgmt_gen_set_template(fns);
  65             break;
  66         case OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS:
  67             if (keymgmt->gen_set_params == NULL) {
  68                 setgenparamfncnt++;
  69                 keymgmt->gen_set_params =
  70                     OSSL_get_OP_keymgmt_gen_set_params(fns);
  71             }
  72             break;
  73         case OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS:
  74             if (keymgmt->gen_settable_params == NULL) {
  75                 setgenparamfncnt++;
  76                 keymgmt->gen_settable_params =
  77                     OSSL_get_OP_keymgmt_gen_settable_params(fns);
  78             }
  79             break;
  80         case OSSL_FUNC_KEYMGMT_GEN_GET_PARAMS:
  81             if (keymgmt->gen_get_params == NULL) {
  82                 getgenparamfncnt++;
  83                 keymgmt->gen_get_params =
  84                     OSSL_get_OP_keymgmt_gen_get_params(fns);
  85             }
  86             break;
  87         case OSSL_FUNC_KEYMGMT_GEN_GETTABLE_PARAMS:
  88             if (keymgmt->gen_gettable_params == NULL) {
  89                 getgenparamfncnt++;
  90                 keymgmt->gen_gettable_params =
  91                     OSSL_get_OP_keymgmt_gen_gettable_params(fns);
  92             }
  93             break;
  94         case OSSL_FUNC_KEYMGMT_GEN:
  95             if (keymgmt->gen == NULL)
  96                 keymgmt->gen = OSSL_get_OP_keymgmt_gen(fns);
  97             break;
  98         case OSSL_FUNC_KEYMGMT_GEN_CLEANUP:
  99             if (keymgmt->gen_cleanup == NULL)
 100                 keymgmt->gen_cleanup = OSSL_get_OP_keymgmt_gen_cleanup(fns);
 101             break;
 102         case OSSL_FUNC_KEYMGMT_FREE:
 103             if (keymgmt->free == NULL)
 104                 keymgmt->free = OSSL_get_OP_keymgmt_free(fns);
 105             break;
 106         case OSSL_FUNC_KEYMGMT_GET_PARAMS:
 107             if (keymgmt->get_params == NULL) {
 108                 getparamfncnt++;
 109                 keymgmt->get_params = OSSL_get_OP_keymgmt_get_params(fns);
 110             }
 111             break;
 112         case OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS:
 113             if (keymgmt->gettable_params == NULL) {
 114                 getparamfncnt++;
 115                 keymgmt->gettable_params =
 116                     OSSL_get_OP_keymgmt_gettable_params(fns);
 117             }
 118             break;
 119          case OSSL_FUNC_KEYMGMT_SET_PARAMS:
 120             if (keymgmt->set_params == NULL) {
 121                 setparamfncnt++;
 122                 keymgmt->set_params = OSSL_get_OP_keymgmt_set_params(fns);
 123             }
 124             break;
 125         case OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS:
 126             if (keymgmt->settable_params == NULL) {
 127                 setparamfncnt++;
 128                 keymgmt->settable_params =
 129                     OSSL_get_OP_keymgmt_settable_params(fns);
 130             }
 131             break;
 132         case OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME:
 133             if (keymgmt->query_operation_name == NULL)
 134                 keymgmt->query_operation_name =
 135                     OSSL_get_OP_keymgmt_query_operation_name(fns);
 136             break;
 137         case OSSL_FUNC_KEYMGMT_HAS:
 138             if (keymgmt->has == NULL)
 139                 keymgmt->has = OSSL_get_OP_keymgmt_has(fns);
 140             break;
 141         case OSSL_FUNC_KEYMGMT_VALIDATE:
 142             if (keymgmt->validate == NULL)
 143                 keymgmt->validate = OSSL_get_OP_keymgmt_validate(fns);
 144             break;
 145         case OSSL_FUNC_KEYMGMT_MATCH:
 146             if (keymgmt->match == NULL)
 147                 keymgmt->match = OSSL_get_OP_keymgmt_match(fns);
 148             break;
 149         case OSSL_FUNC_KEYMGMT_IMPORT:
 150             if (keymgmt->import == NULL) {
 151                 importfncnt++;
 152                 keymgmt->import = OSSL_get_OP_keymgmt_import(fns);
 153             }
 154             break;
 155         case OSSL_FUNC_KEYMGMT_IMPORT_TYPES:
 156             if (keymgmt->import_types == NULL) {
 157                 importfncnt++;
 158                 keymgmt->import_types = OSSL_get_OP_keymgmt_import_types(fns);
 159             }
 160             break;
 161         case OSSL_FUNC_KEYMGMT_EXPORT:
 162             if (keymgmt->export == NULL) {
 163                 exportfncnt++;
 164                 keymgmt->export = OSSL_get_OP_keymgmt_export(fns);
 165             }
 166             break;
 167         case OSSL_FUNC_KEYMGMT_EXPORT_TYPES:
 168             if (keymgmt->export_types == NULL) {
 169                 exportfncnt++;
 170                 keymgmt->export_types = OSSL_get_OP_keymgmt_export_types(fns);
 171             }
 172             break;
 173         }
 174     }
 175     /*
 176      * Try to check that the method is sensible.
 177      * At least one constructor and the destructor are MANDATORY
 178      * The functions 'has' is MANDATORY
 179      * It makes no sense being able to free stuff if you can't create it.
 180      * It makes no sense providing OSSL_PARAM descriptors for import and
 181      * export if you can't import or export.
 182      */
 183     if (keymgmt->free == NULL
 184         || (keymgmt->new == NULL && keymgmt->gen == NULL)
 185         || keymgmt->has == NULL
 186         || (getparamfncnt != 0 && getparamfncnt != 2)
 187         || (setparamfncnt != 0 && setparamfncnt != 2)
 188         || (setgenparamfncnt != 0 && setgenparamfncnt != 2)
 189         || (getgenparamfncnt != 0 && getgenparamfncnt != 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         EVPerr(0, 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(OPENSSL_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_dispatch,
 212                                        (int (*)(void *))EVP_KEYMGMT_up_ref,
 213                                        (void (*)(void *))EVP_KEYMGMT_free);
 214 }
 215
 216 EVP_KEYMGMT *EVP_KEYMGMT_fetch(OPENSSL_CTX *ctx, const char *algorithm,
 217                                const char *properties)
 218 {
 219     return evp_generic_fetch(ctx, OSSL_OP_KEYMGMT, algorithm, properties,
 220                              keymgmt_from_dispatch,
 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 int EVP_KEYMGMT_is_a(const EVP_KEYMGMT *keymgmt, const char *name)
 259 {
 260     return evp_is_a(keymgmt->prov, keymgmt->name_id, NULL, name);
 261 }
 262
 263 void EVP_KEYMGMT_do_all_provided(OPENSSL_CTX *libctx,
 264                                  void (*fn)(EVP_KEYMGMT *keymgmt, void *arg),
 265                                  void *arg)
 266 {
 267     evp_generic_do_all(libctx, OSSL_OP_KEYMGMT,
 268                        (void (*)(void *, void *))fn, arg,
 269                        keymgmt_from_dispatch,
 270                        (void (*)(void *))EVP_KEYMGMT_free);
 271 }
 272
 273 void EVP_KEYMGMT_names_do_all(const EVP_KEYMGMT *keymgmt,
 274                               void (*fn)(const char *name, void *data),
 275                               void *data)
 276 {
 277     if (keymgmt->prov != NULL)
 278         evp_names_do_all(keymgmt->prov, keymgmt->name_id, fn, data);
 279 }
 280
 281 /*
 282  * Internal API that interfaces with the method function pointers
 283  */
 284 void *evp_keymgmt_newdata(const EVP_KEYMGMT *keymgmt)
 285 {
 286     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 287
 288     /*
 289      * TODO(3.0) 'new' is currently mandatory on its own, but when new
 290      * constructors appear, it won't be quite as mandatory, so we have
 291      * a check for future cases.
 292      */
 293     if (keymgmt->new == NULL)
 294         return NULL;
 295     return keymgmt->new(provctx);
 296 }
 297
 298 void evp_keymgmt_freedata(const EVP_KEYMGMT *keymgmt, void *keydata)
 299 {
 300     /* This is mandatory, no need to check for its presence */
 301     keymgmt->free(keydata);
 302 }
 303
 304 void *evp_keymgmt_gen_init(const EVP_KEYMGMT *keymgmt, int selection)
 305 {
 306     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 307
 308     if (keymgmt->gen_init == NULL)
 309         return NULL;
 310     return keymgmt->gen_init(provctx, selection);
 311 }
 312
 313 int evp_keymgmt_gen_set_template(const EVP_KEYMGMT *keymgmt, void *genctx,
 314                                  void *template)
 315 {
 316     /*
 317      * It's arguable if we actually should return success in this case, as
 318      * it allows the caller to set a template key, which is then ignored.
 319      * However, this is how the legacy methods (EVP_PKEY_METHOD) operate,
 320      * so we do this in the interest of backward compatibility.
 321      * TODO(3.0) Investigate if we should change this behaviour.
 322      */
 323     if (keymgmt->gen_set_template == NULL)
 324         return 1;
 325     return keymgmt->gen_set_template(genctx, template);
 326 }
 327
 328 int evp_keymgmt_gen_set_params(const EVP_KEYMGMT *keymgmt, void *genctx,
 329                                const OSSL_PARAM params[])
 330 {
 331     if (keymgmt->gen_set_params == NULL)
 332         return 0;
 333     return keymgmt->gen_set_params(genctx, params);
 334 }
 335
 336 const OSSL_PARAM *evp_keymgmt_gen_settable_params(const EVP_KEYMGMT *keymgmt)
 337 {
 338     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 339
 340     if (keymgmt->gen_settable_params == NULL)
 341         return NULL;
 342     return keymgmt->gen_settable_params(provctx);
 343 }
 344
 345 int evp_keymgmt_gen_get_params(const EVP_KEYMGMT *keymgmt, void *genctx,
 346                                OSSL_PARAM params[])
 347 {
 348     if (keymgmt->gen_get_params == NULL)
 349         return 0;
 350     return keymgmt->gen_get_params(genctx, params);
 351 }
 352
 353 const OSSL_PARAM *evp_keymgmt_gen_gettable_params(const EVP_KEYMGMT *keymgmt)
 354 {
 355     void *provctx = ossl_provider_ctx(EVP_KEYMGMT_provider(keymgmt));
 356
 357     if (keymgmt->gen_gettable_params == NULL)
 358         return NULL;
 359     return keymgmt->gen_gettable_params(provctx);
 360 }
 361
 362 void *evp_keymgmt_gen(const EVP_KEYMGMT *keymgmt, void *genctx,
 363                       OSSL_CALLBACK *cb, void *cbarg)
 364 {
 365     if (keymgmt->gen == NULL)
 366         return NULL;
 367     return keymgmt->gen(genctx, cb, cbarg);
 368 }
 369
 370 void evp_keymgmt_gen_cleanup(const EVP_KEYMGMT *keymgmt, void *genctx)
 371 {
 372     if (keymgmt->gen != NULL)
 373         keymgmt->gen_cleanup(genctx);
 374 }
 375
 376 int evp_keymgmt_get_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 377                            OSSL_PARAM params[])
 378 {
 379     if (keymgmt->get_params == NULL)
 380         return 1;
 381     return keymgmt->get_params(keydata, params);
 382 }
 383
 384 const OSSL_PARAM *evp_keymgmt_gettable_params(const EVP_KEYMGMT *keymgmt)
 385 {
 386     if (keymgmt->gettable_params == NULL)
 387         return NULL;
 388     return keymgmt->gettable_params();
 389 }
 390
 391 int evp_keymgmt_set_params(const EVP_KEYMGMT *keymgmt, void *keydata,
 392                            const OSSL_PARAM params[])
 393 {
 394     if (keymgmt->set_params == NULL)
 395         return 1;
 396     return keymgmt->set_params(keydata, params);
 397 }
 398
 399 const OSSL_PARAM *evp_keymgmt_settable_params(const EVP_KEYMGMT *keymgmt)
 400 {
 401     if (keymgmt->settable_params == NULL)
 402         return NULL;
 403     return keymgmt->settable_params();
 404 }
 405
 406 int evp_keymgmt_has(const EVP_KEYMGMT *keymgmt, void *keydata, int selection)
 407 {
 408     /* This is mandatory, no need to check for its presence */
 409     return keymgmt->has(keydata, selection);
 410 }
 411
 412 int evp_keymgmt_validate(const EVP_KEYMGMT *keymgmt, void *keydata,
 413                          int selection)
 414 {
 415     /* We assume valid if the implementation doesn't have a function */
 416     if (keymgmt->validate == NULL)
 417         return 1;
 418     return keymgmt->validate(keydata, selection);
 419 }
 420
 421 int evp_keymgmt_match(const EVP_KEYMGMT *keymgmt,
 422                       const void *keydata1, const void *keydata2,
 423                       int selection)
 424 {
 425     /* We assume no match if the implementation doesn't have a function */
 426     if (keymgmt->match == NULL)
 427         return 0;
 428     return keymgmt->match(keydata1, keydata2, selection);
 429 }
 430
 431 int evp_keymgmt_import(const EVP_KEYMGMT *keymgmt, void *keydata,
 432                        int selection, const OSSL_PARAM params[])
 433 {
 434     if (keymgmt->import == NULL)
 435         return 0;
 436     return keymgmt->import(keydata, selection, params);
 437 }
 438
 439 const OSSL_PARAM *evp_keymgmt_import_types(const EVP_KEYMGMT *keymgmt,
 440                                            int selection)
 441 {
 442     if (keymgmt->import_types == NULL)
 443         return NULL;
 444     return keymgmt->import_types(selection);
 445 }
 446
 447 int evp_keymgmt_export(const EVP_KEYMGMT *keymgmt, void *keydata,
 448                        int selection, OSSL_CALLBACK *param_cb, void *cbarg)
 449 {
 450     if (keymgmt->export == NULL)
 451         return 0;
 452     return keymgmt->export(keydata, selection, param_cb, cbarg);
 453 }
 454
 455 const OSSL_PARAM *evp_keymgmt_export_types(const EVP_KEYMGMT *keymgmt,
 456                                            int selection)
 457 {
 458     if (keymgmt->export_types == NULL)
 459         return NULL;
 460     return keymgmt->export_types(selection);
 461 }
 462
 463 int evp_keymgmt_copy(const EVP_KEYMGMT *keymgmt,
 464                      void *keydata_to, const void *keydata_from,
 465                      int selection)
 466 {
 467     /* We assume no copy if the implementation doesn't have a function */
 468     if (keymgmt->copy == NULL)
 469         return 0;
 470     return keymgmt->copy(keydata_to, keydata_from, selection);
 471 }