crypto/evp/keymgmt_lib.c

   1 /*
   2  * Copyright 2019-2022 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/core_names.h>
  11 #include "internal/cryptlib.h"
  12 #include "internal/nelem.h"
  13 #include "crypto/evp.h"
  14 #include "internal/core.h"
  15 #include "internal/provider.h"
  16 #include "evp_local.h"
  17
  18 /*
  19  * match_type() checks if two EVP_KEYMGMT are matching key types.  This
  20  * function assumes that the caller has made all the necessary NULL checks.
  21  */
  22 static int match_type(const EVP_KEYMGMT *keymgmt1, const EVP_KEYMGMT *keymgmt2)
  23 {
  24     const char *name2 = EVP_KEYMGMT_get0_name(keymgmt2);
  25
  26     return EVP_KEYMGMT_is_a(keymgmt1, name2);
  27 }
  28
  29 int evp_keymgmt_util_try_import(const OSSL_PARAM params[], void *arg)
  30 {
  31     struct evp_keymgmt_util_try_import_data_st *data = arg;
  32     int delete_on_error = 0;
  33
  34     /* Just in time creation of keydata */
  35     if (data->keydata == NULL) {
  36         if ((data->keydata = evp_keymgmt_newdata(data->keymgmt)) == NULL) {
  37             ERR_raise(ERR_LIB_EVP, ERR_R_EVP_LIB);
  38             return 0;
  39         }
  40         delete_on_error = 1;
  41     }
  42
  43     /*
  44      * It's fine if there was no data to transfer, we just end up with an
  45      * empty destination key.
  46      */
  47     if (params[0].key == NULL)
  48         return 1;
  49
  50     if (evp_keymgmt_import(data->keymgmt, data->keydata, data->selection,
  51                            params))
  52         return 1;
  53     if (delete_on_error) {
  54         evp_keymgmt_freedata(data->keymgmt, data->keydata);
  55         data->keydata = NULL;
  56     }
  57     return 0;
  58 }
  59
  60 int evp_keymgmt_util_assign_pkey(EVP_PKEY *pkey, EVP_KEYMGMT *keymgmt,
  61                                  void *keydata)
  62 {
  63     if (pkey == NULL || keymgmt == NULL || keydata == NULL
  64         || !EVP_PKEY_set_type_by_keymgmt(pkey, keymgmt)) {
  65         ERR_raise(ERR_LIB_EVP, ERR_R_INTERNAL_ERROR);
  66         return 0;
  67     }
  68     pkey->keydata = keydata;
  69     evp_keymgmt_util_cache_keyinfo(pkey);
  70     return 1;
  71 }
  72
  73 EVP_PKEY *evp_keymgmt_util_make_pkey(EVP_KEYMGMT *keymgmt, void *keydata)
  74 {
  75     EVP_PKEY *pkey = NULL;
  76
  77     if (keymgmt == NULL
  78         || keydata == NULL
  79         || (pkey = EVP_PKEY_new()) == NULL
  80         || !evp_keymgmt_util_assign_pkey(pkey, keymgmt, keydata)) {
  81         EVP_PKEY_free(pkey);
  82         return NULL;
  83     }
  84     return pkey;
  85 }
  86
  87 int evp_keymgmt_util_export(const EVP_PKEY *pk, int selection,
  88                             OSSL_CALLBACK *export_cb, void *export_cbarg)
  89 {
  90     if (pk == NULL || export_cb == NULL)
  91         return 0;
  92     return evp_keymgmt_export(pk->keymgmt, pk->keydata, selection,
  93                               export_cb, export_cbarg);
  94 }
  95
  96 void *evp_keymgmt_util_export_to_provider(EVP_PKEY *pk, EVP_KEYMGMT *keymgmt,
  97                                           int selection)
  98 {
  99     struct evp_keymgmt_util_try_import_data_st import_data;
 100     OP_CACHE_ELEM *op;
 101
 102     /* Export to where? */
 103     if (keymgmt == NULL)
 104         return NULL;
 105
 106     /* If we have an unassigned key, give up */
 107     if (pk->keydata == NULL)
 108         return NULL;
 109
 110     /*
 111      * If |keymgmt| matches the "origin" |keymgmt|, there is no more to do.
 112      * The "origin" is determined by the |keymgmt| pointers being identical
 113      * or when the provider and the name ID match.  The latter case handles the
 114      * situation where the fetch cache is flushed and a "new" key manager is
 115      * created.
 116      */
 117     if (pk->keymgmt == keymgmt
 118         || (pk->keymgmt->name_id == keymgmt->name_id
 119             && pk->keymgmt->prov == keymgmt->prov))
 120         return pk->keydata;
 121
 122     if (!CRYPTO_THREAD_read_lock(pk->lock))
 123         return NULL;
 124     /*
 125      * If the provider native "origin" hasn't changed since last time, we
 126      * try to find our keymgmt in the operation cache.  If it has changed
 127      * and our keymgmt isn't found, we will clear the cache further down.
 128      */
 129     if (pk->dirty_cnt == pk->dirty_cnt_copy) {
 130         /* If this key is already exported to |keymgmt|, no more to do */
 131         op = evp_keymgmt_util_find_operation_cache(pk, keymgmt, selection);
 132         if (op != NULL && op->keymgmt != NULL) {
 133             void *ret = op->keydata;
 134
 135             CRYPTO_THREAD_unlock(pk->lock);
 136             return ret;
 137         }
 138     }
 139     CRYPTO_THREAD_unlock(pk->lock);
 140
 141     /* If the "origin" |keymgmt| doesn't support exporting, give up */
 142     if (pk->keymgmt->export == NULL)
 143         return NULL;
 144
 145     /*
 146      * Make sure that the type of the keymgmt to export to matches the type
 147      * of the "origin"
 148      */
 149     if (!ossl_assert(match_type(pk->keymgmt, keymgmt)))
 150         return NULL;
 151
 152     /*
 153      * We look at the already cached provider keys, and import from the
 154      * first that supports it (i.e. use its export function), and export
 155      * the imported data to the new provider.
 156      */
 157
 158     /* Setup for the export callback */
 159     import_data.keydata = NULL;  /* evp_keymgmt_util_try_import will create it */
 160     import_data.keymgmt = keymgmt;
 161     import_data.selection = selection;
 162
 163     /*
 164      * The export function calls the callback (evp_keymgmt_util_try_import),
 165      * which does the import for us.  If successful, we're done.
 166      */
 167     if (!evp_keymgmt_util_export(pk, selection,
 168                                  &evp_keymgmt_util_try_import, &import_data))
 169         /* If there was an error, bail out */
 170         return NULL;
 171
 172     if (!CRYPTO_THREAD_write_lock(pk->lock)) {
 173         evp_keymgmt_freedata(keymgmt, import_data.keydata);
 174         return NULL;
 175     }
 176     /* Check to make sure some other thread didn't get there first */
 177     op = evp_keymgmt_util_find_operation_cache(pk, keymgmt, selection);
 178     if (op != NULL && op->keydata != NULL) {
 179         void *ret = op->keydata;
 180
 181         CRYPTO_THREAD_unlock(pk->lock);
 182
 183         /*
 184          * Another thread seemms to have already exported this so we abandon
 185          * all the work we just did.
 186          */
 187         evp_keymgmt_freedata(keymgmt, import_data.keydata);
 188
 189         return ret;
 190     }
 191
 192     /*
 193      * If the dirty counter changed since last time, then clear the
 194      * operation cache.  In that case, we know that |i| is zero.
 195      */
 196     if (pk->dirty_cnt != pk->dirty_cnt_copy)
 197         evp_keymgmt_util_clear_operation_cache(pk);
 198
 199     /* Add the new export to the operation cache */
 200     if (!evp_keymgmt_util_cache_keydata(pk, keymgmt, import_data.keydata,
 201                                         selection)) {
 202         CRYPTO_THREAD_unlock(pk->lock);
 203         evp_keymgmt_freedata(keymgmt, import_data.keydata);
 204         return NULL;
 205     }
 206
 207     /* Synchronize the dirty count */
 208     pk->dirty_cnt_copy = pk->dirty_cnt;
 209
 210     CRYPTO_THREAD_unlock(pk->lock);
 211
 212     return import_data.keydata;
 213 }
 214
 215 static void op_cache_free(OP_CACHE_ELEM *e)
 216 {
 217     evp_keymgmt_freedata(e->keymgmt, e->keydata);
 218     EVP_KEYMGMT_free(e->keymgmt);
 219     OPENSSL_free(e);
 220 }
 221
 222 int evp_keymgmt_util_clear_operation_cache(EVP_PKEY *pk)
 223 {
 224     if (pk != NULL) {
 225         sk_OP_CACHE_ELEM_pop_free(pk->operation_cache, op_cache_free);
 226         pk->operation_cache = NULL;
 227     }
 228
 229     return 1;
 230 }
 231
 232 OP_CACHE_ELEM *evp_keymgmt_util_find_operation_cache(EVP_PKEY *pk,
 233                                                      EVP_KEYMGMT *keymgmt,
 234                                                      int selection)
 235 {
 236     int i, end = sk_OP_CACHE_ELEM_num(pk->operation_cache);
 237     OP_CACHE_ELEM *p;
 238
 239     /*
 240      * A comparison and sk_P_CACHE_ELEM_find() are avoided to not cause
 241      * problems when we've only a read lock.
 242      */
 243     for (i = 0; i < end; i++) {
 244         p = sk_OP_CACHE_ELEM_value(pk->operation_cache, i);
 245         if (keymgmt == p->keymgmt && (p->selection & selection) == selection)
 246             return p;
 247     }
 248     return NULL;
 249 }
 250
 251 int evp_keymgmt_util_cache_keydata(EVP_PKEY *pk, EVP_KEYMGMT *keymgmt,
 252                                    void *keydata, int selection)
 253 {
 254     OP_CACHE_ELEM *p = NULL;
 255
 256     if (keydata != NULL) {
 257         if (pk->operation_cache == NULL) {
 258             pk->operation_cache = sk_OP_CACHE_ELEM_new_null();
 259             if (pk->operation_cache == NULL)
 260                 return 0;
 261         }
 262
 263         p = OPENSSL_malloc(sizeof(*p));
 264         if (p == NULL)
 265             return 0;
 266         p->keydata = keydata;
 267         p->keymgmt = keymgmt;
 268         p->selection = selection;
 269
 270         if (!EVP_KEYMGMT_up_ref(keymgmt)) {
 271             OPENSSL_free(p);
 272             return 0;
 273         }
 274
 275         if (!sk_OP_CACHE_ELEM_push(pk->operation_cache, p)) {
 276             EVP_KEYMGMT_free(keymgmt);
 277             OPENSSL_free(p);
 278             return 0;
 279         }
 280     }
 281     return 1;
 282 }
 283
 284 void evp_keymgmt_util_cache_keyinfo(EVP_PKEY *pk)
 285 {
 286     /*
 287      * Cache information about the provider "origin" key.
 288      *
 289      * This services functions like EVP_PKEY_get_size, EVP_PKEY_get_bits, etc
 290      */
 291     if (pk->keydata != NULL) {
 292         int bits = 0;
 293         int security_bits = 0;
 294         int size = 0;
 295         OSSL_PARAM params[4];
 296
 297         params[0] = OSSL_PARAM_construct_int(OSSL_PKEY_PARAM_BITS, &bits);
 298         params[1] = OSSL_PARAM_construct_int(OSSL_PKEY_PARAM_SECURITY_BITS,
 299                                              &security_bits);
 300         params[2] = OSSL_PARAM_construct_int(OSSL_PKEY_PARAM_MAX_SIZE, &size);
 301         params[3] = OSSL_PARAM_construct_end();
 302         if (evp_keymgmt_get_params(pk->keymgmt, pk->keydata, params)) {
 303             pk->cache.size = size;
 304             pk->cache.bits = bits;
 305             pk->cache.security_bits = security_bits;
 306         }
 307     }
 308 }
 309
 310 void *evp_keymgmt_util_fromdata(EVP_PKEY *target, EVP_KEYMGMT *keymgmt,
 311                                 int selection, const OSSL_PARAM params[])
 312 {
 313     void *keydata = NULL;
 314
 315     if ((keydata = evp_keymgmt_newdata(keymgmt)) == NULL
 316         || !evp_keymgmt_import(keymgmt, keydata, selection, params)
 317         || !evp_keymgmt_util_assign_pkey(target, keymgmt, keydata)) {
 318         evp_keymgmt_freedata(keymgmt, keydata);
 319         keydata = NULL;
 320     }
 321     return keydata;
 322 }
 323
 324 int evp_keymgmt_util_has(EVP_PKEY *pk, int selection)
 325 {
 326     /* Check if key is even assigned */
 327     if (pk->keymgmt == NULL)
 328         return 0;
 329
 330     return evp_keymgmt_has(pk->keymgmt, pk->keydata, selection);
 331 }
 332
 333 /*
 334  * evp_keymgmt_util_match() doesn't just look at the provider side "origin",
 335  * but also in the operation cache to see if there's any common keymgmt that
 336  * supplies OP_keymgmt_match.
 337  *
 338  * evp_keymgmt_util_match() adheres to the return values that EVP_PKEY_eq()
 339  * and EVP_PKEY_parameters_eq() return, i.e.:
 340  *
 341  *  1   same key
 342  *  0   not same key
 343  * -1   not same key type
 344  * -2   unsupported operation
 345  */
 346 int evp_keymgmt_util_match(EVP_PKEY *pk1, EVP_PKEY *pk2, int selection)
 347 {
 348     EVP_KEYMGMT *keymgmt1 = NULL, *keymgmt2 = NULL;
 349     void *keydata1 = NULL, *keydata2 = NULL;
 350
 351     if (pk1 == NULL || pk2 == NULL) {
 352         if (pk1 == NULL && pk2 == NULL)
 353             return 1;
 354         return 0;
 355     }
 356
 357     keymgmt1 = pk1->keymgmt;
 358     keydata1 = pk1->keydata;
 359     keymgmt2 = pk2->keymgmt;
 360     keydata2 = pk2->keydata;
 361
 362     if (keymgmt1 != keymgmt2) {
 363         /*
 364          * The condition for a successful cross export is that the
 365          * keydata to be exported is NULL (typed, but otherwise empty
 366          * EVP_PKEY), or that it was possible to export it with
 367          * evp_keymgmt_util_export_to_provider().
 368          *
 369          * We use |ok| to determine if it's ok to cross export one way,
 370          * but also to determine if we should attempt a cross export
 371          * the other way.  There's no point doing it both ways.
 372          */
 373         int ok = 0;
 374
 375         /* Complex case, where the keymgmt differ */
 376         if (keymgmt1 != NULL
 377             && keymgmt2 != NULL
 378             && !match_type(keymgmt1, keymgmt2)) {
 379             ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
 380             return -1;           /* Not the same type */
 381         }
 382
 383         /*
 384          * The key types are determined to match, so we try cross export,
 385          * but only to keymgmt's that supply a matching function.
 386          */
 387         if (keymgmt2 != NULL
 388             && keymgmt2->match != NULL) {
 389             void *tmp_keydata = NULL;
 390
 391             ok = 1;
 392             if (keydata1 != NULL) {
 393                 tmp_keydata =
 394                     evp_keymgmt_util_export_to_provider(pk1, keymgmt2,
 395                                                         selection);
 396                 ok = (tmp_keydata != NULL);
 397             }
 398             if (ok) {
 399                 keymgmt1 = keymgmt2;
 400                 keydata1 = tmp_keydata;
 401             }
 402         }
 403         /*
 404          * If we've successfully cross exported one way, there's no point
 405          * doing it the other way, hence the |!ok| check.
 406          */
 407         if (!ok
 408             && keymgmt1 != NULL
 409             && keymgmt1->match != NULL) {
 410             void *tmp_keydata = NULL;
 411
 412             ok = 1;
 413             if (keydata2 != NULL) {
 414                 tmp_keydata =
 415                     evp_keymgmt_util_export_to_provider(pk2, keymgmt1,
 416                                                         selection);
 417                 ok = (tmp_keydata != NULL);
 418             }
 419             if (ok) {
 420                 keymgmt2 = keymgmt1;
 421                 keydata2 = tmp_keydata;
 422             }
 423         }
 424     }
 425
 426     /* If we still don't have matching keymgmt implementations, we give up */
 427     if (keymgmt1 != keymgmt2)
 428         return -2;
 429
 430     /* If both keydata are NULL, then they're the same key */
 431     if (keydata1 == NULL && keydata2 == NULL)
 432         return 1;
 433     /* If only one of the keydata is NULL, then they're different keys */
 434     if (keydata1 == NULL || keydata2 == NULL)
 435         return 0;
 436     /* If both keydata are non-NULL, we let the backend decide */
 437     return evp_keymgmt_match(keymgmt1, keydata1, keydata2, selection);
 438 }
 439
 440 int evp_keymgmt_util_copy(EVP_PKEY *to, EVP_PKEY *from, int selection)
 441 {
 442     /* Save copies of pointers we want to play with without affecting |to| */
 443     EVP_KEYMGMT *to_keymgmt = to->keymgmt;
 444     void *to_keydata = to->keydata, *alloc_keydata = NULL;
 445
 446     /* An unassigned key can't be copied */
 447     if (from == NULL || from->keydata == NULL)
 448         return 0;
 449
 450     /*
 451      * If |to| is unassigned, ensure it gets the same KEYMGMT as |from|,
 452      * Note that the final setting of KEYMGMT is done further down, with
 453      * EVP_PKEY_set_type_by_keymgmt(); we don't want to do that prematurely.
 454      */
 455     if (to_keymgmt == NULL)
 456         to_keymgmt = from->keymgmt;
 457
 458     if (to_keymgmt == from->keymgmt && to_keymgmt->dup != NULL
 459         && to_keydata == NULL) {
 460         to_keydata = alloc_keydata = evp_keymgmt_dup(to_keymgmt,
 461                                                      from->keydata,
 462                                                      selection);
 463         if (to_keydata == NULL)
 464             return 0;
 465     } else if (match_type(to_keymgmt, from->keymgmt)) {
 466         struct evp_keymgmt_util_try_import_data_st import_data;
 467
 468         import_data.keymgmt = to_keymgmt;
 469         import_data.keydata = to_keydata;
 470         import_data.selection = selection;
 471
 472         if (!evp_keymgmt_util_export(from, selection,
 473                                      &evp_keymgmt_util_try_import,
 474                                      &import_data))
 475             return 0;
 476
 477         /*
 478          * In case to_keydata was previously unallocated,
 479          * evp_keymgmt_util_try_import() may have created it for us.
 480          */
 481         if (to_keydata == NULL)
 482             to_keydata = alloc_keydata = import_data.keydata;
 483     } else {
 484         ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
 485         return 0;
 486     }
 487
 488     /*
 489      * We only need to set the |to| type when its |keymgmt| isn't set.
 490      * We can then just set its |keydata| to what we have, which might
 491      * be exactly what it had when entering this function.
 492      * This is a bit different from using evp_keymgmt_util_assign_pkey(),
 493      * which isn't as careful with |to|'s original |keymgmt|, since it's
 494      * meant to forcibly reassign an EVP_PKEY no matter what, which is
 495      * why we don't use that one here.
 496      */
 497     if (to->keymgmt == NULL
 498         && !EVP_PKEY_set_type_by_keymgmt(to, to_keymgmt)) {
 499         evp_keymgmt_freedata(to_keymgmt, alloc_keydata);
 500         return 0;
 501     }
 502     to->keydata = to_keydata;
 503     evp_keymgmt_util_cache_keyinfo(to);
 504
 505     return 1;
 506 }
 507
 508 void *evp_keymgmt_util_gen(EVP_PKEY *target, EVP_KEYMGMT *keymgmt,
 509                            void *genctx, OSSL_CALLBACK *cb, void *cbarg)
 510 {
 511     void *keydata = NULL;
 512
 513     if ((keydata = evp_keymgmt_gen(keymgmt, genctx, cb, cbarg)) == NULL
 514         || !evp_keymgmt_util_assign_pkey(target, keymgmt, keydata)) {
 515         evp_keymgmt_freedata(keymgmt, keydata);
 516         keydata = NULL;
 517     }
 518
 519     return keydata;
 520 }
 521
 522 /*
 523  * Returns the same numbers as EVP_PKEY_get_default_digest_name()
 524  * When the string from the EVP_KEYMGMT implementation is "", we use
 525  * SN_undef, since that corresponds to what EVP_PKEY_get_default_nid()
 526  * returns for no digest.
 527  */
 528 int evp_keymgmt_util_get_deflt_digest_name(EVP_KEYMGMT *keymgmt,
 529                                            void *keydata,
 530                                            char *mdname, size_t mdname_sz)
 531 {
 532     OSSL_PARAM params[3];
 533     char mddefault[100] = "";
 534     char mdmandatory[100] = "";
 535     char *result = NULL;
 536     int rv = -2;
 537
 538     params[0] =
 539         OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_DEFAULT_DIGEST,
 540                                          mddefault, sizeof(mddefault));
 541     params[1] =
 542         OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_MANDATORY_DIGEST,
 543                                          mdmandatory,
 544                                          sizeof(mdmandatory));
 545     params[2] = OSSL_PARAM_construct_end();
 546
 547     if (!evp_keymgmt_get_params(keymgmt, keydata, params))
 548         return 0;
 549
 550     if (OSSL_PARAM_modified(params + 1)) {
 551         if (params[1].return_size <= 1) /* Only a NUL byte */
 552             result = SN_undef;
 553         else
 554             result = mdmandatory;
 555         rv = 2;
 556     } else if (OSSL_PARAM_modified(params)) {
 557         if (params[0].return_size <= 1) /* Only a NUL byte */
 558             result = SN_undef;
 559         else
 560             result = mddefault;
 561         rv = 1;
 562     }
 563     if (rv > 0)
 564         OPENSSL_strlcpy(mdname, result, mdname_sz);
 565     return rv;
 566 }
 567
 568 /*
 569  * If |keymgmt| has the method function |query_operation_name|, use it to get
 570  * the name of a supported operation identity.  Otherwise, return the keytype,
 571  * assuming that it works as a default operation name.
 572  */
 573 const char *evp_keymgmt_util_query_operation_name(EVP_KEYMGMT *keymgmt,
 574                                                   int op_id)
 575 {
 576     const char *name = NULL;
 577
 578     if (keymgmt != NULL) {
 579         if (keymgmt->query_operation_name != NULL)
 580             name = keymgmt->query_operation_name(op_id);
 581         if (name == NULL)
 582             name = EVP_KEYMGMT_get0_name(keymgmt);
 583     }
 584     return name;
 585 }