crypto/ec/ec_pmeth.c

   1 /*
   2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   3  * 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 "cryptlib.h"
  61 #include <openssl/asn1t.h>
  62 #include <openssl/x509.h>
  63 #include <openssl/ec.h>
  64 #include "ec_lcl.h"
  65 #include <openssl/ecdsa.h>
  66 #include <openssl/evp.h>
  67 #include "internal/evp_int.h"
  68
  69 /* EC pkey context structure */
  70
  71 typedef struct {
  72     /* Key and paramgen group */
  73     EC_GROUP *gen_group;
  74     /* message digest */
  75     const EVP_MD *md;
  76     /* Duplicate key if custom cofactor needed */
  77     EC_KEY *co_key;
  78     /* Cofactor mode */
  79     signed char cofactor_mode;
  80     /* KDF (if any) to use for ECDH */
  81     char kdf_type;
  82     /* Message digest to use for key derivation */
  83     const EVP_MD *kdf_md;
  84     /* User key material */
  85     unsigned char *kdf_ukm;
  86     size_t kdf_ukmlen;
  87     /* KDF output length */
  88     size_t kdf_outlen;
  89 } EC_PKEY_CTX;
  90
  91 static int pkey_ec_init(EVP_PKEY_CTX *ctx)
  92 {
  93     EC_PKEY_CTX *dctx;
  94     dctx = OPENSSL_malloc(sizeof(EC_PKEY_CTX));
  95     if (!dctx)
  96         return 0;
  97     dctx->gen_group = NULL;
  98     dctx->md = NULL;
  99
 100     dctx->cofactor_mode = -1;
 101     dctx->co_key = NULL;
 102     dctx->kdf_type = EVP_PKEY_ECDH_KDF_NONE;
 103     dctx->kdf_md = NULL;
 104     dctx->kdf_outlen = 0;
 105     dctx->kdf_ukm = NULL;
 106     dctx->kdf_ukmlen = 0;
 107
 108     ctx->data = dctx;
 109
 110     return 1;
 111 }
 112
 113 static int pkey_ec_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
 114 {
 115     EC_PKEY_CTX *dctx, *sctx;
 116     if (!pkey_ec_init(dst))
 117         return 0;
 118     sctx = src->data;
 119     dctx = dst->data;
 120     if (sctx->gen_group) {
 121         dctx->gen_group = EC_GROUP_dup(sctx->gen_group);
 122         if (!dctx->gen_group)
 123             return 0;
 124     }
 125     dctx->md = sctx->md;
 126
 127     if (sctx->co_key) {
 128         dctx->co_key = EC_KEY_dup(sctx->co_key);
 129         if (!dctx->co_key)
 130             return 0;
 131     }
 132     dctx->kdf_type = sctx->kdf_type;
 133     dctx->kdf_md = sctx->kdf_md;
 134     dctx->kdf_outlen = sctx->kdf_outlen;
 135     if (sctx->kdf_ukm) {
 136         dctx->kdf_ukm = BUF_memdup(sctx->kdf_ukm, sctx->kdf_ukmlen);
 137         if (!dctx->kdf_ukm)
 138             return 0;
 139     } else
 140         dctx->kdf_ukm = NULL;
 141     dctx->kdf_ukmlen = sctx->kdf_ukmlen;
 142     return 1;
 143 }
 144
 145 static void pkey_ec_cleanup(EVP_PKEY_CTX *ctx)
 146 {
 147     EC_PKEY_CTX *dctx = ctx->data;
 148     if (dctx) {
 149         EC_GROUP_free(dctx->gen_group);
 150         EC_KEY_free(dctx->co_key);
 151         OPENSSL_free(dctx->kdf_ukm);
 152         OPENSSL_free(dctx);
 153     }
 154 }
 155
 156 static int pkey_ec_sign(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 157                         const unsigned char *tbs, size_t tbslen)
 158 {
 159     int ret, type;
 160     unsigned int sltmp;
 161     EC_PKEY_CTX *dctx = ctx->data;
 162     EC_KEY *ec = ctx->pkey->pkey.ec;
 163
 164     if (!sig) {
 165         *siglen = ECDSA_size(ec);
 166         return 1;
 167     } else if (*siglen < (size_t)ECDSA_size(ec)) {
 168         ECerr(EC_F_PKEY_EC_SIGN, EC_R_BUFFER_TOO_SMALL);
 169         return 0;
 170     }
 171
 172     if (dctx->md)
 173         type = EVP_MD_type(dctx->md);
 174     else
 175         type = NID_sha1;
 176
 177     ret = ECDSA_sign(type, tbs, tbslen, sig, &sltmp, ec);
 178
 179     if (ret <= 0)
 180         return ret;
 181     *siglen = (size_t)sltmp;
 182     return 1;
 183 }
 184
 185 static int pkey_ec_verify(EVP_PKEY_CTX *ctx,
 186                           const unsigned char *sig, size_t siglen,
 187                           const unsigned char *tbs, size_t tbslen)
 188 {
 189     int ret, type;
 190     EC_PKEY_CTX *dctx = ctx->data;
 191     EC_KEY *ec = ctx->pkey->pkey.ec;
 192
 193     if (dctx->md)
 194         type = EVP_MD_type(dctx->md);
 195     else
 196         type = NID_sha1;
 197
 198     ret = ECDSA_verify(type, tbs, tbslen, sig, siglen, ec);
 199
 200     return ret;
 201 }
 202
 203 #ifndef OPENSSL_NO_EC
 204 static int pkey_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
 205                           size_t *keylen)
 206 {
 207     int ret;
 208     size_t outlen;
 209     const EC_POINT *pubkey = NULL;
 210     EC_KEY *eckey;
 211     EC_PKEY_CTX *dctx = ctx->data;
 212     if (!ctx->pkey || !ctx->peerkey) {
 213         ECerr(EC_F_PKEY_EC_DERIVE, EC_R_KEYS_NOT_SET);
 214         return 0;
 215     }
 216
 217     eckey = dctx->co_key ? dctx->co_key : ctx->pkey->pkey.ec;
 218
 219     if (!key) {
 220         const EC_GROUP *group;
 221         group = EC_KEY_get0_group(eckey);
 222         *keylen = (EC_GROUP_get_degree(group) + 7) / 8;
 223         return 1;
 224     }
 225     pubkey = EC_KEY_get0_public_key(ctx->peerkey->pkey.ec);
 226
 227     /*
 228      * NB: unlike PKCS#3 DH, if *outlen is less than maximum size this is not
 229      * an error, the result is truncated.
 230      */
 231
 232     outlen = *keylen;
 233
 234     ret = ECDH_compute_key(key, outlen, pubkey, eckey, 0);
 235     if (ret <= 0)
 236         return 0;
 237     *keylen = ret;
 238     return 1;
 239 }
 240
 241 static int pkey_ec_kdf_derive(EVP_PKEY_CTX *ctx,
 242                               unsigned char *key, size_t *keylen)
 243 {
 244     EC_PKEY_CTX *dctx = ctx->data;
 245     unsigned char *ktmp = NULL;
 246     size_t ktmplen;
 247     int rv = 0;
 248     if (dctx->kdf_type == EVP_PKEY_ECDH_KDF_NONE)
 249         return pkey_ec_derive(ctx, key, keylen);
 250     if (!key) {
 251         *keylen = dctx->kdf_outlen;
 252         return 1;
 253     }
 254     if (*keylen != dctx->kdf_outlen)
 255         return 0;
 256     if (!pkey_ec_derive(ctx, NULL, &ktmplen))
 257         return 0;
 258     ktmp = OPENSSL_malloc(ktmplen);
 259     if (!ktmp)
 260         return 0;
 261     if (!pkey_ec_derive(ctx, ktmp, &ktmplen))
 262         goto err;
 263     /* Do KDF stuff */
 264     if (!ECDH_KDF_X9_62(key, *keylen, ktmp, ktmplen,
 265                         dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
 266         goto err;
 267     rv = 1;
 268
 269  err:
 270     OPENSSL_clear_free(ktmp, ktmplen);
 271     return rv;
 272 }
 273 #endif
 274
 275 static int pkey_ec_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
 276 {
 277     EC_PKEY_CTX *dctx = ctx->data;
 278     EC_GROUP *group;
 279     switch (type) {
 280     case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
 281         group = EC_GROUP_new_by_curve_name(p1);
 282         if (group == NULL) {
 283             ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_CURVE);
 284             return 0;
 285         }
 286         EC_GROUP_free(dctx->gen_group);
 287         dctx->gen_group = group;
 288         return 1;
 289
 290     case EVP_PKEY_CTRL_EC_PARAM_ENC:
 291         if (!dctx->gen_group) {
 292             ECerr(EC_F_PKEY_EC_CTRL, EC_R_NO_PARAMETERS_SET);
 293             return 0;
 294         }
 295         EC_GROUP_set_asn1_flag(dctx->gen_group, p1);
 296         return 1;
 297
 298 #ifndef OPENSSL_NO_EC
 299     case EVP_PKEY_CTRL_EC_ECDH_COFACTOR:
 300         if (p1 == -2) {
 301             if (dctx->cofactor_mode != -1)
 302                 return dctx->cofactor_mode;
 303             else {
 304                 EC_KEY *ec_key = ctx->pkey->pkey.ec;
 305                 return EC_KEY_get_flags(ec_key) & EC_FLAG_COFACTOR_ECDH ? 1 :
 306                     0;
 307             }
 308         } else if (p1 < -1 || p1 > 1)
 309             return -2;
 310         dctx->cofactor_mode = p1;
 311         if (p1 != -1) {
 312             EC_KEY *ec_key = ctx->pkey->pkey.ec;
 313             if (!ec_key->group)
 314                 return -2;
 315             /* If cofactor is 1 cofactor mode does nothing */
 316             if (BN_is_one(ec_key->group->cofactor))
 317                 return 1;
 318             if (!dctx->co_key) {
 319                 dctx->co_key = EC_KEY_dup(ec_key);
 320                 if (!dctx->co_key)
 321                     return 0;
 322             }
 323             if (p1)
 324                 EC_KEY_set_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
 325             else
 326                 EC_KEY_clear_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
 327         } else {
 328             EC_KEY_free(dctx->co_key);
 329             dctx->co_key = NULL;
 330         }
 331         return 1;
 332 #endif
 333
 334     case EVP_PKEY_CTRL_EC_KDF_TYPE:
 335         if (p1 == -2)
 336             return dctx->kdf_type;
 337         if (p1 != EVP_PKEY_ECDH_KDF_NONE && p1 != EVP_PKEY_ECDH_KDF_X9_62)
 338             return -2;
 339         dctx->kdf_type = p1;
 340         return 1;
 341
 342     case EVP_PKEY_CTRL_EC_KDF_MD:
 343         dctx->kdf_md = p2;
 344         return 1;
 345
 346     case EVP_PKEY_CTRL_GET_EC_KDF_MD:
 347         *(const EVP_MD **)p2 = dctx->kdf_md;
 348         return 1;
 349
 350     case EVP_PKEY_CTRL_EC_KDF_OUTLEN:
 351         if (p1 <= 0)
 352             return -2;
 353         dctx->kdf_outlen = (size_t)p1;
 354         return 1;
 355
 356     case EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN:
 357         *(int *)p2 = dctx->kdf_outlen;
 358         return 1;
 359
 360     case EVP_PKEY_CTRL_EC_KDF_UKM:
 361         OPENSSL_free(dctx->kdf_ukm);
 362         dctx->kdf_ukm = p2;
 363         if (p2)
 364             dctx->kdf_ukmlen = p1;
 365         else
 366             dctx->kdf_ukmlen = 0;
 367         return 1;
 368
 369     case EVP_PKEY_CTRL_GET_EC_KDF_UKM:
 370         *(unsigned char **)p2 = dctx->kdf_ukm;
 371         return dctx->kdf_ukmlen;
 372
 373     case EVP_PKEY_CTRL_MD:
 374         if (EVP_MD_type((const EVP_MD *)p2) != NID_sha1 &&
 375             EVP_MD_type((const EVP_MD *)p2) != NID_ecdsa_with_SHA1 &&
 376             EVP_MD_type((const EVP_MD *)p2) != NID_sha224 &&
 377             EVP_MD_type((const EVP_MD *)p2) != NID_sha256 &&
 378             EVP_MD_type((const EVP_MD *)p2) != NID_sha384 &&
 379             EVP_MD_type((const EVP_MD *)p2) != NID_sha512) {
 380             ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_DIGEST_TYPE);
 381             return 0;
 382         }
 383         dctx->md = p2;
 384         return 1;
 385
 386     case EVP_PKEY_CTRL_GET_MD:
 387         *(const EVP_MD **)p2 = dctx->md;
 388         return 1;
 389
 390     case EVP_PKEY_CTRL_PEER_KEY:
 391         /* Default behaviour is OK */
 392     case EVP_PKEY_CTRL_DIGESTINIT:
 393     case EVP_PKEY_CTRL_PKCS7_SIGN:
 394     case EVP_PKEY_CTRL_CMS_SIGN:
 395         return 1;
 396
 397     default:
 398         return -2;
 399
 400     }
 401 }
 402
 403 static int pkey_ec_ctrl_str(EVP_PKEY_CTX *ctx,
 404                             const char *type, const char *value)
 405 {
 406     if (!strcmp(type, "ec_paramgen_curve")) {
 407         int nid;
 408         nid = EC_curve_nist2nid(value);
 409         if (nid == NID_undef)
 410             nid = OBJ_sn2nid(value);
 411         if (nid == NID_undef)
 412             nid = OBJ_ln2nid(value);
 413         if (nid == NID_undef) {
 414             ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_CURVE);
 415             return 0;
 416         }
 417         return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid);
 418     } else if (!strcmp(type, "ec_param_enc")) {
 419         int param_enc;
 420         if (!strcmp(value, "explicit"))
 421             param_enc = 0;
 422         else if (!strcmp(value, "named_curve"))
 423             param_enc = OPENSSL_EC_NAMED_CURVE;
 424         else
 425             return -2;
 426         return EVP_PKEY_CTX_set_ec_param_enc(ctx, param_enc);
 427     } else if (!strcmp(type, "ecdh_kdf_md")) {
 428         const EVP_MD *md;
 429         if (!(md = EVP_get_digestbyname(value))) {
 430             ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_DIGEST);
 431             return 0;
 432         }
 433         return EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md);
 434     } else if (!strcmp(type, "ecdh_cofactor_mode")) {
 435         int co_mode;
 436         co_mode = atoi(value);
 437         return EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, co_mode);
 438     }
 439
 440     return -2;
 441 }
 442
 443 static int pkey_ec_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
 444 {
 445     EC_KEY *ec = NULL;
 446     EC_PKEY_CTX *dctx = ctx->data;
 447     int ret = 0;
 448     if (dctx->gen_group == NULL) {
 449         ECerr(EC_F_PKEY_EC_PARAMGEN, EC_R_NO_PARAMETERS_SET);
 450         return 0;
 451     }
 452     ec = EC_KEY_new();
 453     if (!ec)
 454         return 0;
 455     ret = EC_KEY_set_group(ec, dctx->gen_group);
 456     if (ret)
 457         EVP_PKEY_assign_EC_KEY(pkey, ec);
 458     else
 459         EC_KEY_free(ec);
 460     return ret;
 461 }
 462
 463 static int pkey_ec_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
 464 {
 465     EC_KEY *ec = NULL;
 466     EC_PKEY_CTX *dctx = ctx->data;
 467     if (ctx->pkey == NULL && dctx->gen_group == NULL) {
 468         ECerr(EC_F_PKEY_EC_KEYGEN, EC_R_NO_PARAMETERS_SET);
 469         return 0;
 470     }
 471     ec = EC_KEY_new();
 472     if (!ec)
 473         return 0;
 474     EVP_PKEY_assign_EC_KEY(pkey, ec);
 475     if (ctx->pkey) {
 476         /* Note: if error return, pkey is freed by parent routine */
 477         if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
 478             return 0;
 479     } else {
 480         if (!EC_KEY_set_group(ec, dctx->gen_group))
 481             return 0;
 482     }
 483     return EC_KEY_generate_key(pkey->pkey.ec);
 484 }
 485
 486 const EVP_PKEY_METHOD ec_pkey_meth = {
 487     EVP_PKEY_EC,
 488     0,
 489     pkey_ec_init,
 490     pkey_ec_copy,
 491     pkey_ec_cleanup,
 492
 493     0,
 494     pkey_ec_paramgen,
 495
 496     0,
 497     pkey_ec_keygen,
 498
 499     0,
 500     pkey_ec_sign,
 501
 502     0,
 503     pkey_ec_verify,
 504
 505     0, 0,
 506
 507     0, 0, 0, 0,
 508
 509     0, 0,
 510
 511     0, 0,
 512
 513     0,
 514 #ifndef OPENSSL_NO_EC
 515     pkey_ec_kdf_derive,
 516 #else
 517     0,
 518 #endif
 519     pkey_ec_ctrl,
 520     pkey_ec_ctrl_str
 521 };