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 #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 #undef PROG
 130 #define PROG    dhparam_main
 131
 132 #define DEFBITS 512
 133
 134 /* -inform arg  - input format - default PEM (DER or PEM)
 135  * -outform arg - output format - default PEM
 136  * -in arg      - input file - default stdin
 137  * -out arg     - output file - default stdout
 138  * -dsaparam  - read or generate DSA parameters, convert to DH
 139  * -check       - check the parameters are ok
 140  * -noout
 141  * -text
 142  * -C
 143  */
 144
 145 static void MS_CALLBACK dh_cb(int p, int n, void *arg);
 146
 147 int MAIN(int, char **);
 148
 149 int MAIN(int argc, char **argv)
 150         {
 151         ENGINE *e = NULL;
 152         DH *dh=NULL;
 153         int i,badops=0,text=0;
 154 #ifndef OPENSSL_NO_DSA
 155         int dsaparam=0;
 156 #endif
 157         BIO *in=NULL,*out=NULL;
 158         int informat,outformat,check=0,noout=0,C=0,ret=1;
 159         char *infile,*outfile,*prog;
 160         char *inrand=NULL,*engine=NULL;
 161         int num = 0, g = 0;
 162
 163         apps_startup();
 164
 165         if (bio_err == NULL)
 166                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
 167                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
 168
 169         infile=NULL;
 170         outfile=NULL;
 171         informat=FORMAT_PEM;
 172         outformat=FORMAT_PEM;
 173
 174         prog=argv[0];
 175         argc--;
 176         argv++;
 177         while (argc >= 1)
 178                 {
 179                 if      (strcmp(*argv,"-inform") == 0)
 180                         {
 181                         if (--argc < 1) goto bad;
 182                         informat=str2fmt(*(++argv));
 183                         }
 184                 else if (strcmp(*argv,"-outform") == 0)
 185                         {
 186                         if (--argc < 1) goto bad;
 187                         outformat=str2fmt(*(++argv));
 188                         }
 189                 else if (strcmp(*argv,"-in") == 0)
 190                         {
 191                         if (--argc < 1) goto bad;
 192                         infile= *(++argv);
 193                         }
 194                 else if (strcmp(*argv,"-out") == 0)
 195                         {
 196                         if (--argc < 1) goto bad;
 197                         outfile= *(++argv);
 198                         }
 199                 else if (strcmp(*argv,"-engine") == 0)
 200                         {
 201                         if (--argc < 1) goto bad;
 202                         engine= *(++argv);
 203                         }
 204                 else if (strcmp(*argv,"-check") == 0)
 205                         check=1;
 206                 else if (strcmp(*argv,"-text") == 0)
 207                         text=1;
 208 #ifndef OPENSSL_NO_DSA
 209                 else if (strcmp(*argv,"-dsaparam") == 0)
 210                         dsaparam=1;
 211 #endif
 212                 else if (strcmp(*argv,"-C") == 0)
 213                         C=1;
 214                 else if (strcmp(*argv,"-noout") == 0)
 215                         noout=1;
 216                 else if (strcmp(*argv,"-2") == 0)
 217                         g=2;
 218                 else if (strcmp(*argv,"-5") == 0)
 219                         g=5;
 220                 else if (strcmp(*argv,"-rand") == 0)
 221                         {
 222                         if (--argc < 1) goto bad;
 223                         inrand= *(++argv);
 224                         }
 225                 else if (((sscanf(*argv,"%d",&num) == 0) || (num <= 0)))
 226                         goto bad;
 227                 argv++;
 228                 argc--;
 229                 }
 230
 231         if (badops)
 232                 {
 233 bad:
 234                 BIO_printf(bio_err,"%s [options] [numbits]\n",prog);
 235                 BIO_printf(bio_err,"where options are\n");
 236                 BIO_printf(bio_err," -inform arg   input format - one of DER PEM\n");
 237                 BIO_printf(bio_err," -outform arg  output format - one of DER PEM\n");
 238                 BIO_printf(bio_err," -in arg       input file\n");
 239                 BIO_printf(bio_err," -out arg      output file\n");
 240 #ifndef OPENSSL_NO_DSA
 241                 BIO_printf(bio_err," -dsaparam     read or generate DSA parameters, convert to DH\n");
 242 #endif
 243                 BIO_printf(bio_err," -check        check the DH parameters\n");
 244                 BIO_printf(bio_err," -text         print a text form of the DH parameters\n");
 245                 BIO_printf(bio_err," -C            Output C code\n");
 246                 BIO_printf(bio_err," -2            generate parameters using  2 as the generator value\n");
 247                 BIO_printf(bio_err," -5            generate parameters using  5 as the generator value\n");
 248                 BIO_printf(bio_err," numbits       number of bits in to generate (default 512)\n");
 249                 BIO_printf(bio_err," -engine e     use engine e, possibly a hardware device.\n");
 250                 BIO_printf(bio_err," -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR, LIST_SEPARATOR_CHAR);
 251                 BIO_printf(bio_err,"               - load the file (or the files in the directory) into\n");
 252                 BIO_printf(bio_err,"               the random number generator\n");
 253                 BIO_printf(bio_err," -noout        no output\n");
 254                 goto end;
 255                 }
 256
 257         ERR_load_crypto_strings();
 258
 259         e = setup_engine(bio_err, engine, 0);
 260
 261         if (g && !num)
 262                 num = DEFBITS;
 263
 264 #ifndef OPENSSL_NO_DSA
 265         if (dsaparam)
 266                 {
 267                 if (g)
 268                         {
 269                         BIO_printf(bio_err, "generator may not be chosen for DSA parameters\n");
 270                         goto end;
 271                         }
 272                 }
 273         else
 274 #endif
 275                 {
 276                 /* DH parameters */
 277                 if (num && !g)
 278                         g = 2;
 279                 }
 280
 281         if(num) {
 282
 283                 if (!app_RAND_load_file(NULL, bio_err, 1) && inrand == NULL)
 284                         {
 285                         BIO_printf(bio_err,"warning, not much extra random data, consider using the -rand option\n");
 286                         }
 287                 if (inrand != NULL)
 288                         BIO_printf(bio_err,"%ld semi-random bytes loaded\n",
 289                                 app_RAND_load_files(inrand));
 290
 291 #ifndef OPENSSL_NO_DSA
 292                 if (dsaparam)
 293                         {
 294                         DSA *dsa;
 295
 296                         BIO_printf(bio_err,"Generating DSA parameters, %d bit long prime\n",num);
 297                         dsa = DSA_generate_parameters(num, NULL, 0, NULL, NULL, dh_cb, bio_err);
 298                         if (dsa == NULL)
 299                                 {
 300                                 ERR_print_errors(bio_err);
 301                                 goto end;
 302                                 }
 303
 304                         dh = DSA_dup_DH(dsa);
 305                         DSA_free(dsa);
 306                         if (dh == NULL)
 307                                 {
 308                                 ERR_print_errors(bio_err);
 309                                 goto end;
 310                                 }
 311                         }
 312                 else
 313 #endif
 314                         {
 315                         BIO_printf(bio_err,"Generating DH parameters, %d bit long safe prime, generator %d\n",num,g);
 316                         BIO_printf(bio_err,"This is going to take a long time\n");
 317                         dh=DH_generate_parameters(num,g,dh_cb,bio_err);
 318
 319                         if (dh == NULL)
 320                                 {
 321                                 ERR_print_errors(bio_err);
 322                                 goto end;
 323                                 }
 324                         }
 325
 326                 app_RAND_write_file(NULL, bio_err);
 327         } else {
 328
 329                 in=BIO_new(BIO_s_file());
 330                 if (in == NULL)
 331                         {
 332                         ERR_print_errors(bio_err);
 333                         goto end;
 334                         }
 335                 if (infile == NULL)
 336                         BIO_set_fp(in,stdin,BIO_NOCLOSE);
 337                 else
 338                         {
 339                         if (BIO_read_filename(in,infile) <= 0)
 340                                 {
 341                                 perror(infile);
 342                                 goto end;
 343                                 }
 344                         }
 345
 346                 if      (informat != FORMAT_ASN1 && informat != FORMAT_PEM)
 347                         {
 348                         BIO_printf(bio_err,"bad input format specified\n");
 349                         goto end;
 350                         }
 351
 352 #ifndef OPENSSL_NO_DSA
 353                 if (dsaparam)
 354                         {
 355                         DSA *dsa;
 356
 357                         if (informat == FORMAT_ASN1)
 358                                 dsa=d2i_DSAparams_bio(in,NULL);
 359                         else /* informat == FORMAT_PEM */
 360                                 dsa=PEM_read_bio_DSAparams(in,NULL,NULL,NULL);
 361
 362                         if (dsa == NULL)
 363                                 {
 364                                 BIO_printf(bio_err,"unable to load DSA parameters\n");
 365                                 ERR_print_errors(bio_err);
 366                                 goto end;
 367                                 }
 368
 369                         dh = DSA_dup_DH(dsa);
 370                         DSA_free(dsa);
 371                         if (dh == NULL)
 372                                 {
 373                                 ERR_print_errors(bio_err);
 374                                 goto end;
 375                                 }
 376                         }
 377                 else
 378 #endif
 379                         {
 380                         if (informat == FORMAT_ASN1)
 381                                 dh=d2i_DHparams_bio(in,NULL);
 382                         else /* informat == FORMAT_PEM */
 383                                 dh=PEM_read_bio_DHparams(in,NULL,NULL,NULL);
 384
 385                         if (dh == NULL)
 386                                 {
 387                                 BIO_printf(bio_err,"unable to load DH parameters\n");
 388                                 ERR_print_errors(bio_err);
 389                                 goto end;
 390                                 }
 391                         }
 392
 393                 /* dh != NULL */
 394         }
 395
 396         out=BIO_new(BIO_s_file());
 397         if (out == NULL)
 398                 {
 399                 ERR_print_errors(bio_err);
 400                 goto end;
 401                 }
 402         if (outfile == NULL)
 403                 {
 404                 BIO_set_fp(out,stdout,BIO_NOCLOSE);
 405 #ifdef OPENSSL_SYS_VMS
 406                 {
 407                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
 408                 out = BIO_push(tmpbio, out);
 409                 }
 410 #endif
 411                 }
 412         else
 413                 {
 414                 if (BIO_write_filename(out,outfile) <= 0)
 415                         {
 416                         perror(outfile);
 417                         goto end;
 418                         }
 419                 }
 420
 421
 422         if (text)
 423                 {
 424                 DHparams_print(out,dh);
 425                 }
 426
 427         if (check)
 428                 {
 429                 if (!DH_check(dh,&i))
 430                         {
 431                         ERR_print_errors(bio_err);
 432                         goto end;
 433                         }
 434                 if (i & DH_CHECK_P_NOT_PRIME)
 435                         printf("p value is not prime\n");
 436                 if (i & DH_CHECK_P_NOT_SAFE_PRIME)
 437                         printf("p value is not a safe prime\n");
 438                 if (i & DH_UNABLE_TO_CHECK_GENERATOR)
 439                         printf("unable to check the generator value\n");
 440                 if (i & DH_NOT_SUITABLE_GENERATOR)
 441                         printf("the g value is not a generator\n");
 442                 if (i == 0)
 443                         printf("DH parameters appear to be ok.\n");
 444                 }
 445         if (C)
 446                 {
 447                 unsigned char *data;
 448                 int len,l,bits;
 449
 450                 len=BN_num_bytes(dh->p);
 451                 bits=BN_num_bits(dh->p);
 452                 data=(unsigned char *)OPENSSL_malloc(len);
 453                 if (data == NULL)
 454                         {
 455                         perror("OPENSSL_malloc");
 456                         goto end;
 457                         }
 458                 printf("#ifndef HEADER_DH_H\n"
 459                        "#include <openssl/dh.h>\n"
 460                        "#endif\n");
 461                 printf("DH *get_dh%d()\n\t{\n",bits);
 462
 463                 l=BN_bn2bin(dh->p,data);
 464                 printf("\tstatic unsigned char dh%d_p[]={",bits);
 465                 for (i=0; i<l; i++)
 466                         {
 467                         if ((i%12) == 0) printf("\n\t\t");
 468                         printf("0x%02X,",data[i]);
 469                         }
 470                 printf("\n\t\t};\n");
 471
 472                 l=BN_bn2bin(dh->g,data);
 473                 printf("\tstatic unsigned char dh%d_g[]={",bits);
 474                 for (i=0; i<l; i++)
 475                         {
 476                         if ((i%12) == 0) printf("\n\t\t");
 477                         printf("0x%02X,",data[i]);
 478                         }
 479                 printf("\n\t\t};\n");
 480
 481                 printf("\tDH *dh;\n\n");
 482                 printf("\tif ((dh=DH_new()) == NULL) return(NULL);\n");
 483                 printf("\tdh->p=BN_bin2bn(dh%d_p,sizeof(dh%d_p),NULL);\n",
 484                         bits,bits);
 485                 printf("\tdh->g=BN_bin2bn(dh%d_g,sizeof(dh%d_g),NULL);\n",
 486                         bits,bits);
 487                 printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n");
 488                 printf("\t\t{ DH_free(dh); return(NULL); }\n");
 489                 if (dh->length)
 490                         printf("\tdh->length = %d;\n", dh->length);
 491                 printf("\treturn(dh);\n\t}\n");
 492                 OPENSSL_free(data);
 493                 }
 494
 495
 496         if (!noout)
 497                 {
 498                 if      (outformat == FORMAT_ASN1)
 499                         i=i2d_DHparams_bio(out,dh);
 500                 else if (outformat == FORMAT_PEM)
 501                         i=PEM_write_bio_DHparams(out,dh);
 502                 else    {
 503                         BIO_printf(bio_err,"bad output format specified for outfile\n");
 504                         goto end;
 505                         }
 506                 if (!i)
 507                         {
 508                         BIO_printf(bio_err,"unable to write DH parameters\n");
 509                         ERR_print_errors(bio_err);
 510                         goto end;
 511                         }
 512                 }
 513         ret=0;
 514 end:
 515         if (in != NULL) BIO_free(in);
 516         if (out != NULL) BIO_free_all(out);
 517         if (dh != NULL) DH_free(dh);
 518         apps_shutdown();
 519         EXIT(ret);
 520         }
 521
 522 /* dh_cb is identical to dsa_cb in apps/dsaparam.c */
 523 static void MS_CALLBACK dh_cb(int p, int n, void *arg)
 524         {
 525         char c='*';
 526
 527         if (p == 0) c='.';
 528         if (p == 1) c='+';
 529         if (p == 2) c='*';
 530         if (p == 3) c='\n';
 531         BIO_write((BIO *)arg,&c,1);
 532         (void)BIO_flush((BIO *)arg);
 533 #ifdef LINT
 534         p=n;
 535 #endif
 536         }
 537
 538 #endif