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