Revert "Missing perldoc markup around < literal"
[openssl.git] / apps / dsaparam.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <openssl/opensslconf.h> /* for OPENSSL_NO_DSA */
59
60 #ifndef OPENSSL_NO_DSA
61 # include <stdio.h>
62 # include <stdlib.h>
63 # include <time.h>
64 # include <string.h>
65 # include "apps.h"
66 # include <openssl/bio.h>
67 # include <openssl/err.h>
68 # include <openssl/bn.h>
69 # include <openssl/dsa.h>
70 # include <openssl/x509.h>
71 # include <openssl/pem.h>
72
73 # ifdef GENCB_TEST
74
75 static int stop_keygen_flag = 0;
76
77 static void timebomb_sigalarm(int foo)
78 {
79     stop_keygen_flag = 1;
80 }
81
82 # endif
83
84 static int dsa_cb(int p, int n, BN_GENCB *cb);
85
86 typedef enum OPTION_choice {
87     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
88     OPT_INFORM, OPT_OUTFORM, OPT_IN, OPT_OUT, OPT_TEXT, OPT_C,
89     OPT_NOOUT, OPT_GENKEY, OPT_RAND, OPT_NON_FIPS_ALLOW, OPT_ENGINE,
90     OPT_TIMEBOMB
91 } OPTION_CHOICE;
92
93 OPTIONS dsaparam_options[] = {
94     {"help", OPT_HELP, '-', "Display this summary"},
95     {"inform", OPT_INFORM, 'F', "Input format - DER or PEM"},
96     {"in", OPT_IN, '<', "Input file"},
97     {"outform", OPT_OUTFORM, 'F', "Output format - DER or PEM"},
98     {"out", OPT_OUT, '>', "Output file"},
99     {"text", OPT_TEXT, '-', "Print as text"},
100     {"C", OPT_C, '-', "Output C code"},
101     {"noout", OPT_NOOUT, '-', "No output"},
102     {"genkey", OPT_GENKEY, '-', "Generate a DSA key"},
103     {"rand", OPT_RAND, 's', "Files to use for random number input"},
104     {"non-fips-allow", OPT_NON_FIPS_ALLOW, '-'},
105 # ifdef GENCB_TEST
106     {"timebomb", OPT_TIMEBOMB, 'p', "Interrupt keygen after 'pnum' seconds"},
107 # endif
108 # ifndef OPENSSL_NO_ENGINE
109     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
110 # endif
111     {NULL}
112 };
113
114 int dsaparam_main(int argc, char **argv)
115 {
116     DSA *dsa = NULL;
117     BIO *in = NULL, *out = NULL;
118     BN_GENCB *cb = NULL;
119     int numbits = -1, num = 0, genkey = 0, need_rand = 0, non_fips_allow = 0;
120     int informat = FORMAT_PEM, outformat = FORMAT_PEM, noout = 0, C = 0;
121     int ret = 1, i, text = 0, private = 0;
122 # ifdef GENCB_TEST
123     int timebomb = 0;
124 # endif
125     char *infile = NULL, *outfile = NULL, *prog, *inrand = NULL;
126     OPTION_CHOICE o;
127
128     prog = opt_init(argc, argv, dsaparam_options);
129     while ((o = opt_next()) != OPT_EOF) {
130         switch (o) {
131         case OPT_EOF:
132         case OPT_ERR:
133  opthelp:
134             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
135             goto end;
136         case OPT_HELP:
137             opt_help(dsaparam_options);
138             ret = 0;
139             goto end;
140         case OPT_INFORM:
141             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
142                 goto opthelp;
143             break;
144         case OPT_IN:
145             infile = opt_arg();
146             break;
147         case OPT_OUTFORM:
148             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
149                 goto opthelp;
150             break;
151         case OPT_OUT:
152             outfile = opt_arg();
153             break;
154         case OPT_ENGINE:
155             (void)setup_engine(opt_arg(), 0);
156             break;
157         case OPT_TIMEBOMB:
158 # ifdef GENCB_TEST
159             timebomb = atoi(opt_arg());
160             break;
161 # endif
162         case OPT_TEXT:
163             text = 1;
164             break;
165         case OPT_C:
166             C = 1;
167             break;
168         case OPT_GENKEY:
169             genkey = need_rand = 1;
170             break;
171         case OPT_RAND:
172             inrand = opt_arg();
173             need_rand = 1;
174             break;
175         case OPT_NOOUT:
176             noout = 1;
177             break;
178         case OPT_NON_FIPS_ALLOW:
179             non_fips_allow = 1;
180             break;
181         }
182     }
183     argc = opt_num_rest();
184     argv = opt_rest();
185
186     if (!app_load_modules(NULL))
187         goto end;
188
189     if (argc == 1) {
190         if (!opt_int(argv[0], &num))
191             goto end;
192         /* generate a key */
193         numbits = num;
194         need_rand = 1;
195     }
196     private = genkey ? 1 : 0;
197
198     in = bio_open_default(infile, "r");
199     if (in == NULL)
200         goto end;
201     out = bio_open_owner(outfile, "w", private);
202     if (out == NULL)
203         goto end;
204
205     if (need_rand) {
206         app_RAND_load_file(NULL, (inrand != NULL));
207         if (inrand != NULL)
208             BIO_printf(bio_err, "%ld semi-random bytes loaded\n",
209                        app_RAND_load_files(inrand));
210     }
211
212     if (numbits > 0) {
213         cb = BN_GENCB_new();
214         if (!cb) {
215             BIO_printf(bio_err, "Error allocating BN_GENCB object\n");
216             goto end;
217         }
218         BN_GENCB_set(cb, dsa_cb, bio_err);
219         assert(need_rand);
220         dsa = DSA_new();
221         if (!dsa) {
222             BIO_printf(bio_err, "Error allocating DSA object\n");
223             goto end;
224         }
225         if (non_fips_allow)
226             dsa->flags |= DSA_FLAG_NON_FIPS_ALLOW;
227         BIO_printf(bio_err, "Generating DSA parameters, %d bit long prime\n",
228                    num);
229         BIO_printf(bio_err, "This could take some time\n");
230 # ifdef GENCB_TEST
231         if (timebomb > 0) {
232             struct sigaction act;
233             act.sa_handler = timebomb_sigalarm;
234             act.sa_flags = 0;
235             BIO_printf(bio_err,
236                        "(though I'll stop it if not done within %d secs)\n",
237                        timebomb);
238             if (sigaction(SIGALRM, &act, NULL) != 0) {
239                 BIO_printf(bio_err, "Error, couldn't set SIGALRM handler\n");
240                 goto end;
241             }
242             alarm(timebomb);
243         }
244 # endif
245         if (!DSA_generate_parameters_ex(dsa, num, NULL, 0, NULL, NULL, cb)) {
246 # ifdef GENCB_TEST
247             if (stop_keygen_flag) {
248                 BIO_printf(bio_err, "DSA key generation time-stopped\n");
249                 /* This is an asked-for behaviour! */
250                 ret = 0;
251                 goto end;
252             }
253 # endif
254             ERR_print_errors(bio_err);
255             BIO_printf(bio_err, "Error, DSA key generation failed\n");
256             goto end;
257         }
258     } else if (informat == FORMAT_ASN1)
259         dsa = d2i_DSAparams_bio(in, NULL);
260     else
261         dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
262     if (dsa == NULL) {
263         BIO_printf(bio_err, "unable to load DSA parameters\n");
264         ERR_print_errors(bio_err);
265         goto end;
266     }
267
268     if (text) {
269         DSAparams_print(out, dsa);
270     }
271
272     if (C) {
273         int len = BN_num_bytes(dsa->p);
274         int bits_p = BN_num_bits(dsa->p);
275         unsigned char *data = app_malloc(len + 20, "BN space");
276
277         BIO_printf(bio_out, "DSA *get_dsa%d()\n{\n", bits_p);
278         print_bignum_var(bio_out, dsa->p, "dsap", len, data);
279         print_bignum_var(bio_out, dsa->q, "dsaq", len, data);
280         print_bignum_var(bio_out, dsa->g, "dsag", len, data);
281         BIO_printf(bio_out, "    DSA *dsa = DSA_new();\n"
282                             "\n");
283         BIO_printf(bio_out, "    if (dsa == NULL)\n"
284                             "        return NULL;\n");
285         BIO_printf(bio_out, "    dsa->p = BN_bin2bn(dsap_%d, sizeof (dsap_%d), NULL);\n",
286                bits_p, bits_p);
287         BIO_printf(bio_out, "    dsa->q = BN_bin2bn(dsaq_%d, sizeof (dsaq_%d), NULL);\n",
288                bits_p, bits_p);
289         BIO_printf(bio_out, "    dsa->g = BN_bin2bn(dsag_%d, sizeof (dsag_%d), NULL);\n",
290                bits_p, bits_p);
291         BIO_printf(bio_out, "    if (!dsa->p || !dsa->q || !dsa->g) {\n"
292                             "        DSA_free(dsa);\n"
293                             "        return NULL;\n"
294                             "    }\n"
295                             "    return(dsa);\n}\n");
296     }
297
298     if (!noout) {
299         if (outformat == FORMAT_ASN1)
300             i = i2d_DSAparams_bio(out, dsa);
301         else
302             i = PEM_write_bio_DSAparams(out, dsa);
303         if (!i) {
304             BIO_printf(bio_err, "unable to write DSA parameters\n");
305             ERR_print_errors(bio_err);
306             goto end;
307         }
308     }
309     if (genkey) {
310         DSA *dsakey;
311
312         assert(need_rand);
313         if ((dsakey = DSAparams_dup(dsa)) == NULL)
314             goto end;
315         if (non_fips_allow)
316             dsakey->flags |= DSA_FLAG_NON_FIPS_ALLOW;
317         if (!DSA_generate_key(dsakey)) {
318             ERR_print_errors(bio_err);
319             DSA_free(dsakey);
320             goto end;
321         }
322         assert(private);
323         if (outformat == FORMAT_ASN1)
324             i = i2d_DSAPrivateKey_bio(out, dsakey);
325         else
326             i = PEM_write_bio_DSAPrivateKey(out, dsakey, NULL, NULL, 0, NULL,
327                                             NULL);
328         DSA_free(dsakey);
329     }
330     if (need_rand)
331         app_RAND_write_file(NULL);
332     ret = 0;
333  end:
334     BN_GENCB_free(cb);
335     BIO_free(in);
336     BIO_free_all(out);
337     DSA_free(dsa);
338     return (ret);
339 }
340
341 static int dsa_cb(int p, int n, BN_GENCB *cb)
342 {
343     char c = '*';
344
345     if (p == 0)
346         c = '.';
347     if (p == 1)
348         c = '+';
349     if (p == 2)
350         c = '*';
351     if (p == 3)
352         c = '\n';
353     BIO_write(BN_GENCB_get_arg(cb), &c, 1);
354     (void)BIO_flush(BN_GENCB_get_arg(cb));
355 # ifdef GENCB_TEST
356     if (stop_keygen_flag)
357         return 0;
358 # endif
359     return 1;
360 }
361 #else                           /* !OPENSSL_NO_DSA */
362
363 # if PEDANTIC
364 static void *dummy = &dummy;
365 # endif
366
367 #endif