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     return (ret);
 200 }
 201
 202 void EVP_PKEY_up_ref(EVP_PKEY *pkey)
 203 {
 204     CRYPTO_add(&pkey->references, 1, CRYPTO_LOCK_EVP_PKEY);
 205 }
 206
 207 /*
 208  * Setup a public key ASN1 method and ENGINE from a NID or a string. If pkey
 209  * is NULL just return 1 or 0 if the algorithm exists.
 210  */
 211
 212 static int pkey_set_type(EVP_PKEY *pkey, int type, const char *str, int len)
 213 {
 214     const EVP_PKEY_ASN1_METHOD *ameth;
 215     ENGINE *e = NULL;
 216     if (pkey) {
 217         if (pkey->pkey.ptr)
 218             EVP_PKEY_free_it(pkey);
 219         /*
 220          * If key type matches and a method exists then this lookup has
 221          * succeeded once so just indicate success.
 222          */
 223         if ((type == pkey->save_type) && pkey->ameth)
 224             return 1;
 225 #ifndef OPENSSL_NO_ENGINE
 226         /* If we have an ENGINE release it */
 227         ENGINE_finish(pkey->engine);
 228         pkey->engine = NULL;
 229 #endif
 230     }
 231     if (str)
 232         ameth = EVP_PKEY_asn1_find_str(&e, str, len);
 233     else
 234         ameth = EVP_PKEY_asn1_find(&e, type);
 235 #ifndef OPENSSL_NO_ENGINE
 236     if (pkey == NULL)
 237         ENGINE_finish(e);
 238 #endif
 239     if (ameth == NULL) {
 240         EVPerr(EVP_F_PKEY_SET_TYPE, EVP_R_UNSUPPORTED_ALGORITHM);
 241         return 0;
 242     }
 243     if (pkey) {
 244         pkey->ameth = ameth;
 245         pkey->engine = e;
 246
 247         pkey->type = pkey->ameth->pkey_id;
 248         pkey->save_type = type;
 249     }
 250     return 1;
 251 }
 252
 253 int EVP_PKEY_set_type(EVP_PKEY *pkey, int type)
 254 {
 255     return pkey_set_type(pkey, type, NULL, -1);
 256 }
 257
 258 int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len)
 259 {
 260     return pkey_set_type(pkey, EVP_PKEY_NONE, str, len);
 261 }
 262
 263 int EVP_PKEY_assign(EVP_PKEY *pkey, int type, void *key)
 264 {
 265     if (pkey == NULL || !EVP_PKEY_set_type(pkey, type))
 266         return 0;
 267     pkey->pkey.ptr = key;
 268     return (key != NULL);
 269 }
 270
 271 void *EVP_PKEY_get0(const EVP_PKEY *pkey)
 272 {
 273     return pkey->pkey.ptr;
 274 }
 275
 276 #ifndef OPENSSL_NO_RSA
 277 int EVP_PKEY_set1_RSA(EVP_PKEY *pkey, RSA *key)
 278 {
 279     int ret = EVP_PKEY_assign_RSA(pkey, key);
 280     if (ret)
 281         RSA_up_ref(key);
 282     return ret;
 283 }
 284
 285 RSA *EVP_PKEY_get0_RSA(EVP_PKEY *pkey)
 286 {
 287     if (pkey->type != EVP_PKEY_RSA) {
 288         EVPerr(EVP_F_EVP_PKEY_GET0_RSA, EVP_R_EXPECTING_AN_RSA_KEY);
 289         return NULL;
 290     }
 291     return pkey->pkey.rsa;
 292 }
 293
 294 RSA *EVP_PKEY_get1_RSA(EVP_PKEY *pkey)
 295 {
 296     RSA *ret = EVP_PKEY_get0_RSA(pkey);
 297     if (ret != NULL)
 298         RSA_up_ref(ret);
 299     return ret;
 300 }
 301 #endif
 302
 303 #ifndef OPENSSL_NO_DSA
 304 int EVP_PKEY_set1_DSA(EVP_PKEY *pkey, DSA *key)
 305 {
 306     int ret = EVP_PKEY_assign_DSA(pkey, key);
 307     if (ret)
 308         DSA_up_ref(key);
 309     return ret;
 310 }
 311
 312 DSA *EVP_PKEY_get0_DSA(EVP_PKEY *pkey)
 313 {
 314     if (pkey->type != EVP_PKEY_DSA) {
 315         EVPerr(EVP_F_EVP_PKEY_GET0_DSA, EVP_R_EXPECTING_A_DSA_KEY);
 316         return NULL;
 317     }
 318     return pkey->pkey.dsa;
 319 }
 320
 321 DSA *EVP_PKEY_get1_DSA(EVP_PKEY *pkey)
 322 {
 323     DSA *ret = EVP_PKEY_get0_DSA(pkey);
 324     if (ret != NULL)
 325         DSA_up_ref(ret);
 326     return ret;
 327 }
 328 #endif
 329
 330 #ifndef OPENSSL_NO_EC
 331
 332 int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey, EC_KEY *key)
 333 {
 334     int ret = EVP_PKEY_assign_EC_KEY(pkey, key);
 335     if (ret)
 336         EC_KEY_up_ref(key);
 337     return ret;
 338 }
 339
 340 EC_KEY *EVP_PKEY_get0_EC_KEY(EVP_PKEY *pkey)
 341 {
 342     if (pkey->type != EVP_PKEY_EC) {
 343         EVPerr(EVP_F_EVP_PKEY_GET0_EC_KEY, EVP_R_EXPECTING_A_EC_KEY);
 344         return NULL;
 345     }
 346     return pkey->pkey.ec;
 347 }
 348
 349 EC_KEY *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey)
 350 {
 351     EC_KEY *ret = EVP_PKEY_get0_EC_KEY(pkey);
 352     if (ret != NULL)
 353         EC_KEY_up_ref(ret);
 354     return ret;
 355 }
 356 #endif
 357
 358 #ifndef OPENSSL_NO_DH
 359
 360 int EVP_PKEY_set1_DH(EVP_PKEY *pkey, DH *key)
 361 {
 362     int ret = EVP_PKEY_assign_DH(pkey, key);
 363     if (ret)
 364         DH_up_ref(key);
 365     return ret;
 366 }
 367
 368 DH *EVP_PKEY_get0_DH(EVP_PKEY *pkey)
 369 {
 370     if (pkey->type != EVP_PKEY_DH && pkey->type != EVP_PKEY_DHX) {
 371         EVPerr(EVP_F_EVP_PKEY_GET0_DH, EVP_R_EXPECTING_A_DH_KEY);
 372         return NULL;
 373     }
 374     return pkey->pkey.dh;
 375 }
 376
 377 DH *EVP_PKEY_get1_DH(EVP_PKEY *pkey)
 378 {
 379     DH *ret = EVP_PKEY_get0_DH(pkey);
 380     if (ret != NULL)
 381         DH_up_ref(ret);
 382     return ret;
 383 }
 384 #endif
 385
 386 int EVP_PKEY_type(int type)
 387 {
 388     int ret;
 389     const EVP_PKEY_ASN1_METHOD *ameth;
 390     ENGINE *e;
 391     ameth = EVP_PKEY_asn1_find(&e, type);
 392     if (ameth)
 393         ret = ameth->pkey_id;
 394     else
 395         ret = NID_undef;
 396 #ifndef OPENSSL_NO_ENGINE
 397     ENGINE_finish(e);
 398 #endif
 399     return ret;
 400 }
 401
 402 int EVP_PKEY_id(const EVP_PKEY *pkey)
 403 {
 404     return pkey->type;
 405 }
 406
 407 int EVP_PKEY_base_id(const EVP_PKEY *pkey)
 408 {
 409     return EVP_PKEY_type(pkey->type);
 410 }
 411
 412 void EVP_PKEY_free(EVP_PKEY *x)
 413 {
 414     int i;
 415
 416     if (x == NULL)
 417         return;
 418
 419     i = CRYPTO_add(&x->references, -1, CRYPTO_LOCK_EVP_PKEY);
 420     REF_PRINT_COUNT("EVP_PKEY", x);
 421     if (i > 0)
 422         return;
 423     REF_ASSERT_ISNT(i < 0);
 424     EVP_PKEY_free_it(x);
 425     sk_X509_ATTRIBUTE_pop_free(x->attributes, X509_ATTRIBUTE_free);
 426     OPENSSL_free(x);
 427 }
 428
 429 static void EVP_PKEY_free_it(EVP_PKEY *x)
 430 {
 431     /* internal function; x is never NULL */
 432     if (x->ameth && x->ameth->pkey_free) {
 433         x->ameth->pkey_free(x);
 434         x->pkey.ptr = NULL;
 435     }
 436 #ifndef OPENSSL_NO_ENGINE
 437     ENGINE_finish(x->engine);
 438     x->engine = NULL;
 439 #endif
 440 }
 441
 442 static int unsup_alg(BIO *out, const EVP_PKEY *pkey, int indent,
 443                      const char *kstr)
 444 {
 445     BIO_indent(out, indent, 128);
 446     BIO_printf(out, "%s algorithm \"%s\" unsupported\n",
 447                kstr, OBJ_nid2ln(pkey->type));
 448     return 1;
 449 }
 450
 451 int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey,
 452                           int indent, ASN1_PCTX *pctx)
 453 {
 454     if (pkey->ameth && pkey->ameth->pub_print)
 455         return pkey->ameth->pub_print(out, pkey, indent, pctx);
 456
 457     return unsup_alg(out, pkey, indent, "Public Key");
 458 }
 459
 460 int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey,
 461                            int indent, ASN1_PCTX *pctx)
 462 {
 463     if (pkey->ameth && pkey->ameth->priv_print)
 464         return pkey->ameth->priv_print(out, pkey, indent, pctx);
 465
 466     return unsup_alg(out, pkey, indent, "Private Key");
 467 }
 468
 469 int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey,
 470                           int indent, ASN1_PCTX *pctx)
 471 {
 472     if (pkey->ameth && pkey->ameth->param_print)
 473         return pkey->ameth->param_print(out, pkey, indent, pctx);
 474     return unsup_alg(out, pkey, indent, "Parameters");
 475 }
 476
 477 int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid)
 478 {
 479     if (!pkey->ameth || !pkey->ameth->pkey_ctrl)
 480         return -2;
 481     return pkey->ameth->pkey_ctrl(pkey, ASN1_PKEY_CTRL_DEFAULT_MD_NID,
 482                                   0, pnid);
 483 }