1 /* $OpenBSD: ecparam.c,v 1.17 2018/02/07 05:47:55 jsing Exp $ */
3 * Written by Nils Larsch for the OpenSSL project.
5 /* ====================================================================
6 * Copyright (c) 1998-2005 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 * openssl-core@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).
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
61 * Portions of the attached software ("Contribution") are developed by
62 * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
64 * The Contribution is licensed pursuant to the OpenSSL open source
65 * license provided above.
67 * The elliptic curve binary polynomial software is originally written by
68 * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
72 #include <openssl/opensslconf.h>
83 #include <openssl/bio.h>
84 #include <openssl/bn.h>
85 #include <openssl/ec.h>
86 #include <openssl/err.h>
87 #include <openssl/pem.h>
88 #include <openssl/x509.h>
90 static int ecparam_print_var(BIO
*, BIGNUM
*, const char *, int,
98 point_conversion_form_t form
;
113 ecparam_opt_form(char *arg
)
115 if (strcmp(arg
, "compressed") == 0)
116 ecparam_config
.form
= POINT_CONVERSION_COMPRESSED
;
117 else if (strcmp(arg
, "uncompressed") == 0)
118 ecparam_config
.form
= POINT_CONVERSION_UNCOMPRESSED
;
119 else if (strcmp(arg
, "hybrid") == 0)
120 ecparam_config
.form
= POINT_CONVERSION_HYBRID
;
124 ecparam_config
.new_form
= 1;
129 ecparam_opt_enctype(char *arg
)
131 if (strcmp(arg
, "explicit") == 0)
132 ecparam_config
.asn1_flag
= 0;
133 else if (strcmp(arg
, "named_curve") == 0)
134 ecparam_config
.asn1_flag
= OPENSSL_EC_NAMED_CURVE
;
138 ecparam_config
.new_asn1_flag
= 1;
142 struct option ecparam_options
[] = {
145 .desc
= "Convert the EC parameters into C code",
147 .opt
.flag
= &ecparam_config
.C
,
151 .desc
= "Validate the elliptic curve parameters",
153 .opt
.flag
= &ecparam_config
.check
,
158 .desc
= "Specify point conversion form:\n"
159 " compressed, uncompressed (default), hybrid",
160 .type
= OPTION_ARG_FUNC
,
161 .opt
.argfunc
= ecparam_opt_form
,
165 .desc
= "Generate an EC private key using the specified "
168 .opt
.flag
= &ecparam_config
.genkey
,
173 .desc
= "Input file to read parameters from (default stdin)",
175 .opt
.arg
= &ecparam_config
.infile
,
180 .desc
= "Input format (DER or PEM)",
181 .type
= OPTION_ARG_FORMAT
,
182 .opt
.value
= &ecparam_config
.informat
,
185 .name
= "list_curves",
186 .desc
= "Print list of all currently implemented EC "
189 .opt
.flag
= &ecparam_config
.list_curves
,
194 .desc
= "Use the EC parameters with the specified name",
196 .opt
.arg
= &ecparam_config
.curve_name
,
200 .desc
= "Do not output seed with explicit parameter encoding",
202 .opt
.flag
= &ecparam_config
.no_seed
,
206 .desc
= "Do not output encoded version of EC parameters",
208 .opt
.flag
= &ecparam_config
.noout
,
213 .desc
= "Output file to write parameters to (default stdout)",
215 .opt
.arg
= &ecparam_config
.outfile
,
220 .desc
= "Output format (DER or PEM)",
221 .type
= OPTION_ARG_FORMAT
,
222 .opt
.value
= &ecparam_config
.outformat
,
227 .desc
= "Specify EC parameter ASN.1 encoding type:\n"
228 " explicit, named_curve (default)",
229 .type
= OPTION_ARG_FUNC
,
230 .opt
.argfunc
= ecparam_opt_enctype
,
234 .desc
= "Print out the EC parameters in human readable form",
236 .opt
.flag
= &ecparam_config
.text
,
244 fprintf(stderr
, "usage: ecparam [-C] [-check] [-conv_form arg] "
246 " [-in file] [-inform DER | PEM] [-list_curves] [-name arg]\n"
247 " [-no_seed] [-noout] [-out file] [-outform DER | PEM]\n"
248 " [-param_enc arg] [-text]\n\n");
249 options_usage(ecparam_options
);
253 ecparam_main(int argc
, char **argv
)
255 BIGNUM
*ec_p
= NULL
, *ec_a
= NULL
, *ec_b
= NULL
, *ec_gen
= NULL
;
256 BIGNUM
*ec_order
= NULL
, *ec_cofactor
= NULL
;
257 EC_GROUP
*group
= NULL
;
258 unsigned char *buffer
= NULL
;
259 BIO
*in
= NULL
, *out
= NULL
;
262 if (single_execution
) {
263 if (pledge("stdio cpath wpath rpath", NULL
) == -1) {
269 memset(&ecparam_config
, 0, sizeof(ecparam_config
));
270 ecparam_config
.asn1_flag
= OPENSSL_EC_NAMED_CURVE
;
271 ecparam_config
.form
= POINT_CONVERSION_UNCOMPRESSED
;
272 ecparam_config
.informat
= FORMAT_PEM
;
273 ecparam_config
.outformat
= FORMAT_PEM
;
275 if (options_parse(argc
, argv
, ecparam_options
, NULL
, NULL
) != 0) {
280 in
= BIO_new(BIO_s_file());
281 out
= BIO_new(BIO_s_file());
282 if ((in
== NULL
) || (out
== NULL
)) {
283 ERR_print_errors(bio_err
);
286 if (ecparam_config
.infile
== NULL
)
287 BIO_set_fp(in
, stdin
, BIO_NOCLOSE
);
289 if (BIO_read_filename(in
, ecparam_config
.infile
) <= 0) {
290 perror(ecparam_config
.infile
);
294 if (ecparam_config
.outfile
== NULL
) {
295 BIO_set_fp(out
, stdout
, BIO_NOCLOSE
);
297 if (BIO_write_filename(out
, ecparam_config
.outfile
) <= 0) {
298 perror(ecparam_config
.outfile
);
303 if (ecparam_config
.list_curves
) {
304 EC_builtin_curve
*curves
= NULL
;
308 crv_len
= EC_get_builtin_curves(NULL
, 0);
310 curves
= reallocarray(NULL
, crv_len
, sizeof(EC_builtin_curve
));
314 if (!EC_get_builtin_curves(curves
, crv_len
)) {
318 for (n
= 0; n
< crv_len
; n
++) {
321 comment
= curves
[n
].comment
;
322 sname
= OBJ_nid2sn(curves
[n
].nid
);
324 comment
= "CURVE DESCRIPTION NOT AVAILABLE";
328 BIO_printf(out
, " %-10s: ", sname
);
329 BIO_printf(out
, "%s\n", comment
);
336 if (ecparam_config
.curve_name
!= NULL
) {
340 * workaround for the SECG curve names secp192r1 and
341 * secp256r1 (which are the same as the curves prime192v1 and
342 * prime256v1 defined in X9.62)
344 if (!strcmp(ecparam_config
.curve_name
, "secp192r1")) {
345 BIO_printf(bio_err
, "using curve name prime192v1 "
346 "instead of secp192r1\n");
347 nid
= NID_X9_62_prime192v1
;
348 } else if (!strcmp(ecparam_config
.curve_name
, "secp256r1")) {
349 BIO_printf(bio_err
, "using curve name prime256v1 "
350 "instead of secp256r1\n");
351 nid
= NID_X9_62_prime256v1
;
353 nid
= OBJ_sn2nid(ecparam_config
.curve_name
);
356 nid
= EC_curve_nist2nid(ecparam_config
.curve_name
);
359 BIO_printf(bio_err
, "unknown curve name (%s)\n",
360 ecparam_config
.curve_name
);
363 group
= EC_GROUP_new_by_curve_name(nid
);
365 BIO_printf(bio_err
, "unable to create curve (%s)\n",
366 ecparam_config
.curve_name
);
369 EC_GROUP_set_asn1_flag(group
, ecparam_config
.asn1_flag
);
370 EC_GROUP_set_point_conversion_form(group
, ecparam_config
.form
);
371 } else if (ecparam_config
.informat
== FORMAT_ASN1
) {
372 group
= d2i_ECPKParameters_bio(in
, NULL
);
373 } else if (ecparam_config
.informat
== FORMAT_PEM
) {
374 group
= PEM_read_bio_ECPKParameters(in
, NULL
, NULL
, NULL
);
376 BIO_printf(bio_err
, "bad input format specified\n");
382 "unable to load elliptic curve parameters\n");
383 ERR_print_errors(bio_err
);
386 if (ecparam_config
.new_form
)
387 EC_GROUP_set_point_conversion_form(group
, ecparam_config
.form
);
389 if (ecparam_config
.new_asn1_flag
)
390 EC_GROUP_set_asn1_flag(group
, ecparam_config
.asn1_flag
);
392 if (ecparam_config
.no_seed
)
393 EC_GROUP_set_seed(group
, NULL
, 0);
395 if (ecparam_config
.text
) {
396 if (!ECPKParameters_print(out
, group
, 0))
399 if (ecparam_config
.check
) {
400 BIO_printf(bio_err
, "checking elliptic curve parameters: ");
401 if (!EC_GROUP_check(group
, NULL
)) {
402 BIO_printf(bio_err
, "failed\n");
403 ERR_print_errors(bio_err
);
405 BIO_printf(bio_err
, "ok\n");
408 if (ecparam_config
.C
) {
409 size_t buf_len
= 0, tmp_len
= 0;
410 const EC_POINT
*point
;
411 int is_prime
, len
= 0;
412 const EC_METHOD
*meth
= EC_GROUP_method_of(group
);
414 if ((ec_p
= BN_new()) == NULL
|| (ec_a
= BN_new()) == NULL
||
415 (ec_b
= BN_new()) == NULL
|| (ec_gen
= BN_new()) == NULL
||
416 (ec_order
= BN_new()) == NULL
||
417 (ec_cofactor
= BN_new()) == NULL
) {
421 is_prime
= (EC_METHOD_get_field_type(meth
) ==
422 NID_X9_62_prime_field
);
425 if (!EC_GROUP_get_curve_GFp(group
, ec_p
, ec_a
,
429 if (!EC_GROUP_get_curve_GF2m(group
, ec_p
, ec_a
,
434 if ((point
= EC_GROUP_get0_generator(group
)) == NULL
)
436 if (!EC_POINT_point2bn(group
, point
,
437 EC_GROUP_get_point_conversion_form(group
), ec_gen
,
440 if (!EC_GROUP_get_order(group
, ec_order
, NULL
))
442 if (!EC_GROUP_get_cofactor(group
, ec_cofactor
, NULL
))
445 len
= BN_num_bits(ec_order
);
447 if ((tmp_len
= (size_t) BN_num_bytes(ec_p
)) > buf_len
)
449 if ((tmp_len
= (size_t) BN_num_bytes(ec_a
)) > buf_len
)
451 if ((tmp_len
= (size_t) BN_num_bytes(ec_b
)) > buf_len
)
453 if ((tmp_len
= (size_t) BN_num_bytes(ec_gen
)) > buf_len
)
455 if ((tmp_len
= (size_t) BN_num_bytes(ec_order
)) > buf_len
)
457 if ((tmp_len
= (size_t) BN_num_bytes(ec_cofactor
)) > buf_len
)
460 buffer
= malloc(buf_len
);
462 if (buffer
== NULL
) {
466 ecparam_print_var(out
, ec_p
, "ec_p", len
, buffer
);
467 ecparam_print_var(out
, ec_a
, "ec_a", len
, buffer
);
468 ecparam_print_var(out
, ec_b
, "ec_b", len
, buffer
);
469 ecparam_print_var(out
, ec_gen
, "ec_gen", len
, buffer
);
470 ecparam_print_var(out
, ec_order
, "ec_order", len
, buffer
);
471 ecparam_print_var(out
, ec_cofactor
, "ec_cofactor", len
,
474 BIO_printf(out
, "\n\n");
476 BIO_printf(out
, "EC_GROUP *get_ec_group_%d(void)\n\t{\n", len
);
477 BIO_printf(out
, "\tint ok=0;\n");
478 BIO_printf(out
, "\tEC_GROUP *group = NULL;\n");
479 BIO_printf(out
, "\tEC_POINT *point = NULL;\n");
480 BIO_printf(out
, "\tBIGNUM *tmp_1 = NULL, *tmp_2 = NULL, "
481 "*tmp_3 = NULL;\n\n");
482 BIO_printf(out
, "\tif ((tmp_1 = BN_bin2bn(ec_p_%d, "
483 "sizeof(ec_p_%d), NULL)) == NULL)\n\t\t"
484 "goto err;\n", len
, len
);
485 BIO_printf(out
, "\tif ((tmp_2 = BN_bin2bn(ec_a_%d, "
486 "sizeof(ec_a_%d), NULL)) == NULL)\n\t\t"
487 "goto err;\n", len
, len
);
488 BIO_printf(out
, "\tif ((tmp_3 = BN_bin2bn(ec_b_%d, "
489 "sizeof(ec_b_%d), NULL)) == NULL)\n\t\t"
490 "goto err;\n", len
, len
);
492 BIO_printf(out
, "\tif ((group = EC_GROUP_new_curve_"
493 "GFp(tmp_1, tmp_2, tmp_3, NULL)) == NULL)"
494 "\n\t\tgoto err;\n\n");
496 BIO_printf(out
, "\tif ((group = EC_GROUP_new_curve_"
497 "GF2m(tmp_1, tmp_2, tmp_3, NULL)) == NULL)"
498 "\n\t\tgoto err;\n\n");
500 BIO_printf(out
, "\t/* build generator */\n");
501 BIO_printf(out
, "\tif ((tmp_1 = BN_bin2bn(ec_gen_%d, "
502 "sizeof(ec_gen_%d), tmp_1)) == NULL)"
503 "\n\t\tgoto err;\n", len
, len
);
504 BIO_printf(out
, "\tpoint = EC_POINT_bn2point(group, tmp_1, "
506 BIO_printf(out
, "\tif (point == NULL)\n\t\tgoto err;\n");
507 BIO_printf(out
, "\tif ((tmp_2 = BN_bin2bn(ec_order_%d, "
508 "sizeof(ec_order_%d), tmp_2)) == NULL)"
509 "\n\t\tgoto err;\n", len
, len
);
510 BIO_printf(out
, "\tif ((tmp_3 = BN_bin2bn(ec_cofactor_%d, "
511 "sizeof(ec_cofactor_%d), tmp_3)) == NULL)"
512 "\n\t\tgoto err;\n", len
, len
);
513 BIO_printf(out
, "\tif (!EC_GROUP_set_generator(group, point,"
514 " tmp_2, tmp_3))\n\t\tgoto err;\n");
515 BIO_printf(out
, "\n\tok=1;\n");
516 BIO_printf(out
, "err:\n");
517 BIO_printf(out
, "\tif (tmp_1)\n\t\tBN_free(tmp_1);\n");
518 BIO_printf(out
, "\tif (tmp_2)\n\t\tBN_free(tmp_2);\n");
519 BIO_printf(out
, "\tif (tmp_3)\n\t\tBN_free(tmp_3);\n");
520 BIO_printf(out
, "\tif (point)\n\t\tEC_POINT_free(point);\n");
521 BIO_printf(out
, "\tif (!ok)\n");
522 BIO_printf(out
, "\t\t{\n");
523 BIO_printf(out
, "\t\tEC_GROUP_free(group);\n");
524 BIO_printf(out
, "\t\tgroup = NULL;\n");
525 BIO_printf(out
, "\t\t}\n");
526 BIO_printf(out
, "\treturn(group);\n\t}\n");
528 if (!ecparam_config
.noout
) {
529 if (ecparam_config
.outformat
== FORMAT_ASN1
)
530 i
= i2d_ECPKParameters_bio(out
, group
);
531 else if (ecparam_config
.outformat
== FORMAT_PEM
)
532 i
= PEM_write_bio_ECPKParameters(out
, group
);
534 BIO_printf(bio_err
, "bad output format specified for"
539 BIO_printf(bio_err
, "unable to write elliptic "
540 "curve parameters\n");
541 ERR_print_errors(bio_err
);
545 if (ecparam_config
.genkey
) {
546 EC_KEY
*eckey
= EC_KEY_new();
551 if (EC_KEY_set_group(eckey
, group
) == 0) {
556 if (!EC_KEY_generate_key(eckey
)) {
560 if (ecparam_config
.outformat
== FORMAT_ASN1
)
561 i
= i2d_ECPrivateKey_bio(out
, eckey
);
562 else if (ecparam_config
.outformat
== FORMAT_PEM
)
563 i
= PEM_write_bio_ECPrivateKey(out
, eckey
, NULL
,
564 NULL
, 0, NULL
, NULL
);
566 BIO_printf(bio_err
, "bad output format specified "
581 BN_free(ec_cofactor
);
587 EC_GROUP_free(group
);
593 ecparam_print_var(BIO
* out
, BIGNUM
* in
, const char *var
,
594 int len
, unsigned char *buffer
)
596 BIO_printf(out
, "static unsigned char %s_%d[] = {", var
, len
);
598 BIO_printf(out
, "\n\t0x00");
602 l
= BN_bn2bin(in
, buffer
);
603 for (i
= 0; i
< l
- 1; i
++) {
605 BIO_printf(out
, "\n\t");
606 BIO_printf(out
, "0x%02X,", buffer
[i
]);
609 BIO_printf(out
, "\n\t");
610 BIO_printf(out
, "0x%02X", buffer
[i
]);
612 BIO_printf(out
, "\n\t};\n\n");