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