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