Fix typo in help & comment formatting
[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 <assert.h>
62 # include <stdio.h>
63 # include <stdlib.h>
64 # include <time.h>
65 # include <string.h>
66 # include "apps.h"
67 # include <openssl/bio.h>
68 # include <openssl/err.h>
69 # include <openssl/bn.h>
70 # include <openssl/dsa.h>
71 # include <openssl/x509.h>
72 # include <openssl/pem.h>
73
74 # ifdef GENCB_TEST
75
76 static int stop_keygen_flag = 0;
77
78 static void timebomb_sigalarm(int foo)
79 {
80     stop_keygen_flag = 1;
81 }
82
83 # endif
84
85 static int dsa_cb(int p, int n, BN_GENCB *cb);
86
87 typedef enum OPTION_choice {
88     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
89     OPT_INFORM, OPT_OUTFORM, OPT_IN, OPT_OUT, OPT_TEXT, OPT_C,
90     OPT_NOOUT, OPT_GENKEY, OPT_RAND, OPT_NON_FIPS_ALLOW, OPT_ENGINE,
91     OPT_TIMEBOMB
92 } OPTION_CHOICE;
93
94 OPTIONS dsaparam_options[] = {
95     {"help", OPT_HELP, '-', "Display this summary"},
96     {"inform", OPT_INFORM, 'F', "Input format - DER or PEM"},
97     {"in", OPT_IN, '<', "Input file"},
98     {"outform", OPT_OUTFORM, 'F', "Output format - DER or PEM"},
99     {"out", OPT_OUT, '>', "Output file"},
100     {"text", OPT_TEXT, '-', "Print as text"},
101     {"C", OPT_C, '-', "Output C code"},
102     {"noout", OPT_NOOUT, '-', "No output"},
103     {"genkey", OPT_GENKEY, '-', "Generate a DSA key"},
104     {"rand", OPT_RAND, 's', "Files to use for random number input"},
105     {"non-fips-allow", OPT_NON_FIPS_ALLOW, '-'},
106 # ifndef OPENSSL_NO_ENGINE
107     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
108 # endif
109 # ifdef GENCB_TEST
110     {"timebomb", OPT_TIMEBOMB, 'p', "Interrupt keygen after 'pnum' seconds"},
111 # endif
112     {NULL}
113 };
114
115 int dsaparam_main(int argc, char **argv)
116 {
117     DSA *dsa = NULL;
118     BIO *in = NULL, *out = NULL;
119     BN_GENCB *cb = NULL;
120     int numbits = -1, num, genkey = 0, need_rand = 0, non_fips_allow = 0;
121     int informat = FORMAT_PEM, outformat = FORMAT_PEM, noout = 0, C = 0, ret =
122         1;
123     int i, text = 0;
124 # ifdef GENCB_TEST
125     int timebomb = 0;
126 # endif
127     char *infile = NULL, *outfile = NULL, *prog, *inrand = NULL;
128     OPTION_CHOICE o;
129
130     prog = opt_init(argc, argv, dsaparam_options);
131     while ((o = opt_next()) != OPT_EOF) {
132         switch (o) {
133         case OPT_EOF:
134         case OPT_ERR:
135  opthelp:
136             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
137             goto end;
138         case OPT_HELP:
139             opt_help(dsaparam_options);
140             ret = 0;
141             goto end;
142         case OPT_INFORM:
143             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
144                 goto opthelp;
145             break;
146         case OPT_IN:
147             infile = opt_arg();
148             break;
149         case OPT_OUTFORM:
150             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
151                 goto opthelp;
152             break;
153         case OPT_OUT:
154             outfile = opt_arg();
155             break;
156         case OPT_ENGINE:
157             (void)setup_engine(opt_arg(), 0);
158             break;
159         case OPT_TIMEBOMB:
160 # ifdef GENCB_TEST
161             timebomb = atoi(opt_arg());
162             break;
163 # endif
164         case OPT_TEXT:
165             text = 1;
166             break;
167         case OPT_C:
168             C = 1;
169             break;
170         case OPT_GENKEY:
171             genkey = need_rand = 1;
172             break;
173         case OPT_RAND:
174             inrand = opt_arg();
175             need_rand = 1;
176             break;
177         case OPT_NOOUT:
178             noout = 1;
179             break;
180         case OPT_NON_FIPS_ALLOW:
181             non_fips_allow = 1;
182             break;
183         }
184     }
185     argc = opt_num_rest();
186     argv = opt_rest();
187
188     if (argc == 1) {
189         if (!opt_int(argv[0], &num))
190             goto end;
191         /* generate a key */
192         numbits = num;
193         need_rand = 1;
194     }
195
196     in = bio_open_default(infile, "r");
197     if (in == NULL)
198         goto end;
199     out = bio_open_default(outfile, "w");
200     if (out == NULL)
201         goto end;
202
203     if (need_rand) {
204         app_RAND_load_file(NULL, (inrand != NULL));
205         if (inrand != NULL)
206             BIO_printf(bio_err, "%ld semi-random bytes loaded\n",
207                        app_RAND_load_files(inrand));
208     }
209
210     if (numbits > 0) {
211         cb = BN_GENCB_new();
212         if (!cb) {
213             BIO_printf(bio_err, "Error allocating BN_GENCB object\n");
214             goto end;
215         }
216         BN_GENCB_set(cb, dsa_cb, bio_err);
217         assert(need_rand);
218         dsa = DSA_new();
219         if (!dsa) {
220             BIO_printf(bio_err, "Error allocating DSA object\n");
221             goto end;
222         }
223         if (non_fips_allow)
224             dsa->flags |= DSA_FLAG_NON_FIPS_ALLOW;
225         BIO_printf(bio_err, "Generating DSA parameters, %d bit long prime\n",
226                    num);
227         BIO_printf(bio_err, "This could take some time\n");
228 # ifdef GENCB_TEST
229         if (timebomb > 0) {
230             struct sigaction act;
231             act.sa_handler = timebomb_sigalarm;
232             act.sa_flags = 0;
233             BIO_printf(bio_err,
234                        "(though I'll stop it if not done within %d secs)\n",
235                        timebomb);
236             if (sigaction(SIGALRM, &act, NULL) != 0) {
237                 BIO_printf(bio_err, "Error, couldn't set SIGALRM handler\n");
238                 goto end;
239             }
240             alarm(timebomb);
241         }
242 # endif
243         if (!DSA_generate_parameters_ex(dsa, num, NULL, 0, NULL, NULL, cb)) {
244 # ifdef GENCB_TEST
245             if (stop_keygen_flag) {
246                 BIO_printf(bio_err, "DSA key generation time-stopped\n");
247                 /* This is an asked-for behaviour! */
248                 ret = 0;
249                 goto end;
250             }
251 # endif
252             ERR_print_errors(bio_err);
253             BIO_printf(bio_err, "Error, DSA key generation failed\n");
254             goto end;
255         }
256     } else if (informat == FORMAT_ASN1)
257         dsa = d2i_DSAparams_bio(in, NULL);
258     else
259         dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
260     if (dsa == NULL) {
261         BIO_printf(bio_err, "unable to load DSA parameters\n");
262         ERR_print_errors(bio_err);
263         goto end;
264     }
265
266     if (text) {
267         DSAparams_print(out, dsa);
268     }
269
270     if (C) {
271         unsigned char *data;
272         int len, bits_p;
273
274         len = BN_num_bytes(dsa->p);
275         bits_p = BN_num_bits(dsa->p);
276         data = (unsigned char *)OPENSSL_malloc(len + 20);
277         if (data == NULL) {
278             perror("OPENSSL_malloc");
279             goto end;
280         }
281
282         BIO_printf(bio_out, "DSA *get_dsa%d()\n{\n", bits_p);
283         print_bignum_var(bio_out, dsa->p, "dsap", len, data);
284         print_bignum_var(bio_out, dsa->q, "dsaq", len, data);
285         print_bignum_var(bio_out, dsa->g, "dsag", len, data);
286         BIO_printf(bio_out, "    DSA *dsa = DSA_new();\n"
287                             "\n");
288         BIO_printf(bio_out, "    if (dsa == NULL)\n"
289                             "        return NULL;\n");
290         BIO_printf(bio_out, "    dsa->p = BN_bin2bn(dsap_%d, sizeof (dsap_%d), NULL);\n",
291                bits_p, bits_p);
292         BIO_printf(bio_out, "    dsa->q = BN_bin2bn(dsaq_%d, sizeof (dsaq_%d), NULL);\n",
293                bits_p, bits_p);
294         BIO_printf(bio_out, "    dsa->g = BN_bin2bn(dsag_%d, sizeof (dsag_%d), NULL);\n",
295                bits_p, bits_p);
296         BIO_printf(bio_out, "    if (!dsa->p || !dsa->q || !dsa->g) {\n"
297                             "        DSA_free(dsa);\n"
298                             "        return NULL;\n"
299                             "    }\n"
300                             "    return(dsa);\n}\n");
301     }
302
303     if (!noout) {
304         if (outformat == FORMAT_ASN1)
305             i = i2d_DSAparams_bio(out, dsa);
306         else
307             i = PEM_write_bio_DSAparams(out, dsa);
308         if (!i) {
309             BIO_printf(bio_err, "unable to write DSA parameters\n");
310             ERR_print_errors(bio_err);
311             goto end;
312         }
313     }
314     if (genkey) {
315         DSA *dsakey;
316
317         assert(need_rand);
318         if ((dsakey = DSAparams_dup(dsa)) == NULL)
319             goto end;
320         if (non_fips_allow)
321             dsakey->flags |= DSA_FLAG_NON_FIPS_ALLOW;
322         if (!DSA_generate_key(dsakey)) {
323             ERR_print_errors(bio_err);
324             DSA_free(dsakey);
325             goto end;
326         }
327         if (outformat == FORMAT_ASN1)
328             i = i2d_DSAPrivateKey_bio(out, dsakey);
329         else
330             i = PEM_write_bio_DSAPrivateKey(out, dsakey, NULL, NULL, 0, NULL,
331                                             NULL);
332         DSA_free(dsakey);
333     }
334     if (need_rand)
335         app_RAND_write_file(NULL);
336     ret = 0;
337  end:
338     if (cb != NULL)
339         BN_GENCB_free(cb);
340     BIO_free(in);
341     BIO_free_all(out);
342     DSA_free(dsa);
343     return (ret);
344 }
345
346 static int dsa_cb(int p, int n, BN_GENCB *cb)
347 {
348     char c = '*';
349
350     if (p == 0)
351         c = '.';
352     if (p == 1)
353         c = '+';
354     if (p == 2)
355         c = '*';
356     if (p == 3)
357         c = '\n';
358     BIO_write(BN_GENCB_get_arg(cb), &c, 1);
359     (void)BIO_flush(BN_GENCB_get_arg(cb));
360 # ifdef GENCB_TEST
361     if (stop_keygen_flag)
362         return 0;
363 # endif
364     return 1;
365 }
366 #else                           /* !OPENSSL_NO_DSA */
367
368 # if PEDANTIC
369 static void *dummy = &dummy;
370 # endif
371
372 #endif