Add "sections" to -help output
[openssl.git] / apps / gendsa.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 #include <openssl/opensslconf.h>
11 #ifdef OPENSSL_NO_DSA
12 NON_EMPTY_TRANSLATION_UNIT
13 #else
14
15 # include <stdio.h>
16 # include <string.h>
17 # include <sys/types.h>
18 # include <sys/stat.h>
19 # include "apps.h"
20 # include "progs.h"
21 # include <openssl/bio.h>
22 # include <openssl/err.h>
23 # include <openssl/bn.h>
24 # include <openssl/dsa.h>
25 # include <openssl/x509.h>
26 # include <openssl/pem.h>
27
28 typedef enum OPTION_choice {
29     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
30     OPT_OUT, OPT_PASSOUT, OPT_ENGINE, OPT_CIPHER, OPT_VERBOSE,
31     OPT_R_ENUM
32 } OPTION_CHOICE;
33
34 const OPTIONS gendsa_options[] = {
35     {OPT_HELP_STR, 1, '-', "Usage: %s [args] dsaparam-file\n"},
36
37     OPT_SECTION("General"),
38     {"help", OPT_HELP, '-', "Display this summary"},
39 # ifndef OPENSSL_NO_ENGINE
40     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
41 # endif
42
43     OPT_SECTION("Output"),
44     {"out", OPT_OUT, '>', "Output the key to the specified file"},
45     {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
46     OPT_R_OPTIONS,
47     {"", OPT_CIPHER, '-', "Encrypt the output with any supported cipher"},
48     {"verbose", OPT_VERBOSE, '-', "Verbose output"},
49     {NULL}
50 };
51
52 int gendsa_main(int argc, char **argv)
53 {
54     ENGINE *e = NULL;
55     BIO *out = NULL, *in = NULL;
56     DSA *dsa = NULL;
57     const EVP_CIPHER *enc = NULL;
58     char *dsaparams = NULL;
59     char *outfile = NULL, *passoutarg = NULL, *passout = NULL, *prog;
60     OPTION_CHOICE o;
61     int ret = 1, private = 0, verbose = 0;
62     const BIGNUM *p = NULL;
63
64     prog = opt_init(argc, argv, gendsa_options);
65     while ((o = opt_next()) != OPT_EOF) {
66         switch (o) {
67         case OPT_EOF:
68         case OPT_ERR:
69  opthelp:
70             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
71             goto end;
72         case OPT_HELP:
73             ret = 0;
74             opt_help(gendsa_options);
75             goto end;
76         case OPT_OUT:
77             outfile = opt_arg();
78             break;
79         case OPT_PASSOUT:
80             passoutarg = opt_arg();
81             break;
82         case OPT_ENGINE:
83             e = setup_engine(opt_arg(), 0);
84             break;
85         case OPT_R_CASES:
86             if (!opt_rand(o))
87                 goto end;
88             break;
89         case OPT_CIPHER:
90             if (!opt_cipher(opt_unknown(), &enc))
91                 goto end;
92             break;
93         case OPT_VERBOSE:
94             verbose = 1;
95             break;
96         }
97     }
98     argc = opt_num_rest();
99     argv = opt_rest();
100     private = 1;
101
102     if (argc != 1)
103         goto opthelp;
104     dsaparams = *argv;
105
106     if (!app_passwd(NULL, passoutarg, NULL, &passout)) {
107         BIO_printf(bio_err, "Error getting password\n");
108         goto end;
109     }
110
111     in = bio_open_default(dsaparams, 'r', FORMAT_PEM);
112     if (in == NULL)
113         goto end2;
114
115     if ((dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL)) == NULL) {
116         BIO_printf(bio_err, "unable to load DSA parameter file\n");
117         goto end;
118     }
119     BIO_free(in);
120     in = NULL;
121
122     out = bio_open_owner(outfile, FORMAT_PEM, private);
123     if (out == NULL)
124         goto end2;
125
126     DSA_get0_pqg(dsa, &p, NULL, NULL);
127
128     if (BN_num_bits(p) > OPENSSL_DSA_MAX_MODULUS_BITS)
129         BIO_printf(bio_err,
130                    "Warning: It is not recommended to use more than %d bit for DSA keys.\n"
131                    "         Your key size is %d! Larger key size may behave not as expected.\n",
132                    OPENSSL_DSA_MAX_MODULUS_BITS, BN_num_bits(p));
133
134     if (verbose)
135         BIO_printf(bio_err, "Generating DSA key, %d bits\n", BN_num_bits(p));
136     if (!DSA_generate_key(dsa))
137         goto end;
138
139     assert(private);
140     if (!PEM_write_bio_DSAPrivateKey(out, dsa, enc, NULL, 0, NULL, passout))
141         goto end;
142     ret = 0;
143  end:
144     if (ret != 0)
145         ERR_print_errors(bio_err);
146  end2:
147     BIO_free(in);
148     BIO_free_all(out);
149     DSA_free(dsa);
150     release_engine(e);
151     OPENSSL_free(passout);
152     return ret;
153 }
154 #endif