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