6f8638a89812898131a002b5a6fef3dd83f6189b
[openssl.git] / providers / implementations / keymgmt / ec_kmgmt.c
1 /*
2  * Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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
8  */
9
10 /*
11  * ECDH/ECDSA low level APIs are deprecated for public use, but still ok for
12  * internal use.
13  */
14 #include "internal/deprecated.h"
15
16 #include <string.h>
17 #include <openssl/core_dispatch.h>
18 #include <openssl/core_names.h>
19 #include <openssl/bn.h>
20 #include <openssl/err.h>
21 #include <openssl/objects.h>
22 #include <openssl/proverr.h>
23 #include "crypto/bn.h"
24 #include "crypto/ec.h"
25 #include "prov/implementations.h"
26 #include "prov/providercommon.h"
27 #include "prov/provider_ctx.h"
28 #include "internal/param_build_set.h"
29
30 #ifndef FIPS_MODULE
31 # ifndef OPENSSL_NO_SM2
32 #  include "crypto/sm2.h"
33 # endif
34 #endif
35
36 static OSSL_FUNC_keymgmt_new_fn ec_newdata;
37 static OSSL_FUNC_keymgmt_gen_init_fn ec_gen_init;
38 static OSSL_FUNC_keymgmt_gen_set_template_fn ec_gen_set_template;
39 static OSSL_FUNC_keymgmt_gen_set_params_fn ec_gen_set_params;
40 static OSSL_FUNC_keymgmt_gen_settable_params_fn ec_gen_settable_params;
41 static OSSL_FUNC_keymgmt_gen_fn ec_gen;
42 static OSSL_FUNC_keymgmt_gen_cleanup_fn ec_gen_cleanup;
43 static OSSL_FUNC_keymgmt_load_fn ec_load;
44 static OSSL_FUNC_keymgmt_free_fn ec_freedata;
45 static OSSL_FUNC_keymgmt_get_params_fn ec_get_params;
46 static OSSL_FUNC_keymgmt_gettable_params_fn ec_gettable_params;
47 static OSSL_FUNC_keymgmt_set_params_fn ec_set_params;
48 static OSSL_FUNC_keymgmt_settable_params_fn ec_settable_params;
49 static OSSL_FUNC_keymgmt_has_fn ec_has;
50 static OSSL_FUNC_keymgmt_match_fn ec_match;
51 static OSSL_FUNC_keymgmt_validate_fn ec_validate;
52 static OSSL_FUNC_keymgmt_import_fn ec_import;
53 static OSSL_FUNC_keymgmt_import_types_fn ec_import_types;
54 static OSSL_FUNC_keymgmt_export_fn ec_export;
55 static OSSL_FUNC_keymgmt_export_types_fn ec_export_types;
56 static OSSL_FUNC_keymgmt_query_operation_name_fn ec_query_operation_name;
57 static OSSL_FUNC_keymgmt_dup_fn ec_dup;
58 #ifndef FIPS_MODULE
59 # ifndef OPENSSL_NO_SM2
60 static OSSL_FUNC_keymgmt_new_fn sm2_newdata;
61 static OSSL_FUNC_keymgmt_gen_init_fn sm2_gen_init;
62 static OSSL_FUNC_keymgmt_gen_fn sm2_gen;
63 static OSSL_FUNC_keymgmt_get_params_fn sm2_get_params;
64 static OSSL_FUNC_keymgmt_gettable_params_fn sm2_gettable_params;
65 static OSSL_FUNC_keymgmt_settable_params_fn sm2_settable_params;
66 static OSSL_FUNC_keymgmt_import_fn sm2_import;
67 static OSSL_FUNC_keymgmt_query_operation_name_fn sm2_query_operation_name;
68 static OSSL_FUNC_keymgmt_validate_fn sm2_validate;
69 # endif
70 #endif
71
72 #define EC_DEFAULT_MD "SHA256"
73 #define EC_POSSIBLE_SELECTIONS                                                 \
74     (OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_ALL_PARAMETERS)
75 #define SM2_DEFAULT_MD "SM3"
76
77 static
78 const char *ec_query_operation_name(int operation_id)
79 {
80     switch (operation_id) {
81     case OSSL_OP_KEYEXCH:
82         return "ECDH";
83     case OSSL_OP_SIGNATURE:
84         return "ECDSA";
85     }
86     return NULL;
87 }
88
89 #ifndef FIPS_MODULE
90 # ifndef OPENSSL_NO_SM2
91 static
92 const char *sm2_query_operation_name(int operation_id)
93 {
94     switch (operation_id) {
95     case OSSL_OP_SIGNATURE:
96         return "SM2";
97     }
98     return NULL;
99 }
100 # endif
101 #endif
102
103 /*
104  * Callers of key_to_params MUST make sure that domparams_to_params is also
105  * called!
106  *
107  * This function only exports the bare keypair, domain parameters and other
108  * parameters are exported separately.
109  */
110 static ossl_inline
111 int key_to_params(const EC_KEY *eckey, OSSL_PARAM_BLD *tmpl,
112                   OSSL_PARAM params[], int include_private,
113                   unsigned char **pub_key)
114 {
115     BIGNUM *x = NULL, *y = NULL;
116     const BIGNUM *priv_key = NULL;
117     const EC_POINT *pub_point = NULL;
118     const EC_GROUP *ecg = NULL;
119     size_t pub_key_len = 0;
120     int ret = 0;
121     BN_CTX *bnctx = NULL;
122
123     if (eckey == NULL
124         || (ecg = EC_KEY_get0_group(eckey)) == NULL)
125         return 0;
126
127     priv_key = EC_KEY_get0_private_key(eckey);
128     pub_point = EC_KEY_get0_public_key(eckey);
129
130     if (pub_point != NULL) {
131         OSSL_PARAM *p = NULL, *px = NULL, *py = NULL;
132         /*
133          * EC_POINT_point2buf() can generate random numbers in some
134          * implementations so we need to ensure we use the correct libctx.
135          */
136         bnctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eckey));
137         if (bnctx == NULL)
138             goto err;
139
140
141         /* If we are doing a get then check first before decoding the point */
142         if (tmpl == NULL) {
143             p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_PUB_KEY);
144             px = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_EC_PUB_X);
145             py = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_EC_PUB_Y);
146         }
147
148         if (p != NULL || tmpl != NULL) {
149             /* convert pub_point to a octet string according to the SECG standard */
150             if ((pub_key_len = EC_POINT_point2buf(ecg, pub_point,
151                                                   POINT_CONVERSION_COMPRESSED,
152                                                   pub_key, bnctx)) == 0
153                 || !ossl_param_build_set_octet_string(tmpl, p,
154                                                       OSSL_PKEY_PARAM_PUB_KEY,
155                                                       *pub_key, pub_key_len))
156                 goto err;
157         }
158         if (px != NULL || py != NULL) {
159             if (px != NULL)
160                 x = BN_CTX_get(bnctx);
161             if (py != NULL)
162                 y = BN_CTX_get(bnctx);
163
164             if (!EC_POINT_get_affine_coordinates(ecg, pub_point, x, y, bnctx))
165                 goto err;
166             if (px != NULL
167                 && !ossl_param_build_set_bn(tmpl, px,
168                                             OSSL_PKEY_PARAM_EC_PUB_X, x))
169                 goto err;
170             if (py != NULL
171                 && !ossl_param_build_set_bn(tmpl, py,
172                                             OSSL_PKEY_PARAM_EC_PUB_Y, y))
173                 goto err;
174         }
175     }
176
177     if (priv_key != NULL && include_private) {
178         size_t sz;
179         int ecbits;
180
181         /*
182          * Key import/export should never leak the bit length of the secret
183          * scalar in the key.
184          *
185          * For this reason, on export we use padded BIGNUMs with fixed length.
186          *
187          * When importing we also should make sure that, even if short lived,
188          * the newly created BIGNUM is marked with the BN_FLG_CONSTTIME flag as
189          * soon as possible, so that any processing of this BIGNUM might opt for
190          * constant time implementations in the backend.
191          *
192          * Setting the BN_FLG_CONSTTIME flag alone is never enough, we also have
193          * to preallocate the BIGNUM internal buffer to a fixed public size big
194          * enough that operations performed during the processing never trigger
195          * a realloc which would leak the size of the scalar through memory
196          * accesses.
197          *
198          * Fixed Length
199          * ------------
200          *
201          * The order of the large prime subgroup of the curve is our choice for
202          * a fixed public size, as that is generally the upper bound for
203          * generating a private key in EC cryptosystems and should fit all valid
204          * secret scalars.
205          *
206          * For padding on export we just use the bit length of the order
207          * converted to bytes (rounding up).
208          *
209          * For preallocating the BIGNUM storage we look at the number of "words"
210          * required for the internal representation of the order, and we
211          * preallocate 2 extra "words" in case any of the subsequent processing
212          * might temporarily overflow the order length.
213          */
214         ecbits = EC_GROUP_order_bits(ecg);
215         if (ecbits <= 0)
216             goto err;
217         sz = (ecbits + 7) / 8;
218
219         if (!ossl_param_build_set_bn_pad(tmpl, params,
220                                          OSSL_PKEY_PARAM_PRIV_KEY,
221                                          priv_key, sz))
222             goto err;
223     }
224     ret = 1;
225  err:
226     BN_CTX_free(bnctx);
227     return ret;
228 }
229
230 static ossl_inline
231 int otherparams_to_params(const EC_KEY *ec, OSSL_PARAM_BLD *tmpl,
232                           OSSL_PARAM params[])
233 {
234     int ecdh_cofactor_mode = 0, group_check = 0;
235     const char *name = NULL;
236     point_conversion_form_t format;
237
238     if (ec == NULL)
239         return 0;
240
241     format = EC_KEY_get_conv_form(ec);
242     name = ossl_ec_pt_format_id2name((int)format);
243     if (name != NULL
244         && !ossl_param_build_set_utf8_string(tmpl, params,
245                                              OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
246                                              name))
247         return 0;
248
249     group_check = EC_KEY_get_flags(ec) & EC_FLAG_CHECK_NAMED_GROUP_MASK;
250     name = ossl_ec_check_group_type_id2name(group_check);
251     if (name != NULL
252         && !ossl_param_build_set_utf8_string(tmpl, params,
253                                              OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE,
254                                              name))
255         return 0;
256
257     if ((EC_KEY_get_enc_flags(ec) & EC_PKEY_NO_PUBKEY) != 0
258             && !ossl_param_build_set_int(tmpl, params,
259                                          OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC, 0))
260         return 0;
261
262     ecdh_cofactor_mode =
263         (EC_KEY_get_flags(ec) & EC_FLAG_COFACTOR_ECDH) ? 1 : 0;
264     return ossl_param_build_set_int(tmpl, params,
265                                     OSSL_PKEY_PARAM_USE_COFACTOR_ECDH,
266                                     ecdh_cofactor_mode);
267 }
268
269 static
270 void *ec_newdata(void *provctx)
271 {
272     if (!ossl_prov_is_running())
273         return NULL;
274     return EC_KEY_new_ex(PROV_LIBCTX_OF(provctx), NULL);
275 }
276
277 #ifndef FIPS_MODULE
278 # ifndef OPENSSL_NO_SM2
279 static
280 void *sm2_newdata(void *provctx)
281 {
282     if (!ossl_prov_is_running())
283         return NULL;
284     return EC_KEY_new_by_curve_name_ex(PROV_LIBCTX_OF(provctx), NULL, NID_sm2);
285 }
286 # endif
287 #endif
288
289 static
290 void ec_freedata(void *keydata)
291 {
292     EC_KEY_free(keydata);
293 }
294
295 static
296 int ec_has(const void *keydata, int selection)
297 {
298     const EC_KEY *ec = keydata;
299     int ok = 1;
300
301     if (!ossl_prov_is_running() || ec == NULL)
302         return 0;
303     if ((selection & EC_POSSIBLE_SELECTIONS) == 0)
304         return 1; /* the selection is not missing */
305
306     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
307         ok = ok && (EC_KEY_get0_public_key(ec) != NULL);
308     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
309         ok = ok && (EC_KEY_get0_private_key(ec) != NULL);
310     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
311         ok = ok && (EC_KEY_get0_group(ec) != NULL);
312     /*
313      * We consider OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS to always be
314      * available, so no extra check is needed other than the previous one
315      * against EC_POSSIBLE_SELECTIONS.
316      */
317     return ok;
318 }
319
320 static int ec_match(const void *keydata1, const void *keydata2, int selection)
321 {
322     const EC_KEY *ec1 = keydata1;
323     const EC_KEY *ec2 = keydata2;
324     const EC_GROUP *group_a = EC_KEY_get0_group(ec1);
325     const EC_GROUP *group_b = EC_KEY_get0_group(ec2);
326     BN_CTX *ctx = NULL;
327     int ok = 1;
328
329     if (!ossl_prov_is_running())
330         return 0;
331
332     ctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(ec1));
333     if (ctx == NULL)
334         return 0;
335
336     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
337         ok = ok && group_a != NULL && group_b != NULL
338             && EC_GROUP_cmp(group_a, group_b, ctx) == 0;
339     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
340         int key_checked = 0;
341
342         if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
343             const EC_POINT *pa = EC_KEY_get0_public_key(ec1);
344             const EC_POINT *pb = EC_KEY_get0_public_key(ec2);
345
346             if (pa != NULL && pb != NULL) {
347                 ok = ok && EC_POINT_cmp(group_b, pa, pb, ctx) == 0;
348                 key_checked = 1;
349             }
350         }
351         if (!key_checked
352             && (selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
353             const BIGNUM *pa = EC_KEY_get0_private_key(ec1);
354             const BIGNUM *pb = EC_KEY_get0_private_key(ec2);
355
356             if (pa != NULL && pb != NULL) {
357                 ok = ok && BN_cmp(pa, pb) == 0;
358                 key_checked = 1;
359             }
360         }
361         ok = ok && key_checked;
362     }
363     BN_CTX_free(ctx);
364     return ok;
365 }
366
367 static int common_check_sm2(const EC_KEY *ec, int sm2_wanted)
368 {
369     const EC_GROUP *ecg = NULL;
370
371     /*
372      * sm2_wanted: import the keys or domparams only on SM2 Curve
373      * !sm2_wanted: import the keys or domparams only not on SM2 Curve
374      */
375     if ((ecg = EC_KEY_get0_group(ec)) == NULL
376         || (sm2_wanted ^ (EC_GROUP_get_curve_name(ecg) == NID_sm2)))
377         return 0;
378     return 1;
379 }
380
381 static
382 int common_import(void *keydata, int selection, const OSSL_PARAM params[],
383                   int sm2_wanted)
384 {
385     EC_KEY *ec = keydata;
386     int ok = 1;
387
388     if (!ossl_prov_is_running() || ec == NULL)
389         return 0;
390
391     /*
392      * In this implementation, we can export/import only keydata in the
393      * following combinations:
394      *   - domain parameters (+optional other params)
395      *   - public key with associated domain parameters (+optional other params)
396      *   - private key with associated domain parameters and optional public key
397      *         (+optional other params)
398      *
399      * This means:
400      *   - domain parameters must always be requested
401      *   - private key must be requested alongside public key
402      *   - other parameters are always optional
403      */
404     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) == 0)
405         return 0;
406
407     ok = ok && ossl_ec_group_fromdata(ec, params);
408
409     if (!common_check_sm2(ec, sm2_wanted))
410         return 0;
411
412     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
413         int include_private =
414             selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
415
416         ok = ok && ossl_ec_key_fromdata(ec, params, include_private);
417     }
418     if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
419         ok = ok && ossl_ec_key_otherparams_fromdata(ec, params);
420
421     return ok;
422 }
423
424 static
425 int ec_import(void *keydata, int selection, const OSSL_PARAM params[])
426 {
427     return common_import(keydata, selection, params, 0);
428 }
429
430 #ifndef FIPS_MODULE
431 # ifndef OPENSSL_NO_SM2
432 static
433 int sm2_import(void *keydata, int selection, const OSSL_PARAM params[])
434 {
435     return common_import(keydata, selection, params, 1);
436 }
437 # endif
438 #endif
439
440 static
441 int ec_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
442               void *cbarg)
443 {
444     EC_KEY *ec = keydata;
445     OSSL_PARAM_BLD *tmpl = NULL;
446     OSSL_PARAM *params = NULL;
447     unsigned char *pub_key = NULL, *genbuf = NULL;
448     BN_CTX *bnctx = NULL;
449     int ok = 1;
450
451     if (!ossl_prov_is_running() || ec == NULL)
452         return 0;
453
454     /*
455      * In this implementation, we can export/import only keydata in the
456      * following combinations:
457      *   - domain parameters (+optional other params)
458      *   - public key with associated domain parameters (+optional other params)
459      *   - private key with associated public key and domain parameters
460      *         (+optional other params)
461      *
462      * This means:
463      *   - domain parameters must always be requested
464      *   - private key must be requested alongside public key
465      *   - other parameters are always optional
466      */
467     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) == 0)
468         return 0;
469     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
470             && (selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) == 0)
471         return 0;
472
473     tmpl = OSSL_PARAM_BLD_new();
474     if (tmpl == NULL)
475         return 0;
476
477     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
478         bnctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(ec));
479         if (bnctx == NULL) {
480             ok = 0;
481             goto end;
482         }
483         BN_CTX_start(bnctx);
484         ok = ok && ossl_ec_group_todata(EC_KEY_get0_group(ec), tmpl, NULL,
485                                         ossl_ec_key_get_libctx(ec),
486                                         ossl_ec_key_get0_propq(ec),
487                                         bnctx, &genbuf);
488     }
489
490     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
491         int include_private =
492             selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
493
494         ok = ok && key_to_params(ec, tmpl, NULL, include_private, &pub_key);
495     }
496     if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
497         ok = ok && otherparams_to_params(ec, tmpl, NULL);
498
499     if (ok && (params = OSSL_PARAM_BLD_to_param(tmpl)) != NULL)
500         ok = param_cb(params, cbarg);
501     else
502         ok = 0;
503 end:
504     OSSL_PARAM_free(params);
505     OSSL_PARAM_BLD_free(tmpl);
506     OPENSSL_free(pub_key);
507     OPENSSL_free(genbuf);
508     BN_CTX_end(bnctx);
509     BN_CTX_free(bnctx);
510     return ok;
511 }
512
513 /* IMEXPORT = IMPORT + EXPORT */
514
515 # define EC_IMEXPORTABLE_DOM_PARAMETERS                                        \
516     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0),               \
517     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_ENCODING, NULL, 0),              \
518     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT, NULL, 0),\
519     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_FIELD_TYPE, NULL, 0),            \
520     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_P, NULL, 0),                              \
521     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_A, NULL, 0),                              \
522     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_B, NULL, 0),                              \
523     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_GENERATOR, NULL, 0),            \
524     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_ORDER, NULL, 0),                          \
525     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_COFACTOR, NULL, 0),                       \
526     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_SEED, NULL, 0)
527
528 # define EC_IMEXPORTABLE_PUBLIC_KEY                                            \
529     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0)
530 # define EC_IMEXPORTABLE_PRIVATE_KEY                                           \
531     OSSL_PARAM_BN(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)
532 # define EC_IMEXPORTABLE_OTHER_PARAMETERS                                      \
533     OSSL_PARAM_int(OSSL_PKEY_PARAM_USE_COFACTOR_ECDH, NULL),                   \
534     OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC, NULL)
535
536 /*
537  * Include all the possible combinations of OSSL_PARAM arrays for
538  * ec_imexport_types().
539  *
540  * They are in a separate file as it is ~100 lines of unreadable and
541  * uninteresting machine generated stuff.
542  */
543 #include "ec_kmgmt_imexport.inc"
544
545 static ossl_inline
546 const OSSL_PARAM *ec_imexport_types(int selection)
547 {
548     int type_select = 0;
549
550     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
551         type_select += 1;
552     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
553         type_select += 2;
554     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
555         type_select += 4;
556     if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
557         type_select += 8;
558     return ec_types[type_select];
559 }
560
561 static
562 const OSSL_PARAM *ec_import_types(int selection)
563 {
564     return ec_imexport_types(selection);
565 }
566
567 static
568 const OSSL_PARAM *ec_export_types(int selection)
569 {
570     return ec_imexport_types(selection);
571 }
572
573 static int ec_get_ecm_params(const EC_GROUP *group, OSSL_PARAM params[])
574 {
575 #ifdef OPENSSL_NO_EC2M
576     return 1;
577 #else
578     int ret = 0, m;
579     unsigned int k1 = 0, k2 = 0, k3 = 0;
580     int basis_nid;
581     const char *basis_name = NULL;
582     int fid = EC_GROUP_get_field_type(group);
583
584     if (fid != NID_X9_62_characteristic_two_field)
585         return 1;
586
587     basis_nid = EC_GROUP_get_basis_type(group);
588     if (basis_nid == NID_X9_62_tpBasis)
589         basis_name = SN_X9_62_tpBasis;
590     else if (basis_nid == NID_X9_62_ppBasis)
591         basis_name = SN_X9_62_ppBasis;
592     else
593         goto err;
594
595     m = EC_GROUP_get_degree(group);
596     if (!ossl_param_build_set_int(NULL, params, OSSL_PKEY_PARAM_EC_CHAR2_M, m)
597         || !ossl_param_build_set_utf8_string(NULL, params,
598                                              OSSL_PKEY_PARAM_EC_CHAR2_TYPE,
599                                              basis_name))
600         goto err;
601
602     if (basis_nid == NID_X9_62_tpBasis) {
603         if (!EC_GROUP_get_trinomial_basis(group, &k1)
604             || !ossl_param_build_set_int(NULL, params,
605                                          OSSL_PKEY_PARAM_EC_CHAR2_TP_BASIS,
606                                          (int)k1))
607             goto err;
608     } else {
609         if (!EC_GROUP_get_pentanomial_basis(group, &k1, &k2, &k3)
610             || !ossl_param_build_set_int(NULL, params,
611                                          OSSL_PKEY_PARAM_EC_CHAR2_PP_K1, (int)k1)
612             || !ossl_param_build_set_int(NULL, params,
613                                          OSSL_PKEY_PARAM_EC_CHAR2_PP_K2, (int)k2)
614             || !ossl_param_build_set_int(NULL, params,
615                                          OSSL_PKEY_PARAM_EC_CHAR2_PP_K3, (int)k3))
616             goto err;
617     }
618     ret = 1;
619 err:
620     return ret;
621 #endif /* OPENSSL_NO_EC2M */
622 }
623
624 static
625 int common_get_params(void *key, OSSL_PARAM params[], int sm2)
626 {
627     int ret = 0;
628     EC_KEY *eck = key;
629     const EC_GROUP *ecg = NULL;
630     OSSL_PARAM *p;
631     unsigned char *pub_key = NULL, *genbuf = NULL;
632     OSSL_LIB_CTX *libctx;
633     const char *propq;
634     BN_CTX *bnctx = NULL;
635
636     ecg = EC_KEY_get0_group(eck);
637     if (ecg == NULL)
638         return 0;
639
640     libctx = ossl_ec_key_get_libctx(eck);
641     propq = ossl_ec_key_get0_propq(eck);
642
643     bnctx = BN_CTX_new_ex(libctx);
644     if (bnctx == NULL)
645         return 0;
646     BN_CTX_start(bnctx);
647
648     if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
649         && !OSSL_PARAM_set_int(p, ECDSA_size(eck)))
650         goto err;
651     if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
652         && !OSSL_PARAM_set_int(p, EC_GROUP_order_bits(ecg)))
653         goto err;
654     if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL) {
655         int ecbits, sec_bits;
656
657         ecbits = EC_GROUP_order_bits(ecg);
658
659         /*
660          * The following estimates are based on the values published
661          * in Table 2 of "NIST Special Publication 800-57 Part 1 Revision 4"
662          * at http://dx.doi.org/10.6028/NIST.SP.800-57pt1r4 .
663          *
664          * Note that the above reference explicitly categorizes algorithms in a
665          * discrete set of values {80, 112, 128, 192, 256}, and that it is
666          * relevant only for NIST approved Elliptic Curves, while OpenSSL
667          * applies the same logic also to other curves.
668          *
669          * Classifications produced by other standardazing bodies might differ,
670          * so the results provided for "bits of security" by this provider are
671          * to be considered merely indicative, and it is the users'
672          * responsibility to compare these values against the normative
673          * references that may be relevant for their intent and purposes.
674          */
675         if (ecbits >= 512)
676             sec_bits = 256;
677         else if (ecbits >= 384)
678             sec_bits = 192;
679         else if (ecbits >= 256)
680             sec_bits = 128;
681         else if (ecbits >= 224)
682             sec_bits = 112;
683         else if (ecbits >= 160)
684             sec_bits = 80;
685         else
686             sec_bits = ecbits / 2;
687
688         if (!OSSL_PARAM_set_int(p, sec_bits))
689             goto err;
690     }
691
692     if ((p = OSSL_PARAM_locate(params,
693                                OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS))
694             != NULL) {
695         int explicitparams = EC_KEY_decoded_from_explicit_params(eck);
696
697         if (explicitparams < 0
698              || !OSSL_PARAM_set_int(p, explicitparams))
699             goto err;
700     }
701
702     if (!sm2) {
703         if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_DEFAULT_DIGEST)) != NULL
704                 && !OSSL_PARAM_set_utf8_string(p, EC_DEFAULT_MD))
705             goto err;
706     } else {
707         if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_DEFAULT_DIGEST)) != NULL
708                 && !OSSL_PARAM_set_utf8_string(p, SM2_DEFAULT_MD))
709             goto err;
710     }
711
712     /* SM2 doesn't support this PARAM */
713     if (!sm2) {
714         p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_USE_COFACTOR_ECDH);
715         if (p != NULL) {
716             int ecdh_cofactor_mode = 0;
717
718             ecdh_cofactor_mode =
719                 (EC_KEY_get_flags(eck) & EC_FLAG_COFACTOR_ECDH) ? 1 : 0;
720
721             if (!OSSL_PARAM_set_int(p, ecdh_cofactor_mode))
722                 goto err;
723         }
724     }
725     if ((p = OSSL_PARAM_locate(params,
726                                OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY)) != NULL) {
727         p->return_size = EC_POINT_point2oct(EC_KEY_get0_group(key),
728                                             EC_KEY_get0_public_key(key),
729                                             POINT_CONVERSION_UNCOMPRESSED,
730                                             p->data, p->return_size, bnctx);
731         if (p->return_size == 0)
732             goto err;
733     }
734
735     ret = ec_get_ecm_params(ecg, params)
736           && ossl_ec_group_todata(ecg, NULL, params, libctx, propq, bnctx,
737                                   &genbuf)
738           && key_to_params(eck, NULL, params, 1, &pub_key)
739           && otherparams_to_params(eck, NULL, params);
740 err:
741     OPENSSL_free(genbuf);
742     OPENSSL_free(pub_key);
743     BN_CTX_end(bnctx);
744     BN_CTX_free(bnctx);
745     return ret;
746 }
747
748 static
749 int ec_get_params(void *key, OSSL_PARAM params[])
750 {
751     return common_get_params(key, params, 0);
752 }
753
754 #ifndef OPENSSL_NO_EC2M
755 # define EC2M_GETTABLE_DOM_PARAMS                                              \
756         OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_CHAR2_M, NULL),                      \
757         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_CHAR2_TYPE, NULL, 0),        \
758         OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_CHAR2_TP_BASIS, NULL),               \
759         OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_CHAR2_PP_K1, NULL),                  \
760         OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_CHAR2_PP_K2, NULL),                  \
761         OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_CHAR2_PP_K3, NULL),
762 #else
763 # define EC2M_GETTABLE_DOM_PARAMS
764 #endif
765
766 static const OSSL_PARAM ec_known_gettable_params[] = {
767     OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
768     OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
769     OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
770     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_DEFAULT_DIGEST, NULL, 0),
771     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),
772     OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS, NULL),
773     EC_IMEXPORTABLE_DOM_PARAMETERS,
774     EC2M_GETTABLE_DOM_PARAMS
775     EC_IMEXPORTABLE_PUBLIC_KEY,
776     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_PUB_X, NULL, 0),
777     OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_PUB_Y, NULL, 0),
778     EC_IMEXPORTABLE_PRIVATE_KEY,
779     EC_IMEXPORTABLE_OTHER_PARAMETERS,
780     OSSL_PARAM_END
781 };
782
783 static
784 const OSSL_PARAM *ec_gettable_params(void *provctx)
785 {
786     return ec_known_gettable_params;
787 }
788
789 static const OSSL_PARAM ec_known_settable_params[] = {
790     OSSL_PARAM_int(OSSL_PKEY_PARAM_USE_COFACTOR_ECDH, NULL),
791     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),
792     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_ENCODING, NULL, 0),
793     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT, NULL, 0),
794     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_SEED, NULL, 0),
795     OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC, NULL),
796     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE, NULL, 0),
797     OSSL_PARAM_END
798 };
799
800 static
801 const OSSL_PARAM *ec_settable_params(void *provctx)
802 {
803     return ec_known_settable_params;
804 }
805
806 static
807 int ec_set_params(void *key, const OSSL_PARAM params[])
808 {
809     EC_KEY *eck = key;
810     const OSSL_PARAM *p;
811
812     if (key == NULL)
813         return 0;
814     if (params == NULL)
815         return 1;
816
817
818     if (!ossl_ec_group_set_params((EC_GROUP *)EC_KEY_get0_group(key), params))
819         return 0;
820
821     p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY);
822     if (p != NULL) {
823         BN_CTX *ctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(key));
824         int ret = 1;
825
826         if (ctx == NULL
827                 || p->data_type != OSSL_PARAM_OCTET_STRING
828                 || !EC_KEY_oct2key(key, p->data, p->data_size, ctx))
829             ret = 0;
830         BN_CTX_free(ctx);
831         if (!ret)
832             return 0;
833     }
834
835     return ossl_ec_key_otherparams_fromdata(eck, params);
836 }
837
838 #ifndef FIPS_MODULE
839 # ifndef OPENSSL_NO_SM2
840 static
841 int sm2_get_params(void *key, OSSL_PARAM params[])
842 {
843     return common_get_params(key, params, 1);
844 }
845
846 static const OSSL_PARAM sm2_known_gettable_params[] = {
847     OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
848     OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
849     OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
850     OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_DEFAULT_DIGEST, NULL, 0),
851     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),
852     OSSL_PARAM_int(OSSL_PKEY_PARAM_EC_DECODED_FROM_EXPLICIT_PARAMS, NULL),
853     EC_IMEXPORTABLE_DOM_PARAMETERS,
854     EC_IMEXPORTABLE_PUBLIC_KEY,
855     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_PUB_X, NULL, 0),
856     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_PUB_Y, NULL, 0),
857     EC_IMEXPORTABLE_PRIVATE_KEY,
858     OSSL_PARAM_END
859 };
860
861 static
862 const OSSL_PARAM *sm2_gettable_params(ossl_unused void *provctx)
863 {
864     return sm2_known_gettable_params;
865 }
866
867 static const OSSL_PARAM sm2_known_settable_params[] = {
868     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY, NULL, 0),
869     OSSL_PARAM_END
870 };
871
872 static
873 const OSSL_PARAM *sm2_settable_params(ossl_unused void *provctx)
874 {
875     return sm2_known_settable_params;
876 }
877
878 static
879 int sm2_validate(const void *keydata, int selection, int checktype)
880 {
881     const EC_KEY *eck = keydata;
882     int ok = 1;
883     BN_CTX *ctx = NULL;
884
885     if (!ossl_prov_is_running())
886         return 0;
887
888     if ((selection & EC_POSSIBLE_SELECTIONS) == 0)
889         return 1; /* nothing to validate */
890
891     ctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eck));
892     if  (ctx == NULL)
893         return 0;
894
895     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0)
896         ok = ok && EC_GROUP_check(EC_KEY_get0_group(eck), ctx);
897
898     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
899         if (checktype == OSSL_KEYMGMT_VALIDATE_QUICK_CHECK)
900             ok = ok && ossl_ec_key_public_check_quick(eck, ctx);
901         else
902             ok = ok && ossl_ec_key_public_check(eck, ctx);
903     }
904
905     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
906         ok = ok && ossl_sm2_key_private_check(eck);
907
908     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == OSSL_KEYMGMT_SELECT_KEYPAIR)
909         ok = ok && ossl_ec_key_pairwise_check(eck, ctx);
910
911     BN_CTX_free(ctx);
912     return ok;
913 }
914 # endif
915 #endif
916
917 static
918 int ec_validate(const void *keydata, int selection, int checktype)
919 {
920     const EC_KEY *eck = keydata;
921     int ok = 1;
922     BN_CTX *ctx = NULL;
923
924     if (!ossl_prov_is_running())
925         return 0;
926
927     if ((selection & EC_POSSIBLE_SELECTIONS) == 0)
928         return 1; /* nothing to validate */
929
930     ctx = BN_CTX_new_ex(ossl_ec_key_get_libctx(eck));
931     if  (ctx == NULL)
932         return 0;
933
934     if ((selection & OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS) != 0) {
935         int flags = EC_KEY_get_flags(eck);
936
937         if ((flags & EC_FLAG_CHECK_NAMED_GROUP) != 0)
938             ok = ok && EC_GROUP_check_named_curve(EC_KEY_get0_group(eck),
939                            (flags & EC_FLAG_CHECK_NAMED_GROUP_NIST) != 0, ctx);
940         else
941             ok = ok && EC_GROUP_check(EC_KEY_get0_group(eck), ctx);
942     }
943
944     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
945         if (checktype == OSSL_KEYMGMT_VALIDATE_QUICK_CHECK)
946             ok = ok && ossl_ec_key_public_check_quick(eck, ctx);
947         else
948             ok = ok && ossl_ec_key_public_check(eck, ctx);
949     }
950
951     if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
952         ok = ok && ossl_ec_key_private_check(eck);
953
954     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == OSSL_KEYMGMT_SELECT_KEYPAIR)
955         ok = ok && ossl_ec_key_pairwise_check(eck, ctx);
956
957     BN_CTX_free(ctx);
958     return ok;
959 }
960
961 struct ec_gen_ctx {
962     OSSL_LIB_CTX *libctx;
963     char *group_name;
964     char *encoding;
965     char *pt_format;
966     char *group_check;
967     char *field_type;
968     BIGNUM *p, *a, *b, *order, *cofactor;
969     unsigned char *gen, *seed;
970     size_t gen_len, seed_len;
971     int selection;
972     int ecdh_mode;
973     EC_GROUP *gen_group;
974 };
975
976 static void *ec_gen_init(void *provctx, int selection,
977                          const OSSL_PARAM params[])
978 {
979     OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
980     struct ec_gen_ctx *gctx = NULL;
981
982     if (!ossl_prov_is_running() || (selection & (EC_POSSIBLE_SELECTIONS)) == 0)
983         return NULL;
984
985     if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
986         gctx->libctx = libctx;
987         gctx->selection = selection;
988         gctx->ecdh_mode = 0;
989     }
990     if (!ec_gen_set_params(gctx, params)) {
991         OPENSSL_free(gctx);
992         gctx = NULL;
993     }
994     return gctx;
995 }
996
997 #ifndef FIPS_MODULE
998 # ifndef OPENSSL_NO_SM2
999 static void *sm2_gen_init(void *provctx, int selection,
1000                          const OSSL_PARAM params[])
1001 {
1002     struct ec_gen_ctx *gctx = ec_gen_init(provctx, selection, params);
1003
1004     if (gctx != NULL) {
1005         if (gctx->group_name != NULL)
1006             return gctx;
1007         if ((gctx->group_name = OPENSSL_strdup("sm2")) != NULL)
1008             return gctx;
1009         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
1010         ec_gen_cleanup(gctx);
1011     }
1012     return NULL;
1013 }
1014 # endif
1015 #endif
1016
1017 static int ec_gen_set_group(void *genctx, const EC_GROUP *src)
1018 {
1019     struct ec_gen_ctx *gctx = genctx;
1020     EC_GROUP *group;
1021
1022     group = EC_GROUP_dup(src);
1023     if (group == NULL) {
1024         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_CURVE);
1025         return 0;
1026     }
1027     EC_GROUP_free(gctx->gen_group);
1028     gctx->gen_group = group;
1029     return 1;
1030 }
1031
1032 static int ec_gen_set_template(void *genctx, void *templ)
1033 {
1034     struct ec_gen_ctx *gctx = genctx;
1035     EC_KEY *ec = templ;
1036     const EC_GROUP *ec_group;
1037
1038     if (!ossl_prov_is_running() || gctx == NULL || ec == NULL)
1039         return 0;
1040     if ((ec_group = EC_KEY_get0_group(ec)) == NULL)
1041         return 0;
1042     return ec_gen_set_group(gctx, ec_group);
1043 }
1044
1045 #define COPY_INT_PARAM(params, key, val)                                       \
1046 p = OSSL_PARAM_locate_const(params, key);                                      \
1047 if (p != NULL && !OSSL_PARAM_get_int(p, &val))                                 \
1048     goto err;
1049
1050 #define COPY_UTF8_PARAM(params, key, val)                                      \
1051 p = OSSL_PARAM_locate_const(params, key);                                      \
1052 if (p != NULL) {                                                               \
1053     if (p->data_type != OSSL_PARAM_UTF8_STRING)                                \
1054         goto err;                                                              \
1055     OPENSSL_free(val);                                                         \
1056     val = OPENSSL_strdup(p->data);                                             \
1057     if (val == NULL)                                                           \
1058         goto err;                                                              \
1059 }
1060
1061 #define COPY_OCTET_PARAM(params, key, val, len)                                \
1062 p = OSSL_PARAM_locate_const(params, key);                                      \
1063 if (p != NULL) {                                                               \
1064     if (p->data_type != OSSL_PARAM_OCTET_STRING)                               \
1065         goto err;                                                              \
1066     OPENSSL_free(val);                                                         \
1067     len = p->data_size;                                                        \
1068     val = OPENSSL_memdup(p->data, p->data_size);                               \
1069     if (val == NULL)                                                           \
1070         goto err;                                                              \
1071 }
1072
1073 #define COPY_BN_PARAM(params, key, bn)                                         \
1074 p = OSSL_PARAM_locate_const(params, key);                                      \
1075 if (p != NULL) {                                                               \
1076     if (bn == NULL)                                                            \
1077         bn = BN_new();                                                         \
1078     if (bn == NULL || !OSSL_PARAM_get_BN(p, &bn))                              \
1079         goto err;                                                              \
1080 }
1081
1082 static int ec_gen_set_params(void *genctx, const OSSL_PARAM params[])
1083 {
1084     int ret = 0;
1085     struct ec_gen_ctx *gctx = genctx;
1086     const OSSL_PARAM *p;
1087     EC_GROUP *group = NULL;
1088
1089     COPY_INT_PARAM(params, OSSL_PKEY_PARAM_USE_COFACTOR_ECDH, gctx->ecdh_mode);
1090
1091     COPY_UTF8_PARAM(params, OSSL_PKEY_PARAM_GROUP_NAME, gctx->group_name);
1092     COPY_UTF8_PARAM(params, OSSL_PKEY_PARAM_EC_FIELD_TYPE, gctx->field_type);
1093     COPY_UTF8_PARAM(params, OSSL_PKEY_PARAM_EC_ENCODING, gctx->encoding);
1094     COPY_UTF8_PARAM(params, OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT, gctx->pt_format);
1095     COPY_UTF8_PARAM(params, OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE, gctx->group_check);
1096
1097     COPY_BN_PARAM(params, OSSL_PKEY_PARAM_EC_P, gctx->p);
1098     COPY_BN_PARAM(params, OSSL_PKEY_PARAM_EC_A, gctx->a);
1099     COPY_BN_PARAM(params, OSSL_PKEY_PARAM_EC_B, gctx->b);
1100     COPY_BN_PARAM(params, OSSL_PKEY_PARAM_EC_ORDER, gctx->order);
1101     COPY_BN_PARAM(params, OSSL_PKEY_PARAM_EC_COFACTOR, gctx->cofactor);
1102
1103     COPY_OCTET_PARAM(params, OSSL_PKEY_PARAM_EC_SEED, gctx->seed, gctx->seed_len);
1104     COPY_OCTET_PARAM(params, OSSL_PKEY_PARAM_EC_GENERATOR, gctx->gen,
1105                      gctx->gen_len);
1106
1107     ret = 1;
1108 err:
1109     EC_GROUP_free(group);
1110     return ret;
1111 }
1112
1113 static int ec_gen_set_group_from_params(struct ec_gen_ctx *gctx)
1114 {
1115     int ret = 0;
1116     OSSL_PARAM_BLD *bld;
1117     OSSL_PARAM *params = NULL;
1118     EC_GROUP *group = NULL;
1119
1120     bld = OSSL_PARAM_BLD_new();
1121     if (bld == NULL)
1122         return 0;
1123
1124     if (gctx->encoding != NULL
1125         && !OSSL_PARAM_BLD_push_utf8_string(bld, OSSL_PKEY_PARAM_EC_ENCODING,
1126                                             gctx->encoding, 0))
1127         goto err;
1128
1129     if (gctx->pt_format != NULL
1130         && !OSSL_PARAM_BLD_push_utf8_string(bld,
1131                                             OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT,
1132                                             gctx->pt_format, 0))
1133         goto err;
1134
1135     if (gctx->group_name != NULL) {
1136         if (!OSSL_PARAM_BLD_push_utf8_string(bld, OSSL_PKEY_PARAM_GROUP_NAME,
1137                                              gctx->group_name, 0))
1138             goto err;
1139         /* Ignore any other parameters if there is a group name */
1140         goto build;
1141     } else if (gctx->field_type != NULL) {
1142         if (!OSSL_PARAM_BLD_push_utf8_string(bld, OSSL_PKEY_PARAM_EC_FIELD_TYPE,
1143                                              gctx->field_type, 0))
1144             goto err;
1145     } else {
1146         goto err;
1147     }
1148     if (gctx->p == NULL
1149         || gctx->a == NULL
1150         || gctx->b == NULL
1151         || gctx->order == NULL
1152         || !OSSL_PARAM_BLD_push_BN(bld, OSSL_PKEY_PARAM_EC_P, gctx->p)
1153         || !OSSL_PARAM_BLD_push_BN(bld, OSSL_PKEY_PARAM_EC_A, gctx->a)
1154         || !OSSL_PARAM_BLD_push_BN(bld, OSSL_PKEY_PARAM_EC_B, gctx->b)
1155         || !OSSL_PARAM_BLD_push_BN(bld, OSSL_PKEY_PARAM_EC_ORDER, gctx->order))
1156         goto err;
1157
1158     if (gctx->cofactor != NULL
1159         && !OSSL_PARAM_BLD_push_BN(bld, OSSL_PKEY_PARAM_EC_COFACTOR,
1160                                    gctx->cofactor))
1161         goto err;
1162
1163     if (gctx->seed != NULL
1164         && !OSSL_PARAM_BLD_push_octet_string(bld, OSSL_PKEY_PARAM_EC_SEED,
1165                                              gctx->seed, gctx->seed_len))
1166         goto err;
1167
1168     if (gctx->gen == NULL
1169         || !OSSL_PARAM_BLD_push_octet_string(bld, OSSL_PKEY_PARAM_EC_GENERATOR,
1170                                              gctx->gen, gctx->gen_len))
1171         goto err;
1172 build:
1173     params = OSSL_PARAM_BLD_to_param(bld);
1174     if (params == NULL)
1175         goto err;
1176     group = EC_GROUP_new_from_params(params, gctx->libctx, NULL);
1177     if (group == NULL)
1178         goto err;
1179
1180     EC_GROUP_free(gctx->gen_group);
1181     gctx->gen_group = group;
1182
1183     ret = 1;
1184 err:
1185     OSSL_PARAM_free(params);
1186     OSSL_PARAM_BLD_free(bld);
1187     return ret;
1188 }
1189
1190 static const OSSL_PARAM *ec_gen_settable_params(ossl_unused void *genctx,
1191                                                 ossl_unused void *provctx)
1192 {
1193     static OSSL_PARAM settable[] = {
1194         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_GROUP_NAME, NULL, 0),
1195         OSSL_PARAM_int(OSSL_PKEY_PARAM_USE_COFACTOR_ECDH, NULL),
1196         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_ENCODING, NULL, 0),
1197         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT, NULL, 0),
1198         OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_EC_FIELD_TYPE, NULL, 0),
1199         OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_P, NULL, 0),
1200         OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_A, NULL, 0),
1201         OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_B, NULL, 0),
1202         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_GENERATOR, NULL, 0),
1203         OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_ORDER, NULL, 0),
1204         OSSL_PARAM_BN(OSSL_PKEY_PARAM_EC_COFACTOR, NULL, 0),
1205         OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_EC_SEED, NULL, 0),
1206         OSSL_PARAM_END
1207     };
1208
1209     return settable;
1210 }
1211
1212 static int ec_gen_assign_group(EC_KEY *ec, EC_GROUP *group)
1213 {
1214     if (group == NULL) {
1215         ERR_raise(ERR_LIB_PROV, PROV_R_NO_PARAMETERS_SET);
1216         return 0;
1217     }
1218     return EC_KEY_set_group(ec, group) > 0;
1219 }
1220
1221 /*
1222  * The callback arguments (osslcb & cbarg) are not used by EC_KEY generation
1223  */
1224 static void *ec_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
1225 {
1226     struct ec_gen_ctx *gctx = genctx;
1227     EC_KEY *ec = NULL;
1228     int ret = 0;
1229
1230     if (!ossl_prov_is_running()
1231         || gctx == NULL
1232         || (ec = EC_KEY_new_ex(gctx->libctx, NULL)) == NULL)
1233         return NULL;
1234
1235     if (gctx->gen_group == NULL) {
1236         if (!ec_gen_set_group_from_params(gctx))
1237             goto err;
1238     } else {
1239         if (gctx->encoding != NULL) {
1240             int flags = ossl_ec_encoding_name2id(gctx->encoding);
1241
1242             if (flags < 0)
1243                 goto err;
1244             EC_GROUP_set_asn1_flag(gctx->gen_group, flags);
1245         }
1246         if (gctx->pt_format != NULL) {
1247             int format = ossl_ec_pt_format_name2id(gctx->pt_format);
1248
1249             if (format < 0)
1250                 goto err;
1251             EC_GROUP_set_point_conversion_form(gctx->gen_group, format);
1252         }
1253     }
1254
1255     /* We must always assign a group, no matter what */
1256     ret = ec_gen_assign_group(ec, gctx->gen_group);
1257
1258     /* Whether you want it or not, you get a keypair, not just one half */
1259     if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
1260         ret = ret && EC_KEY_generate_key(ec);
1261
1262     if (gctx->ecdh_mode != -1)
1263         ret = ret && ossl_ec_set_ecdh_cofactor_mode(ec, gctx->ecdh_mode);
1264
1265     if (gctx->group_check != NULL)
1266         ret = ret && ossl_ec_set_check_group_type_from_name(ec, gctx->group_check);
1267     if (ret)
1268         return ec;
1269 err:
1270     /* Something went wrong, throw the key away */
1271     EC_KEY_free(ec);
1272     return NULL;
1273 }
1274
1275 #ifndef FIPS_MODULE
1276 # ifndef OPENSSL_NO_SM2
1277 /*
1278  * The callback arguments (osslcb & cbarg) are not used by EC_KEY generation
1279  */
1280 static void *sm2_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
1281 {
1282     struct ec_gen_ctx *gctx = genctx;
1283     EC_KEY *ec = NULL;
1284     int ret = 1;
1285
1286     if (gctx == NULL
1287         || (ec = EC_KEY_new_ex(gctx->libctx, NULL)) == NULL)
1288         return NULL;
1289
1290     if (gctx->gen_group == NULL) {
1291         if (!ec_gen_set_group_from_params(gctx))
1292             goto err;
1293     } else {
1294         if (gctx->encoding) {
1295             int flags = ossl_ec_encoding_name2id(gctx->encoding);
1296
1297             if (flags < 0)
1298                 goto err;
1299             EC_GROUP_set_asn1_flag(gctx->gen_group, flags);
1300         }
1301         if (gctx->pt_format != NULL) {
1302             int format = ossl_ec_pt_format_name2id(gctx->pt_format);
1303
1304             if (format < 0)
1305                 goto err;
1306             EC_GROUP_set_point_conversion_form(gctx->gen_group, format);
1307         }
1308     }
1309
1310     /* We must always assign a group, no matter what */
1311     ret = ec_gen_assign_group(ec, gctx->gen_group);
1312
1313     /* Whether you want it or not, you get a keypair, not just one half */
1314     if ((gctx->selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
1315         ret = ret && EC_KEY_generate_key(ec);
1316
1317     if (ret)
1318         return ec;
1319 err:
1320     /* Something went wrong, throw the key away */
1321     EC_KEY_free(ec);
1322     return NULL;
1323 }
1324 # endif
1325 #endif
1326
1327 static void ec_gen_cleanup(void *genctx)
1328 {
1329     struct ec_gen_ctx *gctx = genctx;
1330
1331     if (gctx == NULL)
1332         return;
1333
1334     EC_GROUP_free(gctx->gen_group);
1335     BN_free(gctx->p);
1336     BN_free(gctx->a);
1337     BN_free(gctx->b);
1338     BN_free(gctx->order);
1339     BN_free(gctx->cofactor);
1340     OPENSSL_free(gctx->group_name);
1341     OPENSSL_free(gctx->field_type);
1342     OPENSSL_free(gctx->pt_format);
1343     OPENSSL_free(gctx->encoding);
1344     OPENSSL_free(gctx->seed);
1345     OPENSSL_free(gctx->gen);
1346     OPENSSL_free(gctx);
1347 }
1348
1349 static void *common_load(const void *reference, size_t reference_sz,
1350                          int sm2_wanted)
1351 {
1352     EC_KEY *ec = NULL;
1353
1354     if (ossl_prov_is_running() && reference_sz == sizeof(ec)) {
1355         /* The contents of the reference is the address to our object */
1356         ec = *(EC_KEY **)reference;
1357
1358         if (!common_check_sm2(ec, sm2_wanted))
1359             return NULL;
1360
1361         /* We grabbed, so we detach it */
1362         *(EC_KEY **)reference = NULL;
1363         return ec;
1364     }
1365     return NULL;
1366 }
1367
1368 static void *ec_load(const void *reference, size_t reference_sz)
1369 {
1370     return common_load(reference, reference_sz, 0);
1371 }
1372
1373 #ifndef FIPS_MODULE
1374 # ifndef OPENSSL_NO_SM2
1375 static void *sm2_load(const void *reference, size_t reference_sz)
1376 {
1377     return common_load(reference, reference_sz, 1);
1378 }
1379 # endif
1380 #endif
1381
1382 static void *ec_dup(const void *keydata_from, int selection)
1383 {
1384     if (ossl_prov_is_running())
1385         return ossl_ec_key_dup(keydata_from, selection);
1386     return NULL;
1387 }
1388
1389 const OSSL_DISPATCH ossl_ec_keymgmt_functions[] = {
1390     { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))ec_newdata },
1391     { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))ec_gen_init },
1392     { OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE,
1393       (void (*)(void))ec_gen_set_template },
1394     { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))ec_gen_set_params },
1395     { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
1396       (void (*)(void))ec_gen_settable_params },
1397     { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))ec_gen },
1398     { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))ec_gen_cleanup },
1399     { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))ec_load },
1400     { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))ec_freedata },
1401     { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))ec_get_params },
1402     { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))ec_gettable_params },
1403     { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))ec_set_params },
1404     { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))ec_settable_params },
1405     { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))ec_has },
1406     { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))ec_match },
1407     { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))ec_validate },
1408     { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))ec_import },
1409     { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))ec_import_types },
1410     { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))ec_export },
1411     { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))ec_export_types },
1412     { OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME,
1413       (void (*)(void))ec_query_operation_name },
1414     { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))ec_dup },
1415     { 0, NULL }
1416 };
1417
1418 #ifndef FIPS_MODULE
1419 # ifndef OPENSSL_NO_SM2
1420 const OSSL_DISPATCH ossl_sm2_keymgmt_functions[] = {
1421     { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))sm2_newdata },
1422     { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))sm2_gen_init },
1423     { OSSL_FUNC_KEYMGMT_GEN_SET_TEMPLATE,
1424       (void (*)(void))ec_gen_set_template },
1425     { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))ec_gen_set_params },
1426     { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
1427       (void (*)(void))ec_gen_settable_params },
1428     { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))sm2_gen },
1429     { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))ec_gen_cleanup },
1430     { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))sm2_load },
1431     { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))ec_freedata },
1432     { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))sm2_get_params },
1433     { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))sm2_gettable_params },
1434     { OSSL_FUNC_KEYMGMT_SET_PARAMS, (void (*) (void))ec_set_params },
1435     { OSSL_FUNC_KEYMGMT_SETTABLE_PARAMS, (void (*) (void))sm2_settable_params },
1436     { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))ec_has },
1437     { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))ec_match },
1438     { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))sm2_validate },
1439     { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))sm2_import },
1440     { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))ec_import_types },
1441     { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))ec_export },
1442     { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))ec_export_types },
1443     { OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME,
1444       (void (*)(void))sm2_query_operation_name },
1445     { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))ec_dup },
1446     { 0, NULL }
1447 };
1448 # endif
1449 #endif