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