apps/dhparam.c

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57 /* ====================================================================
  58  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
  59  *
  60  * Redistribution and use in source and binary forms, with or without
  61  * modification, are permitted provided that the following conditions
  62  * are met:
  63  *
  64  * 1. Redistributions of source code must retain the above copyright
  65  *    notice, this list of conditions and the following disclaimer.
  66  *
  67  * 2. Redistributions in binary form must reproduce the above copyright
  68  *    notice, this list of conditions and the following disclaimer in
  69  *    the documentation and/or other materials provided with the
  70  *    distribution.
  71  *
  72  * 3. All advertising materials mentioning features or use of this
  73  *    software must display the following acknowledgment:
  74  *    "This product includes software developed by the OpenSSL Project
  75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  76  *
  77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  78  *    endorse or promote products derived from this software without
  79  *    prior written permission. For written permission, please contact
  80  *    openssl-core@openssl.org.
  81  *
  82  * 5. Products derived from this software may not be called "OpenSSL"
  83  *    nor may "OpenSSL" appear in their names without prior written
  84  *    permission of the OpenSSL Project.
  85  *
  86  * 6. Redistributions of any form whatsoever must retain the following
  87  *    acknowledgment:
  88  *    "This product includes software developed by the OpenSSL Project
  89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  90  *
  91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 102  * OF THE POSSIBILITY OF SUCH DAMAGE.
 103  * ====================================================================
 104  *
 105  * This product includes cryptographic software written by Eric Young
 106  * (eay@cryptsoft.com).  This product includes software written by Tim
 107  * Hudson (tjh@cryptsoft.com).
 108  *
 109  */
 110
 111 #include <openssl/opensslconf.h> /* for OPENSSL_NO_DH */
 112 #ifndef OPENSSL_NO_DH
 113 # include <stdio.h>
 114 # include <stdlib.h>
 115 # include <time.h>
 116 # include <string.h>
 117 # include "apps.h"
 118 # include <openssl/bio.h>
 119 # include <openssl/err.h>
 120 # include <openssl/bn.h>
 121 # include <openssl/dh.h>
 122 # include <openssl/x509.h>
 123 # include <openssl/pem.h>
 124
 125 # ifndef OPENSSL_NO_DSA
 126 #  include <openssl/dsa.h>
 127 # endif
 128
 129 # define DEFBITS 2048
 130
 131 static int dh_cb(int p, int n, BN_GENCB *cb);
 132
 133 typedef enum OPTION_choice {
 134     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
 135     OPT_INFORM, OPT_OUTFORM, OPT_IN, OPT_OUT,
 136     OPT_ENGINE, OPT_CHECK, OPT_TEXT, OPT_NOOUT,
 137     OPT_RAND, OPT_DSAPARAM, OPT_C, OPT_2, OPT_5
 138 } OPTION_CHOICE;
 139
 140 OPTIONS dhparam_options[] = {
 141     {OPT_HELP_STR, 1, '-', "Usage: %s [flags] [numbits]\n"},
 142     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
 143     {"help", OPT_HELP, '-', "Display this summary"},
 144     {"in", OPT_IN, '<', "Input file"},
 145     {"inform", OPT_INFORM, 'F', "Input format, DER or PEM"},
 146     {"outform", OPT_OUTFORM, 'F', "Output format, DER or PEM"},
 147     {"out", OPT_OUT, '>', "Output file"},
 148     {"check", OPT_CHECK, '-', "Check the DH parameters"},
 149     {"text", OPT_TEXT, '-', "Print a text form of the DH parameters"},
 150     {"noout", OPT_NOOUT, '-'},
 151     {"rand", OPT_RAND, 's',
 152      "Load the file(s) into the random number generator"},
 153     {"C", OPT_C, '-', "Print C code"},
 154     {"2", OPT_2, '-', "Generate parameters using 2 as the generator value"},
 155     {"5", OPT_5, '-', "Generate parameters using 5 as the generator value"},
 156 # ifndef OPENSSL_NO_DSA
 157     {"dsaparam", OPT_DSAPARAM, '-',
 158      "Read or generate DSA parameters, convert to DH"},
 159 # endif
 160 # ifndef OPENSSL_NO_ENGINE
 161     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
 162 # endif
 163     {NULL}
 164 };
 165
 166 int dhparam_main(int argc, char **argv)
 167 {
 168     BIO *in = NULL, *out = NULL;
 169     DH *dh = NULL;
 170     char *infile = NULL, *outfile = NULL, *prog, *inrand = NULL;
 171     int dsaparam = 0, i, text = 0, C = 0, ret = 1, num = 0, g = 0;
 172     int informat = FORMAT_PEM, outformat = FORMAT_PEM, check = 0, noout = 0;
 173     OPTION_CHOICE o;
 174
 175     prog = opt_init(argc, argv, dhparam_options);
 176     while ((o = opt_next()) != OPT_EOF) {
 177         switch (o) {
 178         case OPT_EOF:
 179         case OPT_ERR:
 180  opthelp:
 181             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 182             goto end;
 183         case OPT_HELP:
 184             opt_help(dhparam_options);
 185             ret = 0;
 186             goto end;
 187         case OPT_INFORM:
 188             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
 189                 goto opthelp;
 190             break;
 191         case OPT_OUTFORM:
 192             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
 193                 goto opthelp;
 194             break;
 195         case OPT_IN:
 196             infile = opt_arg();
 197             break;
 198         case OPT_OUT:
 199             outfile = opt_arg();
 200             break;
 201         case OPT_ENGINE:
 202             (void)setup_engine(opt_arg(), 0);
 203             break;
 204         case OPT_CHECK:
 205             check = 1;
 206             break;
 207         case OPT_TEXT:
 208             text = 1;
 209             break;
 210         case OPT_DSAPARAM:
 211             dsaparam = 1;
 212             break;
 213         case OPT_C:
 214             C = 1;
 215             break;
 216         case OPT_2:
 217             g = 2;
 218             break;
 219         case OPT_5:
 220             g = 5;
 221             break;
 222         case OPT_NOOUT:
 223             noout = 1;
 224             break;
 225         case OPT_RAND:
 226             inrand = opt_arg();
 227             break;
 228         }
 229     }
 230     argc = opt_num_rest();
 231     argv = opt_rest();
 232
 233     if (argv[0] && (!opt_int(argv[0], &num) || num <= 0))
 234         goto end;
 235
 236     if (g && !num)
 237         num = DEFBITS;
 238
 239 # ifndef OPENSSL_NO_DSA
 240     if (dsaparam && g) {
 241         BIO_printf(bio_err,
 242                    "generator may not be chosen for DSA parameters\n");
 243         goto end;
 244     }
 245 # endif
 246     /* DH parameters */
 247     if (num && !g)
 248         g = 2;
 249
 250     if (num) {
 251
 252         BN_GENCB *cb;
 253         cb = BN_GENCB_new();
 254         if (cb == NULL) {
 255             ERR_print_errors(bio_err);
 256             goto end;
 257         }
 258
 259         BN_GENCB_set(cb, dh_cb, bio_err);
 260         if (!app_RAND_load_file(NULL, 1) && inrand == NULL) {
 261             BIO_printf(bio_err,
 262                        "warning, not much extra random data, consider using the -rand option\n");
 263         }
 264         if (inrand != NULL)
 265             BIO_printf(bio_err, "%ld semi-random bytes loaded\n",
 266                        app_RAND_load_files(inrand));
 267
 268 # ifndef OPENSSL_NO_DSA
 269         if (dsaparam) {
 270             DSA *dsa = DSA_new();
 271
 272             BIO_printf(bio_err,
 273                        "Generating DSA parameters, %d bit long prime\n", num);
 274             if (dsa == NULL
 275                 || !DSA_generate_parameters_ex(dsa, num, NULL, 0, NULL, NULL,
 276                                                cb)) {
 277                 DSA_free(dsa);
 278                 BN_GENCB_free(cb);
 279                 ERR_print_errors(bio_err);
 280                 goto end;
 281             }
 282
 283             dh = DSA_dup_DH(dsa);
 284             DSA_free(dsa);
 285             if (dh == NULL) {
 286                 BN_GENCB_free(cb);
 287                 ERR_print_errors(bio_err);
 288                 goto end;
 289             }
 290         } else
 291 # endif
 292         {
 293             dh = DH_new();
 294             BIO_printf(bio_err,
 295                        "Generating DH parameters, %d bit long safe prime, generator %d\n",
 296                        num, g);
 297             BIO_printf(bio_err, "This is going to take a long time\n");
 298             if (dh == NULL || !DH_generate_parameters_ex(dh, num, g, cb)) {
 299                 BN_GENCB_free(cb);
 300                 ERR_print_errors(bio_err);
 301                 goto end;
 302             }
 303         }
 304
 305         BN_GENCB_free(cb);
 306         app_RAND_write_file(NULL);
 307     } else {
 308
 309         in = bio_open_default(infile, 'r', informat);
 310         if (in == NULL)
 311             goto end;
 312
 313 # ifndef OPENSSL_NO_DSA
 314         if (dsaparam) {
 315             DSA *dsa;
 316
 317             if (informat == FORMAT_ASN1)
 318                 dsa = d2i_DSAparams_bio(in, NULL);
 319             else                /* informat == FORMAT_PEM */
 320                 dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
 321
 322             if (dsa == NULL) {
 323                 BIO_printf(bio_err, "unable to load DSA parameters\n");
 324                 ERR_print_errors(bio_err);
 325                 goto end;
 326             }
 327
 328             dh = DSA_dup_DH(dsa);
 329             DSA_free(dsa);
 330             if (dh == NULL) {
 331                 ERR_print_errors(bio_err);
 332                 goto end;
 333             }
 334         } else
 335 # endif
 336         {
 337             if (informat == FORMAT_ASN1)
 338                 dh = d2i_DHparams_bio(in, NULL);
 339             else                /* informat == FORMAT_PEM */
 340                 dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
 341
 342             if (dh == NULL) {
 343                 BIO_printf(bio_err, "unable to load DH parameters\n");
 344                 ERR_print_errors(bio_err);
 345                 goto end;
 346             }
 347         }
 348
 349         /* dh != NULL */
 350     }
 351
 352     out = bio_open_default(outfile, 'w', outformat);
 353     if (out == NULL)
 354         goto end;
 355
 356     if (text) {
 357         DHparams_print(out, dh);
 358     }
 359
 360     if (check) {
 361         if (!DH_check(dh, &i)) {
 362             ERR_print_errors(bio_err);
 363             goto end;
 364         }
 365         if (i & DH_CHECK_P_NOT_PRIME)
 366             printf("p value is not prime\n");
 367         if (i & DH_CHECK_P_NOT_SAFE_PRIME)
 368             printf("p value is not a safe prime\n");
 369         if (i & DH_UNABLE_TO_CHECK_GENERATOR)
 370             printf("unable to check the generator value\n");
 371         if (i & DH_NOT_SUITABLE_GENERATOR)
 372             printf("the g value is not a generator\n");
 373         if (i == 0)
 374             printf("DH parameters appear to be ok.\n");
 375     }
 376     if (C) {
 377         unsigned char *data;
 378         int len, bits;
 379
 380         len = BN_num_bytes(dh->p);
 381         bits = BN_num_bits(dh->p);
 382         data = app_malloc(len, "print a BN");
 383         BIO_printf(out, "#ifndef HEADER_DH_H\n"
 384                         "# include <openssl/dh.h>\n"
 385                         "#endif\n"
 386                         "\n");
 387         BIO_printf(out, "DH *get_dh%d()\n{\n", bits);
 388         print_bignum_var(out, dh->p, "dhp", bits, data);
 389         print_bignum_var(out, dh->g, "dhg", bits, data);
 390         BIO_printf(out, "    DH *dh = DN_new();\n"
 391                         "\n"
 392                         "    if (dh == NULL)\n"
 393                         "        return NULL;\n");
 394         BIO_printf(out, "    dh->p = BN_bin2bn(dhp_%d, sizeof (dhp_%d), NULL);\n",
 395                bits, bits);
 396         BIO_printf(out, "    dh->g = BN_bin2bn(dhg_%d, sizeof (dhg_%d), NULL);\n",
 397                bits, bits);
 398         BIO_printf(out, "    if (!dh->p || !dh->g) {\n"
 399                         "        DH_free(dh);\n"
 400                         "        return NULL;\n"
 401                         "    }\n");
 402         if (dh->length)
 403             BIO_printf(out,
 404                         "    dh->length = %ld;\n", dh->length);
 405         BIO_printf(out, "    return dh;\n}\n");
 406         OPENSSL_free(data);
 407     }
 408
 409     if (!noout) {
 410         if (outformat == FORMAT_ASN1)
 411             i = i2d_DHparams_bio(out, dh);
 412         else if (dh->q)
 413             i = PEM_write_bio_DHxparams(out, dh);
 414         else
 415             i = PEM_write_bio_DHparams(out, dh);
 416         if (!i) {
 417             BIO_printf(bio_err, "unable to write DH parameters\n");
 418             ERR_print_errors(bio_err);
 419             goto end;
 420         }
 421     }
 422     ret = 0;
 423  end:
 424     BIO_free(in);
 425     BIO_free_all(out);
 426     DH_free(dh);
 427     return (ret);
 428 }
 429
 430 static int dh_cb(int p, int n, BN_GENCB *cb)
 431 {
 432     char c = '*';
 433
 434     if (p == 0)
 435         c = '.';
 436     if (p == 1)
 437         c = '+';
 438     if (p == 2)
 439         c = '*';
 440     if (p == 3)
 441         c = '\n';
 442     BIO_write(BN_GENCB_get_arg(cb), &c, 1);
 443     (void)BIO_flush(BN_GENCB_get_arg(cb));
 444     return 1;
 445 }
 446
 447 #else                           /* !OPENSSL_NO_DH */
 448
 449 # if PEDANTIC
 450 static void *dummy = &dummy;
 451 # endif
 452
 453 #endif