apps/ecparam.c

   1 /*
   2  * Written by Nils Larsch for the OpenSSL project.
   3  */
   4 /* ====================================================================
   5  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. All advertising materials mentioning features or use of this
  20  *    software must display the following acknowledgment:
  21  *    "This product includes software developed by the OpenSSL Project
  22  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23  *
  24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25  *    endorse or promote products derived from this software without
  26  *    prior written permission. For written permission, please contact
  27  *    openssl-core@openssl.org.
  28  *
  29  * 5. Products derived from this software may not be called "OpenSSL"
  30  *    nor may "OpenSSL" appear in their names without prior written
  31  *    permission of the OpenSSL Project.
  32  *
  33  * 6. Redistributions of any form whatsoever must retain the following
  34  *    acknowledgment:
  35  *    "This product includes software developed by the OpenSSL Project
  36  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37  *
  38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49  * OF THE POSSIBILITY OF SUCH DAMAGE.
  50  * ====================================================================
  51  *
  52  * This product includes cryptographic software written by Eric Young
  53  * (eay@cryptsoft.com).  This product includes software written by Tim
  54  * Hudson (tjh@cryptsoft.com).
  55  *
  56  */
  57 /* ====================================================================
  58  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  59  *
  60  * Portions of the attached software ("Contribution") are developed by
  61  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
  62  *
  63  * The Contribution is licensed pursuant to the OpenSSL open source
  64  * license provided above.
  65  *
  66  * The elliptic curve binary polynomial software is originally written by
  67  * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories.
  68  *
  69  */
  70
  71 #include <openssl/opensslconf.h>
  72 #ifndef OPENSSL_NO_EC
  73 # include <assert.h>
  74 # include <stdio.h>
  75 # include <stdlib.h>
  76 # include <time.h>
  77 # include <string.h>
  78 # include "apps.h"
  79 # include <openssl/bio.h>
  80 # include <openssl/err.h>
  81 # include <openssl/bn.h>
  82 # include <openssl/ec.h>
  83 # include <openssl/x509.h>
  84 # include <openssl/pem.h>
  85
  86 typedef enum OPTION_choice {
  87     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  88     OPT_INFORM, OPT_OUTFORM, OPT_IN, OPT_OUT, OPT_TEXT, OPT_C,
  89     OPT_CHECK, OPT_LIST_CURVES, OPT_NO_SEED, OPT_NOOUT, OPT_NAME,
  90     OPT_CONV_FORM, OPT_PARAM_ENC, OPT_GENKEY, OPT_RAND, OPT_ENGINE
  91 } OPTION_CHOICE;
  92
  93 OPTIONS ecparam_options[] = {
  94     {"help", OPT_HELP, '-', "Display this summary"},
  95     {"inform", OPT_INFORM, 'F', "Input format - default PEM (DER or PEM)"},
  96     {"outform", OPT_OUTFORM, 'F', "Output format - default PEM"},
  97     {"in", OPT_IN, '<', "Input file  - default stdin"},
  98     {"out", OPT_OUT, '>', "Output file - default stdout"},
  99     {"text", OPT_TEXT, '-', "Print the ec parameters in text form"},
 100     {"C", OPT_C, '-', "Print a 'C' function creating the parameters"},
 101     {"check", OPT_CHECK, '-', "Validate the ec parameters"},
 102     {"list_curves", OPT_LIST_CURVES, '-',
 103      "Prints a list of all curve 'short names'"},
 104     {"no_seed", OPT_NO_SEED, '-',
 105      "If 'explicit' parameters are chosen do not use the seed"},
 106     {"noout", OPT_NOOUT, '-', "Do not print the ec parameter"},
 107     {"name", OPT_NAME, 's',
 108      "Use the ec parameters with specified 'short name'"},
 109     {"conv_form", OPT_CONV_FORM, 's', "Specifies the point conversion form "},
 110     {"param_enc", OPT_PARAM_ENC, 's',
 111      "Specifies the way the ec parameters are encoded"},
 112     {"genkey", OPT_GENKEY, '-', "Generate ec key"},
 113     {"rand", OPT_RAND, 's', "Files to use for random number input"},
 114 # ifndef OPENSSL_NO_ENGINE
 115     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
 116 # endif
 117     {NULL}
 118 };
 119
 120 OPT_PAIR forms[] = {
 121     {"compressed", POINT_CONVERSION_COMPRESSED},
 122     {"uncompressed", POINT_CONVERSION_UNCOMPRESSED},
 123     {"hybrid", POINT_CONVERSION_HYBRID},
 124     {NULL}
 125 };
 126
 127 OPT_PAIR encodings[] = {
 128     {"named_curve", OPENSSL_EC_NAMED_CURVE},
 129     {"explicit", 0},
 130     {NULL}
 131 };
 132
 133 int ecparam_main(int argc, char **argv)
 134 {
 135     BIGNUM *ec_gen = NULL, *ec_order = NULL, *ec_cofactor = NULL;
 136     BIGNUM *ec_p = NULL, *ec_a = NULL, *ec_b = NULL;
 137     BIO *in = NULL, *out = NULL;
 138     EC_GROUP *group = NULL;
 139     point_conversion_form_t form = POINT_CONVERSION_UNCOMPRESSED;
 140     char *curve_name = NULL, *inrand = NULL;
 141     char *infile = NULL, *outfile = NULL, *prog;
 142     unsigned char *buffer = NULL;
 143     OPTION_CHOICE o;
 144     int asn1_flag = OPENSSL_EC_NAMED_CURVE, new_asn1_flag = 0;
 145     int informat = FORMAT_PEM, outformat = FORMAT_PEM, noout = 0, C = 0, ret =
 146         1;
 147     int list_curves = 0, no_seed = 0, check = 0, new_form = 0;
 148     int text = 0, i, need_rand = 0, genkey = 0;
 149
 150     prog = opt_init(argc, argv, ecparam_options);
 151     while ((o = opt_next()) != OPT_EOF) {
 152         switch (o) {
 153         case OPT_EOF:
 154         case OPT_ERR:
 155  opthelp:
 156             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 157             goto end;
 158         case OPT_HELP:
 159             opt_help(ecparam_options);
 160             ret = 0;
 161             goto end;
 162         case OPT_INFORM:
 163             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
 164                 goto opthelp;
 165             break;
 166         case OPT_IN:
 167             infile = opt_arg();
 168             break;
 169         case OPT_OUTFORM:
 170             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
 171                 goto opthelp;
 172             break;
 173         case OPT_OUT:
 174             outfile = opt_arg();
 175             break;
 176         case OPT_TEXT:
 177             text = 1;
 178             break;
 179         case OPT_C:
 180             C = 1;
 181             break;
 182         case OPT_CHECK:
 183             check = 1;
 184             break;
 185         case OPT_LIST_CURVES:
 186             list_curves = 1;
 187             break;
 188         case OPT_NO_SEED:
 189             no_seed = 1;
 190             break;
 191         case OPT_NOOUT:
 192             noout = 1;
 193             break;
 194         case OPT_NAME:
 195             curve_name = opt_arg();
 196             break;
 197         case OPT_CONV_FORM:
 198             if (!opt_pair(opt_arg(), forms, &new_form))
 199                 goto opthelp;
 200             form = new_form;
 201             new_form = 1;
 202             break;
 203         case OPT_PARAM_ENC:
 204             if (!opt_pair(opt_arg(), encodings, &asn1_flag))
 205                 goto opthelp;
 206             new_asn1_flag = 1;
 207             break;
 208         case OPT_GENKEY:
 209             genkey = need_rand = 1;
 210             break;
 211         case OPT_RAND:
 212             inrand = opt_arg();
 213             need_rand = 1;
 214             break;
 215         case OPT_ENGINE:
 216             (void)setup_engine(opt_arg(), 0);
 217             break;
 218         }
 219     }
 220     argc = opt_num_rest();
 221     argv = opt_rest();
 222
 223     in = bio_open_default(infile, RB(informat));
 224     if (in == NULL)
 225         goto end;
 226     out = bio_open_default(outfile, WB(outformat));
 227     if (out == NULL)
 228         goto end;
 229
 230     if (list_curves) {
 231         EC_builtin_curve *curves = NULL;
 232         size_t crv_len = EC_get_builtin_curves(NULL, 0);
 233         size_t n;
 234
 235         curves = app_malloc((int)(sizeof *curves * crv_len), "list curves");
 236         if (!EC_get_builtin_curves(curves, crv_len)) {
 237             OPENSSL_free(curves);
 238             goto end;
 239         }
 240
 241         for (n = 0; n < crv_len; n++) {
 242             const char *comment;
 243             const char *sname;
 244             comment = curves[n].comment;
 245             sname = OBJ_nid2sn(curves[n].nid);
 246             if (comment == NULL)
 247                 comment = "CURVE DESCRIPTION NOT AVAILABLE";
 248             if (sname == NULL)
 249                 sname = "";
 250
 251             BIO_printf(out, "  %-10s: ", sname);
 252             BIO_printf(out, "%s\n", comment);
 253         }
 254
 255         OPENSSL_free(curves);
 256         ret = 0;
 257         goto end;
 258     }
 259
 260     if (curve_name != NULL) {
 261         int nid;
 262
 263         /*
 264          * workaround for the SECG curve names secp192r1 and secp256r1 (which
 265          * are the same as the curves prime192v1 and prime256v1 defined in
 266          * X9.62)
 267          */
 268         if (!strcmp(curve_name, "secp192r1")) {
 269             BIO_printf(bio_err, "using curve name prime192v1 "
 270                        "instead of secp192r1\n");
 271             nid = NID_X9_62_prime192v1;
 272         } else if (!strcmp(curve_name, "secp256r1")) {
 273             BIO_printf(bio_err, "using curve name prime256v1 "
 274                        "instead of secp256r1\n");
 275             nid = NID_X9_62_prime256v1;
 276         } else
 277             nid = OBJ_sn2nid(curve_name);
 278
 279         if (nid == 0)
 280             nid = EC_curve_nist2nid(curve_name);
 281
 282         if (nid == 0) {
 283             BIO_printf(bio_err, "unknown curve name (%s)\n", curve_name);
 284             goto end;
 285         }
 286
 287         group = EC_GROUP_new_by_curve_name(nid);
 288         if (group == NULL) {
 289             BIO_printf(bio_err, "unable to create curve (%s)\n", curve_name);
 290             goto end;
 291         }
 292         EC_GROUP_set_asn1_flag(group, asn1_flag);
 293         EC_GROUP_set_point_conversion_form(group, form);
 294     } else if (informat == FORMAT_ASN1)
 295         group = d2i_ECPKParameters_bio(in, NULL);
 296     else
 297         group = PEM_read_bio_ECPKParameters(in, NULL, NULL, NULL);
 298     if (group == NULL) {
 299         BIO_printf(bio_err, "unable to load elliptic curve parameters\n");
 300         ERR_print_errors(bio_err);
 301         goto end;
 302     }
 303
 304     if (new_form)
 305         EC_GROUP_set_point_conversion_form(group, form);
 306
 307     if (new_asn1_flag)
 308         EC_GROUP_set_asn1_flag(group, asn1_flag);
 309
 310     if (no_seed) {
 311         EC_GROUP_set_seed(group, NULL, 0);
 312     }
 313
 314     if (text) {
 315         if (!ECPKParameters_print(out, group, 0))
 316             goto end;
 317     }
 318
 319     if (check) {
 320         if (group == NULL)
 321             BIO_printf(bio_err, "no elliptic curve parameters\n");
 322         BIO_printf(bio_err, "checking elliptic curve parameters: ");
 323         if (!EC_GROUP_check(group, NULL)) {
 324             BIO_printf(bio_err, "failed\n");
 325             ERR_print_errors(bio_err);
 326         } else
 327             BIO_printf(bio_err, "ok\n");
 328
 329     }
 330
 331     if (C) {
 332         size_t buf_len = 0, tmp_len = 0;
 333         const EC_POINT *point;
 334         int is_prime, len = 0;
 335         const EC_METHOD *meth = EC_GROUP_method_of(group);
 336
 337         if ((ec_p = BN_new()) == NULL
 338                 || (ec_a = BN_new()) == NULL
 339                 || (ec_b = BN_new()) == NULL
 340                 || (ec_gen = BN_new()) == NULL
 341                 || (ec_order = BN_new()) == NULL
 342                 || (ec_cofactor = BN_new()) == NULL) {
 343             perror("Can't allocate BN");
 344             goto end;
 345         }
 346
 347         is_prime = (EC_METHOD_get_field_type(meth) == NID_X9_62_prime_field);
 348         if (!is_prime) {
 349             BIO_printf(bio_err, "Can only handle X9.62 prime fields\n");
 350             goto end;
 351         }
 352
 353         if (!EC_GROUP_get_curve_GFp(group, ec_p, ec_a, ec_b, NULL))
 354             goto end;
 355
 356         if ((point = EC_GROUP_get0_generator(group)) == NULL)
 357             goto end;
 358         if (!EC_POINT_point2bn(group, point,
 359                                EC_GROUP_get_point_conversion_form(group),
 360                                ec_gen, NULL))
 361             goto end;
 362         if (!EC_GROUP_get_order(group, ec_order, NULL))
 363             goto end;
 364         if (!EC_GROUP_get_cofactor(group, ec_cofactor, NULL))
 365             goto end;
 366
 367         if (!ec_p || !ec_a || !ec_b || !ec_gen || !ec_order || !ec_cofactor)
 368             goto end;
 369
 370         len = BN_num_bits(ec_order);
 371
 372         if ((tmp_len = (size_t)BN_num_bytes(ec_p)) > buf_len)
 373             buf_len = tmp_len;
 374         if ((tmp_len = (size_t)BN_num_bytes(ec_a)) > buf_len)
 375             buf_len = tmp_len;
 376         if ((tmp_len = (size_t)BN_num_bytes(ec_b)) > buf_len)
 377             buf_len = tmp_len;
 378         if ((tmp_len = (size_t)BN_num_bytes(ec_gen)) > buf_len)
 379             buf_len = tmp_len;
 380         if ((tmp_len = (size_t)BN_num_bytes(ec_order)) > buf_len)
 381             buf_len = tmp_len;
 382         if ((tmp_len = (size_t)BN_num_bytes(ec_cofactor)) > buf_len)
 383             buf_len = tmp_len;
 384
 385         buffer = app_malloc(buf_len, "BN buffer");
 386
 387         BIO_printf(out, "EC_GROUP *get_ec_group_%d(void)\n{\n", len);
 388         print_bignum_var(out, ec_p, "ec_p", len, buffer);
 389         print_bignum_var(out, ec_a, "ec_a", len, buffer);
 390         print_bignum_var(out, ec_b, "ec_b", len, buffer);
 391         print_bignum_var(out, ec_gen, "ec_gen", len, buffer);
 392         print_bignum_var(out, ec_order, "ec_order", len, buffer);
 393         print_bignum_var(out, ec_cofactor, "ec_cofactor", len, buffer);
 394         BIO_printf(out, "    int ok = 0;\n"
 395                         "    EC_GROUP *group = NULL;\n"
 396                         "    EC_POINT *point = NULL;\n"
 397                         "    BIGNUM *tmp_1 = NULL;\n"
 398                         "    BIGNUM *tmp_2 = NULL;\n"
 399                         "    BIGNUM *tmp_3 = NULL;\n"
 400                         "\n");
 401
 402         BIO_printf(out, "    if ((tmp_1 = BN_bin2bn(ec_p_%d, sizeof (ec_p_%d), NULL)) == NULL)\n"
 403                         "        goto err;\n", len, len);
 404         BIO_printf(out, "    if ((tmp_2 = BN_bin2bn(ec_a_%d, sizeof (ec_a_%d), NULL)) == NULL)\n"
 405                         "        goto err;\n", len, len);
 406         BIO_printf(out, "    if ((tmp_3 = BN_bin2bn(ec_b_%d, sizeof (ec_b_%d), NULL)) == NULL)\n"
 407                         "        goto err;\n", len, len);
 408         BIO_printf(out, "    if ((group = EC_GROUP_new_curve_GFp(tmp_1, tmp_2, tmp_3, NULL)) == NULL)\n"
 409                         "        goto err;\n"
 410                         "\n");
 411         BIO_printf(out, "    /* build generator */\n");
 412         BIO_printf(out, "    if ((tmp_1 = BN_bin2bn(ec_gen_%d, sizeof (ec_gen_%d), tmp_1)) == NULL)\n"
 413                         "        goto err;\n", len, len);
 414         BIO_printf(out, "    point = EC_POINT_bn2point(group, tmp_1, NULL, NULL);\n");
 415         BIO_printf(out, "    if (point == NULL)\n"
 416                         "        goto err;\n");
 417         BIO_printf(out, "    if ((tmp_2 = BN_bin2bn(ec_order_%d, sizeof (ec_order_%d), tmp_2)) == NULL)\n"
 418                         "        goto err;\n", len, len);
 419         BIO_printf(out, "    if ((tmp_3 = BN_bin2bn(ec_cofactor_%d, sizeof (ec_cofactor_%d), tmp_3)) == NULL)\n"
 420                         "        goto err;\n", len, len);
 421         BIO_printf(out, "    if (!EC_GROUP_set_generator(group, point, tmp_2, tmp_3))\n"
 422                         "        goto err;\n"
 423                         "ok = 1;"
 424                         "\n");
 425         BIO_printf(out, "err:\n"
 426                         "    BN_free(tmp_1);\n"
 427                         "    BN_free(tmp_2);\n"
 428                         "    BN_free(tmp_3);\n"
 429                         "    EC_POINT_free(point);\n"
 430                         "    if (!ok) {\n"
 431                         "        EC_GROUP_free(group);\n"
 432                         "        return NULL;\n"
 433                         "    }\n"
 434                         "    return (group);\n"
 435                         "}\n");
 436     }
 437
 438     if (!noout) {
 439         if (outformat == FORMAT_ASN1)
 440             i = i2d_ECPKParameters_bio(out, group);
 441         else
 442             i = PEM_write_bio_ECPKParameters(out, group);
 443         if (!i) {
 444             BIO_printf(bio_err, "unable to write elliptic "
 445                        "curve parameters\n");
 446             ERR_print_errors(bio_err);
 447             goto end;
 448         }
 449     }
 450
 451     if (need_rand) {
 452         app_RAND_load_file(NULL, (inrand != NULL));
 453         if (inrand != NULL)
 454             BIO_printf(bio_err, "%ld semi-random bytes loaded\n",
 455                        app_RAND_load_files(inrand));
 456     }
 457
 458     if (genkey) {
 459         EC_KEY *eckey = EC_KEY_new();
 460
 461         if (eckey == NULL)
 462             goto end;
 463
 464         assert(need_rand);
 465
 466         if (EC_KEY_set_group(eckey, group) == 0)
 467             goto end;
 468
 469         if (!EC_KEY_generate_key(eckey)) {
 470             EC_KEY_free(eckey);
 471             goto end;
 472         }
 473         if (outformat == FORMAT_ASN1)
 474             i = i2d_ECPrivateKey_bio(out, eckey);
 475         else
 476             i = PEM_write_bio_ECPrivateKey(out, eckey, NULL,
 477                                            NULL, 0, NULL, NULL);
 478         EC_KEY_free(eckey);
 479     }
 480
 481     if (need_rand)
 482         app_RAND_write_file(NULL);
 483
 484     ret = 0;
 485  end:
 486     BN_free(ec_p);
 487     BN_free(ec_a);
 488     BN_free(ec_b);
 489     BN_free(ec_gen);
 490     BN_free(ec_order);
 491     BN_free(ec_cofactor);
 492     if (buffer)
 493         OPENSSL_free(buffer);
 494     BIO_free(in);
 495     BIO_free_all(out);
 496     EC_GROUP_free(group);
 497     return (ret);
 498 }
 499
 500 #else                           /* !OPENSSL_NO_EC */
 501
 502 # if PEDANTIC
 503 static void *dummy = &dummy;
 504 # endif
 505
 506 #endif