apps/genpkey.c

   1 /*
   2  * Copyright 2006-2020 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 <stdio.h>
  11 #include <string.h>
  12 #include "apps.h"
  13 #include "progs.h"
  14 #include <openssl/pem.h>
  15 #include <openssl/err.h>
  16 #include <openssl/evp.h>
  17
  18 static int init_keygen_file(EVP_PKEY_CTX **pctx, const char *file, ENGINE *e,
  19                             OSSL_LIB_CTX *libctx, const char *propq);
  20 static int genpkey_cb(EVP_PKEY_CTX *ctx);
  21
  22 typedef enum OPTION_choice {
  23     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  24     OPT_ENGINE, OPT_OUTFORM, OPT_OUT, OPT_PASS, OPT_PARAMFILE,
  25     OPT_ALGORITHM, OPT_PKEYOPT, OPT_GENPARAM, OPT_TEXT, OPT_CIPHER,
  26     OPT_CONFIG,
  27     OPT_PROV_ENUM
  28 } OPTION_CHOICE;
  29
  30 const OPTIONS genpkey_options[] = {
  31     OPT_SECTION("General"),
  32     {"help", OPT_HELP, '-', "Display this summary"},
  33 #ifndef OPENSSL_NO_ENGINE
  34     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
  35 #endif
  36     {"paramfile", OPT_PARAMFILE, '<', "Parameters file"},
  37     {"algorithm", OPT_ALGORITHM, 's', "The public key algorithm"},
  38     {"pkeyopt", OPT_PKEYOPT, 's',
  39      "Set the public key algorithm option as opt:value"},
  40      OPT_CONFIG_OPTION,
  41
  42     OPT_SECTION("Output"),
  43     {"out", OPT_OUT, '>', "Output file"},
  44     {"outform", OPT_OUTFORM, 'F', "output format (DER or PEM)"},
  45     {"pass", OPT_PASS, 's', "Output file pass phrase source"},
  46     {"genparam", OPT_GENPARAM, '-', "Generate parameters, not key"},
  47     {"text", OPT_TEXT, '-', "Print the in text"},
  48     {"", OPT_CIPHER, '-', "Cipher to use to encrypt the key"},
  49
  50     OPT_PROV_OPTIONS,
  51
  52     /* This is deliberately last. */
  53     {OPT_HELP_STR, 1, 1,
  54      "Order of options may be important!  See the documentation.\n"},
  55     {NULL}
  56 };
  57
  58 int genpkey_main(int argc, char **argv)
  59 {
  60     CONF *conf = NULL;
  61     BIO *in = NULL, *out = NULL;
  62     ENGINE *e = NULL;
  63     EVP_PKEY *pkey = NULL;
  64     EVP_PKEY_CTX *ctx = NULL;
  65     char *outfile = NULL, *passarg = NULL, *pass = NULL, *prog;
  66     const EVP_CIPHER *cipher = NULL;
  67     OPTION_CHOICE o;
  68     int outformat = FORMAT_PEM, text = 0, ret = 1, rv, do_param = 0;
  69     int private = 0;
  70     OSSL_LIB_CTX *libctx = app_get0_libctx();
  71     const char *propq = app_get0_propq();
  72
  73     prog = opt_init(argc, argv, genpkey_options);
  74     while ((o = opt_next()) != OPT_EOF) {
  75         switch (o) {
  76         case OPT_EOF:
  77         case OPT_ERR:
  78  opthelp:
  79             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
  80             goto end;
  81         case OPT_HELP:
  82             ret = 0;
  83             opt_help(genpkey_options);
  84             goto end;
  85         case OPT_OUTFORM:
  86             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
  87                 goto opthelp;
  88             break;
  89         case OPT_OUT:
  90             outfile = opt_arg();
  91             break;
  92         case OPT_PASS:
  93             passarg = opt_arg();
  94             break;
  95         case OPT_ENGINE:
  96             e = setup_engine(opt_arg(), 0);
  97             break;
  98         case OPT_PARAMFILE:
  99             if (do_param == 1)
 100                 goto opthelp;
 101             if (!init_keygen_file(&ctx, opt_arg(), e, libctx, propq))
 102                 goto end;
 103             break;
 104         case OPT_ALGORITHM:
 105             if (!init_gen_str(&ctx, opt_arg(), e, do_param, libctx, propq))
 106                 goto end;
 107             break;
 108         case OPT_PKEYOPT:
 109             if (ctx == NULL) {
 110                 BIO_printf(bio_err, "%s: No keytype specified.\n", prog);
 111                 goto opthelp;
 112             }
 113             if (pkey_ctrl_string(ctx, opt_arg()) <= 0) {
 114                 BIO_printf(bio_err,
 115                            "%s: Error setting %s parameter:\n",
 116                            prog, opt_arg());
 117                 ERR_print_errors(bio_err);
 118                 goto end;
 119             }
 120             break;
 121         case OPT_GENPARAM:
 122             if (ctx != NULL) {
 123                 BIO_printf(bio_err,
 124                            "%s: '-genparam' option must be set before"
 125                             " the '-algorithm' option.\n", prog);
 126                 goto opthelp;
 127             }
 128             do_param = 1;
 129             break;
 130         case OPT_TEXT:
 131             text = 1;
 132             break;
 133         case OPT_CIPHER:
 134             if (!opt_cipher(opt_unknown(), &cipher)
 135                 || do_param == 1)
 136                 goto opthelp;
 137             if (EVP_CIPHER_mode(cipher) == EVP_CIPH_GCM_MODE ||
 138                 EVP_CIPHER_mode(cipher) == EVP_CIPH_CCM_MODE ||
 139                 EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE ||
 140                 EVP_CIPHER_mode(cipher) == EVP_CIPH_OCB_MODE) {
 141                 BIO_printf(bio_err, "%s: cipher mode not supported\n", prog);
 142                 goto end;
 143             }
 144             break;
 145         case OPT_CONFIG:
 146             conf = app_load_config_modules(opt_arg());
 147             if (conf == NULL)
 148                 goto end;
 149             break;
 150         case OPT_PROV_CASES:
 151             if (!opt_provider(o))
 152                 goto end;
 153             break;
 154         }
 155     }
 156     argc = opt_num_rest();
 157     if (argc != 0)
 158         goto opthelp;
 159
 160     private = do_param ? 0 : 1;
 161
 162     if (ctx == NULL)
 163         goto opthelp;
 164
 165     if (!app_passwd(passarg, NULL, &pass, NULL)) {
 166         BIO_puts(bio_err, "Error getting password\n");
 167         goto end;
 168     }
 169
 170     out = bio_open_owner(outfile, outformat, private);
 171     if (out == NULL)
 172         goto end;
 173
 174     EVP_PKEY_CTX_set_cb(ctx, genpkey_cb);
 175     EVP_PKEY_CTX_set_app_data(ctx, bio_err);
 176
 177     if (do_param) {
 178         if (EVP_PKEY_paramgen(ctx, &pkey) <= 0) {
 179             BIO_puts(bio_err, "Error generating parameters\n");
 180             ERR_print_errors(bio_err);
 181             goto end;
 182         }
 183     } else {
 184         if (EVP_PKEY_keygen(ctx, &pkey) <= 0) {
 185             BIO_puts(bio_err, "Error generating key\n");
 186             ERR_print_errors(bio_err);
 187             goto end;
 188         }
 189     }
 190
 191     if (do_param) {
 192         rv = PEM_write_bio_Parameters(out, pkey);
 193     } else if (outformat == FORMAT_PEM) {
 194         assert(private);
 195         rv = PEM_write_bio_PrivateKey(out, pkey, cipher, NULL, 0, NULL, pass);
 196     } else if (outformat == FORMAT_ASN1) {
 197         assert(private);
 198         rv = i2d_PrivateKey_bio(out, pkey);
 199     } else {
 200         BIO_printf(bio_err, "Bad format specified for key\n");
 201         goto end;
 202     }
 203
 204     ret = 0;
 205
 206     if (rv <= 0) {
 207         BIO_puts(bio_err, "Error writing key\n");
 208         ERR_print_errors(bio_err);
 209         ret = 1;
 210     }
 211
 212     if (text) {
 213         if (do_param)
 214             rv = EVP_PKEY_print_params(out, pkey, 0, NULL);
 215         else
 216             rv = EVP_PKEY_print_private(out, pkey, 0, NULL);
 217
 218         if (rv <= 0) {
 219             BIO_puts(bio_err, "Error printing key\n");
 220             ERR_print_errors(bio_err);
 221             ret = 1;
 222         }
 223     }
 224
 225  end:
 226     EVP_PKEY_free(pkey);
 227     EVP_PKEY_CTX_free(ctx);
 228     BIO_free_all(out);
 229     BIO_free(in);
 230     release_engine(e);
 231     OPENSSL_free(pass);
 232     NCONF_free(conf);
 233     return ret;
 234 }
 235
 236 static int init_keygen_file(EVP_PKEY_CTX **pctx, const char *file, ENGINE *e,
 237                             OSSL_LIB_CTX *libctx, const char *propq)
 238 {
 239     BIO *pbio;
 240     EVP_PKEY *pkey = NULL;
 241     EVP_PKEY_CTX *ctx = NULL;
 242     if (*pctx) {
 243         BIO_puts(bio_err, "Parameters already set!\n");
 244         return 0;
 245     }
 246
 247     pbio = BIO_new_file(file, "r");
 248     if (pbio == NULL) {
 249         BIO_printf(bio_err, "Can't open parameter file %s\n", file);
 250         return 0;
 251     }
 252
 253     pkey = PEM_read_bio_Parameters(pbio, NULL);
 254     BIO_free(pbio);
 255
 256     if (pkey == NULL) {
 257         BIO_printf(bio_err, "Error reading parameter file %s\n", file);
 258         return 0;
 259     }
 260
 261     if (e != NULL)
 262         ctx = EVP_PKEY_CTX_new(pkey, e);
 263     else
 264         ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, propq);
 265     if (ctx == NULL)
 266         goto err;
 267     if (EVP_PKEY_keygen_init(ctx) <= 0)
 268         goto err;
 269     EVP_PKEY_free(pkey);
 270     *pctx = ctx;
 271     return 1;
 272
 273  err:
 274     BIO_puts(bio_err, "Error initializing context\n");
 275     ERR_print_errors(bio_err);
 276     EVP_PKEY_CTX_free(ctx);
 277     EVP_PKEY_free(pkey);
 278     return 0;
 279
 280 }
 281
 282 int init_gen_str(EVP_PKEY_CTX **pctx,
 283                  const char *algname, ENGINE *e, int do_param,
 284                  OSSL_LIB_CTX *libctx, const char *propq)
 285 {
 286     EVP_PKEY_CTX *ctx = NULL;
 287     int pkey_id;
 288
 289     if (*pctx) {
 290         BIO_puts(bio_err, "Algorithm already set!\n");
 291         return 0;
 292     }
 293
 294     pkey_id = get_legacy_pkey_id(libctx, algname, e);
 295     if (pkey_id != NID_undef)
 296         ctx = EVP_PKEY_CTX_new_id(pkey_id, e);
 297     else
 298         ctx = EVP_PKEY_CTX_new_from_name(libctx, algname, propq);
 299
 300     if (ctx == NULL)
 301         goto err;
 302     if (do_param) {
 303         if (EVP_PKEY_paramgen_init(ctx) <= 0)
 304             goto err;
 305     } else {
 306         if (EVP_PKEY_keygen_init(ctx) <= 0)
 307             goto err;
 308     }
 309
 310     *pctx = ctx;
 311     return 1;
 312
 313  err:
 314     BIO_printf(bio_err, "Error initializing %s context\n", algname);
 315     ERR_print_errors(bio_err);
 316     EVP_PKEY_CTX_free(ctx);
 317     return 0;
 318
 319 }
 320
 321 static int genpkey_cb(EVP_PKEY_CTX *ctx)
 322 {
 323     char c = '*';
 324     BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
 325     int p;
 326     p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
 327     if (p == 0)
 328         c = '.';
 329     if (p == 1)
 330         c = '+';
 331     if (p == 2)
 332         c = '*';
 333     if (p == 3)
 334         c = '\n';
 335     BIO_write(b, &c, 1);
 336     (void)BIO_flush(b);
 337     return 1;
 338 }