2 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
60 #include "internal/cryptlib.h"
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include <openssl/ec.h>
65 #include <openssl/evp.h>
66 #include "internal/evp_int.h"
68 /* EC pkey context structure */
71 /* Key and paramgen group */
75 /* Duplicate key if custom cofactor needed */
78 signed char cofactor_mode;
79 /* KDF (if any) to use for ECDH */
81 /* Message digest to use for key derivation */
83 /* User key material */
84 unsigned char *kdf_ukm;
86 /* KDF output length */
90 static int pkey_ec_init(EVP_PKEY_CTX *ctx)
94 dctx = OPENSSL_zalloc(sizeof(*dctx));
98 dctx->cofactor_mode = -1;
99 dctx->kdf_type = EVP_PKEY_ECDH_KDF_NONE;
104 static int pkey_ec_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
106 EC_PKEY_CTX *dctx, *sctx;
107 if (!pkey_ec_init(dst))
111 if (sctx->gen_group) {
112 dctx->gen_group = EC_GROUP_dup(sctx->gen_group);
113 if (!dctx->gen_group)
119 dctx->co_key = EC_KEY_dup(sctx->co_key);
123 dctx->kdf_type = sctx->kdf_type;
124 dctx->kdf_md = sctx->kdf_md;
125 dctx->kdf_outlen = sctx->kdf_outlen;
127 dctx->kdf_ukm = OPENSSL_memdup(sctx->kdf_ukm, sctx->kdf_ukmlen);
131 dctx->kdf_ukm = NULL;
132 dctx->kdf_ukmlen = sctx->kdf_ukmlen;
136 static void pkey_ec_cleanup(EVP_PKEY_CTX *ctx)
138 EC_PKEY_CTX *dctx = ctx->data;
140 EC_GROUP_free(dctx->gen_group);
141 EC_KEY_free(dctx->co_key);
142 OPENSSL_free(dctx->kdf_ukm);
147 static int pkey_ec_sign(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
148 const unsigned char *tbs, size_t tbslen)
152 EC_PKEY_CTX *dctx = ctx->data;
153 EC_KEY *ec = ctx->pkey->pkey.ec;
156 *siglen = ECDSA_size(ec);
158 } else if (*siglen < (size_t)ECDSA_size(ec)) {
159 ECerr(EC_F_PKEY_EC_SIGN, EC_R_BUFFER_TOO_SMALL);
164 type = EVP_MD_type(dctx->md);
168 ret = ECDSA_sign(type, tbs, tbslen, sig, &sltmp, ec);
172 *siglen = (size_t)sltmp;
176 static int pkey_ec_verify(EVP_PKEY_CTX *ctx,
177 const unsigned char *sig, size_t siglen,
178 const unsigned char *tbs, size_t tbslen)
181 EC_PKEY_CTX *dctx = ctx->data;
182 EC_KEY *ec = ctx->pkey->pkey.ec;
185 type = EVP_MD_type(dctx->md);
189 ret = ECDSA_verify(type, tbs, tbslen, sig, siglen, ec);
194 #ifndef OPENSSL_NO_EC
195 static int pkey_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
200 const EC_POINT *pubkey = NULL;
202 EC_PKEY_CTX *dctx = ctx->data;
203 if (!ctx->pkey || !ctx->peerkey) {
204 ECerr(EC_F_PKEY_EC_DERIVE, EC_R_KEYS_NOT_SET);
208 eckey = dctx->co_key ? dctx->co_key : ctx->pkey->pkey.ec;
211 const EC_GROUP *group;
212 group = EC_KEY_get0_group(eckey);
213 *keylen = (EC_GROUP_get_degree(group) + 7) / 8;
216 pubkey = EC_KEY_get0_public_key(ctx->peerkey->pkey.ec);
219 * NB: unlike PKCS#3 DH, if *outlen is less than maximum size this is not
220 * an error, the result is truncated.
225 ret = ECDH_compute_key(key, outlen, pubkey, eckey, 0);
232 static int pkey_ec_kdf_derive(EVP_PKEY_CTX *ctx,
233 unsigned char *key, size_t *keylen)
235 EC_PKEY_CTX *dctx = ctx->data;
236 unsigned char *ktmp = NULL;
239 if (dctx->kdf_type == EVP_PKEY_ECDH_KDF_NONE)
240 return pkey_ec_derive(ctx, key, keylen);
242 *keylen = dctx->kdf_outlen;
245 if (*keylen != dctx->kdf_outlen)
247 if (!pkey_ec_derive(ctx, NULL, &ktmplen))
249 ktmp = OPENSSL_malloc(ktmplen);
252 if (!pkey_ec_derive(ctx, ktmp, &ktmplen))
255 if (!ECDH_KDF_X9_62(key, *keylen, ktmp, ktmplen,
256 dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
261 OPENSSL_clear_free(ktmp, ktmplen);
266 static int pkey_ec_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
268 EC_PKEY_CTX *dctx = ctx->data;
271 case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
272 group = EC_GROUP_new_by_curve_name(p1);
274 ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_CURVE);
277 EC_GROUP_free(dctx->gen_group);
278 dctx->gen_group = group;
281 case EVP_PKEY_CTRL_EC_PARAM_ENC:
282 if (!dctx->gen_group) {
283 ECerr(EC_F_PKEY_EC_CTRL, EC_R_NO_PARAMETERS_SET);
286 EC_GROUP_set_asn1_flag(dctx->gen_group, p1);
289 #ifndef OPENSSL_NO_EC
290 case EVP_PKEY_CTRL_EC_ECDH_COFACTOR:
292 if (dctx->cofactor_mode != -1)
293 return dctx->cofactor_mode;
295 EC_KEY *ec_key = ctx->pkey->pkey.ec;
296 return EC_KEY_get_flags(ec_key) & EC_FLAG_COFACTOR_ECDH ? 1 :
299 } else if (p1 < -1 || p1 > 1)
301 dctx->cofactor_mode = p1;
303 EC_KEY *ec_key = ctx->pkey->pkey.ec;
306 /* If cofactor is 1 cofactor mode does nothing */
307 if (BN_is_one(ec_key->group->cofactor))
310 dctx->co_key = EC_KEY_dup(ec_key);
315 EC_KEY_set_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
317 EC_KEY_clear_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
319 EC_KEY_free(dctx->co_key);
325 case EVP_PKEY_CTRL_EC_KDF_TYPE:
327 return dctx->kdf_type;
328 if (p1 != EVP_PKEY_ECDH_KDF_NONE && p1 != EVP_PKEY_ECDH_KDF_X9_62)
333 case EVP_PKEY_CTRL_EC_KDF_MD:
337 case EVP_PKEY_CTRL_GET_EC_KDF_MD:
338 *(const EVP_MD **)p2 = dctx->kdf_md;
341 case EVP_PKEY_CTRL_EC_KDF_OUTLEN:
344 dctx->kdf_outlen = (size_t)p1;
347 case EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN:
348 *(int *)p2 = dctx->kdf_outlen;
351 case EVP_PKEY_CTRL_EC_KDF_UKM:
352 OPENSSL_free(dctx->kdf_ukm);
355 dctx->kdf_ukmlen = p1;
357 dctx->kdf_ukmlen = 0;
360 case EVP_PKEY_CTRL_GET_EC_KDF_UKM:
361 *(unsigned char **)p2 = dctx->kdf_ukm;
362 return dctx->kdf_ukmlen;
364 case EVP_PKEY_CTRL_MD:
365 if (EVP_MD_type((const EVP_MD *)p2) != NID_sha1 &&
366 EVP_MD_type((const EVP_MD *)p2) != NID_ecdsa_with_SHA1 &&
367 EVP_MD_type((const EVP_MD *)p2) != NID_sha224 &&
368 EVP_MD_type((const EVP_MD *)p2) != NID_sha256 &&
369 EVP_MD_type((const EVP_MD *)p2) != NID_sha384 &&
370 EVP_MD_type((const EVP_MD *)p2) != NID_sha512) {
371 ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_DIGEST_TYPE);
377 case EVP_PKEY_CTRL_GET_MD:
378 *(const EVP_MD **)p2 = dctx->md;
381 case EVP_PKEY_CTRL_PEER_KEY:
382 /* Default behaviour is OK */
383 case EVP_PKEY_CTRL_DIGESTINIT:
384 case EVP_PKEY_CTRL_PKCS7_SIGN:
385 case EVP_PKEY_CTRL_CMS_SIGN:
394 static int pkey_ec_ctrl_str(EVP_PKEY_CTX *ctx,
395 const char *type, const char *value)
397 if (strcmp(type, "ec_paramgen_curve") == 0) {
399 nid = EC_curve_nist2nid(value);
400 if (nid == NID_undef)
401 nid = OBJ_sn2nid(value);
402 if (nid == NID_undef)
403 nid = OBJ_ln2nid(value);
404 if (nid == NID_undef) {
405 ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_CURVE);
408 return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid);
409 } else if (strcmp(type, "ec_param_enc") == 0) {
411 if (strcmp(value, "explicit") == 0)
413 else if (strcmp(value, "named_curve") == 0)
414 param_enc = OPENSSL_EC_NAMED_CURVE;
417 return EVP_PKEY_CTX_set_ec_param_enc(ctx, param_enc);
418 } else if (strcmp(type, "ecdh_kdf_md") == 0) {
420 if ((md = EVP_get_digestbyname(value)) == NULL) {
421 ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_DIGEST);
424 return EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md);
425 } else if (strcmp(type, "ecdh_cofactor_mode") == 0) {
427 co_mode = atoi(value);
428 return EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, co_mode);
434 static int pkey_ec_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
437 EC_PKEY_CTX *dctx = ctx->data;
439 if (dctx->gen_group == NULL) {
440 ECerr(EC_F_PKEY_EC_PARAMGEN, EC_R_NO_PARAMETERS_SET);
446 ret = EC_KEY_set_group(ec, dctx->gen_group);
448 EVP_PKEY_assign_EC_KEY(pkey, ec);
454 static int pkey_ec_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
457 EC_PKEY_CTX *dctx = ctx->data;
458 if (ctx->pkey == NULL && dctx->gen_group == NULL) {
459 ECerr(EC_F_PKEY_EC_KEYGEN, EC_R_NO_PARAMETERS_SET);
465 EVP_PKEY_assign_EC_KEY(pkey, ec);
467 /* Note: if error return, pkey is freed by parent routine */
468 if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
471 if (!EC_KEY_set_group(ec, dctx->gen_group))
474 return EC_KEY_generate_key(pkey->pkey.ec);
477 const EVP_PKEY_METHOD ec_pkey_meth = {
505 #ifndef OPENSSL_NO_EC