crypto/evp/exchange.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/evp.h>
  12 #include <openssl/err.h>
  13 #include "internal/refcount.h"
  14 #include "crypto/evp.h"
  15 #include "internal/provider.h"
  16 #include "internal/numbers.h"   /* includes SIZE_MAX */
  17 #include "evp_local.h"
  18
  19 static EVP_KEYEXCH *evp_keyexch_new(OSSL_PROVIDER *prov)
  20 {
  21     EVP_KEYEXCH *exchange = OPENSSL_zalloc(sizeof(EVP_KEYEXCH));
  22
  23     if (exchange == NULL) {
  24         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
  25         return NULL;
  26     }
  27
  28     exchange->lock = CRYPTO_THREAD_lock_new();
  29     if (exchange->lock == NULL) {
  30         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
  31         OPENSSL_free(exchange);
  32         return NULL;
  33     }
  34     exchange->prov = prov;
  35     ossl_provider_up_ref(prov);
  36     exchange->refcnt = 1;
  37
  38     return exchange;
  39 }
  40
  41 static void *evp_keyexch_from_algorithm(int name_id,
  42                                         const OSSL_ALGORITHM *algodef,
  43                                         OSSL_PROVIDER *prov)
  44 {
  45     const OSSL_DISPATCH *fns = algodef->implementation;
  46     EVP_KEYEXCH *exchange = NULL;
  47     int fncnt = 0, sparamfncnt = 0, gparamfncnt = 0;
  48
  49     if ((exchange = evp_keyexch_new(prov)) == NULL) {
  50         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
  51         goto err;
  52     }
  53
  54     exchange->name_id = name_id;
  55     exchange->description = algodef->algorithm_description;
  56
  57     for (; fns->function_id != 0; fns++) {
  58         switch (fns->function_id) {
  59         case OSSL_FUNC_KEYEXCH_NEWCTX:
  60             if (exchange->newctx != NULL)
  61                 break;
  62             exchange->newctx = OSSL_FUNC_keyexch_newctx(fns);
  63             fncnt++;
  64             break;
  65         case OSSL_FUNC_KEYEXCH_INIT:
  66             if (exchange->init != NULL)
  67                 break;
  68             exchange->init = OSSL_FUNC_keyexch_init(fns);
  69             fncnt++;
  70             break;
  71         case OSSL_FUNC_KEYEXCH_SET_PEER:
  72             if (exchange->set_peer != NULL)
  73                 break;
  74             exchange->set_peer = OSSL_FUNC_keyexch_set_peer(fns);
  75             break;
  76         case OSSL_FUNC_KEYEXCH_DERIVE:
  77             if (exchange->derive != NULL)
  78                 break;
  79             exchange->derive = OSSL_FUNC_keyexch_derive(fns);
  80             fncnt++;
  81             break;
  82         case OSSL_FUNC_KEYEXCH_FREECTX:
  83             if (exchange->freectx != NULL)
  84                 break;
  85             exchange->freectx = OSSL_FUNC_keyexch_freectx(fns);
  86             fncnt++;
  87             break;
  88         case OSSL_FUNC_KEYEXCH_DUPCTX:
  89             if (exchange->dupctx != NULL)
  90                 break;
  91             exchange->dupctx = OSSL_FUNC_keyexch_dupctx(fns);
  92             break;
  93         case OSSL_FUNC_KEYEXCH_GET_CTX_PARAMS:
  94             if (exchange->get_ctx_params != NULL)
  95                 break;
  96             exchange->get_ctx_params = OSSL_FUNC_keyexch_get_ctx_params(fns);
  97             gparamfncnt++;
  98             break;
  99         case OSSL_FUNC_KEYEXCH_GETTABLE_CTX_PARAMS:
 100             if (exchange->gettable_ctx_params != NULL)
 101                 break;
 102             exchange->gettable_ctx_params
 103                 = OSSL_FUNC_keyexch_gettable_ctx_params(fns);
 104             gparamfncnt++;
 105             break;
 106         case OSSL_FUNC_KEYEXCH_SET_CTX_PARAMS:
 107             if (exchange->set_ctx_params != NULL)
 108                 break;
 109             exchange->set_ctx_params = OSSL_FUNC_keyexch_set_ctx_params(fns);
 110             sparamfncnt++;
 111             break;
 112         case OSSL_FUNC_KEYEXCH_SETTABLE_CTX_PARAMS:
 113             if (exchange->settable_ctx_params != NULL)
 114                 break;
 115             exchange->settable_ctx_params
 116                 = OSSL_FUNC_keyexch_settable_ctx_params(fns);
 117             sparamfncnt++;
 118             break;
 119         }
 120     }
 121     if (fncnt != 4
 122             || (gparamfncnt != 0 && gparamfncnt != 2)
 123             || (sparamfncnt != 0 && sparamfncnt != 2)) {
 124         /*
 125          * In order to be a consistent set of functions we must have at least
 126          * a complete set of "exchange" functions: init, derive, newctx,
 127          * and freectx. The set_ctx_params and settable_ctx_params functions are
 128          * optional, but if one of them is present then the other one must also
 129          * be present. Same goes for get_ctx_params and gettable_ctx_params.
 130          * The dupctx and set_peer functions are optional.
 131          */
 132         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_PROVIDER_FUNCTIONS);
 133         goto err;
 134     }
 135
 136     return exchange;
 137
 138  err:
 139     EVP_KEYEXCH_free(exchange);
 140     return NULL;
 141 }
 142
 143 void EVP_KEYEXCH_free(EVP_KEYEXCH *exchange)
 144 {
 145     int i;
 146
 147     if (exchange == NULL)
 148         return;
 149     CRYPTO_DOWN_REF(&exchange->refcnt, &i, exchange->lock);
 150     if (i > 0)
 151         return;
 152     ossl_provider_free(exchange->prov);
 153     CRYPTO_THREAD_lock_free(exchange->lock);
 154     OPENSSL_free(exchange);
 155 }
 156
 157 int EVP_KEYEXCH_up_ref(EVP_KEYEXCH *exchange)
 158 {
 159     int ref = 0;
 160
 161     CRYPTO_UP_REF(&exchange->refcnt, &ref, exchange->lock);
 162     return 1;
 163 }
 164
 165 OSSL_PROVIDER *EVP_KEYEXCH_provider(const EVP_KEYEXCH *exchange)
 166 {
 167     return exchange->prov;
 168 }
 169
 170 EVP_KEYEXCH *EVP_KEYEXCH_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
 171                                const char *properties)
 172 {
 173     return evp_generic_fetch(ctx, OSSL_OP_KEYEXCH, algorithm, properties,
 174                              evp_keyexch_from_algorithm,
 175                              (int (*)(void *))EVP_KEYEXCH_up_ref,
 176                              (void (*)(void *))EVP_KEYEXCH_free);
 177 }
 178
 179 int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx)
 180 {
 181     return EVP_PKEY_derive_init_ex(ctx, NULL);
 182 }
 183
 184 int EVP_PKEY_derive_init_ex(EVP_PKEY_CTX *ctx, const OSSL_PARAM params[])
 185 {
 186     int ret;
 187     void *provkey = NULL;
 188     EVP_KEYEXCH *exchange = NULL;
 189     EVP_KEYMGMT *tmp_keymgmt = NULL;
 190     const char *supported_exch = NULL;
 191
 192     if (ctx == NULL) {
 193         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 194         return -2;
 195     }
 196
 197     evp_pkey_ctx_free_old_ops(ctx);
 198     ctx->operation = EVP_PKEY_OP_DERIVE;
 199
 200     /*
 201      * TODO when we stop falling back to legacy, this and the ERR_pop_to_mark()
 202      * calls can be removed.
 203      */
 204     ERR_set_mark();
 205
 206     if (evp_pkey_ctx_is_legacy(ctx))
 207         goto legacy;
 208
 209     /*
 210      * Ensure that the key is provided, either natively, or as a cached export.
 211      * If not, goto legacy
 212      */
 213     tmp_keymgmt = ctx->keymgmt;
 214     if (ctx->pkey == NULL) {
 215         /*
 216          * Some algorithms (e.g. legacy KDFs) don't have a pkey - so we create
 217          * a blank one.
 218          */
 219         EVP_PKEY *pkey = EVP_PKEY_new();
 220
 221         if (pkey == NULL || !EVP_PKEY_set_type_by_keymgmt(pkey, tmp_keymgmt)) {
 222             ERR_clear_last_mark();
 223             EVP_PKEY_free(pkey);
 224             ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 225             goto err;
 226         }
 227         provkey = pkey->keydata = evp_keymgmt_newdata(tmp_keymgmt);
 228         if (provkey == NULL)
 229             EVP_PKEY_free(pkey);
 230         else
 231             ctx->pkey = pkey;
 232     } else {
 233         provkey = evp_pkey_export_to_provider(ctx->pkey, ctx->libctx,
 234                                             &tmp_keymgmt, ctx->propquery);
 235     }
 236     if (provkey == NULL)
 237         goto legacy;
 238     if (!EVP_KEYMGMT_up_ref(tmp_keymgmt)) {
 239         ERR_clear_last_mark();
 240         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 241         goto err;
 242     }
 243     EVP_KEYMGMT_free(ctx->keymgmt);
 244     ctx->keymgmt = tmp_keymgmt;
 245
 246     if (ctx->keymgmt->query_operation_name != NULL)
 247         supported_exch = ctx->keymgmt->query_operation_name(OSSL_OP_KEYEXCH);
 248
 249     /*
 250      * If we didn't get a supported exch, assume there is one with the
 251      * same name as the key type.
 252      */
 253     if (supported_exch == NULL)
 254         supported_exch = ctx->keytype;
 255
 256     /*
 257      * Because we cleared out old ops, we shouldn't need to worry about
 258      * checking if exchange is already there.
 259      */
 260     exchange = EVP_KEYEXCH_fetch(ctx->libctx, supported_exch, ctx->propquery);
 261
 262     if (exchange == NULL
 263         || (EVP_KEYMGMT_provider(ctx->keymgmt)
 264             != EVP_KEYEXCH_provider(exchange))) {
 265         /*
 266          * We don't need to free ctx->keymgmt here, as it's not necessarily
 267          * tied to this operation.  It will be freed by EVP_PKEY_CTX_free().
 268          */
 269         EVP_KEYEXCH_free(exchange);
 270         goto legacy;
 271     }
 272
 273     /*
 274      * TODO remove this when legacy is gone
 275      * If we don't have the full support we need with provided methods,
 276      * let's go see if legacy does.
 277      */
 278     ERR_pop_to_mark();
 279
 280     /* No more legacy from here down to legacy: */
 281
 282     ctx->op.kex.exchange = exchange;
 283     ctx->op.kex.exchprovctx = exchange->newctx(ossl_provider_ctx(exchange->prov));
 284     if (ctx->op.kex.exchprovctx == NULL) {
 285         /* The provider key can stay in the cache */
 286         ERR_raise(ERR_LIB_EVP, EVP_R_INITIALIZATION_ERROR);
 287         goto err;
 288     }
 289     ret = exchange->init(ctx->op.kex.exchprovctx, provkey, params);
 290
 291     return ret ? 1 : 0;
 292  err:
 293     evp_pkey_ctx_free_old_ops(ctx);
 294     ctx->operation = EVP_PKEY_OP_UNDEFINED;
 295     return 0;
 296
 297  legacy:
 298     /*
 299      * TODO remove this when legacy is gone
 300      * If we don't have the full support we need with provided methods,
 301      * let's go see if legacy does.
 302      */
 303     ERR_pop_to_mark();
 304
 305 #ifdef FIPS_MODULE
 306     return 0;
 307 #else
 308     if (ctx->pmeth == NULL || ctx->pmeth->derive == NULL) {
 309         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 310         return -2;
 311     }
 312
 313     if (ctx->pmeth->derive_init == NULL)
 314         return 1;
 315     ret = ctx->pmeth->derive_init(ctx);
 316     if (ret <= 0)
 317         ctx->operation = EVP_PKEY_OP_UNDEFINED;
 318     return ret;
 319 #endif
 320 }
 321
 322 int EVP_PKEY_derive_set_peer_ex(EVP_PKEY_CTX *ctx, EVP_PKEY *peer,
 323                                 int validate_peer)
 324 {
 325     int ret = 0, check;
 326     void *provkey = NULL;
 327     EVP_PKEY_CTX *check_ctx = NULL;
 328
 329     if (ctx == NULL) {
 330         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 331         return -1;
 332     }
 333
 334     if (!EVP_PKEY_CTX_IS_DERIVE_OP(ctx) || ctx->op.kex.exchprovctx == NULL)
 335         goto legacy;
 336
 337     if (ctx->op.kex.exchange->set_peer == NULL) {
 338         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 339         return -2;
 340     }
 341
 342     if (validate_peer) {
 343         check_ctx = EVP_PKEY_CTX_new_from_pkey(ctx->libctx, peer, ctx->propquery);
 344         if (check_ctx == NULL)
 345             return -1;
 346         check = EVP_PKEY_public_check(check_ctx);
 347         EVP_PKEY_CTX_free(check_ctx);
 348         if (check <= 0)
 349             return -1;
 350     }
 351
 352     provkey = evp_pkey_export_to_provider(peer, ctx->libctx, &ctx->keymgmt,
 353                                           ctx->propquery);
 354     /*
 355      * If making the key provided wasn't possible, legacy may be able to pick
 356      * it up
 357      */
 358     if (provkey == NULL)
 359         goto legacy;
 360     return ctx->op.kex.exchange->set_peer(ctx->op.kex.exchprovctx, provkey);
 361
 362  legacy:
 363 #ifdef FIPS_MODULE
 364     return ret;
 365 #else
 366     if (ctx->pmeth == NULL
 367         || !(ctx->pmeth->derive != NULL
 368              || ctx->pmeth->encrypt != NULL
 369              || ctx->pmeth->decrypt != NULL)
 370         || ctx->pmeth->ctrl == NULL) {
 371         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 372         return -2;
 373     }
 374     if (ctx->operation != EVP_PKEY_OP_DERIVE
 375         && ctx->operation != EVP_PKEY_OP_ENCRYPT
 376         && ctx->operation != EVP_PKEY_OP_DECRYPT) {
 377         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_INITIALIZED);
 378         return -1;
 379     }
 380
 381     ret = ctx->pmeth->ctrl(ctx, EVP_PKEY_CTRL_PEER_KEY, 0, peer);
 382
 383     if (ret <= 0)
 384         return ret;
 385
 386     if (ret == 2)
 387         return 1;
 388
 389     if (ctx->pkey == NULL) {
 390         ERR_raise(ERR_LIB_EVP, EVP_R_NO_KEY_SET);
 391         return -1;
 392     }
 393
 394     if (ctx->pkey->type != peer->type) {
 395         ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_KEY_TYPES);
 396         return -1;
 397     }
 398
 399     /*
 400      * For clarity.  The error is if parameters in peer are
 401      * present (!missing) but don't match.  EVP_PKEY_parameters_eq may return
 402      * 1 (match), 0 (don't match) and -2 (comparison is not defined).  -1
 403      * (different key types) is impossible here because it is checked earlier.
 404      * -2 is OK for us here, as well as 1, so we can check for 0 only.
 405      */
 406     if (!EVP_PKEY_missing_parameters(peer) &&
 407         !EVP_PKEY_parameters_eq(ctx->pkey, peer)) {
 408         ERR_raise(ERR_LIB_EVP, EVP_R_DIFFERENT_PARAMETERS);
 409         return -1;
 410     }
 411
 412     EVP_PKEY_free(ctx->peerkey);
 413     ctx->peerkey = peer;
 414
 415     ret = ctx->pmeth->ctrl(ctx, EVP_PKEY_CTRL_PEER_KEY, 1, peer);
 416
 417     if (ret <= 0) {
 418         ctx->peerkey = NULL;
 419         return ret;
 420     }
 421
 422     EVP_PKEY_up_ref(peer);
 423     return 1;
 424 #endif
 425 }
 426
 427 int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer)
 428 {
 429     return EVP_PKEY_derive_set_peer_ex(ctx, peer, 1);
 430 }
 431
 432 int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *pkeylen)
 433 {
 434     int ret;
 435
 436     if (ctx == NULL || pkeylen == NULL) {
 437         ERR_raise(ERR_LIB_EVP, ERR_R_PASSED_NULL_PARAMETER);
 438         return -1;
 439     }
 440
 441     if (!EVP_PKEY_CTX_IS_DERIVE_OP(ctx)) {
 442         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_INITIALIZED);
 443         return -1;
 444     }
 445
 446     if (ctx->op.kex.exchprovctx == NULL)
 447         goto legacy;
 448
 449     ret = ctx->op.kex.exchange->derive(ctx->op.kex.exchprovctx, key, pkeylen,
 450                                        key != NULL ? *pkeylen : 0);
 451
 452     return ret;
 453  legacy:
 454     if (ctx->pmeth == NULL || ctx->pmeth->derive == NULL) {
 455         ERR_raise(ERR_LIB_EVP, EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 456         return -2;
 457     }
 458
 459     M_check_autoarg(ctx, key, pkeylen, EVP_F_EVP_PKEY_DERIVE)
 460         return ctx->pmeth->derive(ctx, key, pkeylen);
 461 }
 462
 463 int EVP_KEYEXCH_number(const EVP_KEYEXCH *keyexch)
 464 {
 465     return keyexch->name_id;
 466 }
 467
 468 const char *EVP_KEYEXCH_description(const EVP_KEYEXCH *keyexch)
 469 {
 470     return keyexch->description;
 471 }
 472
 473 int EVP_KEYEXCH_is_a(const EVP_KEYEXCH *keyexch, const char *name)
 474 {
 475     return evp_is_a(keyexch->prov, keyexch->name_id, NULL, name);
 476 }
 477
 478 void EVP_KEYEXCH_do_all_provided(OSSL_LIB_CTX *libctx,
 479                                  void (*fn)(EVP_KEYEXCH *keyexch, void *arg),
 480                                  void *arg)
 481 {
 482     evp_generic_do_all(libctx, OSSL_OP_KEYEXCH,
 483                        (void (*)(void *, void *))fn, arg,
 484                        evp_keyexch_from_algorithm,
 485                        (void (*)(void *))EVP_KEYEXCH_free);
 486 }
 487
 488 int EVP_KEYEXCH_names_do_all(const EVP_KEYEXCH *keyexch,
 489                              void (*fn)(const char *name, void *data),
 490                              void *data)
 491 {
 492     if (keyexch->prov != NULL)
 493         return evp_names_do_all(keyexch->prov, keyexch->name_id, fn, data);
 494
 495     return 1;
 496 }
 497
 498 const OSSL_PARAM *EVP_KEYEXCH_gettable_ctx_params(const EVP_KEYEXCH *keyexch)
 499 {
 500     void *provctx;
 501
 502     if (keyexch == NULL || keyexch->gettable_ctx_params == NULL)
 503         return NULL;
 504
 505     provctx = ossl_provider_ctx(EVP_KEYEXCH_provider(keyexch));
 506     return keyexch->gettable_ctx_params(NULL, provctx);
 507 }
 508
 509 const OSSL_PARAM *EVP_KEYEXCH_settable_ctx_params(const EVP_KEYEXCH *keyexch)
 510 {
 511     void *provctx;
 512
 513     if (keyexch == NULL || keyexch->settable_ctx_params == NULL)
 514         return NULL;
 515     provctx = ossl_provider_ctx(EVP_KEYEXCH_provider(keyexch));
 516     return keyexch->settable_ctx_params(NULL, provctx);
 517 }