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).
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include <openssl/ec.h>
65 #include <openssl/ecdsa.h>
66 #include <openssl/evp.h>
67 #include "internal/evp_int.h"
69 /* EC pkey context structure */
72 /* Key and paramgen group */
76 /* Duplicate key if custom cofactor needed */
79 signed char cofactor_mode;
80 /* KDF (if any) to use for ECDH */
82 /* Message digest to use for key derivation */
84 /* User key material */
85 unsigned char *kdf_ukm;
87 /* KDF output length */
91 static int pkey_ec_init(EVP_PKEY_CTX *ctx)
94 dctx = OPENSSL_malloc(sizeof(EC_PKEY_CTX));
97 dctx->gen_group = NULL;
100 dctx->cofactor_mode = -1;
102 dctx->kdf_type = EVP_PKEY_ECDH_KDF_NONE;
104 dctx->kdf_outlen = 0;
105 dctx->kdf_ukm = NULL;
106 dctx->kdf_ukmlen = 0;
113 static int pkey_ec_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
115 EC_PKEY_CTX *dctx, *sctx;
116 if (!pkey_ec_init(dst))
120 if (sctx->gen_group) {
121 dctx->gen_group = EC_GROUP_dup(sctx->gen_group);
122 if (!dctx->gen_group)
128 dctx->co_key = EC_KEY_dup(sctx->co_key);
132 dctx->kdf_type = sctx->kdf_type;
133 dctx->kdf_md = sctx->kdf_md;
134 dctx->kdf_outlen = sctx->kdf_outlen;
136 dctx->kdf_ukm = BUF_memdup(sctx->kdf_ukm, sctx->kdf_ukmlen);
140 dctx->kdf_ukm = NULL;
141 dctx->kdf_ukmlen = sctx->kdf_ukmlen;
145 static void pkey_ec_cleanup(EVP_PKEY_CTX *ctx)
147 EC_PKEY_CTX *dctx = ctx->data;
149 EC_GROUP_free(dctx->gen_group);
150 EC_KEY_free(dctx->co_key);
152 OPENSSL_free(dctx->kdf_ukm);
157 static int pkey_ec_sign(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
158 const unsigned char *tbs, size_t tbslen)
162 EC_PKEY_CTX *dctx = ctx->data;
163 EC_KEY *ec = ctx->pkey->pkey.ec;
166 *siglen = ECDSA_size(ec);
168 } else if (*siglen < (size_t)ECDSA_size(ec)) {
169 ECerr(EC_F_PKEY_EC_SIGN, EC_R_BUFFER_TOO_SMALL);
174 type = EVP_MD_type(dctx->md);
178 ret = ECDSA_sign(type, tbs, tbslen, sig, &sltmp, ec);
182 *siglen = (size_t)sltmp;
186 static int pkey_ec_verify(EVP_PKEY_CTX *ctx,
187 const unsigned char *sig, size_t siglen,
188 const unsigned char *tbs, size_t tbslen)
191 EC_PKEY_CTX *dctx = ctx->data;
192 EC_KEY *ec = ctx->pkey->pkey.ec;
195 type = EVP_MD_type(dctx->md);
199 ret = ECDSA_verify(type, tbs, tbslen, sig, siglen, ec);
204 #ifndef OPENSSL_NO_EC
205 static int pkey_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
210 const EC_POINT *pubkey = NULL;
212 EC_PKEY_CTX *dctx = ctx->data;
213 if (!ctx->pkey || !ctx->peerkey) {
214 ECerr(EC_F_PKEY_EC_DERIVE, EC_R_KEYS_NOT_SET);
218 eckey = dctx->co_key ? dctx->co_key : ctx->pkey->pkey.ec;
221 const EC_GROUP *group;
222 group = EC_KEY_get0_group(eckey);
223 *keylen = (EC_GROUP_get_degree(group) + 7) / 8;
226 pubkey = EC_KEY_get0_public_key(ctx->peerkey->pkey.ec);
229 * NB: unlike PKCS#3 DH, if *outlen is less than maximum size this is not
230 * an error, the result is truncated.
235 ret = ECDH_compute_key(key, outlen, pubkey, eckey, 0);
242 static int pkey_ec_kdf_derive(EVP_PKEY_CTX *ctx,
243 unsigned char *key, size_t *keylen)
245 EC_PKEY_CTX *dctx = ctx->data;
246 unsigned char *ktmp = NULL;
249 if (dctx->kdf_type == EVP_PKEY_ECDH_KDF_NONE)
250 return pkey_ec_derive(ctx, key, keylen);
252 *keylen = dctx->kdf_outlen;
255 if (*keylen != dctx->kdf_outlen)
257 if (!pkey_ec_derive(ctx, NULL, &ktmplen))
259 ktmp = OPENSSL_malloc(ktmplen);
262 if (!pkey_ec_derive(ctx, ktmp, &ktmplen))
265 if (!ECDH_KDF_X9_62(key, *keylen, ktmp, ktmplen,
266 dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
272 OPENSSL_cleanse(ktmp, ktmplen);
279 static int pkey_ec_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
281 EC_PKEY_CTX *dctx = ctx->data;
284 case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
285 group = EC_GROUP_new_by_curve_name(p1);
287 ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_CURVE);
290 EC_GROUP_free(dctx->gen_group);
291 dctx->gen_group = group;
294 case EVP_PKEY_CTRL_EC_PARAM_ENC:
295 if (!dctx->gen_group) {
296 ECerr(EC_F_PKEY_EC_CTRL, EC_R_NO_PARAMETERS_SET);
299 EC_GROUP_set_asn1_flag(dctx->gen_group, p1);
302 #ifndef OPENSSL_NO_EC
303 case EVP_PKEY_CTRL_EC_ECDH_COFACTOR:
305 if (dctx->cofactor_mode != -1)
306 return dctx->cofactor_mode;
308 EC_KEY *ec_key = ctx->pkey->pkey.ec;
309 return EC_KEY_get_flags(ec_key) & EC_FLAG_COFACTOR_ECDH ? 1 :
312 } else if (p1 < -1 || p1 > 1)
314 dctx->cofactor_mode = p1;
316 EC_KEY *ec_key = ctx->pkey->pkey.ec;
319 /* If cofactor is 1 cofactor mode does nothing */
320 if (BN_is_one(ec_key->group->cofactor))
323 dctx->co_key = EC_KEY_dup(ec_key);
328 EC_KEY_set_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
330 EC_KEY_clear_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
332 EC_KEY_free(dctx->co_key);
338 case EVP_PKEY_CTRL_EC_KDF_TYPE:
340 return dctx->kdf_type;
341 if (p1 != EVP_PKEY_ECDH_KDF_NONE && p1 != EVP_PKEY_ECDH_KDF_X9_62)
346 case EVP_PKEY_CTRL_EC_KDF_MD:
350 case EVP_PKEY_CTRL_GET_EC_KDF_MD:
351 *(const EVP_MD **)p2 = dctx->kdf_md;
354 case EVP_PKEY_CTRL_EC_KDF_OUTLEN:
357 dctx->kdf_outlen = (size_t)p1;
360 case EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN:
361 *(int *)p2 = dctx->kdf_outlen;
364 case EVP_PKEY_CTRL_EC_KDF_UKM:
366 OPENSSL_free(dctx->kdf_ukm);
369 dctx->kdf_ukmlen = p1;
371 dctx->kdf_ukmlen = 0;
374 case EVP_PKEY_CTRL_GET_EC_KDF_UKM:
375 *(unsigned char **)p2 = dctx->kdf_ukm;
376 return dctx->kdf_ukmlen;
378 case EVP_PKEY_CTRL_MD:
379 if (EVP_MD_type((const EVP_MD *)p2) != NID_sha1 &&
380 EVP_MD_type((const EVP_MD *)p2) != NID_ecdsa_with_SHA1 &&
381 EVP_MD_type((const EVP_MD *)p2) != NID_sha224 &&
382 EVP_MD_type((const EVP_MD *)p2) != NID_sha256 &&
383 EVP_MD_type((const EVP_MD *)p2) != NID_sha384 &&
384 EVP_MD_type((const EVP_MD *)p2) != NID_sha512) {
385 ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_DIGEST_TYPE);
391 case EVP_PKEY_CTRL_GET_MD:
392 *(const EVP_MD **)p2 = dctx->md;
395 case EVP_PKEY_CTRL_PEER_KEY:
396 /* Default behaviour is OK */
397 case EVP_PKEY_CTRL_DIGESTINIT:
398 case EVP_PKEY_CTRL_PKCS7_SIGN:
399 case EVP_PKEY_CTRL_CMS_SIGN:
408 static int pkey_ec_ctrl_str(EVP_PKEY_CTX *ctx,
409 const char *type, const char *value)
411 if (!strcmp(type, "ec_paramgen_curve")) {
413 nid = EC_curve_nist2nid(value);
414 if (nid == NID_undef)
415 nid = OBJ_sn2nid(value);
416 if (nid == NID_undef)
417 nid = OBJ_ln2nid(value);
418 if (nid == NID_undef) {
419 ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_CURVE);
422 return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid);
423 } else if (!strcmp(type, "ec_param_enc")) {
425 if (!strcmp(value, "explicit"))
427 else if (!strcmp(value, "named_curve"))
428 param_enc = OPENSSL_EC_NAMED_CURVE;
431 return EVP_PKEY_CTX_set_ec_param_enc(ctx, param_enc);
432 } else if (!strcmp(type, "ecdh_kdf_md")) {
434 if (!(md = EVP_get_digestbyname(value))) {
435 ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_DIGEST);
438 return EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md);
439 } else if (!strcmp(type, "ecdh_cofactor_mode")) {
441 co_mode = atoi(value);
442 return EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, co_mode);
448 static int pkey_ec_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
451 EC_PKEY_CTX *dctx = ctx->data;
453 if (dctx->gen_group == NULL) {
454 ECerr(EC_F_PKEY_EC_PARAMGEN, EC_R_NO_PARAMETERS_SET);
460 ret = EC_KEY_set_group(ec, dctx->gen_group);
462 EVP_PKEY_assign_EC_KEY(pkey, ec);
468 static int pkey_ec_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
471 EC_PKEY_CTX *dctx = ctx->data;
472 if (ctx->pkey == NULL && dctx->gen_group == NULL) {
473 ECerr(EC_F_PKEY_EC_KEYGEN, EC_R_NO_PARAMETERS_SET);
479 EVP_PKEY_assign_EC_KEY(pkey, ec);
481 /* Note: if error return, pkey is freed by parent routine */
482 if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
485 if (!EC_KEY_set_group(ec, dctx->gen_group))
488 return EC_KEY_generate_key(pkey->pkey.ec);
491 const EVP_PKEY_METHOD ec_pkey_meth = {
519 #ifndef OPENSSL_NO_EC