crypto/evp/p_lib.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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 <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include "internal/refcount.h"
  13 #include <openssl/bn.h>
  14 #include <openssl/err.h>
  15 #include <openssl/objects.h>
  16 #include <openssl/evp.h>
  17 #include <openssl/x509.h>
  18 #include <openssl/rsa.h>
  19 #include <openssl/dsa.h>
  20 #include <openssl/dh.h>
  21 #include <openssl/cmac.h>
  22 #include <openssl/engine.h>
  23
  24 #include "internal/asn1_int.h"
  25 #include "internal/evp_int.h"
  26
  27 static void EVP_PKEY_free_it(EVP_PKEY *x);
  28
  29 int EVP_PKEY_bits(const EVP_PKEY *pkey)
  30 {
  31     if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
  32         return pkey->ameth->pkey_bits(pkey);
  33     return 0;
  34 }
  35
  36 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
  37 {
  38     if (pkey == NULL)
  39         return 0;
  40     if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
  41         return -2;
  42     return pkey->ameth->pkey_security_bits(pkey);
  43 }
  44
  45 int EVP_PKEY_size(EVP_PKEY *pkey)
  46 {
  47     if (pkey && pkey->ameth && pkey->ameth->pkey_size)
  48         return pkey->ameth->pkey_size(pkey);
  49     return 0;
  50 }
  51
  52 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
  53 {
  54 #ifndef OPENSSL_NO_DSA
  55     if (pkey->type == EVP_PKEY_DSA) {
  56         int ret = pkey->save_parameters;
  57
  58         if (mode >= 0)
  59             pkey->save_parameters = mode;
  60         return ret;
  61     }
  62 #endif
  63 #ifndef OPENSSL_NO_EC
  64     if (pkey->type == EVP_PKEY_EC) {
  65         int ret = pkey->save_parameters;
  66
  67         if (mode >= 0)
  68             pkey->save_parameters = mode;
  69         return ret;
  70     }
  71 #endif
  72     return 0;
  73 }
  74
  75 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
  76 {
  77     if (to->type == EVP_PKEY_NONE) {
  78         if (EVP_PKEY_set_type(to, from->type) == 0)
  79             return 0;
  80     } else if (to->type != from->type) {
  81         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
  82         goto err;
  83     }
  84
  85     if (EVP_PKEY_missing_parameters(from)) {
  86         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
  87         goto err;
  88     }
  89
  90     if (!EVP_PKEY_missing_parameters(to)) {
  91         if (EVP_PKEY_cmp_parameters(to, from) == 1)
  92             return 1;
  93         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_PARAMETERS);
  94         return 0;
  95     }
  96
  97     if (from->ameth && from->ameth->param_copy)
  98         return from->ameth->param_copy(to, from);
  99  err:
 100     return 0;
 101 }
 102
 103 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
 104 {
 105     if (pkey->ameth && pkey->ameth->param_missing)
 106         return pkey->ameth->param_missing(pkey);
 107     return 0;
 108 }
 109
 110 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
 111 {
 112     if (a->type != b->type)
 113         return -1;
 114     if (a->ameth && a->ameth->param_cmp)
 115         return a->ameth->param_cmp(a, b);
 116     return -2;
 117 }
 118
 119 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
 120 {
 121     if (a->type != b->type)
 122         return -1;
 123
 124     if (a->ameth) {
 125         int ret;
 126         /* Compare parameters if the algorithm has them */
 127         if (a->ameth->param_cmp) {
 128             ret = a->ameth->param_cmp(a, b);
 129             if (ret <= 0)
 130                 return ret;
 131         }
 132
 133         if (a->ameth->pub_cmp)
 134             return a->ameth->pub_cmp(a, b);
 135     }
 136
 137     return -2;
 138 }
 139
 140 EVP_PKEY *EVP_PKEY_new(void)
 141 {
 142     EVP_PKEY *ret = OPENSSL_zalloc(sizeof(*ret));
 143
 144     if (ret == NULL) {
 145         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
 146         return NULL;
 147     }
 148     ret->type = EVP_PKEY_NONE;
 149     ret->save_type = EVP_PKEY_NONE;
 150     ret->references = 1;
 151     ret->save_parameters = 1;
 152     ret->lock = CRYPTO_THREAD_lock_new();
 153     if (ret->lock == NULL) {
 154         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
 155         OPENSSL_free(ret);
 156         return NULL;
 157     }
 158     return ret;
 159 }
 160
 161 int EVP_PKEY_up_ref(EVP_PKEY *pkey)
 162 {
 163     int i;
 164
 165     if (CRYPTO_UP_REF(&pkey->references, &i, pkey->lock) <= 0)
 166         return 0;
 167
 168     REF_PRINT_COUNT("EVP_PKEY", pkey);
 169     REF_ASSERT_ISNT(i < 2);
 170     return ((i > 1) ? 1 : 0);
 171 }
 172
 173 /*
 174  * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
 175  * is NULL just return 1 or 0 if the algorithm exists.
 176  */
 177
 178 static int pkey_set_type(EVP_PKEY *pkey, ENGINE *e, int type, const char *str,
 179                          int len)
 180 {
 181     const EVP_PKEY_ASN1_METHOD *ameth;
 182     ENGINE **eptr = (e == NULL) ? &e :  NULL;
 183
 184     if (pkey) {
 185         if (pkey->pkey.ptr)
 186             EVP_PKEY_free_it(pkey);
 187         /*
 188          * If key type matches and a method exists then this lookup has
 189          * succeeded once so just indicate success.
 190          */
 191         if ((type == pkey->save_type) && pkey->ameth)
 192             return 1;
 193 #ifndef OPENSSL_NO_ENGINE
 194         /* If we have ENGINEs release them */
 195         ENGINE_finish(pkey->engine);
 196         pkey->engine = NULL;
 197         ENGINE_finish(pkey->pmeth_engine);
 198         pkey->pmeth_engine = NULL;
 199 #endif
 200     }
 201     if (str)
 202         ameth = EVP_PKEY_asn1_find_str(eptr, str, len);
 203     else
 204         ameth = EVP_PKEY_asn1_find(eptr, type);
 205 #ifndef OPENSSL_NO_ENGINE
 206     if (pkey == NULL && eptr != NULL)
 207         ENGINE_finish(e);
 208 #endif
 209     if (ameth == NULL) {
 210         EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
 211         return 0;
 212     }
 213     if (pkey) {
 214         pkey->ameth = ameth;
 215         pkey->engine = e;
 216
 217         pkey->type = pkey->ameth->pkey_id;
 218         pkey->save_type = type;
 219     }
 220     return 1;
 221 }
 222
 223 EVP_PKEY *EVP_PKEY_new_raw_private_key(int type, ENGINE *e,
 224                                        const unsigned char *priv,
 225                                        size_t len)
 226 {
 227     EVP_PKEY *ret = EVP_PKEY_new();
 228
 229     if (ret == NULL
 230             || !pkey_set_type(ret, e, type, NULL, -1)) {
 231         /* EVPerr already called */
 232         goto err;
 233     }
 234
 235     if (ret->ameth->set_priv_key == NULL) {
 236         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PRIVATE_KEY,
 237                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 238         goto err;
 239     }
 240
 241     if (!ret->ameth->set_priv_key(ret, priv, len)) {
 242         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PRIVATE_KEY, EVP_R_KEY_SETUP_FAILED);
 243         goto err;
 244     }
 245
 246     return ret;
 247
 248  err:
 249     EVP_PKEY_free(ret);
 250     return NULL;
 251 }
 252
 253 EVP_PKEY *EVP_PKEY_new_raw_public_key(int type, ENGINE *e,
 254                                       const unsigned char *pub,
 255                                       size_t len)
 256 {
 257     EVP_PKEY *ret = EVP_PKEY_new();
 258
 259     if (ret == NULL
 260             || !pkey_set_type(ret, e, type, NULL, -1)) {
 261         /* EVPerr already called */
 262         goto err;
 263     }
 264
 265     if (ret->ameth->set_pub_key == NULL) {
 266         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PUBLIC_KEY,
 267                EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 268         goto err;
 269     }
 270
 271     if (!ret->ameth->set_pub_key(ret, pub, len)) {
 272         EVPerr(EVP_F_EVP_PKEY_NEW_RAW_PUBLIC_KEY, EVP_R_KEY_SETUP_FAILED);
 273         goto err;
 274     }
 275
 276     return ret;
 277
 278  err:
 279     EVP_PKEY_free(ret);
 280     return NULL;
 281 }
 282
 283 EVP_PKEY *EVP_PKEY_new_CMAC_key(ENGINE *e, const unsigned char *priv,
 284                                 size_t len, const EVP_CIPHER *cipher)
 285 {
 286 #ifndef OPENSSL_NO_CMAC
 287     EVP_PKEY *ret = EVP_PKEY_new();
 288     CMAC_CTX *cmctx = CMAC_CTX_new();
 289
 290     if (ret == NULL
 291             || cmctx == NULL
 292             || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1)) {
 293         /* EVPerr already called */
 294         goto err;
 295     }
 296
 297     if (!CMAC_Init(cmctx, priv, len, cipher, e)) {
 298         EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
 299         goto err;
 300     }
 301
 302     ret->pkey.ptr = cmctx;
 303     return ret;
 304
 305  err:
 306     EVP_PKEY_free(ret);
 307     CMAC_CTX_free(cmctx);
 308     return NULL;
 309 #else
 310     EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY,
 311            EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
 312     return NULL;
 313 #endif
 314 }
 315
 316 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
 317 {
 318     return pkey_set_type(pkey, NULL, type, NULL, -1);
 319 }
 320
 321 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
 322 {
 323     return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len);
 324 }
 325 #ifndef OPENSSL_NO_ENGINE
 326 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
 327 {
 328     if (e != NULL) {
 329         if (!ENGINE_init(e)) {
 330             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
 331             return 0;
 332         }
 333         if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
 334             ENGINE_finish(e);
 335             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
 336             return 0;
 337         }
 338     }
 339     ENGINE_finish(pkey->pmeth_engine);
 340     pkey->pmeth_engine = e;
 341     return 1;
 342 }
 343 #endif
 344 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
 345 {
 346     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
 347         return 0;
 348     pkey->pkey.ptr = key;
 349     return (key != NULL);
 350 }
 351
 352 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
 353 {
 354     return pkey->pkey.ptr;
 355 }
 356
 357 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
 358 {
 359     ASN1_OCTET_STRING *os = NULL;
 360     if (pkey->type != EVP_PKEY_HMAC) {
 361         EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
 362         return NULL;
 363     }
 364     os = EVP_PKEY_get0(pkey);
 365     *len = os->length;
 366     return os->data;
 367 }
 368
 369 #ifndef OPENSSL_NO_POLY1305
 370 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
 371 {
 372     ASN1_OCTET_STRING *os = NULL;
 373     if (pkey->type != EVP_PKEY_POLY1305) {
 374         EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
 375         return NULL;
 376     }
 377     os = EVP_PKEY_get0(pkey);
 378     *len = os->length;
 379     return os->data;
 380 }
 381 #endif
 382
 383 #ifndef OPENSSL_NO_SIPHASH
 384 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
 385 {
 386     ASN1_OCTET_STRING *os = NULL;
 387
 388     if (pkey->type != EVP_PKEY_SIPHASH) {
 389         EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
 390         return NULL;
 391     }
 392     os = EVP_PKEY_get0(pkey);
 393     *len = os->length;
 394     return os->data;
 395 }
 396 #endif
 397
 398 #ifndef OPENSSL_NO_RSA
 399 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
 400 {
 401     int ret = EVP_PKEY_assign_RSA(pkey, key);
 402     if (ret)
 403         RSA_up_ref(key);
 404     return ret;
 405 }
 406
 407 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
 408 {
 409     if (pkey->type != EVP_PKEY_RSA) {
 410         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
 411         return NULL;
 412     }
 413     return pkey->pkey.rsa;
 414 }
 415
 416 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
 417 {
 418     RSA *ret = EVP_PKEY_get0_RSA(pkey);
 419     if (ret != NULL)
 420         RSA_up_ref(ret);
 421     return ret;
 422 }
 423 #endif
 424
 425 #ifndef OPENSSL_NO_DSA
 426 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
 427 {
 428     int ret = EVP_PKEY_assign_DSA(pkey, key);
 429     if (ret)
 430         DSA_up_ref(key);
 431     return ret;
 432 }
 433
 434 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
 435 {
 436     if (pkey->type != EVP_PKEY_DSA) {
 437         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
 438         return NULL;
 439     }
 440     return pkey->pkey.dsa;
 441 }
 442
 443 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
 444 {
 445     DSA *ret = EVP_PKEY_get0_DSA(pkey);
 446     if (ret != NULL)
 447         DSA_up_ref(ret);
 448     return ret;
 449 }
 450 #endif
 451
 452 #ifndef OPENSSL_NO_EC
 453
 454 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
 455 {
 456     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
 457     if (ret)
 458         EC_KEY_up_ref(key);
 459     return ret;
 460 }
 461
 462 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
 463 {
 464     if (pkey->type != EVP_PKEY_EC) {
 465         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
 466         return NULL;
 467     }
 468     return pkey->pkey.ec;
 469 }
 470
 471 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
 472 {
 473     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
 474     if (ret != NULL)
 475         EC_KEY_up_ref(ret);
 476     return ret;
 477 }
 478 #endif
 479
 480 #ifndef OPENSSL_NO_DH
 481
 482 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
 483 {
 484     int ret = EVP_PKEY_assign_DH(pkey, key);
 485     if (ret)
 486         DH_up_ref(key);
 487     return ret;
 488 }
 489
 490 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
 491 {
 492     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
 493         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
 494         return NULL;
 495     }
 496     return pkey->pkey.dh;
 497 }
 498
 499 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
 500 {
 501     DH *ret = EVP_PKEY_get0_DH(pkey);
 502     if (ret != NULL)
 503         DH_up_ref(ret);
 504     return ret;
 505 }
 506 #endif
 507
 508 int EVP_PKEY_type(int type)
 509 {
 510     int ret;
 511     const EVP_PKEY_ASN1_METHOD *ameth;
 512     ENGINE *e;
 513     ameth = EVP_PKEY_asn1_find(&e, type);
 514     if (ameth)
 515         ret = ameth->pkey_id;
 516     else
 517         ret = NID_undef;
 518 #ifndef OPENSSL_NO_ENGINE
 519     ENGINE_finish(e);
 520 #endif
 521     return ret;
 522 }
 523
 524 int EVP_PKEY_id(const EVP_PKEY *pkey)
 525 {
 526     return pkey->type;
 527 }
 528
 529 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
 530 {
 531     return EVP_PKEY_type(pkey->type);
 532 }
 533
 534 void EVP_PKEY_free(EVP_PKEY *x)
 535 {
 536     int i;
 537
 538     if (x == NULL)
 539         return;
 540
 541     CRYPTO_DOWN_REF(&x->references, &i, x->lock);
 542     REF_PRINT_COUNT("EVP_PKEY", x);
 543     if (i > 0)
 544         return;
 545     REF_ASSERT_ISNT(i < 0);
 546     EVP_PKEY_free_it(x);
 547     CRYPTO_THREAD_lock_free(x->lock);
 548     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
 549     OPENSSL_free(x);
 550 }
 551
 552 static void EVP_PKEY_free_it(EVP_PKEY *x)
 553 {
 554     /* internal function; x is never NULL */
 555     if (x->ameth && x->ameth->pkey_free) {
 556         x->ameth->pkey_free(x);
 557         x->pkey.ptr = NULL;
 558     }
 559 #ifndef OPENSSL_NO_ENGINE
 560     ENGINE_finish(x->engine);
 561     x->engine = NULL;
 562     ENGINE_finish(x->pmeth_engine);
 563     x->pmeth_engine = NULL;
 564 #endif
 565 }
 566
 567 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
 568                      const char *kstr)
 569 {
 570     BIO_indent(out, indent, 128);
 571     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
 572                kstr, OBJ_nid2ln(pkey->type));
 573     return 1;
 574 }
 575
 576 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
 577                           int indent, ASN1_PCTX *pctx)
 578 {
 579     if (pkey->ameth && pkey->ameth->pub_print)
 580         return pkey->ameth->pub_print(out, pkey, indent, pctx);
 581
 582     return unsup_alg(out, pkey, indent, "Public Key");
 583 }
 584
 585 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
 586                            int indent, ASN1_PCTX *pctx)
 587 {
 588     if (pkey->ameth && pkey->ameth->priv_print)
 589         return pkey->ameth->priv_print(out, pkey, indent, pctx);
 590
 591     return unsup_alg(out, pkey, indent, "Private Key");
 592 }
 593
 594 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
 595                           int indent, ASN1_PCTX *pctx)
 596 {
 597     if (pkey->ameth && pkey->ameth->param_print)
 598         return pkey->ameth->param_print(out, pkey, indent, pctx);
 599     return unsup_alg(out, pkey, indent, "Parameters");
 600 }
 601
 602 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
 603 {
 604     if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
 605         return -2;
 606     return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
 607 }
 608
 609 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
 610 {
 611     return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
 612 }
 613
 614 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
 615                                const unsigned char *pt, size_t ptlen)
 616 {
 617     if (ptlen > INT_MAX)
 618         return 0;
 619     if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
 620                            (void *)pt) <= 0)
 621         return 0;
 622     return 1;
 623 }
 624
 625 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
 626 {
 627     int rv;
 628     rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
 629     if (rv <= 0)
 630         return 0;
 631     return rv;
 632 }