Update some usage messages.
[openssl.git] / apps / genpkey.c
1 /* apps/genpkey.c */
2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
3  * project 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(BIO *err, EVP_PKEY_CTX **pctx,
69                                 const char *file, ENGINE *e);
70 static int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx,
71                                 const char *algname, ENGINE *e, int do_param);
72 static int genpkey_cb(EVP_PKEY_CTX *ctx);
73
74 #define PROG genpkey_main
75
76 int MAIN(int, char **);
77
78 int MAIN(int argc, char **argv)
79         {
80         ENGINE *e = NULL;
81         char **args, *outfile = NULL;
82         char *passarg = NULL;
83         BIO *in = NULL, *out = NULL;
84         const EVP_CIPHER *cipher = NULL;
85         int outformat;
86         int text = 0;
87         EVP_PKEY *pkey=NULL;
88         EVP_PKEY_CTX *ctx = NULL;
89         char *pass = NULL;
90         int badarg = 0;
91         int ret = 1, rv;
92
93         int do_param = 0;
94
95         if (bio_err == NULL)
96                 bio_err = BIO_new_fp (stderr, BIO_NOCLOSE);
97
98         if (!load_config(bio_err, NULL))
99                 goto end;
100
101         outformat=FORMAT_PEM;
102
103         ERR_load_crypto_strings();
104         OpenSSL_add_all_algorithms();
105         args = argv + 1;
106         while (!badarg && *args && *args[0] == '-')
107                 {
108                 if (!strcmp(*args,"-outform"))
109                         {
110                         if (args[1])
111                                 {
112                                 args++;
113                                 outformat=str2fmt(*args);
114                                 }
115                         else badarg = 1;
116                         }
117                 else if (!strcmp(*args,"-pass"))
118                         {
119                         if (!args[1]) goto bad;
120                         passarg= *(++args);
121                         }
122 #ifndef OPENSSL_NO_ENGINE
123                 else if (strcmp(*args,"-engine") == 0)
124                         {
125                         if (!args[1])
126                                 goto bad;
127                         e = setup_engine(bio_err, *(++args), 0);
128                         }
129 #endif
130                 else if (!strcmp (*args, "-paramfile"))
131                         {
132                         if (!args[1])
133                                 goto bad;
134                         args++;
135                         if (do_param == 1)
136                                 goto bad;
137                         if (!init_keygen_file(bio_err, &ctx, *args, e))
138                                 goto end;
139                         }
140                 else if (!strcmp (*args, "-out"))
141                         {
142                         if (args[1])
143                                 {
144                                 args++;
145                                 outfile = *args;
146                                 }
147                         else badarg = 1;
148                         }
149                 else if (strcmp(*args,"-algorithm") == 0)
150                         {
151                         if (!args[1])
152                                 goto bad;
153                         if (!init_gen_str(bio_err, &ctx, *(++args),e, do_param))
154                                 goto end;
155                         }
156                 else if (strcmp(*args,"-pkeyopt") == 0)
157                         {
158                         if (!args[1])
159                                 goto bad;
160                         if (!ctx)
161                                 {
162                                 BIO_puts(bio_err, "No keytype specified\n");
163                                 goto bad;
164                                 }
165                         else if (pkey_ctrl_string(ctx, *(++args)) <= 0)
166                                 {
167                                 BIO_puts(bio_err, "parameter setting error\n");
168                                 ERR_print_errors(bio_err);
169                                 goto end;
170                                 }
171                         }
172                 else if (strcmp(*args,"-genparam") == 0)
173                         {
174                         if (ctx)
175                                 goto bad;
176                         do_param = 1;
177                         }
178                 else if (strcmp(*args,"-text") == 0)
179                         text=1;
180                 else
181                         {
182                         cipher = EVP_get_cipherbyname(*args + 1);
183                         if (!cipher)
184                                 {
185                                 BIO_printf(bio_err, "Unknown cipher %s\n",
186                                                                 *args + 1);
187                                 badarg = 1;
188                                 }
189                         if (do_param == 1)
190                                 badarg = 1;
191                         }
192                 args++;
193                 }
194
195         if (!ctx)
196                 badarg = 1;
197
198         if (badarg)
199                 {
200                 bad:
201                 BIO_printf(bio_err, "Usage: genpkey [options]\n");
202                 BIO_printf(bio_err, "where options may be\n");
203                 BIO_printf(bio_err, "-out file          output file\n");
204                 BIO_printf(bio_err, "-outform X         output format (DER or PEM)\n");
205                 BIO_printf(bio_err, "-pass arg          output file pass phrase source\n");
206                 BIO_printf(bio_err, "-<cipher>          use cipher <cipher> to encrypt the key\n");
207 #ifndef OPENSSL_NO_ENGINE
208                 BIO_printf(bio_err, "-engine e          use engine e, possibly a hardware device.\n");
209 #endif
210                 BIO_printf(bio_err, "-paramfile file    parameters file\n");
211                 BIO_printf(bio_err, "-algorithm alg     the public key algorithm\n");
212                 BIO_printf(bio_err, "-pkeyopt opt:value set the public key algorithm option <opt>\n"
213                                             "                   to value <value>\n");
214                 BIO_printf(bio_err, "-genparam          generate parameters, not key\n");
215                 BIO_printf(bio_err, "-text              print the in text\n");
216                 BIO_printf(bio_err, "NB: options order may be important!  See the manual page.\n");
217                 goto end;
218                 }
219
220         if (!app_passwd(bio_err, passarg, NULL, &pass, NULL))
221                 {
222                 BIO_puts(bio_err, "Error getting password\n");
223                 goto end;
224                 }
225
226         if (outfile)
227                 {
228                 if (!(out = BIO_new_file (outfile, "wb")))
229                         {
230                         BIO_printf(bio_err,
231                                  "Can't open output file %s\n", outfile);
232                         goto end;
233                         }
234                 }
235         else
236                 {
237                 out = BIO_new_fp (stdout, BIO_NOCLOSE);
238 #ifdef OPENSSL_SYS_VMS
239                         {
240                         BIO *tmpbio = BIO_new(BIO_f_linebuffer());
241                         out = BIO_push(tmpbio, out);
242                         }
243 #endif
244                 }
245
246         EVP_PKEY_CTX_set_cb(ctx, genpkey_cb);
247         EVP_PKEY_CTX_set_app_data(ctx, bio_err);
248
249         if (do_param)
250                 {
251                 if (EVP_PKEY_paramgen(ctx, &pkey) <= 0)
252                         {
253                         BIO_puts(bio_err, "Error generating parameters\n");
254                         ERR_print_errors(bio_err);
255                         goto end;
256                         }
257                 }
258         else
259                 {
260                 if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
261                         {
262                         BIO_puts(bio_err, "Error generating key\n");
263                         ERR_print_errors(bio_err);
264                         goto end;
265                         }
266                 }
267
268         if (do_param)
269                 rv = PEM_write_bio_Parameters(out, pkey);
270         else if (outformat == FORMAT_PEM) 
271                 rv = PEM_write_bio_PrivateKey(out, pkey, cipher, NULL, 0,
272                                                                 NULL, pass);
273         else if (outformat == FORMAT_ASN1)
274                 rv = i2d_PrivateKey_bio(out, pkey);
275         else
276                 {
277                 BIO_printf(bio_err, "Bad format specified for key\n");
278                 goto end;
279                 }
280
281         if (rv <= 0)
282                 {
283                 BIO_puts(bio_err, "Error writing key\n");
284                 ERR_print_errors(bio_err);
285                 }
286
287         if (text)
288                 {
289                 if (do_param)
290                         rv = EVP_PKEY_print_params(out, pkey, 0, NULL);
291                 else
292                         rv = EVP_PKEY_print_private(out, pkey, 0, NULL);
293
294                 if (rv <= 0)
295                         {
296                         BIO_puts(bio_err, "Error printing key\n");
297                         ERR_print_errors(bio_err);
298                         }
299                 }
300
301         ret = 0;
302
303         end:
304         if (pkey)
305                 EVP_PKEY_free(pkey);
306         if (ctx)
307                 EVP_PKEY_CTX_free(ctx);
308         if (out)
309                 BIO_free_all(out);
310         BIO_free(in);
311         if (pass)
312                 OPENSSL_free(pass);
313
314         return ret;
315         }
316
317 static int init_keygen_file(BIO *err, EVP_PKEY_CTX **pctx,
318                                 const char *file, ENGINE *e)
319         {
320         BIO *pbio;
321         EVP_PKEY *pkey = NULL;
322         EVP_PKEY_CTX *ctx = NULL;
323         if (*pctx)
324                 {
325                 BIO_puts(err, "Parameters already set!\n");
326                 return 0;
327                 }
328
329         pbio = BIO_new_file(file, "r");
330         if (!pbio)
331                 {
332                 BIO_printf(err, "Can't open parameter file %s\n", file);
333                 return 0;
334                 }
335
336         pkey = PEM_read_bio_Parameters(pbio, NULL);
337         BIO_free(pbio);
338
339         if (!pkey)
340                 {
341                 BIO_printf(bio_err, "Error reading parameter file %s\n", file);
342                 return 0;
343                 }
344
345         ctx = EVP_PKEY_CTX_new(pkey, e);
346         if (!ctx)
347                 goto err;
348         if (EVP_PKEY_keygen_init(ctx) <= 0)
349                 goto err;
350         EVP_PKEY_free(pkey);
351         *pctx = ctx;
352         return 1;
353
354         err:
355         BIO_puts(err, "Error initializing context\n");
356         ERR_print_errors(err);
357         if (ctx)
358                 EVP_PKEY_CTX_free(ctx);
359         if (pkey)
360                 EVP_PKEY_free(pkey);
361         return 0;
362
363         }
364
365 static int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx,
366                                 const char *algname, ENGINE *e, int do_param)
367         {
368         EVP_PKEY_CTX *ctx = NULL;
369         const EVP_PKEY_ASN1_METHOD *ameth;
370         ENGINE *tmpeng = NULL;
371         int pkey_id;
372
373         if (*pctx)
374                 {
375                 BIO_puts(err, "Algorithm already set!\n");
376                 return 0;
377                 }
378         ameth = EVP_PKEY_asn1_find_str(&tmpeng, algname, -1);
379
380         if (!ameth)
381                 {
382                 BIO_printf(bio_err, "Algorithm %s not found\n", algname);
383                 return 0;
384                 }
385
386         EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL, ameth);
387 #ifndef OPENSSL_NO_ENGINE
388         if (tmpeng)
389                 ENGINE_finish(tmpeng);
390 #endif
391         ctx = EVP_PKEY_CTX_new_id(pkey_id, e);
392
393         if (!ctx)
394                 goto err;
395         if (do_param)
396                 {
397                 if (EVP_PKEY_paramgen_init(ctx) <= 0)
398                         goto err;
399                 }
400         else
401                 {
402                 if (EVP_PKEY_keygen_init(ctx) <= 0)
403                         goto err;
404                 }
405
406         *pctx = ctx;
407         return 1;
408
409         err:
410         BIO_printf(err, "Error initializing %s context\n", algname);
411         ERR_print_errors(err);
412         if (ctx)
413                 EVP_PKEY_CTX_free(ctx);
414         return 0;
415
416         }
417
418 static int genpkey_cb(EVP_PKEY_CTX *ctx)
419         {
420         char c='*';
421         BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
422         int p;
423         p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
424         if (p == 0) c='.';
425         if (p == 1) c='+';
426         if (p == 2) c='*';
427         if (p == 3) c='\n';
428         BIO_write(b,&c,1);
429         (void)BIO_flush(b);
430 #ifdef LINT
431         p=n;
432 #endif
433         return 1;
434         }