Annotation of src/usr.bin/openssl/dhparam.c, Revision 1.4
1.4 ! jsing 1: /* $OpenBSD: dhparam.c,v 1.3 2015/07/08 16:37:25 sthen 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: #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: }
1.1 jsing 245:
246: static int dh_cb(int p, int n, BN_GENCB * cb);
247:
248: int dhparam_main(int, char **);
249:
250: int
251: dhparam_main(int argc, char **argv)
252: {
1.4 ! jsing 253: BIO *in = NULL, *out = NULL;
! 254: char *num_bits = NULL;
1.1 jsing 255: DH *dh = NULL;
1.4 ! jsing 256: int num = 0;
! 257: int ret = 1;
! 258: int i;
! 259:
! 260: memset(&dhparam_config, 0, sizeof(dhparam_config));
! 261:
! 262: dhparam_config.informat = FORMAT_PEM;
! 263: dhparam_config.outformat = FORMAT_PEM;
! 264:
! 265: if (options_parse(argc, argv, dhparam_options, &num_bits, NULL) != 0) {
! 266: dhparam_usage();
! 267: return (1);
! 268: }
1.1 jsing 269:
1.4 ! jsing 270: if (num_bits != NULL) {
! 271: if(sscanf(num_bits, "%d", &num) == 0 || num <= 0) {
! 272: BIO_printf(bio_err, "invalid number of bits: %s\n",
! 273: num_bits);
! 274: return (1);
1.1 jsing 275: }
276: }
277:
278: #ifndef OPENSSL_NO_ENGINE
1.4 ! jsing 279: setup_engine(bio_err, dhparam_config.engine, 0);
1.1 jsing 280: #endif
281:
1.4 ! jsing 282: if (dhparam_config.g && !num)
1.1 jsing 283: num = DEFBITS;
284:
1.4 ! jsing 285: if (dhparam_config.dsaparam) {
! 286: if (dhparam_config.g) {
1.1 jsing 287: BIO_printf(bio_err, "generator may not be chosen for DSA parameters\n");
288: goto end;
289: }
1.4 ! jsing 290: } else {
1.1 jsing 291: /* DH parameters */
1.4 ! jsing 292: if (num && !dhparam_config.g)
! 293: dhparam_config.g = 2;
1.1 jsing 294: }
295:
296: if (num) {
297:
298: BN_GENCB cb;
299: BN_GENCB_set(&cb, dh_cb, bio_err);
1.4 ! jsing 300: if (dhparam_config.dsaparam) {
1.1 jsing 301: DSA *dsa = DSA_new();
302:
303: BIO_printf(bio_err, "Generating DSA parameters, %d bit long prime\n", num);
304: if (!dsa || !DSA_generate_parameters_ex(dsa, num,
305: NULL, 0, NULL, NULL, &cb)) {
306: if (dsa)
307: DSA_free(dsa);
308: ERR_print_errors(bio_err);
309: goto end;
310: }
311: dh = DSA_dup_DH(dsa);
312: DSA_free(dsa);
313: if (dh == NULL) {
314: ERR_print_errors(bio_err);
315: goto end;
316: }
1.4 ! jsing 317: } else {
1.1 jsing 318: dh = DH_new();
1.4 ! jsing 319: BIO_printf(bio_err, "Generating DH parameters, %d bit long safe prime, generator %d\n", num, dhparam_config.g);
1.1 jsing 320: BIO_printf(bio_err, "This is going to take a long time\n");
1.4 ! jsing 321: if (!dh || !DH_generate_parameters_ex(dh, num, dhparam_config.g, &cb)) {
1.1 jsing 322: ERR_print_errors(bio_err);
323: goto end;
324: }
325: }
326: } else {
327:
328: in = BIO_new(BIO_s_file());
329: if (in == NULL) {
330: ERR_print_errors(bio_err);
331: goto end;
332: }
1.4 ! jsing 333: if (dhparam_config.infile == NULL)
1.1 jsing 334: BIO_set_fp(in, stdin, BIO_NOCLOSE);
335: else {
1.4 ! jsing 336: if (BIO_read_filename(in, dhparam_config.infile) <= 0) {
! 337: perror(dhparam_config.infile);
1.1 jsing 338: goto end;
339: }
340: }
341:
1.4 ! jsing 342: if (dhparam_config.informat != FORMAT_ASN1 &&
! 343: dhparam_config.informat != FORMAT_PEM) {
1.1 jsing 344: BIO_printf(bio_err, "bad input format specified\n");
345: goto end;
346: }
1.4 ! jsing 347: if (dhparam_config.dsaparam) {
1.1 jsing 348: DSA *dsa;
349:
1.4 ! jsing 350: if (dhparam_config.informat == FORMAT_ASN1)
1.1 jsing 351: dsa = d2i_DSAparams_bio(in, NULL);
352: else /* informat == FORMAT_PEM */
353: dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
354:
355: if (dsa == NULL) {
356: BIO_printf(bio_err, "unable to load DSA parameters\n");
357: ERR_print_errors(bio_err);
358: goto end;
359: }
360: dh = DSA_dup_DH(dsa);
361: DSA_free(dsa);
362: if (dh == NULL) {
363: ERR_print_errors(bio_err);
364: goto end;
365: }
366: } else
367: {
1.4 ! jsing 368: if (dhparam_config.informat == FORMAT_ASN1)
1.1 jsing 369: dh = d2i_DHparams_bio(in, NULL);
370: else /* informat == FORMAT_PEM */
371: dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
372:
373: if (dh == NULL) {
374: BIO_printf(bio_err, "unable to load DH parameters\n");
375: ERR_print_errors(bio_err);
376: goto end;
377: }
378: }
379:
380: /* dh != NULL */
381: }
382:
383: out = BIO_new(BIO_s_file());
384: if (out == NULL) {
385: ERR_print_errors(bio_err);
386: goto end;
387: }
1.4 ! jsing 388: if (dhparam_config.outfile == NULL) {
1.1 jsing 389: BIO_set_fp(out, stdout, BIO_NOCLOSE);
390: } else {
1.4 ! jsing 391: if (BIO_write_filename(out, dhparam_config.outfile) <= 0) {
! 392: perror(dhparam_config.outfile);
1.1 jsing 393: goto end;
394: }
395: }
396:
397:
1.4 ! jsing 398: if (dhparam_config.text) {
1.1 jsing 399: DHparams_print(out, dh);
400: }
1.4 ! jsing 401: if (dhparam_config.check) {
1.1 jsing 402: if (!DH_check(dh, &i)) {
403: ERR_print_errors(bio_err);
404: goto end;
405: }
406: if (i & DH_CHECK_P_NOT_PRIME)
407: printf("p value is not prime\n");
408: if (i & DH_CHECK_P_NOT_SAFE_PRIME)
409: printf("p value is not a safe prime\n");
410: if (i & DH_UNABLE_TO_CHECK_GENERATOR)
411: printf("unable to check the generator value\n");
412: if (i & DH_NOT_SUITABLE_GENERATOR)
413: printf("the g value is not a generator\n");
414: if (i == 0)
415: printf("DH parameters appear to be ok.\n");
416: }
1.4 ! jsing 417: if (dhparam_config.C) {
1.1 jsing 418: unsigned char *data;
419: int len, l, bits;
420:
421: len = BN_num_bytes(dh->p);
422: bits = BN_num_bits(dh->p);
423: data = malloc(len);
424: if (data == NULL) {
425: perror("malloc");
426: goto end;
427: }
428: printf("#ifndef HEADER_DH_H\n"
429: "#include <openssl/dh.h>\n"
430: "#endif\n");
431: printf("DH *get_dh%d()\n\t{\n", bits);
432:
433: l = BN_bn2bin(dh->p, data);
434: printf("\tstatic unsigned char dh%d_p[] = {", bits);
435: for (i = 0; i < l; i++) {
436: if ((i % 12) == 0)
437: printf("\n\t\t");
438: printf("0x%02X, ", data[i]);
439: }
440: printf("\n\t\t};\n");
441:
442: l = BN_bn2bin(dh->g, data);
443: printf("\tstatic unsigned char dh%d_g[] = {", bits);
444: for (i = 0; i < l; i++) {
445: if ((i % 12) == 0)
446: printf("\n\t\t");
447: printf("0x%02X, ", data[i]);
448: }
449: printf("\n\t\t};\n");
450:
451: printf("\tDH *dh;\n\n");
452: printf("\tif ((dh = DH_new()) == NULL) return(NULL);\n");
453: printf("\tdh->p = BN_bin2bn(dh%d_p, sizeof(dh%d_p), NULL);\n",
454: bits, bits);
455: printf("\tdh->g = BN_bin2bn(dh%d_g, sizeof(dh%d_g), NULL);\n",
456: bits, bits);
457: printf("\tif ((dh->p == NULL) || (dh->g == NULL))\n");
458: printf("\t\t{ DH_free(dh); return(NULL); }\n");
459: if (dh->length)
460: printf("\tdh->length = %ld;\n", dh->length);
461: printf("\treturn(dh);\n\t}\n");
462: free(data);
463: }
1.4 ! jsing 464: if (!dhparam_config.noout) {
! 465: if (dhparam_config.outformat == FORMAT_ASN1)
1.1 jsing 466: i = i2d_DHparams_bio(out, dh);
1.4 ! jsing 467: else if (dhparam_config.outformat == FORMAT_PEM)
1.1 jsing 468: i = PEM_write_bio_DHparams(out, dh);
469: else {
470: BIO_printf(bio_err, "bad output format specified for outfile\n");
471: goto end;
472: }
473: if (!i) {
474: BIO_printf(bio_err, "unable to write DH parameters\n");
475: ERR_print_errors(bio_err);
476: goto end;
477: }
478: }
479: ret = 0;
480:
481: end:
482: BIO_free(in);
483: if (out != NULL)
484: BIO_free_all(out);
485: if (dh != NULL)
486: DH_free(dh);
487:
488: return (ret);
489: }
490:
491: /* dh_cb is identical to dsa_cb in apps/dsaparam.c */
492: static int
493: dh_cb(int p, int n, BN_GENCB * cb)
494: {
495: char c = '*';
496:
497: if (p == 0)
498: c = '.';
499: if (p == 1)
500: c = '+';
501: if (p == 2)
502: c = '*';
503: if (p == 3)
504: c = '\n';
505: BIO_write(cb->arg, &c, 1);
506: (void) BIO_flush(cb->arg);
507: return 1;
508: }
509:
510: #endif