2 * Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
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
14 #include <openssl/pem.h>
15 #include <openssl/err.h>
16 #include <openssl/evp.h>
19 # include <openssl/ec.h>
21 static OPT_PAIR ec_conv_forms[] = {
22 {"compressed", POINT_CONVERSION_COMPRESSED},
23 {"uncompressed", POINT_CONVERSION_UNCOMPRESSED},
24 {"hybrid", POINT_CONVERSION_HYBRID},
28 static OPT_PAIR ec_param_enc[] = {
29 {"named_curve", OPENSSL_EC_NAMED_CURVE},
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,
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"},
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 "},
59 {"in", OPT_IN, 's', "Input key"},
60 {"inform", OPT_INFORM, 'f', "Input format (DER/PEM/P12/ENGINE)"},
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"},
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"},
80 int pkey_main(int argc, char **argv)
82 BIO *in = NULL, *out = NULL;
84 EVP_PKEY *pkey = NULL;
85 EVP_PKEY_CTX *ctx = NULL;
86 const EVP_CIPHER *cipher = NULL;
87 char *infile = NULL, *outfile = NULL, *passin = NULL, *passout = NULL;
88 char *passinarg = NULL, *passoutarg = NULL, *prog;
90 int informat = FORMAT_PEM, outformat = FORMAT_PEM;
91 int pubin = 0, pubout = 0, pubtext = 0, text = 0, noout = 0, ret = 1;
92 int private = 0, traditional = 0, check = 0, pub_check = 0;
95 int ec_asn1_flag = OPENSSL_EC_NAMED_CURVE, new_ec_asn1_flag = 0;
96 int i, new_ec_form = 0;
97 point_conversion_form_t ec_form = POINT_CONVERSION_UNCOMPRESSED;
100 prog = opt_init(argc, argv, pkey_options);
101 while ((o = opt_next()) != OPT_EOF) {
106 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
109 opt_help(pkey_options);
113 if (!opt_format(opt_arg(), OPT_FMT_ANY, &informat))
117 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
121 passinarg = opt_arg();
124 passoutarg = opt_arg();
127 e = setup_engine(opt_arg(), 0);
136 pubin = pubout = pubtext = 1;
150 case OPT_TRADITIONAL:
160 if (!opt_cipher(opt_unknown(), &cipher))
163 case OPT_EC_CONV_FORM:
167 if (!opt_pair(opt_arg(), ec_conv_forms, &i))
173 case OPT_EC_PARAM_ENC:
177 if (!opt_pair(opt_arg(), ec_param_enc, &i))
179 new_ec_asn1_flag = 1;
184 if (!opt_provider(o))
190 /* No extra arguments. */
191 argc = opt_num_rest();
195 private = !noout && !pubout ? 1 : 0;
196 if (text && !pubtext)
199 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
200 BIO_printf(bio_err, "Error getting passwords\n");
204 out = bio_open_owner(outfile, outformat, private);
209 pkey = load_pubkey(infile, informat, 1, passin, e, "Public Key");
211 pkey = load_key(infile, informat, 1, passin, e, "key");
215 #ifndef OPENSSL_NO_EC
217 * TODO: remove this and use a set params call with a 'pkeyopt' command
218 * line option instead.
220 if (new_ec_form || new_ec_asn1_flag) {
221 if ((eckey = EVP_PKEY_get0_EC_KEY(pkey)) == NULL) {
222 ERR_print_errors(bio_err);
226 EC_KEY_set_conv_form(eckey, ec_form);
228 if (new_ec_asn1_flag)
229 EC_KEY_set_asn1_flag(eckey, ec_asn1_flag);
233 if (check || pub_check) {
236 ctx = EVP_PKEY_CTX_new(pkey, e);
238 ERR_print_errors(bio_err);
243 r = EVP_PKEY_check(ctx);
245 r = EVP_PKEY_public_check(ctx);
248 BIO_printf(out, "Key is valid\n");
251 * Note: at least for RSA keys if this function returns
252 * -1, there will be no error reasons.
256 BIO_printf(out, "Key is invalid\n");
258 while ((err = ERR_peek_error()) != 0) {
259 BIO_printf(out, "Detailed error: %s\n",
260 ERR_reason_error_string(err));
261 ERR_get_error(); /* remove err from error stack */
268 if (outformat == FORMAT_PEM) {
270 if (!PEM_write_bio_PUBKEY(out, pkey))
275 if (!PEM_write_bio_PrivateKey_traditional(out, pkey, cipher,
280 if (!PEM_write_bio_PrivateKey(out, pkey, cipher,
281 NULL, 0, NULL, passout))
285 } else if (outformat == FORMAT_ASN1) {
287 if (!i2d_PUBKEY_bio(out, pkey))
291 if (!i2d_PrivateKey_bio(out, pkey))
295 BIO_printf(bio_err, "Bad format specified for key\n");
302 if (EVP_PKEY_print_public(out, pkey, 0, NULL) <= 0)
306 if (EVP_PKEY_print_private(out, pkey, 0, NULL) <= 0)
315 ERR_print_errors(bio_err);
316 EVP_PKEY_CTX_free(ctx);
321 OPENSSL_free(passin);
322 OPENSSL_free(passout);