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