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