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