crypto/evp/p_lib.c

   1 /* crypto/evp/p_lib.c */
   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 #include "internal/cryptlib.h"
  61 #include <openssl/bn.h>
  62 #include <openssl/err.h>
  63 #include <openssl/objects.h>
  64 #include <openssl/evp.h>
  65 #include <openssl/x509.h>
  66 #ifndef OPENSSL_NO_RSA
  67 # include <openssl/rsa.h>
  68 #endif
  69 #ifndef OPENSSL_NO_DSA
  70 # include <openssl/dsa.h>
  71 #endif
  72 #ifndef OPENSSL_NO_DH
  73 # include <openssl/dh.h>
  74 #endif
  75
  76 #ifndef OPENSSL_NO_ENGINE
  77 # include <openssl/engine.h>
  78 #endif
  79
  80 #include "internal/asn1_int.h"
  81 #include "internal/evp_int.h"
  82
  83 static void EVP_PKEY_free_it(EVP_PKEY *x);
  84
  85 int EVP_PKEY_bits(EVP_PKEY *pkey)
  86 {
  87     if (pkey && pkey->ameth && pkey->ameth->pkey_bits)
  88         return pkey->ameth->pkey_bits(pkey);
  89     return 0;
  90 }
  91
  92 int EVP_PKEY_security_bits(const EVP_PKEY *pkey)
  93 {
  94     if (pkey == NULL)
  95         return 0;
  96     if (!pkey->ameth || !pkey->ameth->pkey_security_bits)
  97         return -2;
  98     return pkey->ameth->pkey_security_bits(pkey);
  99 }
 100
 101 int EVP_PKEY_size(EVP_PKEY *pkey)
 102 {
 103     if (pkey && pkey->ameth && pkey->ameth->pkey_size)
 104         return pkey->ameth->pkey_size(pkey);
 105     return 0;
 106 }
 107
 108 int EVP_PKEY_save_parameters(EVP_PKEY *pkey, int mode)
 109 {
 110 #ifndef OPENSSL_NO_DSA
 111     if (pkey->type == EVP_PKEY_DSA) {
 112         int ret = pkey->save_parameters;
 113
 114         if (mode >= 0)
 115             pkey->save_parameters = mode;
 116         return (ret);
 117     }
 118 #endif
 119 #ifndef OPENSSL_NO_EC
 120     if (pkey->type == EVP_PKEY_EC) {
 121         int ret = pkey->save_parameters;
 122
 123         if (mode >= 0)
 124             pkey->save_parameters = mode;
 125         return (ret);
 126     }
 127 #endif
 128     return (0);
 129 }
 130
 131 int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from)
 132 {
 133     if (to->type == EVP_PKEY_NONE) {
 134         if (EVP_PKEY_set_type(to, from->type) == 0)
 135             return 0;
 136     } else if (to->type != from->type) {
 137         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_DIFFERENT_KEY_TYPES);
 138         goto err;
 139     }
 140
 141     if (EVP_PKEY_missing_parameters(from)) {
 142         EVPerr(EVP_F_EVP_PKEY_COPY_PARAMETERS, EVP_R_MISSING_PARAMETERS);
 143         goto err;
 144     }
 145     if (from->ameth && from->ameth->param_copy)
 146         return from->ameth->param_copy(to, from);
 147  err:
 148     return 0;
 149 }
 150
 151 int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey)
 152 {
 153     if (pkey->ameth && pkey->ameth->param_missing)
 154         return pkey->ameth->param_missing(pkey);
 155     return 0;
 156 }
 157
 158 int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b)
 159 {
 160     if (a->type != b->type)
 161         return -1;
 162     if (a->ameth && a->ameth->param_cmp)
 163         return a->ameth->param_cmp(a, b);
 164     return -2;
 165 }
 166
 167 int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
 168 {
 169     if (a->type != b->type)
 170         return -1;
 171
 172     if (a->ameth) {
 173         int ret;
 174         /* Compare parameters if the algorithm has them */
 175         if (a->ameth->param_cmp) {
 176             ret = a->ameth->param_cmp(a, b);
 177             if (ret <= 0)
 178                 return ret;
 179         }
 180
 181         if (a->ameth->pub_cmp)
 182             return a->ameth->pub_cmp(a, b);
 183     }
 184
 185     return -2;
 186 }
 187
 188 EVP_PKEY *EVP_PKEY_new(void)
 189 {
 190     EVP_PKEY *ret;
 191
 192     ret = OPENSSL_malloc(sizeof(*ret));
 193     if (ret == NULL) {
 194         EVPerr(EVP_F_EVP_PKEY_NEW, ERR_R_MALLOC_FAILURE);
 195         return (NULL);
 196     }
 197     ret->type = EVP_PKEY_NONE;
 198     ret->save_type = EVP_PKEY_NONE;
 199     ret->references = 1;
 200     ret->ameth = NULL;
 201     ret->engine = NULL;
 202     ret->pkey.ptr = NULL;
 203     ret->attributes = NULL;
 204     ret->save_parameters = 1;
 205     return (ret);
 206 }
 207
 208 void EVP_PKEY_up_ref(EVP_PKEY *pkey)
 209 {
 210     CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
 211 }
 212
 213 /*
 214  * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
 215  * is NULL just return 1 or 0 if the algorithm exists.
 216  */
 217
 218 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
 219 {
 220     const EVP_PKEY_ASN1_METHOD *ameth;
 221     ENGINE *e = NULL;
 222     if (pkey) {
 223         if (pkey->pkey.ptr)
 224             EVP_PKEY_free_it(pkey);
 225         /*
 226          * If key type matches and a method exists then this lookup has
 227          * 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         EVPerr(EVP_F_PKEY_SET_TYPE, 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 EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
 262 {
 263     return pkey_set_type(pkey, type, NULL, -1);
 264 }
 265
 266 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
 267 {
 268     return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
 269 }
 270
 271 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
 272 {
 273     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
 274         return 0;
 275     pkey->pkey.ptr = key;
 276     return (key != NULL);
 277 }
 278
 279 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
 280 {
 281     return pkey->pkey.ptr;
 282 }
 283
 284 #ifndef OPENSSL_NO_RSA
 285 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
 286 {
 287     int ret = EVP_PKEY_assign_RSA(pkey, key);
 288     if (ret)
 289         RSA_up_ref(key);
 290     return ret;
 291 }
 292
 293 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
 294 {
 295     if (pkey->type != EVP_PKEY_RSA) {
 296         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
 297         return NULL;
 298     }
 299     return pkey->pkey.rsa;
 300 }
 301
 302 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
 303 {
 304     RSA *ret = EVP_PKEY_get0_RSA(pkey);
 305     if (ret != NULL)
 306         RSA_up_ref(ret);
 307     return ret;
 308 }
 309 #endif
 310
 311 #ifndef OPENSSL_NO_DSA
 312 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
 313 {
 314     int ret = EVP_PKEY_assign_DSA(pkey, key);
 315     if (ret)
 316         DSA_up_ref(key);
 317     return ret;
 318 }
 319
 320 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
 321 {
 322     if (pkey->type != EVP_PKEY_DSA) {
 323         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
 324         return NULL;
 325     }
 326     return pkey->pkey.dsa;
 327 }
 328
 329 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
 330 {
 331     DSA *ret = EVP_PKEY_get0_DSA(pkey);
 332     if (ret != NULL)
 333         DSA_up_ref(ret);
 334     return ret;
 335 }
 336 #endif
 337
 338 #ifndef OPENSSL_NO_EC
 339
 340 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
 341 {
 342     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
 343     if (ret)
 344         EC_KEY_up_ref(key);
 345     return ret;
 346 }
 347
 348 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
 349 {
 350     if (pkey->type != EVP_PKEY_EC) {
 351         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
 352         return NULL;
 353     }
 354     return pkey->pkey.ec;
 355 }
 356
 357 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
 358 {
 359     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
 360     if (ret != NULL)
 361         EC_KEY_up_ref(ret);
 362     return ret;
 363 }
 364 #endif
 365
 366 #ifndef OPENSSL_NO_DH
 367
 368 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
 369 {
 370     int ret = EVP_PKEY_assign_DH(pkey, key);
 371     if (ret)
 372         DH_up_ref(key);
 373     return ret;
 374 }
 375
 376 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
 377 {
 378     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
 379         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
 380         return NULL;
 381     }
 382     return pkey->pkey.dh;
 383 }
 384
 385 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
 386 {
 387     DH *ret = EVP_PKEY_get0_DH(pkey);
 388     if (ret != NULL)
 389         DH_up_ref(ret);
 390     return ret;
 391 }
 392 #endif
 393
 394 int EVP_PKEY_type(int type)
 395 {
 396     int ret;
 397     const EVP_PKEY_ASN1_METHOD *ameth;
 398     ENGINE *e;
 399     ameth = EVP_PKEY_asn1_find(&e, type);
 400     if (ameth)
 401         ret = ameth->pkey_id;
 402     else
 403         ret = NID_undef;
 404 #ifndef OPENSSL_NO_ENGINE
 405     if (e)
 406         ENGINE_finish(e);
 407 #endif
 408     return ret;
 409 }
 410
 411 int EVP_PKEY_id(const EVP_PKEY *pkey)
 412 {
 413     return pkey->type;
 414 }
 415
 416 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
 417 {
 418     return EVP_PKEY_type(pkey->type);
 419 }
 420
 421 void EVP_PKEY_free(EVP_PKEY *x)
 422 {
 423     int i;
 424
 425     if (x == NULL)
 426         return;
 427
 428     i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
 429 #ifdef REF_PRINT
 430     REF_PRINT("EVP_PKEY", x);
 431 #endif
 432     if (i > 0)
 433         return;
 434 #ifdef REF_CHECK
 435     if (i < 0) {
 436         fprintf(stderr, "EVP_PKEY_free, bad reference count\n");
 437         abort();
 438     }
 439 #endif
 440     EVP_PKEY_free_it(x);
 441     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
 442     OPENSSL_free(x);
 443 }
 444
 445 static void EVP_PKEY_free_it(EVP_PKEY *x)
 446 {
 447     /* internal function; x is never NULL */
 448     if (x->ameth && x->ameth->pkey_free) {
 449         x->ameth->pkey_free(x);
 450         x->pkey.ptr = NULL;
 451     }
 452 #ifndef OPENSSL_NO_ENGINE
 453     if (x->engine) {
 454         ENGINE_finish(x->engine);
 455         x->engine = NULL;
 456     }
 457 #endif
 458 }
 459
 460 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
 461                      const char *kstr)
 462 {
 463     BIO_indent(out, indent, 128);
 464     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
 465                kstr, OBJ_nid2ln(pkey->type));
 466     return 1;
 467 }
 468
 469 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
 470                           int indent, ASN1_PCTX *pctx)
 471 {
 472     if (pkey->ameth && pkey->ameth->pub_print)
 473         return pkey->ameth->pub_print(out, pkey, indent, pctx);
 474
 475     return unsup_alg(out, pkey, indent, "Public Key");
 476 }
 477
 478 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
 479                            int indent, ASN1_PCTX *pctx)
 480 {
 481     if (pkey->ameth && pkey->ameth->priv_print)
 482         return pkey->ameth->priv_print(out, pkey, indent, pctx);
 483
 484     return unsup_alg(out, pkey, indent, "Private Key");
 485 }
 486
 487 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
 488                           int indent, ASN1_PCTX *pctx)
 489 {
 490     if (pkey->ameth && pkey->ameth->param_print)
 491         return pkey->ameth->param_print(out, pkey, indent, pctx);
 492     return unsup_alg(out, pkey, indent, "Parameters");
 493 }
 494
 495 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
 496 {
 497     if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
 498         return -2;
 499     return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,
 500                                   0, pnid);
 501 }