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