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, cmac_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         &cmac_pkey_meth
  94         };
  95
  96 DECLARE_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
  97                            pmeth);
  98
  99 static int pmeth_cmp(const EVP_PKEY_METHOD * const *a,
 100                      const EVP_PKEY_METHOD * const *b)
 101         {
 102         return ((*a)->pkey_id - (*b)->pkey_id);
 103         }
 104
 105 IMPLEMENT_OBJ_BSEARCH_CMP_FN(const EVP_PKEY_METHOD *, const EVP_PKEY_METHOD *,
 106                              pmeth);
 107
 108 const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type)
 109         {
 110         EVP_PKEY_METHOD tmp;
 111         const EVP_PKEY_METHOD *t = &tmp, **ret;
 112         tmp.pkey_id = type;
 113         if (app_pkey_methods)
 114                 {
 115                 int idx;
 116                 idx = sk_EVP_PKEY_METHOD_find(app_pkey_methods, &tmp);
 117                 if (idx >= 0)
 118                         return sk_EVP_PKEY_METHOD_value(app_pkey_methods, idx);
 119                 }
 120         ret = OBJ_bsearch_pmeth(&t, standard_methods,
 121                           sizeof(standard_methods)/sizeof(EVP_PKEY_METHOD *));
 122         if (!ret || !*ret)
 123                 return NULL;
 124         return *ret;
 125         }
 126
 127 static EVP_PKEY_CTX *int_ctx_new(EVP_PKEY *pkey, ENGINE *e, int id)
 128         {
 129         EVP_PKEY_CTX *ret;
 130         const EVP_PKEY_METHOD *pmeth;
 131         if (id == -1)
 132                 {
 133                 if (!pkey || !pkey->ameth)
 134                         return NULL;
 135                 id = pkey->ameth->pkey_id;
 136                 }
 137 #ifndef OPENSSL_NO_ENGINE
 138         if (pkey && pkey->engine)
 139                 e = pkey->engine;
 140         /* Try to find an ENGINE which implements this method */
 141         if (e)
 142                 {
 143                 if (!ENGINE_init(e))
 144                         {
 145                         EVPerr(EVP_F_INT_CTX_NEW,ERR_R_ENGINE_LIB);
 146                         return NULL;
 147                         }
 148                 }
 149         else
 150                 e = ENGINE_get_pkey_meth_engine(id);
 151
 152         /* If an ENGINE handled this method look it up. Othewise
 153          * use internal tables.
 154          */
 155
 156         if (e)
 157                 pmeth = ENGINE_get_pkey_meth(e, id);
 158         else
 159 #endif
 160                 pmeth = EVP_PKEY_meth_find(id);
 161
 162         if (pmeth == NULL)
 163                 {
 164                 EVPerr(EVP_F_INT_CTX_NEW,EVP_R_UNSUPPORTED_ALGORITHM);
 165                 return NULL;
 166                 }
 167
 168         ret = OPENSSL_malloc(sizeof(EVP_PKEY_CTX));
 169         if (!ret)
 170                 {
 171 #ifndef OPENSSL_NO_ENGINE
 172                 if (e)
 173                         ENGINE_finish(e);
 174 #endif
 175                 EVPerr(EVP_F_INT_CTX_NEW,ERR_R_MALLOC_FAILURE);
 176                 return NULL;
 177                 }
 178         ret->engine = e;
 179         ret->pmeth = pmeth;
 180         ret->operation = EVP_PKEY_OP_UNDEFINED;
 181         ret->pkey = pkey;
 182         ret->peerkey = NULL;
 183         ret->pkey_gencb = 0;
 184         if (pkey)
 185                 CRYPTO_add(&pkey->references,1,CRYPTO_LOCK_EVP_PKEY);
 186         ret->data = NULL;
 187
 188         if (pmeth->init)
 189                 {
 190                 if (pmeth->init(ret) <= 0)
 191                         {
 192                         EVP_PKEY_CTX_free(ret);
 193                         return NULL;
 194                         }
 195                 }
 196
 197         return ret;
 198         }
 199
 200 EVP_PKEY_METHOD* EVP_PKEY_meth_new(int id, int flags)
 201         {
 202         EVP_PKEY_METHOD *pmeth;
 203         pmeth = OPENSSL_malloc(sizeof(EVP_PKEY_METHOD));
 204         if (!pmeth)
 205                 return NULL;
 206
 207         pmeth->pkey_id = id;
 208         pmeth->flags = flags | EVP_PKEY_FLAG_DYNAMIC;
 209
 210         pmeth->init = 0;
 211         pmeth->copy = 0;
 212         pmeth->cleanup = 0;
 213         pmeth->paramgen_init = 0;
 214         pmeth->paramgen = 0;
 215         pmeth->keygen_init = 0;
 216         pmeth->keygen = 0;
 217         pmeth->sign_init = 0;
 218         pmeth->sign = 0;
 219         pmeth->verify_init = 0;
 220         pmeth->verify = 0;
 221         pmeth->verify_recover_init = 0;
 222         pmeth->verify_recover = 0;
 223         pmeth->signctx_init = 0;
 224         pmeth->signctx = 0;
 225         pmeth->verifyctx_init = 0;
 226         pmeth->verifyctx = 0;
 227         pmeth->encrypt_init = 0;
 228         pmeth->encrypt = 0;
 229         pmeth->decrypt_init = 0;
 230         pmeth->decrypt = 0;
 231         pmeth->derive_init = 0;
 232         pmeth->derive = 0;
 233         pmeth->ctrl = 0;
 234         pmeth->ctrl_str = 0;
 235
 236         return pmeth;
 237         }
 238
 239 void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth)
 240         {
 241         if (pmeth && (pmeth->flags & EVP_PKEY_FLAG_DYNAMIC))
 242                 OPENSSL_free(pmeth);
 243         }
 244
 245 EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e)
 246         {
 247         return int_ctx_new(pkey, e, -1);
 248         }
 249
 250 EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e)
 251         {
 252         return int_ctx_new(NULL, e, id);
 253         }
 254
 255 EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *pctx)
 256         {
 257         EVP_PKEY_CTX *rctx;
 258         if (!pctx->pmeth || !pctx->pmeth->copy)
 259                 return NULL;
 260 #ifndef OPENSSL_NO_ENGINE
 261         /* Make sure it's safe to copy a pkey context using an ENGINE */
 262         if (pctx->engine && !ENGINE_init(pctx->engine))
 263                 {
 264                 EVPerr(EVP_F_EVP_PKEY_CTX_DUP,ERR_R_ENGINE_LIB);
 265                 return 0;
 266                 }
 267 #endif
 268         rctx = OPENSSL_malloc(sizeof(EVP_PKEY_CTX));
 269         if (!rctx)
 270                 return NULL;
 271
 272         rctx->pmeth = pctx->pmeth;
 273 #ifndef OPENSSL_NO_ENGINE
 274         rctx->engine = pctx->engine;
 275 #endif
 276
 277         if (pctx->pkey)
 278                 CRYPTO_add(&pctx->pkey->references,1,CRYPTO_LOCK_EVP_PKEY);
 279
 280         rctx->pkey = pctx->pkey;
 281
 282         if (pctx->peerkey)
 283                 CRYPTO_add(&pctx->peerkey->references,1,CRYPTO_LOCK_EVP_PKEY);
 284
 285         rctx->peerkey = pctx->peerkey;
 286
 287         rctx->data = NULL;
 288         rctx->app_data = NULL;
 289         rctx->operation = pctx->operation;
 290
 291         if (pctx->pmeth->copy(rctx, pctx) > 0)
 292                 return rctx;
 293
 294         EVP_PKEY_CTX_free(rctx);
 295         return NULL;
 296
 297         }
 298
 299 int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth)
 300         {
 301         if (app_pkey_methods == NULL)
 302                 {
 303                 app_pkey_methods = sk_EVP_PKEY_METHOD_new(pmeth_cmp);
 304                 if (!app_pkey_methods)
 305                         return 0;
 306                 }
 307         if (!sk_EVP_PKEY_METHOD_push(app_pkey_methods, pmeth))
 308                 return 0;
 309         sk_EVP_PKEY_METHOD_sort(app_pkey_methods);
 310         return 1;
 311         }
 312
 313 void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx)
 314         {
 315         if (ctx == NULL)
 316                 return;
 317         if (ctx->pmeth && ctx->pmeth->cleanup)
 318                 ctx->pmeth->cleanup(ctx);
 319         if (ctx->pkey)
 320                 EVP_PKEY_free(ctx->pkey);
 321         if (ctx->peerkey)
 322                 EVP_PKEY_free(ctx->peerkey);
 323 #ifndef OPENSSL_NO_ENGINE
 324         if(ctx->engine)
 325                 /* The EVP_PKEY_CTX we used belongs to an ENGINE, release the
 326                  * functional reference we held for this reason. */
 327                 ENGINE_finish(ctx->engine);
 328 #endif
 329         OPENSSL_free(ctx);
 330         }
 331
 332 int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
 333                                 int cmd, int p1, void *p2)
 334         {
 335         int ret;
 336         if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl)
 337                 {
 338                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
 339                 return -2;
 340                 }
 341         if ((keytype != -1) && (ctx->pmeth->pkey_id != keytype))
 342                 return -1;
 343
 344         if (ctx->operation == EVP_PKEY_OP_UNDEFINED)
 345                 {
 346                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_NO_OPERATION_SET);
 347                 return -1;
 348                 }
 349
 350         if ((optype != -1) && !(ctx->operation & optype))
 351                 {
 352                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_INVALID_OPERATION);
 353                 return -1;
 354                 }
 355
 356         ret = ctx->pmeth->ctrl(ctx, cmd, p1, p2);
 357
 358         if (ret == -2)
 359                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL, EVP_R_COMMAND_NOT_SUPPORTED);
 360
 361         return ret;
 362
 363         }
 364
 365 int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx,
 366                                         const char *name, const char *value)
 367         {
 368         if (!ctx || !ctx->pmeth || !ctx->pmeth->ctrl_str)
 369                 {
 370                 EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR,
 371                                                 EVP_R_COMMAND_NOT_SUPPORTED);
 372                 return -2;
 373                 }
 374         if (!strcmp(name, "digest"))
 375                 {
 376                 const EVP_MD *md;
 377                 if (!value || !(md = EVP_get_digestbyname(value)))
 378                         {
 379                         EVPerr(EVP_F_EVP_PKEY_CTX_CTRL_STR,
 380                                                 EVP_R_INVALID_DIGEST);
 381                         return 0;
 382                         }
 383                 return EVP_PKEY_CTX_set_signature_md(ctx, md);
 384                 }
 385         return ctx->pmeth->ctrl_str(ctx, name, value);
 386         }
 387
 388 int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx)
 389         {
 390         return ctx->operation;
 391         }
 392
 393 void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen)
 394         {
 395         ctx->keygen_info = dat;
 396         ctx->keygen_info_count = datlen;
 397         }
 398
 399 void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data)
 400         {
 401         ctx->data = data;
 402         }
 403
 404 void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx)
 405         {
 406         return ctx->data;
 407         }
 408
 409 EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx)
 410         {
 411         return ctx->pkey;
 412         }
 413
 414 EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx)
 415         {
 416         return ctx->peerkey;
 417         }
 418
 419 void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data)
 420         {
 421         ctx->app_data = data;
 422         }
 423
 424 void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx)
 425         {
 426         return ctx->app_data;
 427         }
 428
 429 void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth,
 430         int (*init)(EVP_PKEY_CTX *ctx))
 431         {
 432         pmeth->init = init;
 433         }
 434
 435 void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth,
 436         int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src))
 437         {
 438         pmeth->copy = copy;
 439         }
 440
 441 void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth,
 442         void (*cleanup)(EVP_PKEY_CTX *ctx))
 443         {
 444         pmeth->cleanup = cleanup;
 445         }
 446
 447 void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth,
 448         int (*paramgen_init)(EVP_PKEY_CTX *ctx),
 449         int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
 450         {
 451         pmeth->paramgen_init = paramgen_init;
 452         pmeth->paramgen = paramgen;
 453         }
 454
 455 void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth,
 456         int (*keygen_init)(EVP_PKEY_CTX *ctx),
 457         int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey))
 458         {
 459         pmeth->keygen_init = keygen_init;
 460         pmeth->keygen = keygen;
 461         }
 462
 463 void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth,
 464         int (*sign_init)(EVP_PKEY_CTX *ctx),
 465         int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 466                                         const unsigned char *tbs, size_t tbslen))
 467         {
 468         pmeth->sign_init = sign_init;
 469         pmeth->sign = sign;
 470         }
 471
 472 void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth,
 473         int (*verify_init)(EVP_PKEY_CTX *ctx),
 474         int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen,
 475                                         const unsigned char *tbs, size_t tbslen))
 476         {
 477         pmeth->verify_init = verify_init;
 478         pmeth->verify = verify;
 479         }
 480
 481 void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth,
 482         int (*verify_recover_init)(EVP_PKEY_CTX *ctx),
 483         int (*verify_recover)(EVP_PKEY_CTX *ctx,
 484                                         unsigned char *sig, size_t *siglen,
 485                                         const unsigned char *tbs, size_t tbslen))
 486         {
 487         pmeth->verify_recover_init = verify_recover_init;
 488         pmeth->verify_recover = verify_recover;
 489         }
 490
 491 void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth,
 492         int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
 493         int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 494                                         EVP_MD_CTX *mctx))
 495         {
 496         pmeth->signctx_init = signctx_init;
 497         pmeth->signctx = signctx;
 498         }
 499
 500 void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth,
 501         int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx),
 502         int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig,int siglen,
 503                                         EVP_MD_CTX *mctx))
 504         {
 505         pmeth->verifyctx_init = verifyctx_init;
 506         pmeth->verifyctx = verifyctx;
 507         }
 508
 509 void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth,
 510         int (*encrypt_init)(EVP_PKEY_CTX *ctx),
 511         int (*encryptfn)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
 512                                         const unsigned char *in, size_t inlen))
 513         {
 514         pmeth->encrypt_init = encrypt_init;
 515         pmeth->encrypt = encryptfn;
 516         }
 517
 518 void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth,
 519         int (*decrypt_init)(EVP_PKEY_CTX *ctx),
 520         int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
 521                                         const unsigned char *in, size_t inlen))
 522         {
 523         pmeth->decrypt_init = decrypt_init;
 524         pmeth->decrypt = decrypt;
 525         }
 526
 527 void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth,
 528         int (*derive_init)(EVP_PKEY_CTX *ctx),
 529         int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen))
 530         {
 531         pmeth->derive_init = derive_init;
 532         pmeth->derive = derive;
 533         }
 534
 535 void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth,
 536         int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2),
 537         int (*ctrl_str)(EVP_PKEY_CTX *ctx, const char *type, const char *value))
 538         {
 539         pmeth->ctrl = ctrl;
 540         pmeth->ctrl_str = ctrl_str;
 541         }