7982222abcc8355ac24bd0d0a8a15523db6510e4
[openssl.git] / 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 MS_CALLBACK 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                 {
186                 if      (strcmp(*argv,"-inform") == 0)
187                         {
188                         if (--argc < 1) goto bad;
189                         informat=str2fmt(*(++argv));
190                         }
191                 else if (strcmp(*argv,"-outform") == 0)
192                         {
193                         if (--argc < 1) goto bad;
194                         outformat=str2fmt(*(++argv));
195                         }
196                 else if (strcmp(*argv,"-in") == 0)
197                         {
198                         if (--argc < 1) goto bad;
199                         infile= *(++argv);
200                         }
201                 else if (strcmp(*argv,"-out") == 0)
202                         {
203                         if (--argc < 1) goto bad;
204                         outfile= *(++argv);
205                         }
206 #ifndef OPENSSL_NO_ENGINE
207                 else if (strcmp(*argv,"-engine") == 0)
208                         {
209                         if (--argc < 1) goto bad;
210                         engine= *(++argv);
211                         }
212 #endif
213                 else if (strcmp(*argv,"-check") == 0)
214                         check=1;
215                 else if (strcmp(*argv,"-text") == 0)
216                         text=1;
217 #ifndef OPENSSL_NO_DSA
218                 else if (strcmp(*argv,"-dsaparam") == 0)
219                         dsaparam=1;
220 #endif
221                 else if (strcmp(*argv,"-C") == 0)
222                         C=1;
223                 else if (strcmp(*argv,"-noout") == 0)
224                         noout=1;
225                 else if (strcmp(*argv,"-2") == 0)
226                         g=2;
227                 else if (strcmp(*argv,"-5") == 0)
228                         g=5;
229                 else if (strcmp(*argv,"-rand") == 0)
230                         {
231                         if (--argc < 1) goto bad;
232                         inrand= *(++argv);
233                         }
234                 else if (((sscanf(*argv,"%d",&num) == 0) || (num <= 0)))
235                         goto bad;
236                 argv++;
237                 argc--;
238                 }
239
240         if (badops)
241                 {
242 bad:
243                 BIO_printf(bio_err,"%s [options] [numbits]\n",prog);
244                 BIO_printf(bio_err,"where options are\n");
245                 BIO_printf(bio_err," -inform arg   input format - one of DER PEM\n");
246                 BIO_printf(bio_err," -outform arg  output format - one of DER PEM\n");
247                 BIO_printf(bio_err," -in arg       input file\n");
248                 BIO_printf(bio_err," -out arg      output file\n");
249 #ifndef OPENSSL_NO_DSA
250                 BIO_printf(bio_err," -dsaparam     read or generate DSA parameters, convert to DH\n");
251 #endif
252                 BIO_printf(bio_err," -check        check the DH parameters\n");
253                 BIO_printf(bio_err," -text         print a text form of the DH parameters\n");
254                 BIO_printf(bio_err," -C            Output C code\n");
255                 BIO_printf(bio_err," -2            generate parameters using  2 as the generator value\n");
256                 BIO_printf(bio_err," -5            generate parameters using  5 as the generator value\n");
257                 BIO_printf(bio_err," numbits       number of bits in to generate (default 2048)\n");
258 #ifndef OPENSSL_NO_ENGINE
259                 BIO_printf(bio_err," -engine e     use engine e, possibly a hardware device.\n");
260 #endif
261                 BIO_printf(bio_err," -rand file%cfile%c...\n", LIST_SEPARATOR_CHAR, LIST_SEPARATOR_CHAR);
262                 BIO_printf(bio_err,"               - load the file (or the files in the directory) into\n");
263                 BIO_printf(bio_err,"               the random number generator\n");
264                 BIO_printf(bio_err," -noout        no output\n");
265                 goto end;
266                 }
267
268         ERR_load_crypto_strings();
269
270 #ifndef OPENSSL_NO_ENGINE
271         setup_engine(bio_err, engine, 0);
272 #endif
273
274         if (g && !num)
275                 num = DEFBITS;
276
277 #ifndef OPENSSL_NO_DSA
278         if (dsaparam)
279                 {
280                 if (g)
281                         {
282                         BIO_printf(bio_err, "generator may not be chosen for DSA parameters\n");
283                         goto end;
284                         }
285                 }
286         else
287 #endif
288                 {
289                 /* DH parameters */
290                 if (num && !g)
291                         g = 2;
292                 }
293
294         if(num) {
295
296                 BN_GENCB *cb;
297                 cb = BN_GENCB_new();
298                 if(!cb)
299                         {
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                         {
307                         BIO_printf(bio_err,"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                         {
316                         DSA *dsa = DSA_new();
317                         
318                         BIO_printf(bio_err,"Generating DSA parameters, %d bit long prime\n",num);
319                         if(!dsa || !DSA_generate_parameters_ex(dsa, num,
320                                                 NULL, 0, NULL, NULL, cb))
321                                 {
322                                 if(dsa) 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                                 {
332                                 BN_GENCB_free(cb);
333                                 ERR_print_errors(bio_err);
334                                 goto end;
335                                 }
336                         }
337                 else
338 #endif
339                         {
340                         dh = DH_new();
341                         BIO_printf(bio_err,"Generating DH parameters, %d bit long safe prime, generator %d\n",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                                 {
345                                 BN_GENCB_free(cb);
346                                 ERR_print_errors(bio_err);
347                                 goto end;
348                                 }
349                         }
350
351                 BN_GENCB_free(cb);
352                 app_RAND_write_file(NULL, bio_err);
353         } else {
354
355                 in=BIO_new(BIO_s_file());
356                 if (in == NULL)
357                         {
358                         ERR_print_errors(bio_err);
359                         goto end;
360                         }
361                 if (infile == NULL)
362                         BIO_set_fp(in,stdin,BIO_NOCLOSE);
363                 else
364                         {
365                         if (BIO_read_filename(in,infile) <= 0)
366                                 {
367                                 perror(infile);
368                                 goto end;
369                                 }
370                         }
371
372                 if      (informat != FORMAT_ASN1 && informat != FORMAT_PEM)
373                         {
374                         BIO_printf(bio_err,"bad input format specified\n");
375                         goto end;
376                         }
377
378 #ifndef OPENSSL_NO_DSA
379                 if (dsaparam)
380                         {
381                         DSA *dsa;
382                         
383                         if (informat == FORMAT_ASN1)
384                                 dsa=d2i_DSAparams_bio(in,NULL);
385                         else /* informat == FORMAT_PEM */
386                                 dsa=PEM_read_bio_DSAparams(in,NULL,NULL,NULL);
387                         
388                         if (dsa == NULL)
389                                 {
390                                 BIO_printf(bio_err,"unable to load DSA parameters\n");
391                                 ERR_print_errors(bio_err);
392                                 goto end;
393                                 }
394                         
395                         dh = DSA_dup_DH(dsa);
396                         DSA_free(dsa);
397                         if (dh == NULL)
398                                 {
399                                 ERR_print_errors(bio_err);
400                                 goto end;
401                                 }
402                         }
403                 else
404 #endif
405                         {
406                         if (informat == FORMAT_ASN1)
407                                 dh=d2i_DHparams_bio(in,NULL);
408                         else /* informat == FORMAT_PEM */
409                                 dh=PEM_read_bio_DHparams(in,NULL,NULL,NULL);
410                         
411                         if (dh == NULL)
412                                 {
413                                 BIO_printf(bio_err,"unable to load DH parameters\n");
414                                 ERR_print_errors(bio_err);
415                                 goto end;
416                                 }
417                         }
418                 
419                 /* dh != NULL */
420         }
421         
422         out=BIO_new(BIO_s_file());
423         if (out == NULL)
424                 {
425                 ERR_print_errors(bio_err);
426                 goto end;
427                 }
428         if (outfile == NULL)
429                 {
430                 BIO_set_fp(out,stdout,BIO_NOCLOSE);
431 #ifdef OPENSSL_SYS_VMS
432                 {
433                 BIO *tmpbio = BIO_new(BIO_f_linebuffer());
434                 out = BIO_push(tmpbio, out);
435                 }
436 #endif
437                 }
438         else
439                 {
440                 if (BIO_write_filename(out,outfile) <= 0)
441                         {
442                         perror(outfile);
443                         goto end;
444                         }
445                 }
446
447
448         if (text)
449                 {
450                 DHparams_print(out,dh);
451                 }
452         
453         if (check)
454                 {
455                 if (!DH_check(dh,&i))
456                         {
457                         ERR_print_errors(bio_err);
458                         goto end;
459                         }
460                 if (i & DH_CHECK_P_NOT_PRIME)
461                         printf("p value is not prime\n");
462                 if (i & DH_CHECK_P_NOT_SAFE_PRIME)
463                         printf("p value is not a safe prime\n");
464                 if (i & DH_UNABLE_TO_CHECK_GENERATOR)
465                         printf("unable to check the generator value\n");
466                 if (i & DH_NOT_SUITABLE_GENERATOR)
467                         printf("the g value is not a generator\n");
468                 if (i == 0)
469                         printf("DH parameters appear to be ok.\n");
470                 }
471         if (C)
472                 {
473                 unsigned char *data;
474                 int len,l,bits;
475
476                 len=BN_num_bytes(dh->p);
477                 bits=BN_num_bits(dh->p);
478                 data=(unsigned char *)OPENSSL_malloc(len);
479                 if (data == NULL)
480                         {
481                         perror("OPENSSL_malloc");
482                         goto end;
483                         }
484                 printf("#ifndef HEADER_DH_H\n"
485                        "#include <openssl/dh.h>\n"
486                        "#endif\n");
487                 printf("DH *get_dh%d()\n\t{\n",bits);
488
489                 l=BN_bn2bin(dh->p,data);
490                 printf("\tstatic unsigned char dh%d_p[]={",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                 l=BN_bn2bin(dh->g,data);
499                 printf("\tstatic unsigned char dh%d_g[]={",bits);
500                 for (i=0; i<l; i++)
501                         {
502                         if ((i%12) == 0) printf("\n\t\t");
503                         printf("0x%02X,",data[i]);
504                         }
505                 printf("\n\t\t};\n");
506
507                 printf("\tDH *dh;\n\n");
508                 printf("\tif ((dh=DH_new()) == NULL) return(NULL);\n");
509                 printf("\tdh->p=BN_bin2bn(dh%d_p,sizeof(dh%d_p),NULL);\n",
510                         bits,bits);
511                 printf("\tdh->g=BN_bin2bn(dh%d_g,sizeof(dh%d_g),NULL);\n",
512                         bits,bits);
513                 printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n");
514                 printf("\t\t{ DH_free(dh); return(NULL); }\n");
515                 if (dh->length)
516                         printf("\tdh->length = %ld;\n", dh->length);
517                 printf("\treturn(dh);\n\t}\n");
518                 OPENSSL_free(data);
519                 }
520
521
522         if (!noout)
523                 {
524                 if      (outformat == FORMAT_ASN1)
525                         i=i2d_DHparams_bio(out,dh);
526                 else if (outformat == FORMAT_PEM)
527                         {
528                         if (dh->q)
529                                 i=PEM_write_bio_DHxparams(out,dh);
530                         else
531                                 i=PEM_write_bio_DHparams(out,dh);
532                         }
533                 else    {
534                         BIO_printf(bio_err,"bad output format specified for outfile\n");
535                         goto end;
536                         }
537                 if (!i)
538                         {
539                         BIO_printf(bio_err,"unable to write DH parameters\n");
540                         ERR_print_errors(bio_err);
541                         goto end;
542                         }
543                 }
544         ret=0;
545 end:
546         if (in != NULL) BIO_free(in);
547         if (out != NULL) BIO_free_all(out);
548         if (dh != NULL) DH_free(dh);
549         apps_shutdown();
550         OPENSSL_EXIT(ret);
551         }
552
553 /* dh_cb is identical to dsa_cb in apps/dsaparam.c */
554 static int MS_CALLBACK dh_cb(int p, int n, BN_GENCB *cb)
555         {
556         char c='*';
557
558         if (p == 0) c='.';
559         if (p == 1) c='+';
560         if (p == 2) c='*';
561         if (p == 3) c='\n';
562         BIO_write(BN_GENCB_get_arg(cb),&c,1);
563         (void)BIO_flush(BN_GENCB_get_arg(cb));
564         return 1;
565         }
566
567 #else /* !OPENSSL_NO_DH */
568
569 # if PEDANTIC
570 static void *dummy=&dummy;
571 # endif
572
573 #endif