lib/libcrypto/evp/p_lib.c

   1 /* $OpenBSD: p_lib.c,v 1.20 2018/02/20 18:05:28 tb Exp $ */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60
  61 #include <openssl/opensslconf.h>
  62
  63 #include <openssl/bn.h>
  64 #include <openssl/err.h>
  65 #include <openssl/evp.h>
  66 #include <openssl/objects.h>
  67 #include <openssl/x509.h>
  68
  69 #ifndef OPENSSL_NO_DH
  70 #include <openssl/dh.h>
  71 #endif
  72 #ifndef OPENSSL_NO_DSA
  73 #include <openssl/dsa.h>
  74 #endif
  75 #ifndef OPENSSL_NO_RSA
  76 #include <openssl/rsa.h>
  77 #endif
  78
  79 #ifndef OPENSSL_NO_ENGINE
  80 #include <openssl/engine.h>
  81 #endif
  82
  83 #include "asn1_locl.h"
  84
  85 static void EVP_PKEY_free_it(EVP_PKEY *x);
  86
  87 int
  88 EVP_PKEY_bits(EVP_PKEY *pkey)
  89 {
  90         if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
  91                 return pkey->ameth->pkey_bits(pkey);
  92         return 0;
  93 }
  94
  95 int
  96 EVP_PKEY_size(EVP_PKEY *pkey)
  97 {
  98         if (pkey && pkey->ameth && pkey->ameth->pkey_size)
  99                 return pkey->ameth->pkey_size(pkey);
 100         return 0;
 101 }
 102
 103 int
 104 EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
 105 {
 106 #ifndef OPENSSL_NO_DSA
 107         if (pkey->type == EVP_PKEY_DSA) {
 108                 int ret = pkey->save_parameters;
 109
 110                 if (mode >= 0)
 111                         pkey->save_parameters = mode;
 112                 return (ret);
 113         }
 114 #endif
 115 #ifndef OPENSSL_NO_EC
 116         if (pkey->type == EVP_PKEY_EC) {
 117                 int ret = pkey->save_parameters;
 118
 119                 if (mode >= 0)
 120                         pkey->save_parameters = mode;
 121                 return (ret);
 122         }
 123 #endif
 124         return (0);
 125 }
 126
 127 int
 128 EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
 129 {
 130         if (to->type != from->type) {
 131                 EVPerror(EVP_R_DIFFERENT_KEY_TYPES);
 132                 goto err;
 133         }
 134
 135         if (EVP_PKEY_missing_parameters(from)) {
 136                 EVPerror(EVP_R_MISSING_PARAMETERS);
 137                 goto err;
 138         }
 139         if (from->ameth && from->ameth->param_copy)
 140                 return from->ameth->param_copy(to, from);
 141
 142 err:
 143         return 0;
 144 }
 145
 146 int
 147 EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
 148 {
 149         if (pkey->ameth && pkey->ameth->param_missing)
 150                 return pkey->ameth->param_missing(pkey);
 151         return 0;
 152 }
 153
 154 int
 155 EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
 156 {
 157         if (a->type != b->type)
 158                 return -1;
 159         if (a->ameth && a->ameth->param_cmp)
 160                 return a->ameth->param_cmp(a, b);
 161         return -2;
 162 }
 163
 164 int
 165 EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
 166 {
 167         if (a->type != b->type)
 168                 return -1;
 169
 170         if (a->ameth) {
 171                 int ret;
 172                 /* Compare parameters if the algorithm has them */
 173                 if (a->ameth->param_cmp) {
 174                         ret = a->ameth->param_cmp(a, b);
 175                         if (ret <= 0)
 176                                 return ret;
 177                 }
 178
 179                 if (a->ameth->pub_cmp)
 180                         return a->ameth->pub_cmp(a, b);
 181         }
 182
 183         return -2;
 184 }
 185
 186 EVP_PKEY *
 187 EVP_PKEY_new(void)
 188 {
 189         EVP_PKEY *ret;
 190
 191         ret = malloc(sizeof(EVP_PKEY));
 192         if (ret == NULL) {
 193                 EVPerror(ERR_R_MALLOC_FAILURE);
 194                 return (NULL);
 195         }
 196         ret->type = EVP_PKEY_NONE;
 197         ret->save_type = EVP_PKEY_NONE;
 198         ret->references = 1;
 199         ret->ameth = NULL;
 200         ret->engine = NULL;
 201         ret->pkey.ptr = NULL;
 202         ret->attributes = NULL;
 203         ret->save_parameters = 1;
 204         return (ret);
 205 }
 206
 207 int
 208 EVP_PKEY_up_ref(EVP_PKEY *pkey)
 209 {
 210         int refs = CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
 211         return ((refs > 1) ? 1 : 0);
 212 }
 213
 214 /* Setup a public key ASN1 method and ENGINE from a NID or a string.
 215  * If pkey is NULL just return 1 or 0 if the algorithm exists.
 216  */
 217
 218 static int
 219 pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
 220 {
 221         const EVP_PKEY_ASN1_METHOD *ameth;
 222         ENGINE *e = NULL;
 223         if (pkey) {
 224                 if (pkey->pkey.ptr)
 225                         EVP_PKEY_free_it(pkey);
 226                 /* If key type matches and a method exists then this
 227                  * lookup has succeeded once so just indicate success.
 228                  */
 229                 if ((type == pkey->save_type) && pkey->ameth)
 230                         return 1;
 231 #ifndef OPENSSL_NO_ENGINE
 232                 /* If we have an ENGINE release it */
 233                 if (pkey->engine) {
 234                         ENGINE_finish(pkey->engine);
 235                         pkey->engine = NULL;
 236                 }
 237 #endif
 238         }
 239         if (str)
 240                 ameth = EVP_PKEY_asn1_find_str(&e, str, len);
 241         else
 242                 ameth = EVP_PKEY_asn1_find(&e, type);
 243 #ifndef OPENSSL_NO_ENGINE
 244         if (!pkey && e)
 245                 ENGINE_finish(e);
 246 #endif
 247         if (!ameth) {
 248                 EVPerror(EVP_R_UNSUPPORTED_ALGORITHM);
 249                 return 0;
 250         }
 251         if (pkey) {
 252                 pkey->ameth = ameth;
 253                 pkey->engine = e;
 254
 255                 pkey->type = pkey->ameth->pkey_id;
 256                 pkey->save_type = type;
 257         }
 258         return 1;
 259 }
 260
 261 int
 262 EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
 263 {
 264         return pkey_set_type(pkey, type, NULL, -1);
 265 }
 266
 267 int
 268 EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
 269 {
 270         return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
 271 }
 272
 273 int
 274 EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
 275 {
 276         if (!EVP_PKEY_set_type(pkey, type))
 277                 return 0;
 278         pkey->pkey.ptr = key;
 279         return (key != NULL);
 280 }
 281
 282 void *
 283 EVP_PKEY_get0(EVP_PKEY *pkey)
 284 {
 285         return pkey->pkey.ptr;
 286 }
 287
 288 #ifndef OPENSSL_NO_RSA
 289 RSA *
 290 EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
 291 {
 292         if (pkey->type != EVP_PKEY_RSA) {
 293                 EVPerror(EVP_R_EXPECTING_AN_RSA_KEY);
 294                 return NULL;
 295         }
 296         return pkey->pkey.rsa;
 297 }
 298
 299 RSA *
 300 EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
 301 {
 302         if (pkey->type != EVP_PKEY_RSA) {
 303                 EVPerror(EVP_R_EXPECTING_AN_RSA_KEY);
 304                 return NULL;
 305         }
 306         RSA_up_ref(pkey->pkey.rsa);
 307         return pkey->pkey.rsa;
 308 }
 309
 310 int
 311 EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
 312 {
 313         int ret = EVP_PKEY_assign_RSA(pkey, key);
 314         if (ret != 0)
 315                 RSA_up_ref(key);
 316         return ret;
 317 }
 318 #endif
 319
 320 #ifndef OPENSSL_NO_DSA
 321 DSA *
 322 EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
 323 {
 324         if (pkey->type != EVP_PKEY_DSA) {
 325                 EVPerror(EVP_R_EXPECTING_A_DSA_KEY);
 326                 return NULL;
 327         }
 328         return pkey->pkey.dsa;
 329 }
 330
 331 DSA *
 332 EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
 333 {
 334         if (pkey->type != EVP_PKEY_DSA) {
 335                 EVPerror(EVP_R_EXPECTING_A_DSA_KEY);
 336                 return NULL;
 337         }
 338         DSA_up_ref(pkey->pkey.dsa);
 339         return pkey->pkey.dsa;
 340 }
 341
 342 int
 343 EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
 344 {
 345         int ret = EVP_PKEY_assign_DSA(pkey, key);
 346         if (ret != 0)
 347                 DSA_up_ref(key);
 348         return ret;
 349 }
 350 #endif
 351
 352 #ifndef OPENSSL_NO_EC
 353 EC_KEY *
 354 EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
 355 {
 356         if (pkey->type != EVP_PKEY_EC) {
 357                 EVPerror(EVP_R_EXPECTING_A_EC_KEY);
 358                 return NULL;
 359         }
 360         return pkey->pkey.ec;
 361 }
 362
 363 EC_KEY *
 364 EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
 365 {
 366         if (pkey->type != EVP_PKEY_EC) {
 367                 EVPerror(EVP_R_EXPECTING_A_EC_KEY);
 368                 return NULL;
 369         }
 370         EC_KEY_up_ref(pkey->pkey.ec);
 371         return pkey->pkey.ec;
 372 }
 373
 374 int
 375 EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
 376 {
 377         int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
 378         if (ret != 0)
 379                 EC_KEY_up_ref(key);
 380         return ret;
 381 }
 382 #endif
 383
 384
 385 #ifndef OPENSSL_NO_DH
 386 DH *
 387 EVP_PKEY_get0_DH(EVP_PKEY *pkey)
 388 {
 389         if (pkey->type != EVP_PKEY_DH) {
 390                 EVPerror(EVP_R_EXPECTING_A_DH_KEY);
 391                 return NULL;
 392         }
 393         return pkey->pkey.dh;
 394 }
 395
 396 DH *
 397 EVP_PKEY_get1_DH(EVP_PKEY *pkey)
 398 {
 399         if (pkey->type != EVP_PKEY_DH) {
 400                 EVPerror(EVP_R_EXPECTING_A_DH_KEY);
 401                 return NULL;
 402         }
 403         DH_up_ref(pkey->pkey.dh);
 404         return pkey->pkey.dh;
 405 }
 406
 407 int
 408 EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
 409 {
 410         int ret = EVP_PKEY_assign_DH(pkey, key);
 411         if (ret != 0)
 412                 DH_up_ref(key);
 413         return ret;
 414 }
 415 #endif
 416
 417 int
 418 EVP_PKEY_type(int type)
 419 {
 420         int ret;
 421         const EVP_PKEY_ASN1_METHOD *ameth;
 422         ENGINE *e;
 423         ameth = EVP_PKEY_asn1_find(&e, type);
 424         if (ameth)
 425                 ret = ameth->pkey_id;
 426         else
 427                 ret = NID_undef;
 428 #ifndef OPENSSL_NO_ENGINE
 429         if (e)
 430                 ENGINE_finish(e);
 431 #endif
 432         return ret;
 433 }
 434
 435 int
 436 EVP_PKEY_id(const EVP_PKEY *pkey)
 437 {
 438         return pkey->type;
 439 }
 440
 441 int
 442 EVP_PKEY_base_id(const EVP_PKEY *pkey)
 443 {
 444         return EVP_PKEY_type(pkey->type);
 445 }
 446
 447 void
 448 EVP_PKEY_free(EVP_PKEY *x)
 449 {
 450         int i;
 451
 452         if (x == NULL)
 453                 return;
 454
 455         i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
 456         if (i > 0)
 457                 return;
 458
 459         EVP_PKEY_free_it(x);
 460         if (x->attributes)
 461                 sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
 462         free(x);
 463 }
 464
 465 static void
 466 EVP_PKEY_free_it(EVP_PKEY *x)
 467 {
 468         if (x->ameth && x->ameth->pkey_free) {
 469                 x->ameth->pkey_free(x);
 470                 x->pkey.ptr = NULL;
 471         }
 472 #ifndef OPENSSL_NO_ENGINE
 473         if (x->engine) {
 474                 ENGINE_finish(x->engine);
 475                 x->engine = NULL;
 476         }
 477 #endif
 478 }
 479
 480 static int
 481 unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent, const char *kstr)
 482 {
 483         BIO_indent(out, indent, 128);
 484         BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
 485             kstr, OBJ_nid2ln(pkey->type));
 486         return 1;
 487 }
 488
 489 int
 490 EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey, int indent,
 491     ASN1_PCTX *pctx)
 492 {
 493         if (pkey->ameth && pkey->ameth->pub_print)
 494                 return pkey->ameth->pub_print(out, pkey, indent, pctx);
 495
 496         return unsup_alg(out, pkey, indent, "Public Key");
 497 }
 498
 499 int
 500 EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey, int indent,
 501     ASN1_PCTX *pctx)
 502 {
 503         if (pkey->ameth && pkey->ameth->priv_print)
 504                 return pkey->ameth->priv_print(out, pkey, indent, pctx);
 505
 506         return unsup_alg(out, pkey, indent, "Private Key");
 507 }
 508
 509 int
 510 EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey, int indent,
 511     ASN1_PCTX *pctx)
 512 {
 513         if (pkey->ameth && pkey->ameth->param_print)
 514                 return pkey->ameth->param_print(out, pkey, indent, pctx);
 515         return unsup_alg(out, pkey, indent, "Parameters");
 516 }
 517
 518 int
 519 EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
 520 {
 521         if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
 522                 return -2;
 523         return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,
 524             0, pnid);
 525 }
 526