crypto/evp/p_lib.c

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