apps/pkey.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 #ifndef OPENSSL_NO_EC
  19 # include <openssl/ec.h>
  20
  21 static OPT_PAIR ec_conv_forms[] = {
  22     {"compressed", POINT_CONVERSION_COMPRESSED},
  23     {"uncompressed", POINT_CONVERSION_UNCOMPRESSED},
  24     {"hybrid", POINT_CONVERSION_HYBRID},
  25     {NULL}
  26 };
  27
  28 static OPT_PAIR ec_param_enc[] = {
  29     {"named_curve", OPENSSL_EC_NAMED_CURVE},
  30     {"explicit", 0},
  31     {NULL}
  32 };
  33 #endif
  34
  35 typedef enum OPTION_choice {
  36     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  37     OPT_INFORM, OPT_OUTFORM, OPT_PASSIN, OPT_PASSOUT, OPT_ENGINE,
  38     OPT_IN, OPT_OUT, OPT_PUBIN, OPT_PUBOUT, OPT_TEXT_PUB,
  39     OPT_TEXT, OPT_NOOUT, OPT_MD, OPT_TRADITIONAL, OPT_CHECK, OPT_PUB_CHECK,
  40     OPT_EC_PARAM_ENC, OPT_EC_CONV_FORM,
  41     OPT_PROV_ENUM
  42 } OPTION_CHOICE;
  43
  44 const OPTIONS pkey_options[] = {
  45     OPT_SECTION("General"),
  46     {"help", OPT_HELP, '-', "Display this summary"},
  47 #ifndef OPENSSL_NO_ENGINE
  48     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
  49 #endif
  50     {"check", OPT_CHECK, '-', "Check key consistency"},
  51     {"pubcheck", OPT_PUB_CHECK, '-', "Check public key consistency"},
  52     {"", OPT_MD, '-', "Any supported cipher"},
  53     {"ec_param_enc", OPT_EC_PARAM_ENC, 's',
  54      "Specifies the way the ec parameters are encoded"},
  55     {"ec_conv_form", OPT_EC_CONV_FORM, 's',
  56      "Specifies the point conversion form "},
  57
  58     OPT_SECTION("Input"),
  59     {"in", OPT_IN, 's', "Input key"},
  60     {"inform", OPT_INFORM, 'f', "Input format (DER or PEM)"},
  61     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
  62     {"pubin", OPT_PUBIN, '-',
  63      "Read public key from input (default is private key)"},
  64     {"traditional", OPT_TRADITIONAL, '-',
  65      "Use traditional format for private keys"},
  66
  67     OPT_SECTION("Output"),
  68     {"outform", OPT_OUTFORM, 'F', "Output format (DER or PEM)"},
  69     {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
  70     {"out", OPT_OUT, '>', "Output file"},
  71     {"pubout", OPT_PUBOUT, '-', "Output public key, not private"},
  72     {"text_pub", OPT_TEXT_PUB, '-', "Only output public key components"},
  73     {"text", OPT_TEXT, '-', "Output in plaintext as well"},
  74     {"noout", OPT_NOOUT, '-', "Don't output the key"},
  75
  76     OPT_PROV_OPTIONS,
  77     {NULL}
  78 };
  79
  80 int pkey_main(int argc, char **argv)
  81 {
  82     BIO *in = NULL, *out = NULL;
  83     ENGINE *e = NULL;
  84     EVP_PKEY *pkey = NULL;
  85     const EVP_CIPHER *cipher = NULL;
  86     char *infile = NULL, *outfile = NULL, *passin = NULL, *passout = NULL;
  87     char *passinarg = NULL, *passoutarg = NULL, *prog;
  88     OPTION_CHOICE o;
  89     int informat = FORMAT_PEM, outformat = FORMAT_PEM;
  90     int pubin = 0, pubout = 0, pubtext = 0, text = 0, noout = 0, ret = 1;
  91     int private = 0, traditional = 0, check = 0, pub_check = 0;
  92 #ifndef OPENSSL_NO_EC
  93     EC_KEY *eckey;
  94     int ec_asn1_flag = OPENSSL_EC_NAMED_CURVE, new_ec_asn1_flag = 0;
  95     int i, new_ec_form = 0;
  96     point_conversion_form_t ec_form = POINT_CONVERSION_UNCOMPRESSED;
  97 #endif
  98
  99     prog = opt_init(argc, argv, pkey_options);
 100     while ((o = opt_next()) != OPT_EOF) {
 101         switch (o) {
 102         case OPT_EOF:
 103         case OPT_ERR:
 104  opthelp:
 105             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 106             goto end;
 107         case OPT_HELP:
 108             opt_help(pkey_options);
 109             ret = 0;
 110             goto end;
 111         case OPT_INFORM:
 112             if (!opt_format(opt_arg(), OPT_FMT_ANY, &informat))
 113                 goto opthelp;
 114             break;
 115         case OPT_OUTFORM:
 116             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
 117                 goto opthelp;
 118             break;
 119         case OPT_PASSIN:
 120             passinarg = opt_arg();
 121             break;
 122         case OPT_PASSOUT:
 123             passoutarg = opt_arg();
 124             break;
 125         case OPT_ENGINE:
 126             e = setup_engine(opt_arg(), 0);
 127             break;
 128         case OPT_IN:
 129             infile = opt_arg();
 130             break;
 131         case OPT_OUT:
 132             outfile = opt_arg();
 133             break;
 134         case OPT_PUBIN:
 135             pubin = pubout = pubtext = 1;
 136             break;
 137         case OPT_PUBOUT:
 138             pubout = 1;
 139             break;
 140         case OPT_TEXT_PUB:
 141             pubtext = text = 1;
 142             break;
 143         case OPT_TEXT:
 144             text = 1;
 145             break;
 146         case OPT_NOOUT:
 147             noout = 1;
 148             break;
 149         case OPT_TRADITIONAL:
 150             traditional = 1;
 151             break;
 152         case OPT_CHECK:
 153             check = 1;
 154             break;
 155         case OPT_PUB_CHECK:
 156             pub_check = 1;
 157             break;
 158         case OPT_MD:
 159             if (!opt_cipher(opt_unknown(), &cipher))
 160                 goto opthelp;
 161             break;
 162         case OPT_EC_CONV_FORM:
 163 #ifdef OPENSSL_NO_EC
 164             goto opthelp;
 165 #else
 166             if (!opt_pair(opt_arg(), ec_conv_forms, &i))
 167                 goto opthelp;
 168             new_ec_form = 1;
 169             ec_form = i;
 170             break;
 171 #endif
 172         case OPT_EC_PARAM_ENC:
 173 #ifdef OPENSSL_NO_EC
 174             goto opthelp;
 175 #else
 176             if (!opt_pair(opt_arg(), ec_param_enc, &i))
 177                 goto opthelp;
 178             new_ec_asn1_flag = 1;
 179             ec_asn1_flag = i;
 180             break;
 181 #endif
 182         case OPT_PROV_CASES:
 183             if (!opt_provider(o))
 184                 goto end;
 185             break;
 186         }
 187     }
 188     argc = opt_num_rest();
 189     if (argc != 0)
 190         goto opthelp;
 191
 192     private = !noout && !pubout ? 1 : 0;
 193     if (text && !pubtext)
 194         private = 1;
 195
 196     if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
 197         BIO_printf(bio_err, "Error getting passwords\n");
 198         goto end;
 199     }
 200
 201     out = bio_open_owner(outfile, outformat, private);
 202     if (out == NULL)
 203         goto end;
 204
 205     if (pubin)
 206         pkey = load_pubkey(infile, informat, 1, passin, e, "Public Key");
 207     else
 208         pkey = load_key(infile, informat, 1, passin, e, "key");
 209     if (pkey == NULL)
 210         goto end;
 211
 212 #ifndef OPENSSL_NO_EC
 213     /*
 214      * TODO: remove this and use a set params call with a 'pkeyopt' command
 215      * line option instead.
 216      */
 217     if (new_ec_form || new_ec_asn1_flag) {
 218         if ((eckey = EVP_PKEY_get0_EC_KEY(pkey)) == NULL) {
 219             ERR_print_errors(bio_err);
 220             goto end;
 221         }
 222         if (new_ec_form)
 223             EC_KEY_set_conv_form(eckey, ec_form);
 224
 225         if (new_ec_asn1_flag)
 226             EC_KEY_set_asn1_flag(eckey, ec_asn1_flag);
 227     }
 228 #endif
 229
 230     if (check || pub_check) {
 231         int r;
 232         EVP_PKEY_CTX *ctx;
 233
 234         ctx = EVP_PKEY_CTX_new(pkey, e);
 235         if (ctx == NULL) {
 236             ERR_print_errors(bio_err);
 237             goto end;
 238         }
 239
 240         if (check)
 241             r = EVP_PKEY_check(ctx);
 242         else
 243             r = EVP_PKEY_public_check(ctx);
 244
 245         if (r == 1) {
 246             BIO_printf(out, "Key is valid\n");
 247         } else {
 248             /*
 249              * Note: at least for RSA keys if this function returns
 250              * -1, there will be no error reasons.
 251              */
 252             unsigned long err;
 253
 254             BIO_printf(out, "Key is invalid\n");
 255
 256             while ((err = ERR_peek_error()) != 0) {
 257                 BIO_printf(out, "Detailed error: %s\n",
 258                            ERR_reason_error_string(err));
 259                 ERR_get_error(); /* remove err from error stack */
 260             }
 261         }
 262         EVP_PKEY_CTX_free(ctx);
 263     }
 264
 265     if (!noout) {
 266         if (outformat == FORMAT_PEM) {
 267             if (pubout) {
 268                 if (!PEM_write_bio_PUBKEY(out, pkey))
 269                     goto end;
 270             } else {
 271                 assert(private);
 272                 if (traditional) {
 273                     if (!PEM_write_bio_PrivateKey_traditional(out, pkey, cipher,
 274                                                               NULL, 0, NULL,
 275                                                               passout))
 276                         goto end;
 277                 } else {
 278                     if (!PEM_write_bio_PrivateKey(out, pkey, cipher,
 279                                                   NULL, 0, NULL, passout))
 280                         goto end;
 281                 }
 282             }
 283         } else if (outformat == FORMAT_ASN1) {
 284             if (pubout) {
 285                 if (!i2d_PUBKEY_bio(out, pkey))
 286                     goto end;
 287             } else {
 288                 assert(private);
 289                 if (!i2d_PrivateKey_bio(out, pkey))
 290                     goto end;
 291             }
 292         } else {
 293             BIO_printf(bio_err, "Bad format specified for key\n");
 294             goto end;
 295         }
 296     }
 297
 298     if (text) {
 299         if (pubtext) {
 300             if (EVP_PKEY_print_public(out, pkey, 0, NULL) <= 0)
 301                 goto end;
 302         } else {
 303             assert(private);
 304             if (EVP_PKEY_print_private(out, pkey, 0, NULL) <= 0)
 305                 goto end;
 306         }
 307     }
 308
 309     ret = 0;
 310
 311  end:
 312     if (ret != 0)
 313         ERR_print_errors(bio_err);
 314     EVP_PKEY_free(pkey);
 315     release_engine(e);
 316     BIO_free_all(out);
 317     BIO_free(in);
 318     OPENSSL_free(passin);
 319     OPENSSL_free(passout);
 320
 321     return ret;
 322 }