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     {OPT_HELP_STR, 1, 1,
  93      "Order of options may be important!  See the documentation.\n"},
  94     {NULL}
  95 };
  96
  97 int genpkey_main(int argc, char **argv)
  98 {
  99     BIO *in = NULL, *out = NULL;
 100     ENGINE *e = NULL;
 101     EVP_PKEY *pkey = NULL;
 102     EVP_PKEY_CTX *ctx = NULL;
 103     char *outfile = NULL, *passarg = NULL, *pass = NULL, *prog;
 104     const EVP_CIPHER *cipher = NULL;
 105     OPTION_CHOICE o;
 106     int outformat = FORMAT_PEM, text = 0, ret = 1, rv, do_param = 0;
 107
 108     prog = opt_init(argc, argv, genpkey_options);
 109     while ((o = opt_next()) != OPT_EOF) {
 110         switch (o) {
 111         case OPT_EOF:
 112         case OPT_ERR:
 113  opthelp:
 114             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 115             goto end;
 116         case OPT_HELP:
 117             ret = 0;
 118             opt_help(genpkey_options);
 119             goto end;
 120         case OPT_OUTFORM:
 121             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
 122                 goto opthelp;
 123             break;
 124         case OPT_OUT:
 125             outfile = opt_arg();
 126             break;
 127
 128         case OPT_PASS:
 129             passarg = opt_arg();
 130             break;
 131         case OPT_ENGINE:
 132             e = setup_engine(opt_arg(), 0);
 133             break;
 134         case OPT_PARAMFILE:
 135             if (do_param == 1)
 136                 goto opthelp;
 137             if (!init_keygen_file(&ctx, opt_arg(), e))
 138                 goto end;
 139             break;
 140         case OPT_ALGORITHM:
 141             if (!init_gen_str(&ctx, opt_arg(), e, do_param))
 142                 goto end;
 143             break;
 144         case OPT_PKEYOPT:
 145             if (ctx == NULL) {
 146                 BIO_printf(bio_err, "%s: No keytype specified.\n", prog);
 147                 goto opthelp;
 148             }
 149             if (pkey_ctrl_string(ctx, opt_arg()) <= 0) {
 150                 BIO_printf(bio_err,
 151                            "%s: Error setting %s parameter:\n",
 152                            prog, opt_arg());
 153                 ERR_print_errors(bio_err);
 154                 goto end;
 155             }
 156             break;
 157         case OPT_GENPARAM:
 158             if (ctx != NULL)
 159                 goto opthelp;
 160             do_param = 1;
 161             break;
 162         case OPT_TEXT:
 163             text = 1;
 164             break;
 165         case OPT_CIPHER:
 166             if (!opt_cipher(opt_unknown(), &cipher)
 167                 || do_param == 1)
 168                 goto opthelp;
 169         }
 170     }
 171     argc = opt_num_rest();
 172     argv = opt_rest();
 173
 174     if (ctx == NULL)
 175         goto opthelp;
 176
 177     if (!app_passwd(passarg, NULL, &pass, NULL)) {
 178         BIO_puts(bio_err, "Error getting password\n");
 179         goto end;
 180     }
 181
 182     out = bio_open_default(outfile, "wb");
 183     if (out == NULL)
 184         goto end;
 185
 186     EVP_PKEY_CTX_set_cb(ctx, genpkey_cb);
 187     EVP_PKEY_CTX_set_app_data(ctx, bio_err);
 188
 189     if (do_param) {
 190         if (EVP_PKEY_paramgen(ctx, &pkey) <= 0) {
 191             BIO_puts(bio_err, "Error generating parameters\n");
 192             ERR_print_errors(bio_err);
 193             goto end;
 194         }
 195     } else {
 196         if (EVP_PKEY_keygen(ctx, &pkey) <= 0) {
 197             BIO_puts(bio_err, "Error generating key\n");
 198             ERR_print_errors(bio_err);
 199             goto end;
 200         }
 201     }
 202
 203     if (do_param)
 204         rv = PEM_write_bio_Parameters(out, pkey);
 205     else if (outformat == FORMAT_PEM)
 206         rv = PEM_write_bio_PrivateKey(out, pkey, cipher, NULL, 0, NULL, pass);
 207     else if (outformat == FORMAT_ASN1)
 208         rv = i2d_PrivateKey_bio(out, pkey);
 209     else {
 210         BIO_printf(bio_err, "Bad format specified for key\n");
 211         goto end;
 212     }
 213
 214     if (rv <= 0) {
 215         BIO_puts(bio_err, "Error writing key\n");
 216         ERR_print_errors(bio_err);
 217     }
 218
 219     if (text) {
 220         if (do_param)
 221             rv = EVP_PKEY_print_params(out, pkey, 0, NULL);
 222         else
 223             rv = EVP_PKEY_print_private(out, pkey, 0, NULL);
 224
 225         if (rv <= 0) {
 226             BIO_puts(bio_err, "Error printing key\n");
 227             ERR_print_errors(bio_err);
 228         }
 229     }
 230
 231     ret = 0;
 232
 233  end:
 234     EVP_PKEY_free(pkey);
 235     EVP_PKEY_CTX_free(ctx);
 236     BIO_free_all(out);
 237     BIO_free(in);
 238     if (pass)
 239         OPENSSL_free(pass);
 240
 241     return ret;
 242 }
 243
 244 static int init_keygen_file(EVP_PKEY_CTX **pctx, const char *file, ENGINE *e)
 245 {
 246     BIO *pbio;
 247     EVP_PKEY *pkey = NULL;
 248     EVP_PKEY_CTX *ctx = NULL;
 249     if (*pctx) {
 250         BIO_puts(bio_err, "Parameters already set!\n");
 251         return 0;
 252     }
 253
 254     pbio = BIO_new_file(file, "r");
 255     if (!pbio) {
 256         BIO_printf(bio_err, "Can't open parameter file %s\n", file);
 257         return 0;
 258     }
 259
 260     pkey = PEM_read_bio_Parameters(pbio, NULL);
 261     BIO_free(pbio);
 262
 263     if (!pkey) {
 264         BIO_printf(bio_err, "Error reading parameter file %s\n", file);
 265         return 0;
 266     }
 267
 268     ctx = EVP_PKEY_CTX_new(pkey, e);
 269     if (!ctx)
 270         goto err;
 271     if (EVP_PKEY_keygen_init(ctx) <= 0)
 272         goto err;
 273     EVP_PKEY_free(pkey);
 274     *pctx = ctx;
 275     return 1;
 276
 277  err:
 278     BIO_puts(bio_err, "Error initializing context\n");
 279     ERR_print_errors(bio_err);
 280     EVP_PKEY_CTX_free(ctx);
 281     EVP_PKEY_free(pkey);
 282     return 0;
 283
 284 }
 285
 286 int init_gen_str(EVP_PKEY_CTX **pctx,
 287                  const char *algname, ENGINE *e, int do_param)
 288 {
 289     EVP_PKEY_CTX *ctx = NULL;
 290     const EVP_PKEY_ASN1_METHOD *ameth;
 291     ENGINE *tmpeng = NULL;
 292     int pkey_id;
 293
 294     if (*pctx) {
 295         BIO_puts(bio_err, "Algorithm already set!\n");
 296         return 0;
 297     }
 298
 299     ameth = EVP_PKEY_asn1_find_str(&tmpeng, algname, -1);
 300
 301 #ifndef OPENSSL_NO_ENGINE
 302     if (!ameth && e)
 303         ameth = ENGINE_get_pkey_asn1_meth_str(e, algname, -1);
 304 #endif
 305
 306     if (!ameth) {
 307         BIO_printf(bio_err, "Algorithm %s not found\n", algname);
 308         return 0;
 309     }
 310
 311     ERR_clear_error();
 312
 313     EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL, ameth);
 314 #ifndef OPENSSL_NO_ENGINE
 315     if (tmpeng)
 316         ENGINE_finish(tmpeng);
 317 #endif
 318     ctx = EVP_PKEY_CTX_new_id(pkey_id, e);
 319
 320     if (!ctx)
 321         goto err;
 322     if (do_param) {
 323         if (EVP_PKEY_paramgen_init(ctx) <= 0)
 324             goto err;
 325     } else {
 326         if (EVP_PKEY_keygen_init(ctx) <= 0)
 327             goto err;
 328     }
 329
 330     *pctx = ctx;
 331     return 1;
 332
 333  err:
 334     BIO_printf(bio_err, "Error initializing %s context\n", algname);
 335     ERR_print_errors(bio_err);
 336     EVP_PKEY_CTX_free(ctx);
 337     return 0;
 338
 339 }
 340
 341 static int genpkey_cb(EVP_PKEY_CTX *ctx)
 342 {
 343     char c = '*';
 344     BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
 345     int p;
 346     p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
 347     if (p == 0)
 348         c = '.';
 349     if (p == 1)
 350         c = '+';
 351     if (p == 2)
 352         c = '*';
 353     if (p == 3)
 354         c = '\n';
 355     BIO_write(b, &c, 1);
 356     (void)BIO_flush(b);
 357     return 1;
 358 }