crypto/evp/pmeth_lib.c

   1 /* pmeth_lib.c */
   2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
   3  * project 2006.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include "cryptlib.h"
  62 #include <openssl/objects.h>
  63 #include <openssl/evp.h>
  64 #ifndef OPENSSL_NO_ENGINE
  65 #include <openssl/engine.h>
  66 #endif
  67 #include "asn1_locl.h"
  68 #include "evp_locl.h"
  69
  70 typedef int sk_cmp_fn_type(const char * const *a, const char * const *b);
  71
  72 DECLARE_STACK_OF(EVP_PKEY_METHOD)
  73 STACK_OF(EVP_PKEY_METHOD) *app_pkey_methods = NULL;
  74
  75 extern const EVP_PKEY_METHOD rsa_pkey_meth, dh_pkey_meth, dsa_pkey_meth;
  76 extern const EVP_PKEY_METHOD ec_pkey_meth, hmac_pkey_meth;
  77
  78 static const EVP_PKEY_METHOD *standard_methods[] =
  79         {
  80 #ifndef OPENSSL_NO_RSA
  81         &rsa_pkey_meth,
  82 #endif
  83 #ifndef OPENSSL_NO_DH
  84         &dh_pkey_meth,
  85 #endif
  86 #ifndef OPENSSL_NO_DSA
  87         &dsa_pkey_meth,
  88 #endif
  89 #ifndef OPENSSL_NO_EC
  90         &ec_pkey_meth,
  91 #endif
  92         &hmac_pkey_meth,
  93         };
  94
  95 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
  96                            pmeth);
  97
  98 static int pmeth_cmp(const EVP_PKEY_METHOD * const *a,
  99                      const EVP_PKEY_METHOD * const *b)
 100         {
 101         return ((*a)->pkey_id - (*b)->pkey_id);
 102         }
 103
 104 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
 105                              pmeth);
 106
 107 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
 108         {
 109         EVP_PKEY_METHOD tmp;
 110         const EVP_PKEY_METHOD *t = &tmp, **ret;
 111         tmp.pkey_id = type;
 112         if (app_pkey_methods)
 113                 {
 114                 int idx;
 115                 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
 116                 if (idx >= 0)
 117                         return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
 118                 }
 119         ret = OBJ_bsearch_pmeth(&t, standard_methods,
 120                           sizeof(standard_methods)/sizeof(EVP_PKEY_METHOD *));
 121         if (!ret || !*ret)
 122                 return NULL;
 123         return *ret;
 124         }
 125
 126 static EVP_PKEY_CTX *int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
 127         {
 128         EVP_PKEY_CTX *ret;
 129         const EVP_PKEY_METHOD *pmeth;
 130         if (id == -1)
 131                 {
 132                 if (!pkey || !pkey->ameth)
 133                         return NULL;
 134                 id = pkey->ameth->pkey_id;
 135                 }
 136 #ifndef OPENSSL_NO_ENGINE
 137         /* Try to find an ENGINE which implements this method */
 138         if (e)
 139                 {
 140                 if (!ENGINE_init(e))
 141                         {
 142                         EVPerr(EVP_F_INT_CTX_NEW,ERR_R_ENGINE_LIB);
 143                         return NULL;
 144                         }
 145                 }
 146         else
 147                 e = ENGINE_get_pkey_meth_engine(id);
 148
 149         /* If an ENGINE handled this method look it up. Othewise
 150          * use internal tables.
 151          */
 152
 153         if (e)
 154                 pmeth = ENGINE_get_pkey_meth(e, id);
 155         else
 156 #endif
 157                 pmeth = EVP_PKEY_meth_find(id);
 158
 159         if (pmeth == NULL)
 160                 {
 161                 EVPerr(EVP_F_INT_CTX_NEW,EVP_R_UNSUPPORTED_ALGORITHM);
 162                 return NULL;
 163                 }
 164
 165         ret = OPENSSL_malloc(sizeof(EVP_PKEY_CTX));
 166         if (!ret)
 167                 {
 168 #ifndef OPENSSL_NO_ENGINE
 169                 if (e)
 170                         ENGINE_finish(e);
 171 #endif
 172                 EVPerr(EVP_F_INT_CTX_NEW,ERR_R_MALLOC_FAILURE);
 173                 return NULL;
 174                 }
 175         ret->engine = e;
 176         ret->pmeth = pmeth;
 177         ret->operation = EVP_PKEY_OP_UNDEFINED;
 178         ret->pkey = pkey;
 179         ret->peerkey = NULL;
 180         if (pkey)
 181                 CRYPTO_add(&pkey->references,1,CRYPTO_LOCK_EVP_PKEY);
 182         ret->data = NULL;
 183
 184         if (pmeth->init)
 185                 {
 186                 if (pmeth->init(ret) <= 0)
 187                         {
 188                         EVP_PKEY_CTX_free(ret);
 189                         return NULL;
 190                         }
 191                 }
 192
 193         return ret;
 194         }
 195
 196 EVP_PKEY_METHOD* EVP_PKEY_meth_new(int id, int flags)
 197         {
 198         EVP_PKEY_METHOD *pmeth;
 199         pmeth = OPENSSL_malloc(sizeof(EVP_PKEY_METHOD));
 200         if (!pmeth)
 201                 return NULL;
 202
 203         pmeth->pkey_id = id;
 204         pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
 205
 206         pmeth->init = 0;
 207         pmeth->copy = 0;
 208         pmeth->cleanup = 0;
 209         pmeth->paramgen_init = 0;
 210         pmeth->paramgen = 0;
 211         pmeth->keygen_init = 0;
 212         pmeth->keygen = 0;
 213         pmeth->sign_init = 0;
 214         pmeth->sign = 0;
 215         pmeth->verify_init = 0;
 216         pmeth->verify = 0;
 217         pmeth->verify_recover_init = 0;
 218         pmeth->verify_recover = 0;
 219         pmeth->signctx_init = 0;
 220         pmeth->signctx = 0;
 221         pmeth->verifyctx_init = 0;
 222         pmeth->verifyctx = 0;
 223         pmeth->encrypt_init = 0;
 224         pmeth->encrypt = 0;
 225         pmeth->decrypt_init = 0;
 226         pmeth->decrypt = 0;
 227         pmeth->derive_init = 0;
 228         pmeth->derive = 0;
 229         pmeth->ctrl = 0;
 230         pmeth->ctrl_str = 0;
 231
 232         return pmeth;
 233         }
 234
 235 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
 236         {
 237         if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
 238                 OPENSSL_free(pmeth);
 239         }
 240
 241 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
 242         {
 243         return int_ctx_new(pkey, e, -1);
 244         }
 245
 246 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
 247         {
 248         return int_ctx_new(NULL, e, id);
 249         }
 250
 251 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
 252         {
 253         EVP_PKEY_CTX *rctx;
 254         if (!pctx->pmeth || !pctx->pmeth->copy)
 255                 return NULL;
 256 #ifndef OPENSSL_NO_ENGINE
 257         /* Make sure it's safe to copy a pkey context using an ENGINE */
 258         if (pctx->engine && !ENGINE_init(pctx->engine))
 259                 {
 260                 EVPerr(EVP_F_EVP_PKEY_CTX_DUP,ERR_R_ENGINE_LIB);
 261                 return 0;
 262                 }
 263 #endif
 264         rctx = OPENSSL_malloc(sizeof(EVP_PKEY_CTX));
 265         if (!rctx)
 266                 return NULL;
 267
 268         rctx->pmeth = pctx->pmeth;
 269 #ifndef OPENSSL_NO_ENGINE
 270         rctx->engine = pctx->engine;
 271 #endif
 272
 273         if (pctx->pkey)
 274                 CRYPTO_add(&pctx->pkey->references,1,CRYPTO_LOCK_EVP_PKEY);
 275
 276         rctx->pkey = pctx->pkey;
 277
 278         if (pctx->peerkey)
 279                 CRYPTO_add(&pctx->peerkey->references,1,CRYPTO_LOCK_EVP_PKEY);
 280
 281         rctx->peerkey = pctx->peerkey;
 282
 283         rctx->data = NULL;
 284         rctx->app_data = NULL;
 285         rctx->operation = pctx->operation;
 286
 287         if (pctx->pmeth->copy(rctx, pctx) > 0)
 288                 return rctx;
 289
 290         EVP_PKEY_CTX_free(rctx);
 291         return NULL;
 292
 293         }
 294
 295 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
 296         {
 297         if (app_pkey_methods == NULL)
 298                 {
 299                 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
 300                 if (!app_pkey_methods)
 301                         return 0;
 302                 }
 303         if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
 304                 return 0;
 305         sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
 306         return 1;
 307         }
 308
 309 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
 310         {
 311         if (ctx == NULL)
 312                 return;
 313         if (ctx->pmeth && ctx->pmeth->cleanup)
 314                 ctx->pmeth->cleanup(ctx);
 315         if (ctx->pkey)
 316                 EVP_PKEY_free(ctx->pkey);
 317         if (ctx->peerkey)
 318                 EVP_PKEY_free(ctx->peerkey);
 319 #ifndef OPENSSL_NO_ENGINE
 320         if(ctx->engine)
 321                 /* The EVP_PKEY_CTX we used belongs to an ENGINE, release the
 322                  * functional reference we held for this reason. */
 323                 ENGINE_finish(ctx->engine);
 324 #endif
 325         OPENSSL_free(ctx);
 326         }
 327
 328 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
 329                                 int cmd, int p1, void *p2)
 330         {
 331         int ret;
 332         if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl)
 333                 {
 334                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
 335                 return -2;
 336                 }
 337         if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
 338                 return -1;
 339
 340         if (ctx->operation == EVP_PKEY_OP_UNDEFINED)
 341                 {
 342                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
 343                 return -1;
 344                 }
 345
 346         if ((optype != -1) && !(ctx->operation & optype))
 347                 {
 348                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
 349                 return -1;
 350                 }
 351
 352         ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
 353
 354         if (ret == -2)
 355                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
 356
 357         return ret;
 358
 359         }
 360
 361 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
 362                                         const char *name, const char *value)
 363         {
 364         if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str)
 365                 {
 366                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR,
 367                                                 EVP_R_COMMAND_NOT_SUPPORTED);
 368                 return -2;
 369                 }
 370         if (!strcmp(name, "digest"))
 371                 {
 372                 const EVP_MD *md;
 373                 if (!value || !(md = EVP_get_digestbyname(value)))
 374                         {
 375                         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR,
 376                                                 EVP_R_INVALID_DIGEST);
 377                         return 0;
 378                         }
 379                 return EVP_PKEY_CTX_set_signature_md(ctx, md);
 380                 }
 381         return ctx->pmeth->ctrl_str(ctx, name, value);
 382         }
 383
 384 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
 385         {
 386         return ctx->operation;
 387         }
 388
 389 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
 390         {
 391         ctx->keygen_info = dat;
 392         ctx->keygen_info_count = datlen;
 393         }
 394
 395 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
 396         {
 397         ctx->data = data;
 398         }
 399
 400 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
 401         {
 402         return ctx->data;
 403         }
 404
 405 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
 406         {
 407         return ctx->pkey;
 408         }
 409
 410 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
 411         {
 412         return ctx->peerkey;
 413         }
 414
 415 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
 416         {
 417         ctx->app_data = data;
 418         }
 419
 420 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
 421         {
 422         return ctx->app_data;
 423         }
 424
 425 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
 426         int (*init)(EVP_PKEY_CTX *ctx))
 427         {
 428         pmeth->init = init;
 429         }
 430
 431 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
 432         int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src))
 433         {
 434         pmeth->copy = copy;
 435         }
 436
 437 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
 438         void (*cleanup)(EVP_PKEY_CTX *ctx))
 439         {
 440         pmeth->cleanup = cleanup;
 441         }
 442
 443 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
 444         int (*paramgen_init)(EVP_PKEY_CTX *ctx),
 445         int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
 446         {
 447         pmeth->paramgen_init = paramgen_init;
 448         pmeth->paramgen = paramgen;
 449         }
 450
 451 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
 452         int (*keygen_init)(EVP_PKEY_CTX *ctx),
 453         int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
 454         {
 455         pmeth->keygen_init = keygen_init;
 456         pmeth->keygen = keygen;
 457         }
 458
 459 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
 460         int (*sign_init)(EVP_PKEY_CTX *ctx),
 461         int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 462                                         const unsigned char *tbs, size_t tbslen))
 463         {
 464         pmeth->sign_init = sign_init;
 465         pmeth->sign = sign;
 466         }
 467
 468 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
 469         int (*verify_init)(EVP_PKEY_CTX *ctx),
 470         int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen,
 471                                         const unsigned char *tbs, size_t tbslen))
 472         {
 473         pmeth->verify_init = verify_init;
 474         pmeth->verify = verify;
 475         }
 476
 477 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
 478         int (*verify_recover_init)(EVP_PKEY_CTX *ctx),
 479         int (*verify_recover)(EVP_PKEY_CTX *ctx,
 480                                         unsigned char *sig, size_t *siglen,
 481                                         const unsigned char *tbs, size_t tbslen))
 482         {
 483         pmeth->verify_recover_init = verify_recover_init;
 484         pmeth->verify_recover = verify_recover;
 485         }
 486
 487 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
 488         int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
 489         int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 490                                         EVP_MD_CTX *mctx))
 491         {
 492         pmeth->signctx_init = signctx_init;
 493         pmeth->signctx = signctx;
 494         }
 495
 496 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
 497         int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
 498         int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig,int siglen,
 499                                         EVP_MD_CTX *mctx))
 500         {
 501         pmeth->verifyctx_init = verifyctx_init;
 502         pmeth->verifyctx = verifyctx;
 503         }
 504
 505 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
 506         int (*encrypt_init)(EVP_PKEY_CTX *ctx),
 507         int (*encryptfn)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
 508                                         const unsigned char *in, size_t inlen))
 509         {
 510         pmeth->encrypt_init = encrypt_init;
 511         pmeth->encrypt = encryptfn;
 512         }
 513
 514 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
 515         int (*decrypt_init)(EVP_PKEY_CTX *ctx),
 516         int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
 517                                         const unsigned char *in, size_t inlen))
 518         {
 519         pmeth->decrypt_init = decrypt_init;
 520         pmeth->decrypt = decrypt;
 521         }
 522
 523 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
 524         int (*derive_init)(EVP_PKEY_CTX *ctx),
 525         int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen))
 526         {
 527         pmeth->derive_init = derive_init;
 528         pmeth->derive = derive;
 529         }
 530
 531 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
 532         int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2),
 533         int (*ctrl_str)(EVP_PKEY_CTX *ctx, const char *type, const char *value))
 534         {
 535         pmeth->ctrl = ctrl;
 536         pmeth->ctrl_str = ctrl_str;
 537         }