2 * Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include "internal/cryptlib.h"
12 #include <openssl/asn1t.h>
13 #include <openssl/x509.h>
14 #include <openssl/ec.h>
16 #include <openssl/evp.h>
17 #include "internal/evp_int.h"
19 #if !defined(OPENSSL_NO_SM2)
20 # include <openssl/sm2.h>
23 /* EC pkey context structure */
26 /* Key and paramgen group */
30 /* Duplicate key if custom cofactor needed */
33 signed char cofactor_mode;
34 /* KDF (if any) to use for ECDH */
36 /* Message digest to use for key derivation */
38 /* User key material */
39 unsigned char *kdf_ukm;
41 /* KDF output length */
45 static int pkey_ec_init(EVP_PKEY_CTX *ctx)
49 if ((dctx = OPENSSL_zalloc(sizeof(*dctx))) == NULL) {
50 ECerr(EC_F_PKEY_EC_INIT, ERR_R_MALLOC_FAILURE);
54 dctx->cofactor_mode = -1;
55 dctx->kdf_type = EVP_PKEY_ECDH_KDF_NONE;
60 static int pkey_ec_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
62 EC_PKEY_CTX *dctx, *sctx;
63 if (!pkey_ec_init(dst))
67 if (sctx->gen_group) {
68 dctx->gen_group = EC_GROUP_dup(sctx->gen_group);
75 dctx->co_key = EC_KEY_dup(sctx->co_key);
79 dctx->kdf_type = sctx->kdf_type;
80 dctx->kdf_md = sctx->kdf_md;
81 dctx->kdf_outlen = sctx->kdf_outlen;
83 dctx->kdf_ukm = OPENSSL_memdup(sctx->kdf_ukm, sctx->kdf_ukmlen);
88 dctx->kdf_ukmlen = sctx->kdf_ukmlen;
92 static void pkey_ec_cleanup(EVP_PKEY_CTX *ctx)
94 EC_PKEY_CTX *dctx = ctx->data;
96 EC_GROUP_free(dctx->gen_group);
97 EC_KEY_free(dctx->co_key);
98 OPENSSL_free(dctx->kdf_ukm);
103 static int pkey_ec_sign(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
104 const unsigned char *tbs, size_t tbslen)
108 EC_PKEY_CTX *dctx = ctx->data;
109 EC_KEY *ec = ctx->pkey->pkey.ec;
110 const int ec_nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
113 *siglen = ECDSA_size(ec);
115 } else if (*siglen < (size_t)ECDSA_size(ec)) {
116 ECerr(EC_F_PKEY_EC_SIGN, EC_R_BUFFER_TOO_SMALL);
121 type = EVP_MD_type(dctx->md);
125 if (ec_nid == NID_sm2) {
126 #if defined(OPENSSL_NO_SM2)
129 ret = SM2_sign(type, tbs, tbslen, sig, &sltmp, ec);
132 ret = ECDSA_sign(type, tbs, tbslen, sig, &sltmp, ec);
137 *siglen = (size_t)sltmp;
141 static int pkey_ec_verify(EVP_PKEY_CTX *ctx,
142 const unsigned char *sig, size_t siglen,
143 const unsigned char *tbs, size_t tbslen)
146 EC_PKEY_CTX *dctx = ctx->data;
147 EC_KEY *ec = ctx->pkey->pkey.ec;
148 const int ec_nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
151 type = EVP_MD_type(dctx->md);
155 if (ec_nid == NID_sm2) {
156 #if defined(OPENSSL_NO_SM2)
159 ret = SM2_verify(type, tbs, tbslen, sig, siglen, ec);
162 ret = ECDSA_verify(type, tbs, tbslen, sig, siglen, ec);
168 #ifndef OPENSSL_NO_EC
169 static int pkey_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen)
173 const EC_POINT *pubkey = NULL;
175 EC_PKEY_CTX *dctx = ctx->data;
176 if (!ctx->pkey || !ctx->peerkey) {
177 ECerr(EC_F_PKEY_EC_DERIVE, EC_R_KEYS_NOT_SET);
181 eckey = dctx->co_key ? dctx->co_key : ctx->pkey->pkey.ec;
184 const EC_GROUP *group;
185 group = EC_KEY_get0_group(eckey);
186 *keylen = (EC_GROUP_get_degree(group) + 7) / 8;
189 pubkey = EC_KEY_get0_public_key(ctx->peerkey->pkey.ec);
192 * NB: unlike PKCS#3 DH, if *outlen is less than maximum size this is not
193 * an error, the result is truncated.
198 ret = ECDH_compute_key(key, outlen, pubkey, eckey, 0);
205 static int pkey_ecies_encrypt(EVP_PKEY_CTX *ctx,
206 unsigned char *out, size_t *outlen,
207 const unsigned char *in, size_t inlen)
210 EC_KEY *ec = ctx->pkey->pkey.ec;
211 const int ec_nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
213 if (ec_nid == NID_sm2) {
214 # if defined(OPENSSL_NO_SM2)
218 EC_PKEY_CTX *dctx = ctx->data;
221 md_type = EVP_MD_type(dctx->md);
222 else if (ec_nid == NID_sm2)
225 md_type = NID_sha256;
228 *outlen = SM2_ciphertext_size(ec, EVP_get_digestbynid(md_type),
233 ret = SM2_encrypt(ec, EVP_get_digestbynid(md_type),
234 in, inlen, out, outlen);
238 /* standard ECIES not implemented */
245 static int pkey_ecies_decrypt(EVP_PKEY_CTX *ctx,
246 unsigned char *out, size_t *outlen,
247 const unsigned char *in, size_t inlen)
250 EC_KEY *ec = ctx->pkey->pkey.ec;
251 const int ec_nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
253 if (ec_nid == NID_sm2) {
254 # if defined(OPENSSL_NO_SM2)
258 EC_PKEY_CTX *dctx = ctx->data;
261 md_type = EVP_MD_type(dctx->md);
262 else if (ec_nid == NID_sm2)
265 md_type = NID_sha256;
268 *outlen = SM2_plaintext_size(ec, EVP_get_digestbynid(md_type), inlen);
272 ret = SM2_decrypt(ec, EVP_get_digestbynid(md_type),
273 in, inlen, out, outlen);
277 /* standard ECIES not implemented */
284 static int pkey_ec_kdf_derive(EVP_PKEY_CTX *ctx,
285 unsigned char *key, size_t *keylen)
287 EC_PKEY_CTX *dctx = ctx->data;
288 unsigned char *ktmp = NULL;
291 if (dctx->kdf_type == EVP_PKEY_ECDH_KDF_NONE)
292 return pkey_ec_derive(ctx, key, keylen);
294 *keylen = dctx->kdf_outlen;
297 if (*keylen != dctx->kdf_outlen)
299 if (!pkey_ec_derive(ctx, NULL, &ktmplen))
301 if ((ktmp = OPENSSL_malloc(ktmplen)) == NULL) {
302 ECerr(EC_F_PKEY_EC_KDF_DERIVE, ERR_R_MALLOC_FAILURE);
305 if (!pkey_ec_derive(ctx, ktmp, &ktmplen))
308 if (!ECDH_KDF_X9_62(key, *keylen, ktmp, ktmplen,
309 dctx->kdf_ukm, dctx->kdf_ukmlen, dctx->kdf_md))
314 OPENSSL_clear_free(ktmp, ktmplen);
319 static int pkey_ec_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
321 EC_PKEY_CTX *dctx = ctx->data;
324 case EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID:
325 group = EC_GROUP_new_by_curve_name(p1);
327 ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_CURVE);
330 EC_GROUP_free(dctx->gen_group);
331 dctx->gen_group = group;
334 case EVP_PKEY_CTRL_EC_PARAM_ENC:
335 if (!dctx->gen_group) {
336 ECerr(EC_F_PKEY_EC_CTRL, EC_R_NO_PARAMETERS_SET);
339 EC_GROUP_set_asn1_flag(dctx->gen_group, p1);
342 #ifndef OPENSSL_NO_EC
343 case EVP_PKEY_CTRL_EC_ECDH_COFACTOR:
345 if (dctx->cofactor_mode != -1)
346 return dctx->cofactor_mode;
348 EC_KEY *ec_key = ctx->pkey->pkey.ec;
349 return EC_KEY_get_flags(ec_key) & EC_FLAG_COFACTOR_ECDH ? 1 : 0;
351 } else if (p1 < -1 || p1 > 1)
353 dctx->cofactor_mode = p1;
355 EC_KEY *ec_key = ctx->pkey->pkey.ec;
358 /* If cofactor is 1 cofactor mode does nothing */
359 if (BN_is_one(ec_key->group->cofactor))
362 dctx->co_key = EC_KEY_dup(ec_key);
367 EC_KEY_set_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
369 EC_KEY_clear_flags(dctx->co_key, EC_FLAG_COFACTOR_ECDH);
371 EC_KEY_free(dctx->co_key);
377 case EVP_PKEY_CTRL_EC_KDF_TYPE:
379 return dctx->kdf_type;
380 if (p1 != EVP_PKEY_ECDH_KDF_NONE && p1 != EVP_PKEY_ECDH_KDF_X9_62)
385 case EVP_PKEY_CTRL_EC_KDF_MD:
389 case EVP_PKEY_CTRL_GET_EC_KDF_MD:
390 *(const EVP_MD **)p2 = dctx->kdf_md;
393 case EVP_PKEY_CTRL_EC_KDF_OUTLEN:
396 dctx->kdf_outlen = (size_t)p1;
399 case EVP_PKEY_CTRL_GET_EC_KDF_OUTLEN:
400 *(int *)p2 = dctx->kdf_outlen;
403 case EVP_PKEY_CTRL_EC_KDF_UKM:
404 OPENSSL_free(dctx->kdf_ukm);
407 dctx->kdf_ukmlen = p1;
409 dctx->kdf_ukmlen = 0;
412 case EVP_PKEY_CTRL_GET_EC_KDF_UKM:
413 *(unsigned char **)p2 = dctx->kdf_ukm;
414 return dctx->kdf_ukmlen;
416 case EVP_PKEY_CTRL_MD:
417 if (EVP_MD_type((const EVP_MD *)p2) != NID_sha1 &&
418 EVP_MD_type((const EVP_MD *)p2) != NID_ecdsa_with_SHA1 &&
419 EVP_MD_type((const EVP_MD *)p2) != NID_sha224 &&
420 EVP_MD_type((const EVP_MD *)p2) != NID_sha256 &&
421 EVP_MD_type((const EVP_MD *)p2) != NID_sha384 &&
422 EVP_MD_type((const EVP_MD *)p2) != NID_sha512 &&
423 EVP_MD_type((const EVP_MD *)p2) != NID_sm3) {
424 ECerr(EC_F_PKEY_EC_CTRL, EC_R_INVALID_DIGEST_TYPE);
430 case EVP_PKEY_CTRL_GET_MD:
431 *(const EVP_MD **)p2 = dctx->md;
434 case EVP_PKEY_CTRL_PEER_KEY:
435 /* Default behaviour is OK */
436 case EVP_PKEY_CTRL_DIGESTINIT:
437 case EVP_PKEY_CTRL_PKCS7_SIGN:
438 case EVP_PKEY_CTRL_CMS_SIGN:
447 static int pkey_ec_ctrl_str(EVP_PKEY_CTX *ctx,
448 const char *type, const char *value)
450 if (strcmp(type, "ec_paramgen_curve") == 0) {
452 nid = EC_curve_nist2nid(value);
453 if (nid == NID_undef)
454 nid = OBJ_sn2nid(value);
455 if (nid == NID_undef)
456 nid = OBJ_ln2nid(value);
457 if (nid == NID_undef) {
458 ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_CURVE);
461 return EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid);
462 } else if (strcmp(type, "ec_param_enc") == 0) {
464 if (strcmp(value, "explicit") == 0)
466 else if (strcmp(value, "named_curve") == 0)
467 param_enc = OPENSSL_EC_NAMED_CURVE;
470 return EVP_PKEY_CTX_set_ec_param_enc(ctx, param_enc);
471 } else if (strcmp(type, "ecdh_kdf_md") == 0) {
473 if ((md = EVP_get_digestbyname(value)) == NULL) {
474 ECerr(EC_F_PKEY_EC_CTRL_STR, EC_R_INVALID_DIGEST);
477 return EVP_PKEY_CTX_set_ecdh_kdf_md(ctx, md);
478 } else if (strcmp(type, "ecdh_cofactor_mode") == 0) {
480 co_mode = atoi(value);
481 return EVP_PKEY_CTX_set_ecdh_cofactor_mode(ctx, co_mode);
487 static int pkey_ec_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
490 EC_PKEY_CTX *dctx = ctx->data;
492 if (dctx->gen_group == NULL) {
493 ECerr(EC_F_PKEY_EC_PARAMGEN, EC_R_NO_PARAMETERS_SET);
499 ret = EC_KEY_set_group(ec, dctx->gen_group);
501 EVP_PKEY_assign_EC_KEY(pkey, ec);
507 static int pkey_ec_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
510 EC_PKEY_CTX *dctx = ctx->data;
511 if (ctx->pkey == NULL && dctx->gen_group == NULL) {
512 ECerr(EC_F_PKEY_EC_KEYGEN, EC_R_NO_PARAMETERS_SET);
518 EVP_PKEY_assign_EC_KEY(pkey, ec);
520 /* Note: if error return, pkey is freed by parent routine */
521 if (!EVP_PKEY_copy_parameters(pkey, ctx->pkey))
524 if (!EC_KEY_set_group(ec, dctx->gen_group))
527 return EC_KEY_generate_key(pkey->pkey.ec);
530 const EVP_PKEY_METHOD ec_pkey_meth = {
560 #ifndef OPENSSL_NO_EC