Add more features that may be disabled
[openssl.git] / apps / genpkey.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 2006
4  */
5 /* ====================================================================
6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58 #include <stdio.h>
59 #include <string.h>
60 #include "apps.h"
61 #include <openssl/pem.h>
62 #include <openssl/err.h>
63 #include <openssl/evp.h>
64 #ifndef OPENSSL_NO_ENGINE
65 # include <openssl/engine.h>
66 #endif
67
68 static int init_keygen_file(EVP_PKEY_CTX **pctx, const char *file, ENGINE *e);
69 static int genpkey_cb(EVP_PKEY_CTX *ctx);
70
71 typedef enum OPTION_choice {
72     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
73     OPT_ENGINE, OPT_OUTFORM, OPT_OUT, OPT_PASS, OPT_PARAMFILE,
74     OPT_ALGORITHM, OPT_PKEYOPT, OPT_GENPARAM, OPT_TEXT, OPT_CIPHER
75 } OPTION_CHOICE;
76
77 OPTIONS genpkey_options[] = {
78     {"help", OPT_HELP, '-', "Display this summary"},
79     {"out", OPT_OUT, '>', "Output file"},
80     {"outform", OPT_OUTFORM, 'F', "output format (DER or PEM)"},
81     {"pass", OPT_PASS, 's', "Output file pass phrase source"},
82     {"paramfile", OPT_PARAMFILE, '<', "Parameters file"},
83     {"algorithm", OPT_ALGORITHM, 's', "The public key algorithm"},
84     {"pkeyopt", OPT_PKEYOPT, 's',
85      "Set the public key algorithm option as opt:value"},
86     {"genparam", OPT_GENPARAM, '-', "Generate parameters, not key"},
87     {"text", OPT_TEXT, '-', "Print the in text"},
88     {"", OPT_CIPHER, '-', "Cipher to use to encrypt the key"},
89 #ifndef OPENSSL_NO_ENGINE
90     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
91 #endif
92     /* This is deliberately last. */
93     {OPT_HELP_STR, 1, 1,
94      "Order of options may be important!  See the documentation.\n"},
95     {NULL}
96 };
97
98 int genpkey_main(int argc, char **argv)
99 {
100     BIO *in = NULL, *out = NULL;
101     ENGINE *e = NULL;
102     EVP_PKEY *pkey = NULL;
103     EVP_PKEY_CTX *ctx = NULL;
104     char *outfile = NULL, *passarg = NULL, *pass = NULL, *prog;
105     const EVP_CIPHER *cipher = NULL;
106     OPTION_CHOICE o;
107     int outformat = FORMAT_PEM, text = 0, ret = 1, rv, do_param = 0;
108     int private = 0;
109
110     prog = opt_init(argc, argv, genpkey_options);
111     while ((o = opt_next()) != OPT_EOF) {
112         switch (o) {
113         case OPT_EOF:
114         case OPT_ERR:
115  opthelp:
116             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
117             goto end;
118         case OPT_HELP:
119             ret = 0;
120             opt_help(genpkey_options);
121             goto end;
122         case OPT_OUTFORM:
123             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
124                 goto opthelp;
125             break;
126         case OPT_OUT:
127             outfile = opt_arg();
128             break;
129         case OPT_PASS:
130             passarg = opt_arg();
131             break;
132         case OPT_ENGINE:
133             e = setup_engine(opt_arg(), 0);
134             break;
135         case OPT_PARAMFILE:
136             if (do_param == 1)
137                 goto opthelp;
138             if (!init_keygen_file(&ctx, opt_arg(), e))
139                 goto end;
140             break;
141         case OPT_ALGORITHM:
142             if (!init_gen_str(&ctx, opt_arg(), e, do_param))
143                 goto end;
144             break;
145         case OPT_PKEYOPT:
146             if (ctx == NULL) {
147                 BIO_printf(bio_err, "%s: No keytype specified.\n", prog);
148                 goto opthelp;
149             }
150             if (pkey_ctrl_string(ctx, opt_arg()) <= 0) {
151                 BIO_printf(bio_err,
152                            "%s: Error setting %s parameter:\n",
153                            prog, opt_arg());
154                 ERR_print_errors(bio_err);
155                 goto end;
156             }
157             break;
158         case OPT_GENPARAM:
159             if (ctx != NULL)
160                 goto opthelp;
161             do_param = 1;
162             break;
163         case OPT_TEXT:
164             text = 1;
165             break;
166         case OPT_CIPHER:
167             if (!opt_cipher(opt_unknown(), &cipher)
168                 || do_param == 1)
169                 goto opthelp;
170         }
171     }
172     argc = opt_num_rest();
173     argv = opt_rest();
174     private = do_param ? 0 : 1;
175
176     if (ctx == NULL)
177         goto opthelp;
178
179     if (!app_passwd(passarg, NULL, &pass, NULL)) {
180         BIO_puts(bio_err, "Error getting password\n");
181         goto end;
182     }
183
184     if (!app_load_modules(NULL))
185         goto end;
186
187     out = bio_open_owner(outfile, outformat, private);
188     if (out == NULL)
189         goto end;
190
191     EVP_PKEY_CTX_set_cb(ctx, genpkey_cb);
192     EVP_PKEY_CTX_set_app_data(ctx, bio_err);
193
194     if (do_param) {
195         if (EVP_PKEY_paramgen(ctx, &pkey) <= 0) {
196             BIO_puts(bio_err, "Error generating parameters\n");
197             ERR_print_errors(bio_err);
198             goto end;
199         }
200     } else {
201         if (EVP_PKEY_keygen(ctx, &pkey) <= 0) {
202             BIO_puts(bio_err, "Error generating key\n");
203             ERR_print_errors(bio_err);
204             goto end;
205         }
206     }
207
208     if (do_param)
209         rv = PEM_write_bio_Parameters(out, pkey);
210     else if (outformat == FORMAT_PEM) {
211         assert(private);
212         rv = PEM_write_bio_PrivateKey(out, pkey, cipher, NULL, 0, NULL, pass);
213     } else if (outformat == FORMAT_ASN1) {
214         assert(private);
215         rv = i2d_PrivateKey_bio(out, pkey);
216     } else {
217         BIO_printf(bio_err, "Bad format specified for key\n");
218         goto end;
219     }
220
221     if (rv <= 0) {
222         BIO_puts(bio_err, "Error writing key\n");
223         ERR_print_errors(bio_err);
224     }
225
226     if (text) {
227         if (do_param)
228             rv = EVP_PKEY_print_params(out, pkey, 0, NULL);
229         else
230             rv = EVP_PKEY_print_private(out, pkey, 0, NULL);
231
232         if (rv <= 0) {
233             BIO_puts(bio_err, "Error printing key\n");
234             ERR_print_errors(bio_err);
235         }
236     }
237
238     ret = 0;
239
240  end:
241     EVP_PKEY_free(pkey);
242     EVP_PKEY_CTX_free(ctx);
243     BIO_free_all(out);
244     BIO_free(in);
245     OPENSSL_free(pass);
246
247     return ret;
248 }
249
250 static int init_keygen_file(EVP_PKEY_CTX **pctx, const char *file, ENGINE *e)
251 {
252     BIO *pbio;
253     EVP_PKEY *pkey = NULL;
254     EVP_PKEY_CTX *ctx = NULL;
255     if (*pctx) {
256         BIO_puts(bio_err, "Parameters already set!\n");
257         return 0;
258     }
259
260     pbio = BIO_new_file(file, "r");
261     if (!pbio) {
262         BIO_printf(bio_err, "Can't open parameter file %s\n", file);
263         return 0;
264     }
265
266     pkey = PEM_read_bio_Parameters(pbio, NULL);
267     BIO_free(pbio);
268
269     if (!pkey) {
270         BIO_printf(bio_err, "Error reading parameter file %s\n", file);
271         return 0;
272     }
273
274     ctx = EVP_PKEY_CTX_new(pkey, e);
275     if (!ctx)
276         goto err;
277     if (EVP_PKEY_keygen_init(ctx) <= 0)
278         goto err;
279     EVP_PKEY_free(pkey);
280     *pctx = ctx;
281     return 1;
282
283  err:
284     BIO_puts(bio_err, "Error initializing context\n");
285     ERR_print_errors(bio_err);
286     EVP_PKEY_CTX_free(ctx);
287     EVP_PKEY_free(pkey);
288     return 0;
289
290 }
291
292 int init_gen_str(EVP_PKEY_CTX **pctx,
293                  const char *algname, ENGINE *e, int do_param)
294 {
295     EVP_PKEY_CTX *ctx = NULL;
296     const EVP_PKEY_ASN1_METHOD *ameth;
297     ENGINE *tmpeng = NULL;
298     int pkey_id;
299
300     if (*pctx) {
301         BIO_puts(bio_err, "Algorithm already set!\n");
302         return 0;
303     }
304
305     ameth = EVP_PKEY_asn1_find_str(&tmpeng, algname, -1);
306
307 #ifndef OPENSSL_NO_ENGINE
308     if (!ameth && e)
309         ameth = ENGINE_get_pkey_asn1_meth_str(e, algname, -1);
310 #endif
311
312     if (!ameth) {
313         BIO_printf(bio_err, "Algorithm %s not found\n", algname);
314         return 0;
315     }
316
317     ERR_clear_error();
318
319     EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL, ameth);
320 #ifndef OPENSSL_NO_ENGINE
321     if (tmpeng)
322         ENGINE_finish(tmpeng);
323 #endif
324     ctx = EVP_PKEY_CTX_new_id(pkey_id, e);
325
326     if (!ctx)
327         goto err;
328     if (do_param) {
329         if (EVP_PKEY_paramgen_init(ctx) <= 0)
330             goto err;
331     } else {
332         if (EVP_PKEY_keygen_init(ctx) <= 0)
333             goto err;
334     }
335
336     *pctx = ctx;
337     return 1;
338
339  err:
340     BIO_printf(bio_err, "Error initializing %s context\n", algname);
341     ERR_print_errors(bio_err);
342     EVP_PKEY_CTX_free(ctx);
343     return 0;
344
345 }
346
347 static int genpkey_cb(EVP_PKEY_CTX *ctx)
348 {
349     char c = '*';
350     BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
351     int p;
352     p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
353     if (p == 0)
354         c = '.';
355     if (p == 1)
356         c = '+';
357     if (p == 2)
358         c = '*';
359     if (p == 3)
360         c = '\n';
361     BIO_write(b, &c, 1);
362     (void)BIO_flush(b);
363     return 1;
364 }