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