crypto/evp/pmeth_lib.c

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