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, int type, const char *str, int len)
 178 {
 179     const EVP_PKEY_ASN1_METHOD *ameth;
 180     ENGINE *e = NULL;
 181     if (pkey) {
 182         if (pkey->pkey.ptr)
 183             EVP_PKEY_free_it(pkey);
 184         /*
 185          * If key type matches and a method exists then this lookup has
 186          * succeeded once so just indicate success.
 187          */
 188         if ((type == pkey->save_type) && pkey->ameth)
 189             return 1;
 190 #ifndef OPENSSL_NO_ENGINE
 191         /* If we have ENGINEs release them */
 192         ENGINE_finish(pkey->engine);
 193         pkey->engine = NULL;
 194         ENGINE_finish(pkey->pmeth_engine);
 195         pkey->pmeth_engine = NULL;
 196 #endif
 197     }
 198     if (str)
 199         ameth = EVP_PKEY_asn1_find_str(&e, str, len);
 200     else
 201         ameth = EVP_PKEY_asn1_find(&e, type);
 202 #ifndef OPENSSL_NO_ENGINE
 203     if (pkey == NULL)
 204         ENGINE_finish(e);
 205 #endif
 206     if (ameth == NULL) {
 207         EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
 208         return 0;
 209     }
 210     if (pkey) {
 211         pkey->ameth = ameth;
 212         pkey->engine = e;
 213
 214         pkey->type = pkey->ameth->pkey_id;
 215         pkey->save_type = type;
 216     }
 217     return 1;
 218 }
 219
 220 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
 221 {
 222     return pkey_set_type(pkey, type, NULL, -1);
 223 }
 224
 225 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
 226 {
 227     return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
 228 }
 229 #ifndef OPENSSL_NO_ENGINE
 230 int EVP_PKEY_set1_engine(EVP_PKEY *pkey, ENGINE *e)
 231 {
 232     if (e != NULL) {
 233         if (!ENGINE_init(e)) {
 234             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, ERR_R_ENGINE_LIB);
 235             return 0;
 236         }
 237         if (ENGINE_get_pkey_meth(e, pkey->type) == NULL) {
 238             ENGINE_finish(e);
 239             EVPerr(EVP_F_EVP_PKEY_SET1_ENGINE, EVP_R_UNSUPPORTED_ALGORITHM);
 240             return 0;
 241         }
 242     }
 243     ENGINE_finish(pkey->pmeth_engine);
 244     pkey->pmeth_engine = e;
 245     return 1;
 246 }
 247 #endif
 248 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
 249 {
 250     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
 251         return 0;
 252     pkey->pkey.ptr = key;
 253     return (key != NULL);
 254 }
 255
 256 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
 257 {
 258     return pkey->pkey.ptr;
 259 }
 260
 261 const unsigned char *EVP_PKEY_get0_hmac(const EVP_PKEY *pkey, size_t *len)
 262 {
 263     ASN1_OCTET_STRING *os = NULL;
 264     if (pkey->type != EVP_PKEY_HMAC) {
 265         EVPerr(EVP_F_EVP_PKEY_GET0_HMAC, EVP_R_EXPECTING_AN_HMAC_KEY);
 266         return NULL;
 267     }
 268     os = EVP_PKEY_get0(pkey);
 269     *len = os->length;
 270     return os->data;
 271 }
 272
 273 #ifndef OPENSSL_NO_POLY1305
 274 const unsigned char *EVP_PKEY_get0_poly1305(const EVP_PKEY *pkey, size_t *len)
 275 {
 276     ASN1_OCTET_STRING *os = NULL;
 277     if (pkey->type != EVP_PKEY_POLY1305) {
 278         EVPerr(EVP_F_EVP_PKEY_GET0_POLY1305, EVP_R_EXPECTING_A_POLY1305_KEY);
 279         return NULL;
 280     }
 281     os = EVP_PKEY_get0(pkey);
 282     *len = os->length;
 283     return os->data;
 284 }
 285 #endif
 286
 287 #ifndef OPENSSL_NO_SIPHASH
 288 const unsigned char *EVP_PKEY_get0_siphash(const EVP_PKEY *pkey, size_t *len)
 289 {
 290     ASN1_OCTET_STRING *os = NULL;
 291
 292     if (pkey->type != EVP_PKEY_SIPHASH) {
 293         EVPerr(EVP_F_EVP_PKEY_GET0_SIPHASH, EVP_R_EXPECTING_A_SIPHASH_KEY);
 294         return NULL;
 295     }
 296     os = EVP_PKEY_get0(pkey);
 297     *len = os->length;
 298     return os->data;
 299 }
 300 #endif
 301
 302 #ifndef OPENSSL_NO_RSA
 303 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
 304 {
 305     int ret = EVP_PKEY_assign_RSA(pkey, key);
 306     if (ret)
 307         RSA_up_ref(key);
 308     return ret;
 309 }
 310
 311 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
 312 {
 313     if (pkey->type != EVP_PKEY_RSA) {
 314         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
 315         return NULL;
 316     }
 317     return pkey->pkey.rsa;
 318 }
 319
 320 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
 321 {
 322     RSA *ret = EVP_PKEY_get0_RSA(pkey);
 323     if (ret != NULL)
 324         RSA_up_ref(ret);
 325     return ret;
 326 }
 327 #endif
 328
 329 #ifndef OPENSSL_NO_DSA
 330 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
 331 {
 332     int ret = EVP_PKEY_assign_DSA(pkey, key);
 333     if (ret)
 334         DSA_up_ref(key);
 335     return ret;
 336 }
 337
 338 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
 339 {
 340     if (pkey->type != EVP_PKEY_DSA) {
 341         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
 342         return NULL;
 343     }
 344     return pkey->pkey.dsa;
 345 }
 346
 347 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
 348 {
 349     DSA *ret = EVP_PKEY_get0_DSA(pkey);
 350     if (ret != NULL)
 351         DSA_up_ref(ret);
 352     return ret;
 353 }
 354 #endif
 355
 356 #ifndef OPENSSL_NO_EC
 357
 358 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
 359 {
 360     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
 361     if (ret)
 362         EC_KEY_up_ref(key);
 363     return ret;
 364 }
 365
 366 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
 367 {
 368     if (pkey->type != EVP_PKEY_EC) {
 369         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
 370         return NULL;
 371     }
 372     return pkey->pkey.ec;
 373 }
 374
 375 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
 376 {
 377     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
 378     if (ret != NULL)
 379         EC_KEY_up_ref(ret);
 380     return ret;
 381 }
 382 #endif
 383
 384 #ifndef OPENSSL_NO_DH
 385
 386 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
 387 {
 388     int ret = EVP_PKEY_assign_DH(pkey, key);
 389     if (ret)
 390         DH_up_ref(key);
 391     return ret;
 392 }
 393
 394 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
 395 {
 396     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
 397         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
 398         return NULL;
 399     }
 400     return pkey->pkey.dh;
 401 }
 402
 403 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
 404 {
 405     DH *ret = EVP_PKEY_get0_DH(pkey);
 406     if (ret != NULL)
 407         DH_up_ref(ret);
 408     return ret;
 409 }
 410 #endif
 411
 412 int EVP_PKEY_type(int type)
 413 {
 414     int ret;
 415     const EVP_PKEY_ASN1_METHOD *ameth;
 416     ENGINE *e;
 417     ameth = EVP_PKEY_asn1_find(&e, type);
 418     if (ameth)
 419         ret = ameth->pkey_id;
 420     else
 421         ret = NID_undef;
 422 #ifndef OPENSSL_NO_ENGINE
 423     ENGINE_finish(e);
 424 #endif
 425     return ret;
 426 }
 427
 428 int EVP_PKEY_id(const EVP_PKEY *pkey)
 429 {
 430     return pkey->type;
 431 }
 432
 433 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
 434 {
 435     return EVP_PKEY_type(pkey->type);
 436 }
 437
 438 void EVP_PKEY_free(EVP_PKEY *x)
 439 {
 440     int i;
 441
 442     if (x == NULL)
 443         return;
 444
 445     CRYPTO_DOWN_REF(&x->references, &i, x->lock);
 446     REF_PRINT_COUNT("EVP_PKEY", x);
 447     if (i > 0)
 448         return;
 449     REF_ASSERT_ISNT(i < 0);
 450     EVP_PKEY_free_it(x);
 451     CRYPTO_THREAD_lock_free(x->lock);
 452     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
 453     OPENSSL_free(x);
 454 }
 455
 456 static void EVP_PKEY_free_it(EVP_PKEY *x)
 457 {
 458     /* internal function; x is never NULL */
 459     if (x->ameth && x->ameth->pkey_free) {
 460         x->ameth->pkey_free(x);
 461         x->pkey.ptr = NULL;
 462     }
 463 #ifndef OPENSSL_NO_ENGINE
 464     ENGINE_finish(x->engine);
 465     x->engine = NULL;
 466     ENGINE_finish(x->pmeth_engine);
 467     x->pmeth_engine = NULL;
 468 #endif
 469 }
 470
 471 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
 472                      const char *kstr)
 473 {
 474     BIO_indent(out, indent, 128);
 475     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
 476                kstr, OBJ_nid2ln(pkey->type));
 477     return 1;
 478 }
 479
 480 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
 481                           int indent, ASN1_PCTX *pctx)
 482 {
 483     if (pkey->ameth && pkey->ameth->pub_print)
 484         return pkey->ameth->pub_print(out, pkey, indent, pctx);
 485
 486     return unsup_alg(out, pkey, indent, "Public Key");
 487 }
 488
 489 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
 490                            int indent, ASN1_PCTX *pctx)
 491 {
 492     if (pkey->ameth && pkey->ameth->priv_print)
 493         return pkey->ameth->priv_print(out, pkey, indent, pctx);
 494
 495     return unsup_alg(out, pkey, indent, "Private Key");
 496 }
 497
 498 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
 499                           int indent, ASN1_PCTX *pctx)
 500 {
 501     if (pkey->ameth && pkey->ameth->param_print)
 502         return pkey->ameth->param_print(out, pkey, indent, pctx);
 503     return unsup_alg(out, pkey, indent, "Parameters");
 504 }
 505
 506 static int evp_pkey_asn1_ctrl(EVP_PKEY *pkey, int op, int arg1, void *arg2)
 507 {
 508     if (pkey->ameth == NULL || pkey->ameth->pkey_ctrl == NULL)
 509         return -2;
 510     return pkey->ameth->pkey_ctrl(pkey, op, arg1, arg2);
 511 }
 512
 513 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
 514 {
 515     return evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID, 0, pnid);
 516 }
 517
 518 int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey,
 519                                const unsigned char *pt, size_t ptlen)
 520 {
 521     if (ptlen > INT_MAX)
 522         return 0;
 523     if (evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_SET1_TLS_ENCPT, ptlen,
 524                            (void *)pt) <= 0)
 525         return 0;
 526     return 1;
 527 }
 528
 529 size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt)
 530 {
 531     int rv;
 532     rv = evp_pkey_asn1_ctrl(pkey, ASN1_PKEY_CTRL_GET1_TLS_ENCPT, 0, ppt);
 533     if (rv <= 0)
 534         return 0;
 535     return rv;
 536 }