apps/dhparam.c

   1 /* apps/dhparam.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58 /* ====================================================================
  59  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111
 112 #include <openssl/opensslconf.h> /* for OPENSSL_NO_DH */
 113 #ifndef OPENSSL_NO_DH
 114 # include <stdio.h>
 115 # include <stdlib.h>
 116 # include <time.h>
 117 # include <string.h>
 118 # include "apps.h"
 119 # include <openssl/bio.h>
 120 # include <openssl/err.h>
 121 # include <openssl/bn.h>
 122 # include <openssl/dh.h>
 123 # include <openssl/x509.h>
 124 # include <openssl/pem.h>
 125
 126 # ifndef OPENSSL_NO_DSA
 127 #  include <openssl/dsa.h>
 128 # endif
 129
 130 # undef PROG
 131 # define PROG    dhparam_main
 132
 133 # define DEFBITS 2048
 134
 135 /*-
 136  * -inform arg  - input format - default PEM (DER or PEM)
 137  * -outform arg - output format - default PEM
 138  * -in arg      - input file - default stdin
 139  * -out arg     - output file - default stdout
 140  * -dsaparam  - read or generate DSA parameters, convert to DH
 141  * -check       - check the parameters are ok
 142  * -noout
 143  * -text
 144  * -C
 145  */
 146
 147 static int dh_cb(int p, int n, BN_GENCB *cb);
 148
 149 int MAIN(int, char **);
 150
 151 int MAIN(int argc, char **argv)
 152 {
 153     DH *dh = NULL;
 154     int i, badops = 0, text = 0;
 155 # ifndef OPENSSL_NO_DSA
 156     int dsaparam = 0;
 157 # endif
 158     BIO *in = NULL, *out = NULL;
 159     int informat, outformat, check = 0, noout = 0, C = 0, ret = 1;
 160     char *infile, *outfile, *prog;
 161     char *inrand = NULL;
 162 # ifndef OPENSSL_NO_ENGINE
 163     char *engine = NULL;
 164 # endif
 165     int num = 0, g = 0;
 166
 167     apps_startup();
 168
 169     if (bio_err == NULL)
 170         if ((bio_err = BIO_new(BIO_s_file())) != NULL)
 171             BIO_set_fp(bio_err, stderr, BIO_NOCLOSE | BIO_FP_TEXT);
 172
 173     if (!load_config(bio_err, NULL))
 174         goto end;
 175
 176     infile = NULL;
 177     outfile = NULL;
 178     informat = FORMAT_PEM;
 179     outformat = FORMAT_PEM;
 180
 181     prog = argv[0];
 182     argc--;
 183     argv++;
 184     while (argc >= 1) {
 185         if (strcmp(*argv, "-inform") == 0) {
 186             if (--argc < 1)
 187                 goto bad;
 188             informat = str2fmt(*(++argv));
 189         } else if (strcmp(*argv, "-outform") == 0) {
 190             if (--argc < 1)
 191                 goto bad;
 192             outformat = str2fmt(*(++argv));
 193         } else if (strcmp(*argv, "-in") == 0) {
 194             if (--argc < 1)
 195                 goto bad;
 196             infile = *(++argv);
 197         } else if (strcmp(*argv, "-out") == 0) {
 198             if (--argc < 1)
 199                 goto bad;
 200             outfile = *(++argv);
 201         }
 202 # ifndef OPENSSL_NO_ENGINE
 203         else if (strcmp(*argv, "-engine") == 0) {
 204             if (--argc < 1)
 205                 goto bad;
 206             engine = *(++argv);
 207         }
 208 # endif
 209         else if (strcmp(*argv, "-check") == 0)
 210             check = 1;
 211         else if (strcmp(*argv, "-text") == 0)
 212             text = 1;
 213 # ifndef OPENSSL_NO_DSA
 214         else if (strcmp(*argv, "-dsaparam") == 0)
 215             dsaparam = 1;
 216 # endif
 217         else if (strcmp(*argv, "-C") == 0)
 218             C = 1;
 219         else if (strcmp(*argv, "-noout") == 0)
 220             noout = 1;
 221         else if (strcmp(*argv, "-2") == 0)
 222             g = 2;
 223         else if (strcmp(*argv, "-5") == 0)
 224             g = 5;
 225         else if (strcmp(*argv, "-rand") == 0) {
 226             if (--argc < 1)
 227                 goto bad;
 228             inrand = *(++argv);
 229         } else if (((sscanf(*argv, "%d", &num) == 0) || (num <= 0)))
 230             goto bad;
 231         argv++;
 232         argc--;
 233     }
 234
 235     if (badops) {
 236  bad:
 237         BIO_printf(bio_err, "%s [options] [numbits]\n", prog);
 238         BIO_printf(bio_err, "where options are\n");
 239         BIO_printf(bio_err, " -inform arg   input format - one of DER PEM\n");
 240         BIO_printf(bio_err,
 241                    " -outform arg  output format - one of DER PEM\n");
 242         BIO_printf(bio_err, " -in arg       input file\n");
 243         BIO_printf(bio_err, " -out arg      output file\n");
 244 # ifndef OPENSSL_NO_DSA
 245         BIO_printf(bio_err,
 246                    " -dsaparam     read or generate DSA parameters, convert to DH\n");
 247 # endif
 248         BIO_printf(bio_err, " -check        check the DH parameters\n");
 249         BIO_printf(bio_err,
 250                    " -text         print a text form of the DH parameters\n");
 251         BIO_printf(bio_err, " -C            Output C code\n");
 252         BIO_printf(bio_err,
 253                    " -2            generate parameters using  2 as the generator value\n");
 254         BIO_printf(bio_err,
 255                    " -5            generate parameters using  5 as the generator value\n");
 256         BIO_printf(bio_err,
 257                    " numbits       number of bits in to generate (default 2048)\n");
 258 # ifndef OPENSSL_NO_ENGINE
 259         BIO_printf(bio_err,
 260                    " -engine e     use engine e, possibly a hardware device.\n");
 261 # endif
 262         BIO_printf(bio_err, " -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR,
 263                    LIST_SEPARATOR_CHAR);
 264         BIO_printf(bio_err,
 265                    "               - load the file (or the files in the directory) into\n");
 266         BIO_printf(bio_err, "               the random number generator\n");
 267         BIO_printf(bio_err, " -noout        no output\n");
 268         goto end;
 269     }
 270
 271     ERR_load_crypto_strings();
 272
 273 # ifndef OPENSSL_NO_ENGINE
 274     setup_engine(bio_err, engine, 0);
 275 # endif
 276
 277     if (g && !num)
 278         num = DEFBITS;
 279
 280 # ifndef OPENSSL_NO_DSA
 281     if (dsaparam) {
 282         if (g) {
 283             BIO_printf(bio_err,
 284                        "generator may not be chosen for DSA parameters\n");
 285             goto end;
 286         }
 287     } else
 288 # endif
 289     {
 290         /* DH parameters */
 291         if (num && !g)
 292             g = 2;
 293     }
 294
 295     if (num) {
 296
 297         BN_GENCB *cb;
 298         cb = BN_GENCB_new();
 299         if (!cb) {
 300             ERR_print_errors(bio_err);
 301             goto end;
 302         }
 303
 304         BN_GENCB_set(cb, dh_cb, bio_err);
 305         if (!app_RAND_load_file(NULL, bio_err, 1) && inrand == NULL) {
 306             BIO_printf(bio_err,
 307                        "warning, not much extra random data, consider using the -rand option\n");
 308         }
 309         if (inrand != NULL)
 310             BIO_printf(bio_err, "%ld semi-random bytes loaded\n",
 311                        app_RAND_load_files(inrand));
 312
 313 # ifndef OPENSSL_NO_DSA
 314         if (dsaparam) {
 315             DSA *dsa = DSA_new();
 316
 317             BIO_printf(bio_err,
 318                        "Generating DSA parameters, %d bit long prime\n", num);
 319             if (!dsa
 320                 || !DSA_generate_parameters_ex(dsa, num, NULL, 0, NULL, NULL,
 321                                                cb)) {
 322                 DSA_free(dsa);
 323                 BN_GENCB_free(cb);
 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                 BN_GENCB_free(cb);
 332                 ERR_print_errors(bio_err);
 333                 goto end;
 334             }
 335         } else
 336 # endif
 337         {
 338             dh = DH_new();
 339             BIO_printf(bio_err,
 340                        "Generating DH parameters, %d bit long safe prime, generator %d\n",
 341                        num, g);
 342             BIO_printf(bio_err, "This is going to take a long time\n");
 343             if (!dh || !DH_generate_parameters_ex(dh, num, g, cb)) {
 344                 BN_GENCB_free(cb);
 345                 ERR_print_errors(bio_err);
 346                 goto end;
 347             }
 348         }
 349
 350         BN_GENCB_free(cb);
 351         app_RAND_write_file(NULL, bio_err);
 352     } else {
 353
 354         in = BIO_new(BIO_s_file());
 355         if (in == NULL) {
 356             ERR_print_errors(bio_err);
 357             goto end;
 358         }
 359         if (infile == NULL)
 360             BIO_set_fp(in, stdin, BIO_NOCLOSE);
 361         else {
 362             if (BIO_read_filename(in, infile) <= 0) {
 363                 perror(infile);
 364                 goto end;
 365             }
 366         }
 367
 368         if (informat != FORMAT_ASN1 && informat != FORMAT_PEM) {
 369             BIO_printf(bio_err, "bad input format specified\n");
 370             goto end;
 371         }
 372 # ifndef OPENSSL_NO_DSA
 373         if (dsaparam) {
 374             DSA *dsa;
 375
 376             if (informat == FORMAT_ASN1)
 377                 dsa = d2i_DSAparams_bio(in, NULL);
 378             else                /* informat == FORMAT_PEM */
 379                 dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
 380
 381             if (dsa == NULL) {
 382                 BIO_printf(bio_err, "unable to load DSA parameters\n");
 383                 ERR_print_errors(bio_err);
 384                 goto end;
 385             }
 386
 387             dh = DSA_dup_DH(dsa);
 388             DSA_free(dsa);
 389             if (dh == NULL) {
 390                 ERR_print_errors(bio_err);
 391                 goto end;
 392             }
 393         } else
 394 # endif
 395         {
 396             if (informat == FORMAT_ASN1)
 397                 dh = d2i_DHparams_bio(in, NULL);
 398             else                /* informat == FORMAT_PEM */
 399                 dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
 400
 401             if (dh == NULL) {
 402                 BIO_printf(bio_err, "unable to load DH parameters\n");
 403                 ERR_print_errors(bio_err);
 404                 goto end;
 405             }
 406         }
 407
 408         /* dh != NULL */
 409     }
 410
 411     out = BIO_new(BIO_s_file());
 412     if (out == NULL) {
 413         ERR_print_errors(bio_err);
 414         goto end;
 415     }
 416     if (outfile == NULL) {
 417         BIO_set_fp(out, stdout, BIO_NOCLOSE);
 418 # ifdef OPENSSL_SYS_VMS
 419         {
 420             BIO *tmpbio = BIO_new(BIO_f_linebuffer());
 421             out = BIO_push(tmpbio, out);
 422         }
 423 # endif
 424     } else {
 425         if (BIO_write_filename(out, outfile) <= 0) {
 426             perror(outfile);
 427             goto end;
 428         }
 429     }
 430
 431     if (text) {
 432         DHparams_print(out, dh);
 433     }
 434
 435     if (check) {
 436         if (!DH_check(dh, &i)) {
 437             ERR_print_errors(bio_err);
 438             goto end;
 439         }
 440         if (i & DH_CHECK_P_NOT_PRIME)
 441             printf("p value is not prime\n");
 442         if (i & DH_CHECK_P_NOT_SAFE_PRIME)
 443             printf("p value is not a safe prime\n");
 444         if (i & DH_UNABLE_TO_CHECK_GENERATOR)
 445             printf("unable to check the generator value\n");
 446         if (i & DH_NOT_SUITABLE_GENERATOR)
 447             printf("the g value is not a generator\n");
 448         if (i == 0)
 449             printf("DH parameters appear to be ok.\n");
 450     }
 451     if (C) {
 452         unsigned char *data;
 453         int len, l, bits;
 454
 455         len = BN_num_bytes(dh->p);
 456         bits = BN_num_bits(dh->p);
 457         data = (unsigned char *)OPENSSL_malloc(len);
 458         if (data == NULL) {
 459             perror("OPENSSL_malloc");
 460             goto end;
 461         }
 462         printf("#ifndef HEADER_DH_H\n"
 463                "#include <openssl/dh.h>\n" "#endif\n");
 464         printf("DH *get_dh%d()\n\t{\n", bits);
 465
 466         l = BN_bn2bin(dh->p, data);
 467         printf("\tstatic unsigned char dh%d_p[]={", bits);
 468         for (i = 0; i < l; i++) {
 469             if ((i % 12) == 0)
 470                 printf("\n\t\t");
 471             printf("0x%02X,", data[i]);
 472         }
 473         printf("\n\t\t};\n");
 474
 475         l = BN_bn2bin(dh->g, data);
 476         printf("\tstatic unsigned char dh%d_g[]={", bits);
 477         for (i = 0; i < l; i++) {
 478             if ((i % 12) == 0)
 479                 printf("\n\t\t");
 480             printf("0x%02X,", data[i]);
 481         }
 482         printf("\n\t\t};\n");
 483
 484         printf("\tDH *dh;\n\n");
 485         printf("\tif ((dh=DH_new()) == NULL) return(NULL);\n");
 486         printf("\tdh->p=BN_bin2bn(dh%d_p,sizeof(dh%d_p),NULL);\n",
 487                bits, bits);
 488         printf("\tdh->g=BN_bin2bn(dh%d_g,sizeof(dh%d_g),NULL);\n",
 489                bits, bits);
 490         printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n");
 491         printf("\t\t{ DH_free(dh); return(NULL); }\n");
 492         if (dh->length)
 493             printf("\tdh->length = %ld;\n", dh->length);
 494         printf("\treturn(dh);\n\t}\n");
 495         OPENSSL_free(data);
 496     }
 497
 498     if (!noout) {
 499         if (outformat == FORMAT_ASN1)
 500             i = i2d_DHparams_bio(out, dh);
 501         else if (outformat == FORMAT_PEM) {
 502             if (dh->q)
 503                 i = PEM_write_bio_DHxparams(out, dh);
 504             else
 505                 i = PEM_write_bio_DHparams(out, dh);
 506         } else {
 507             BIO_printf(bio_err, "bad output format specified for outfile\n");
 508             goto end;
 509         }
 510         if (!i) {
 511             BIO_printf(bio_err, "unable to write DH parameters\n");
 512             ERR_print_errors(bio_err);
 513             goto end;
 514         }
 515     }
 516     ret = 0;
 517  end:
 518     BIO_free(in);
 519     BIO_free_all(out);
 520     DH_free(dh);
 521     apps_shutdown();
 522     OPENSSL_EXIT(ret);
 523 }
 524
 525 /* dh_cb is identical to dsa_cb in apps/dsaparam.c */
 526 static int dh_cb(int p, int n, BN_GENCB *cb)
 527 {
 528     char c = '*';
 529
 530     if (p == 0)
 531         c = '.';
 532     if (p == 1)
 533         c = '+';
 534     if (p == 2)
 535         c = '*';
 536     if (p == 3)
 537         c = '\n';
 538     BIO_write(BN_GENCB_get_arg(cb), &c, 1);
 539     (void)BIO_flush(BN_GENCB_get_arg(cb));
 540     return 1;
 541 }
 542
 543 #else                           /* !OPENSSL_NO_DH */
 544
 545 # if PEDANTIC
 546 static void *dummy = &dummy;
 547 # endif
 548
 549 #endif