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