man1: make all openssl command line tool documentation generated.
[openssl.git] / apps / dsaparam.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* We need to use some deprecated APIs */
11 #define OPENSSL_SUPPRESS_DEPRECATED
12
13 #include <openssl/opensslconf.h>
14 #ifdef OPENSSL_NO_DSA
15 NON_EMPTY_TRANSLATION_UNIT
16 #else
17
18 # include <stdio.h>
19 # include <stdlib.h>
20 # include <time.h>
21 # include <string.h>
22 # include "apps.h"
23 # include "progs.h"
24 # include <openssl/bio.h>
25 # include <openssl/err.h>
26 # include <openssl/bn.h>
27 # include <openssl/dsa.h>
28 # include <openssl/x509.h>
29 # include <openssl/pem.h>
30
31 static int verbose = 0;
32
33 static int dsa_cb(int p, int n, BN_GENCB *cb);
34
35 typedef enum OPTION_choice {
36     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
37     OPT_INFORM, OPT_OUTFORM, OPT_IN, OPT_OUT, OPT_TEXT, OPT_C,
38     OPT_NOOUT, OPT_GENKEY, OPT_ENGINE, OPT_VERBOSE,
39     OPT_R_ENUM
40 } OPTION_CHOICE;
41
42 const OPTIONS dsaparam_options[] = {
43     {OPT_HELP_STR, 1, '-', "Usage: %s [options] [numbits]\n"},
44
45     OPT_SECTION("General"),
46     {"help", OPT_HELP, '-', "Display this summary"},
47 # ifndef OPENSSL_NO_ENGINE
48     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
49 # endif
50
51     OPT_SECTION("Input"),
52     {"in", OPT_IN, '<', "Input file"},
53     {"inform", OPT_INFORM, 'F', "Input format - DER or PEM"},
54
55     OPT_SECTION("Output"),
56     {"out", OPT_OUT, '>', "Output file"},
57     {"outform", OPT_OUTFORM, 'F', "Output format - DER or PEM"},
58     {"text", OPT_TEXT, '-', "Print as text"},
59     {"C", OPT_C, '-', "Output C code"},
60     {"noout", OPT_NOOUT, '-', "No output"},
61     {"verbose", OPT_VERBOSE, '-', "Verbose output"},
62     {"genkey", OPT_GENKEY, '-', "Generate a DSA key"},
63
64     OPT_R_OPTIONS,
65
66     OPT_PARAMETERS(),
67     {"numbits", 0, 0, "Number of bits if generating parameters (optional)"},
68     {NULL}
69 };
70
71 int dsaparam_main(int argc, char **argv)
72 {
73     ENGINE *e = NULL;
74     DSA *dsa = NULL;
75     BIO *in = NULL, *out = NULL;
76     BN_GENCB *cb = NULL;
77     int numbits = -1, num = 0, genkey = 0;
78     int informat = FORMAT_PEM, outformat = FORMAT_PEM, noout = 0, C = 0;
79     int ret = 1, i, text = 0, private = 0;
80     char *infile = NULL, *outfile = NULL, *prog;
81     OPTION_CHOICE o;
82
83     prog = opt_init(argc, argv, dsaparam_options);
84     while ((o = opt_next()) != OPT_EOF) {
85         switch (o) {
86         case OPT_EOF:
87         case OPT_ERR:
88  opthelp:
89             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
90             goto end;
91         case OPT_HELP:
92             opt_help(dsaparam_options);
93             ret = 0;
94             goto end;
95         case OPT_INFORM:
96             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
97                 goto opthelp;
98             break;
99         case OPT_IN:
100             infile = opt_arg();
101             break;
102         case OPT_OUTFORM:
103             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
104                 goto opthelp;
105             break;
106         case OPT_OUT:
107             outfile = opt_arg();
108             break;
109         case OPT_ENGINE:
110             e = setup_engine(opt_arg(), 0);
111             break;
112         case OPT_TEXT:
113             text = 1;
114             break;
115         case OPT_C:
116             C = 1;
117             break;
118         case OPT_GENKEY:
119             genkey = 1;
120             break;
121         case OPT_R_CASES:
122             if (!opt_rand(o))
123                 goto end;
124             break;
125         case OPT_NOOUT:
126             noout = 1;
127             break;
128         case OPT_VERBOSE:
129             verbose = 1;
130             break;
131         }
132     }
133     argc = opt_num_rest();
134     argv = opt_rest();
135
136     if (argc == 1) {
137         if (!opt_int(argv[0], &num) || num < 0)
138             goto end;
139         /* generate a key */
140         numbits = num;
141     }
142     private = genkey ? 1 : 0;
143
144     in = bio_open_default(infile, 'r', informat);
145     if (in == NULL)
146         goto end;
147     out = bio_open_owner(outfile, outformat, private);
148     if (out == NULL)
149         goto end;
150
151     if (numbits > 0) {
152         if (numbits > OPENSSL_DSA_MAX_MODULUS_BITS)
153             BIO_printf(bio_err,
154                        "Warning: It is not recommended to use more than %d bit for DSA keys.\n"
155                        "         Your key size is %d! Larger key size may behave not as expected.\n",
156                        OPENSSL_DSA_MAX_MODULUS_BITS, numbits);
157
158         cb = BN_GENCB_new();
159         if (cb == NULL) {
160             BIO_printf(bio_err, "Error allocating BN_GENCB object\n");
161             goto end;
162         }
163         BN_GENCB_set(cb, dsa_cb, bio_err);
164         dsa = DSA_new();
165         if (dsa == NULL) {
166             BIO_printf(bio_err, "Error allocating DSA object\n");
167             goto end;
168         }
169         if (verbose) {
170             BIO_printf(bio_err, "Generating DSA parameters, %d bit long prime\n",
171                        num);
172             BIO_printf(bio_err, "This could take some time\n");
173         }
174         if (!DSA_generate_parameters_ex(dsa, num, NULL, 0, NULL, NULL, cb)) {
175             ERR_print_errors(bio_err);
176             BIO_printf(bio_err, "Error, DSA key generation failed\n");
177             goto end;
178         }
179     } else if (informat == FORMAT_ASN1) {
180         dsa = d2i_DSAparams_bio(in, NULL);
181     } else {
182         dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
183     }
184     if (dsa == NULL) {
185         BIO_printf(bio_err, "unable to load DSA parameters\n");
186         ERR_print_errors(bio_err);
187         goto end;
188     }
189
190     if (text) {
191         DSAparams_print(out, dsa);
192     }
193
194     if (C) {
195         const BIGNUM *p = NULL, *q = NULL, *g = NULL;
196         unsigned char *data;
197         int len, bits_p;
198
199         DSA_get0_pqg(dsa, &p, &q, &g);
200         len = BN_num_bytes(p);
201         bits_p = BN_num_bits(p);
202
203         data = app_malloc(len + 20, "BN space");
204
205         BIO_printf(bio_out, "static DSA *get_dsa%d(void)\n{\n", bits_p);
206         print_bignum_var(bio_out, p, "dsap", bits_p, data);
207         print_bignum_var(bio_out, q, "dsaq", bits_p, data);
208         print_bignum_var(bio_out, g, "dsag", bits_p, data);
209         BIO_printf(bio_out, "    DSA *dsa = DSA_new();\n"
210                             "    BIGNUM *p, *q, *g;\n"
211                             "\n");
212         BIO_printf(bio_out, "    if (dsa == NULL)\n"
213                             "        return NULL;\n");
214         BIO_printf(bio_out, "    if (!DSA_set0_pqg(dsa, p = BN_bin2bn(dsap_%d, sizeof(dsap_%d), NULL),\n",
215                    bits_p, bits_p);
216         BIO_printf(bio_out, "                           q = BN_bin2bn(dsaq_%d, sizeof(dsaq_%d), NULL),\n",
217                    bits_p, bits_p);
218         BIO_printf(bio_out, "                           g = BN_bin2bn(dsag_%d, sizeof(dsag_%d), NULL))) {\n",
219                    bits_p, bits_p);
220         BIO_printf(bio_out, "        DSA_free(dsa);\n"
221                             "        BN_free(p);\n"
222                             "        BN_free(q);\n"
223                             "        BN_free(g);\n"
224                             "        return NULL;\n"
225                             "    }\n"
226                             "    return dsa;\n}\n");
227         OPENSSL_free(data);
228     }
229
230     if (outformat == FORMAT_ASN1 && genkey)
231         noout = 1;
232
233     if (!noout) {
234         if (outformat == FORMAT_ASN1)
235             i = i2d_DSAparams_bio(out, dsa);
236         else
237             i = PEM_write_bio_DSAparams(out, dsa);
238         if (!i) {
239             BIO_printf(bio_err, "unable to write DSA parameters\n");
240             ERR_print_errors(bio_err);
241             goto end;
242         }
243     }
244     if (genkey) {
245         DSA *dsakey;
246
247         if ((dsakey = DSAparams_dup(dsa)) == NULL)
248             goto end;
249         if (!DSA_generate_key(dsakey)) {
250             ERR_print_errors(bio_err);
251             DSA_free(dsakey);
252             goto end;
253         }
254         assert(private);
255         if (outformat == FORMAT_ASN1)
256             i = i2d_DSAPrivateKey_bio(out, dsakey);
257         else
258             i = PEM_write_bio_DSAPrivateKey(out, dsakey, NULL, NULL, 0, NULL,
259                                             NULL);
260         DSA_free(dsakey);
261     }
262     ret = 0;
263  end:
264     BN_GENCB_free(cb);
265     BIO_free(in);
266     BIO_free_all(out);
267     DSA_free(dsa);
268     release_engine(e);
269     return ret;
270 }
271
272 static int dsa_cb(int p, int n, BN_GENCB *cb)
273 {
274     static const char symbols[] = ".+*\n";
275     char c = (p >= 0 && (size_t)p < sizeof(symbols) - 1) ? symbols[p] : '?';
276
277     if (!verbose)
278         return 1;
279
280     BIO_write(BN_GENCB_get_arg(cb), &c, 1);
281     (void)BIO_flush(BN_GENCB_get_arg(cb));
282     return 1;
283 }
284 #endif