xref: /openbsd-src/usr.bin/openssl/dhparam.c (revision 9b9d2a55a62c8e82206c25f94fcc7f4e2765250e)
1 /* $OpenBSD: dhparam.c,v 1.5 2015/08/22 16:36:05 jsing Exp $ */
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 
114 #ifndef OPENSSL_NO_DH
115 
116 #include <stdio.h>
117 #include <stdlib.h>
118 #include <string.h>
119 #include <time.h>
120 
121 #include "apps.h"
122 
123 #include <openssl/bio.h>
124 #include <openssl/bn.h>
125 #include <openssl/err.h>
126 #include <openssl/dh.h>
127 #include <openssl/pem.h>
128 #include <openssl/x509.h>
129 
130 #include <openssl/dsa.h>
131 
132 #define DEFBITS	2048
133 
134 struct {
135 	int C;
136 	int check;
137 	int dsaparam;
138 #ifndef OPENSSL_NO_ENGINE
139 	char *engine;
140 #endif
141 	int g;
142 	char *infile;
143 	int informat;
144 	int noout;
145 	char *outfile;
146 	int outformat;
147 	int text;
148 } dhparam_config;
149 
150 struct option dhparam_options[] = {
151 	{
152 		.name = "2",
153 		.desc = "Generate DH parameters with a generator value of 2 "
154 		    "(default)",
155 		.type = OPTION_VALUE,
156 		.opt.value = &dhparam_config.g,
157 		.value = 2,
158 	},
159 	{
160 		.name = "5",
161 		.desc = "Generate DH parameters with a generator value of 5",
162 		.type = OPTION_VALUE,
163 		.opt.value = &dhparam_config.g,
164 		.value = 5,
165 	},
166 	{
167 		.name = "C",
168 		.desc = "Convert DH parameters into C code",
169 		.type = OPTION_FLAG,
170 		.opt.flag = &dhparam_config.C,
171 	},
172 	{
173 		.name = "check",
174 		.desc = "Check the DH parameters",
175 		.type = OPTION_FLAG,
176 		.opt.flag = &dhparam_config.check,
177 	},
178 	{
179 		.name = "dsaparam",
180 		.desc = "Read or generate DSA parameters and convert to DH",
181 		.type = OPTION_FLAG,
182 		.opt.flag = &dhparam_config.dsaparam,
183 	},
184 #ifndef OPENSSL_NO_ENGINE
185 	{
186 		.name = "engine",
187 		.argname = "id",
188 		.desc = "Use the engine specified by the given identifier",
189 		.type = OPTION_ARG,
190 		.opt.arg = &dhparam_config.engine,
191 	},
192 #endif
193 	{
194 		.name = "in",
195 		.argname = "file",
196 		.desc = "Input file (default stdin)",
197 		.type = OPTION_ARG,
198 		.opt.arg = &dhparam_config.infile,
199 	},
200 	{
201 		.name = "inform",
202 		.argname = "format",
203 		.desc = "Input format (DER or PEM (default))",
204 		.type = OPTION_ARG_FORMAT,
205 		.opt.value = &dhparam_config.informat,
206 	},
207 	{
208 		.name = "noout",
209 		.desc = "Do not output encoded version of DH parameters",
210 		.type = OPTION_FLAG,
211 		.opt.flag = &dhparam_config.noout,
212 	},
213 	{
214 		.name = "out",
215 		.argname = "file",
216 		.desc = "Output file (default stdout)",
217 		.type = OPTION_ARG,
218 		.opt.arg = &dhparam_config.outfile,
219 	},
220 	{
221 		.name = "outform",
222 		.argname = "format",
223 		.desc = "Output format (DER or PEM (default))",
224 		.type = OPTION_ARG_FORMAT,
225 		.opt.value = &dhparam_config.outformat,
226 	},
227 	{
228 		.name = "text",
229 		.desc = "Print DH parameters in plain text",
230 		.type = OPTION_FLAG,
231 		.opt.flag = &dhparam_config.text,
232 	},
233 	{ NULL },
234 };
235 
236 static void
237 dhparam_usage()
238 {
239 	fprintf(stderr,
240 	    "usage: dhparam [-2 | -5] [-C] [-check] [-dsaparam] [-engine id]\n"
241 	    "    [-in file] [-inform DER | PEM] [-noout] [-out file]\n"
242 	    "    [-outform DER | PEM] [-text] [numbits]\n\n");
243 	options_usage(dhparam_options);
244 }
245 
246 static int dh_cb(int p, int n, BN_GENCB * cb);
247 
248 int
249 dhparam_main(int argc, char **argv)
250 {
251 	BIO *in = NULL, *out = NULL;
252 	char *num_bits = NULL;
253 	DH *dh = NULL;
254 	int num = 0;
255 	int ret = 1;
256 	int i;
257 
258 	memset(&dhparam_config, 0, sizeof(dhparam_config));
259 
260 	dhparam_config.informat = FORMAT_PEM;
261 	dhparam_config.outformat = FORMAT_PEM;
262 
263 	if (options_parse(argc, argv, dhparam_options, &num_bits, NULL) != 0) {
264 		dhparam_usage();
265 		return (1);
266 	}
267 
268 	if (num_bits != NULL) {
269 		if(sscanf(num_bits, "%d", &num) == 0 || num <= 0) {
270 			BIO_printf(bio_err, "invalid number of bits: %s\n",
271 			    num_bits);
272 			return (1);
273 		}
274 	}
275 
276 #ifndef OPENSSL_NO_ENGINE
277 	setup_engine(bio_err, dhparam_config.engine, 0);
278 #endif
279 
280 	if (dhparam_config.g && !num)
281 		num = DEFBITS;
282 
283 	if (dhparam_config.dsaparam) {
284 		if (dhparam_config.g) {
285 			BIO_printf(bio_err, "generator may not be chosen for DSA parameters\n");
286 			goto end;
287 		}
288 	} else {
289 		/* DH parameters */
290 		if (num && !dhparam_config.g)
291 			dhparam_config.g = 2;
292 	}
293 
294 	if (num) {
295 
296 		BN_GENCB cb;
297 		BN_GENCB_set(&cb, dh_cb, bio_err);
298 		if (dhparam_config.dsaparam) {
299 			DSA *dsa = DSA_new();
300 
301 			BIO_printf(bio_err, "Generating DSA parameters, %d bit long prime\n", num);
302 			if (!dsa || !DSA_generate_parameters_ex(dsa, num,
303 				NULL, 0, NULL, NULL, &cb)) {
304 				if (dsa)
305 					DSA_free(dsa);
306 				ERR_print_errors(bio_err);
307 				goto end;
308 			}
309 			dh = DSA_dup_DH(dsa);
310 			DSA_free(dsa);
311 			if (dh == NULL) {
312 				ERR_print_errors(bio_err);
313 				goto end;
314 			}
315 		} else {
316 			dh = DH_new();
317 			BIO_printf(bio_err, "Generating DH parameters, %d bit long safe prime, generator %d\n", num, dhparam_config.g);
318 			BIO_printf(bio_err, "This is going to take a long time\n");
319 			if (!dh || !DH_generate_parameters_ex(dh, num, dhparam_config.g, &cb)) {
320 				ERR_print_errors(bio_err);
321 				goto end;
322 			}
323 		}
324 	} else {
325 
326 		in = BIO_new(BIO_s_file());
327 		if (in == NULL) {
328 			ERR_print_errors(bio_err);
329 			goto end;
330 		}
331 		if (dhparam_config.infile == NULL)
332 			BIO_set_fp(in, stdin, BIO_NOCLOSE);
333 		else {
334 			if (BIO_read_filename(in, dhparam_config.infile) <= 0) {
335 				perror(dhparam_config.infile);
336 				goto end;
337 			}
338 		}
339 
340 		if (dhparam_config.informat != FORMAT_ASN1 &&
341 		    dhparam_config.informat != FORMAT_PEM) {
342 			BIO_printf(bio_err, "bad input format specified\n");
343 			goto end;
344 		}
345 		if (dhparam_config.dsaparam) {
346 			DSA *dsa;
347 
348 			if (dhparam_config.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 				BIO_printf(bio_err, "unable to load DSA parameters\n");
355 				ERR_print_errors(bio_err);
356 				goto end;
357 			}
358 			dh = DSA_dup_DH(dsa);
359 			DSA_free(dsa);
360 			if (dh == NULL) {
361 				ERR_print_errors(bio_err);
362 				goto end;
363 			}
364 		} else
365 		{
366 			if (dhparam_config.informat == FORMAT_ASN1)
367 				dh = d2i_DHparams_bio(in, NULL);
368 			else	/* informat == FORMAT_PEM */
369 				dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
370 
371 			if (dh == NULL) {
372 				BIO_printf(bio_err, "unable to load DH parameters\n");
373 				ERR_print_errors(bio_err);
374 				goto end;
375 			}
376 		}
377 
378 		/* dh != NULL */
379 	}
380 
381 	out = BIO_new(BIO_s_file());
382 	if (out == NULL) {
383 		ERR_print_errors(bio_err);
384 		goto end;
385 	}
386 	if (dhparam_config.outfile == NULL) {
387 		BIO_set_fp(out, stdout, BIO_NOCLOSE);
388 	} else {
389 		if (BIO_write_filename(out, dhparam_config.outfile) <= 0) {
390 			perror(dhparam_config.outfile);
391 			goto end;
392 		}
393 	}
394 
395 
396 	if (dhparam_config.text) {
397 		DHparams_print(out, dh);
398 	}
399 	if (dhparam_config.check) {
400 		if (!DH_check(dh, &i)) {
401 			ERR_print_errors(bio_err);
402 			goto end;
403 		}
404 		if (i & DH_CHECK_P_NOT_PRIME)
405 			printf("p value is not prime\n");
406 		if (i & DH_CHECK_P_NOT_SAFE_PRIME)
407 			printf("p value is not a safe prime\n");
408 		if (i & DH_UNABLE_TO_CHECK_GENERATOR)
409 			printf("unable to check the generator value\n");
410 		if (i & DH_NOT_SUITABLE_GENERATOR)
411 			printf("the g value is not a generator\n");
412 		if (i == 0)
413 			printf("DH parameters appear to be ok.\n");
414 	}
415 	if (dhparam_config.C) {
416 		unsigned char *data;
417 		int len, l, bits;
418 
419 		len = BN_num_bytes(dh->p);
420 		bits = BN_num_bits(dh->p);
421 		data = malloc(len);
422 		if (data == NULL) {
423 			perror("malloc");
424 			goto end;
425 		}
426 		printf("#ifndef HEADER_DH_H\n"
427 		    "#include <openssl/dh.h>\n"
428 		    "#endif\n");
429 		printf("DH *get_dh%d()\n\t{\n", bits);
430 
431 		l = BN_bn2bin(dh->p, data);
432 		printf("\tstatic unsigned char dh%d_p[] = {", bits);
433 		for (i = 0; i < l; i++) {
434 			if ((i % 12) == 0)
435 				printf("\n\t\t");
436 			printf("0x%02X, ", data[i]);
437 		}
438 		printf("\n\t\t};\n");
439 
440 		l = BN_bn2bin(dh->g, data);
441 		printf("\tstatic unsigned char dh%d_g[] = {", bits);
442 		for (i = 0; i < l; i++) {
443 			if ((i % 12) == 0)
444 				printf("\n\t\t");
445 			printf("0x%02X, ", data[i]);
446 		}
447 		printf("\n\t\t};\n");
448 
449 		printf("\tDH *dh;\n\n");
450 		printf("\tif ((dh = DH_new()) == NULL) return(NULL);\n");
451 		printf("\tdh->p = BN_bin2bn(dh%d_p, sizeof(dh%d_p), NULL);\n",
452 		    bits, bits);
453 		printf("\tdh->g = BN_bin2bn(dh%d_g, sizeof(dh%d_g), NULL);\n",
454 		    bits, bits);
455 		printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n");
456 		printf("\t\t{ DH_free(dh); return(NULL); }\n");
457 		if (dh->length)
458 			printf("\tdh->length = %ld;\n", dh->length);
459 		printf("\treturn(dh);\n\t}\n");
460 		free(data);
461 	}
462 	if (!dhparam_config.noout) {
463 		if (dhparam_config.outformat == FORMAT_ASN1)
464 			i = i2d_DHparams_bio(out, dh);
465 		else if (dhparam_config.outformat == FORMAT_PEM)
466 			i = PEM_write_bio_DHparams(out, dh);
467 		else {
468 			BIO_printf(bio_err, "bad output format specified for outfile\n");
469 			goto end;
470 		}
471 		if (!i) {
472 			BIO_printf(bio_err, "unable to write DH parameters\n");
473 			ERR_print_errors(bio_err);
474 			goto end;
475 		}
476 	}
477 	ret = 0;
478 
479 end:
480 	BIO_free(in);
481 	if (out != NULL)
482 		BIO_free_all(out);
483 	if (dh != NULL)
484 		DH_free(dh);
485 
486 	return (ret);
487 }
488 
489 /* dh_cb is identical to dsa_cb in apps/dsaparam.c */
490 static int
491 dh_cb(int p, int n, BN_GENCB * cb)
492 {
493 	char c = '*';
494 
495 	if (p == 0)
496 		c = '.';
497 	if (p == 1)
498 		c = '+';
499 	if (p == 2)
500 		c = '*';
501 	if (p == 3)
502 		c = '\n';
503 	BIO_write(cb->arg, &c, 1);
504 	(void) BIO_flush(cb->arg);
505 	return 1;
506 }
507 
508 #endif
509