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