crypto/evp/p_lib.c

   1 /*
   2  * Copyright 1995-2017 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_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_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         /* We assume the method function calls EVPerr */
 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_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_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         /* We assume the method function calls EVPerr */
 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     EVP_PKEY *ret = EVP_PKEY_new();
 287     CMAC_CTX *cmctx = CMAC_CTX_new();
 288
 289     if (ret == NULL
 290             || cmctx == NULL
 291             || !pkey_set_type(ret, e, EVP_PKEY_CMAC, NULL, -1)) {
 292         /* EVPerr already called */
 293         goto err;
 294     }
 295
 296     if (!CMAC_Init(cmctx, priv, len, cipher, e)) {
 297         EVPerr(EVP_F_EVP_PKEY_NEW_CMAC_KEY, EVP_R_KEY_SETUP_FAILED);
 298         goto err;
 299     }
 300
 301     ret->pkey.ptr = cmctx;
 302     return ret;
 303
 304  err:
 305     EVP_PKEY_free(ret);
 306     CMAC_CTX_free(cmctx);
 307     return NULL;
 308
 309 }
 310
 311 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
 312 {
 313     return pkey_set_type(pkey, NULL, type, NULL, -1);
 314 }
 315
 316 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
 317 {
 318     return pkey_set_type(pkey, NULL, EVP_PKEY_NONE, str, len);
 319 }
 320 #ifndef OPENSSL_NO_ENGINE
 321 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
 322 {
 323     if (e != NULL) {
 324         if (!ENGINE_init(e)) {
 325             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
 326             return 0;
 327         }
 328         if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
 329             ENGINE_finish(e);
 330             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
 331             return 0;
 332         }
 333     }
 334     ENGINE_finish(pkey->pmeth_engine);
 335     pkey->pmeth_engine = e;
 336     return 1;
 337 }
 338 #endif
 339 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
 340 {
 341     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
 342         return 0;
 343     pkey->pkey.ptr = key;
 344     return (key != NULL);
 345 }
 346
 347 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
 348 {
 349     return pkey->pkey.ptr;
 350 }
 351
 352 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
 353 {
 354     ASN1_OCTET_STRING *os = NULL;
 355     if (pkey->type != EVP_PKEY_HMAC) {
 356         EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
 357         return NULL;
 358     }
 359     os = EVP_PKEY_get0(pkey);
 360     *len = os->length;
 361     return os->data;
 362 }
 363
 364 #ifndef OPENSSL_NO_POLY1305
 365 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
 366 {
 367     ASN1_OCTET_STRING *os = NULL;
 368     if (pkey->type != EVP_PKEY_POLY1305) {
 369         EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
 370         return NULL;
 371     }
 372     os = EVP_PKEY_get0(pkey);
 373     *len = os->length;
 374     return os->data;
 375 }
 376 #endif
 377
 378 #ifndef OPENSSL_NO_SIPHASH
 379 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
 380 {
 381     ASN1_OCTET_STRING *os = NULL;
 382
 383     if (pkey->type != EVP_PKEY_SIPHASH) {
 384         EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
 385         return NULL;
 386     }
 387     os = EVP_PKEY_get0(pkey);
 388     *len = os->length;
 389     return os->data;
 390 }
 391 #endif
 392
 393 #ifndef OPENSSL_NO_RSA
 394 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
 395 {
 396     int ret = EVP_PKEY_assign_RSA(pkey, key);
 397     if (ret)
 398         RSA_up_ref(key);
 399     return ret;
 400 }
 401
 402 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
 403 {
 404     if (pkey->type != EVP_PKEY_RSA) {
 405         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
 406         return NULL;
 407     }
 408     return pkey->pkey.rsa;
 409 }
 410
 411 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
 412 {
 413     RSA *ret = EVP_PKEY_get0_RSA(pkey);
 414     if (ret != NULL)
 415         RSA_up_ref(ret);
 416     return ret;
 417 }
 418 #endif
 419
 420 #ifndef OPENSSL_NO_DSA
 421 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
 422 {
 423     int ret = EVP_PKEY_assign_DSA(pkey, key);
 424     if (ret)
 425         DSA_up_ref(key);
 426     return ret;
 427 }
 428
 429 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
 430 {
 431     if (pkey->type != EVP_PKEY_DSA) {
 432         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
 433         return NULL;
 434     }
 435     return pkey->pkey.dsa;
 436 }
 437
 438 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
 439 {
 440     DSA *ret = EVP_PKEY_get0_DSA(pkey);
 441     if (ret != NULL)
 442         DSA_up_ref(ret);
 443     return ret;
 444 }
 445 #endif
 446
 447 #ifndef OPENSSL_NO_EC
 448
 449 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
 450 {
 451     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
 452     if (ret)
 453         EC_KEY_up_ref(key);
 454     return ret;
 455 }
 456
 457 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
 458 {
 459     if (pkey->type != EVP_PKEY_EC) {
 460         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
 461         return NULL;
 462     }
 463     return pkey->pkey.ec;
 464 }
 465
 466 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
 467 {
 468     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
 469     if (ret != NULL)
 470         EC_KEY_up_ref(ret);
 471     return ret;
 472 }
 473 #endif
 474
 475 #ifndef OPENSSL_NO_DH
 476
 477 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
 478 {
 479     int ret = EVP_PKEY_assign_DH(pkey, key);
 480     if (ret)
 481         DH_up_ref(key);
 482     return ret;
 483 }
 484
 485 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
 486 {
 487     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
 488         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
 489         return NULL;
 490     }
 491     return pkey->pkey.dh;
 492 }
 493
 494 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
 495 {
 496     DH *ret = EVP_PKEY_get0_DH(pkey);
 497     if (ret != NULL)
 498         DH_up_ref(ret);
 499     return ret;
 500 }
 501 #endif
 502
 503 int EVP_PKEY_type(int type)
 504 {
 505     int ret;
 506     const EVP_PKEY_ASN1_METHOD *ameth;
 507     ENGINE *e;
 508     ameth = EVP_PKEY_asn1_find(&e, type);
 509     if (ameth)
 510         ret = ameth->pkey_id;
 511     else
 512         ret = NID_undef;
 513 #ifndef OPENSSL_NO_ENGINE
 514     ENGINE_finish(e);
 515 #endif
 516     return ret;
 517 }
 518
 519 int EVP_PKEY_id(const EVP_PKEY *pkey)
 520 {
 521     return pkey->type;
 522 }
 523
 524 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
 525 {
 526     return EVP_PKEY_type(pkey->type);
 527 }
 528
 529 void EVP_PKEY_free(EVP_PKEY *x)
 530 {
 531     int i;
 532
 533     if (x == NULL)
 534         return;
 535
 536     CRYPTO_DOWN_REF(&x->references, &i, x->lock);
 537     REF_PRINT_COUNT("EVP_PKEY", x);
 538     if (i > 0)
 539         return;
 540     REF_ASSERT_ISNT(i < 0);
 541     EVP_PKEY_free_it(x);
 542     CRYPTO_THREAD_lock_free(x->lock);
 543     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
 544     OPENSSL_free(x);
 545 }
 546
 547 static void EVP_PKEY_free_it(EVP_PKEY *x)
 548 {
 549     /* internal function; x is never NULL */
 550     if (x->ameth && x->ameth->pkey_free) {
 551         x->ameth->pkey_free(x);
 552         x->pkey.ptr = NULL;
 553     }
 554 #ifndef OPENSSL_NO_ENGINE
 555     ENGINE_finish(x->engine);
 556     x->engine = NULL;
 557     ENGINE_finish(x->pmeth_engine);
 558     x->pmeth_engine = NULL;
 559 #endif
 560 }
 561
 562 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
 563                      const char *kstr)
 564 {
 565     BIO_indent(out, indent, 128);
 566     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
 567                kstr, OBJ_nid2ln(pkey->type));
 568     return 1;
 569 }
 570
 571 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
 572                           int indent, ASN1_PCTX *pctx)
 573 {
 574     if (pkey->ameth && pkey->ameth->pub_print)
 575         return pkey->ameth->pub_print(out, pkey, indent, pctx);
 576
 577     return unsup_alg(out, pkey, indent, "Public Key");
 578 }
 579
 580 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
 581                            int indent, ASN1_PCTX *pctx)
 582 {
 583     if (pkey->ameth && pkey->ameth->priv_print)
 584         return pkey->ameth->priv_print(out, pkey, indent, pctx);
 585
 586     return unsup_alg(out, pkey, indent, "Private Key");
 587 }
 588
 589 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
 590                           int indent, ASN1_PCTX *pctx)
 591 {
 592     if (pkey->ameth && pkey->ameth->param_print)
 593         return pkey->ameth->param_print(out, pkey, indent, pctx);
 594     return unsup_alg(out, pkey, indent, "Parameters");
 595 }
 596
 597 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
 598 {
 599     if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
 600         return -2;
 601     return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
 602 }
 603
 604 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
 605 {
 606     return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
 607 }
 608
 609 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
 610                                const unsigned char *pt, size_t ptlen)
 611 {
 612     if (ptlen > INT_MAX)
 613         return 0;
 614     if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
 615                            (void *)pt) <= 0)
 616         return 0;
 617     return 1;
 618 }
 619
 620 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
 621 {
 622     int rv;
 623     rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
 624     if (rv <= 0)
 625         return 0;
 626     return rv;
 627 }