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
13 #include <openssl/err.h>
14 #include <openssl/pem.h>
15 #include <openssl/evp.h>
18 DEFINE_STACK_OF_STRING()
25 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
26 const char *keyfile, int keyform, int key_type,
27 char *passinarg, int pkey_op, ENGINE *e,
28 const int impl, int rawin, EVP_PKEY **ppkey);
30 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
33 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
34 unsigned char *out, size_t *poutlen,
35 const unsigned char *in, size_t inlen);
37 static int do_raw_keyop(int pkey_op, EVP_PKEY_CTX *ctx,
38 const EVP_MD *md, EVP_PKEY *pkey, BIO *in,
39 int filesize, unsigned char *sig, int siglen,
40 unsigned char **out, size_t *poutlen);
42 typedef enum OPTION_choice {
43 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
44 OPT_ENGINE, OPT_ENGINE_IMPL, OPT_IN, OPT_OUT,
45 OPT_PUBIN, OPT_CERTIN, OPT_ASN1PARSE, OPT_HEXDUMP, OPT_SIGN,
46 OPT_VERIFY, OPT_VERIFYRECOVER, OPT_REV, OPT_ENCRYPT, OPT_DECRYPT,
47 OPT_DERIVE, OPT_SIGFILE, OPT_INKEY, OPT_PEERKEY, OPT_PASSIN,
48 OPT_PEERFORM, OPT_KEYFORM, OPT_PKEYOPT, OPT_PKEYOPT_PASSIN, OPT_KDF,
49 OPT_KDFLEN, OPT_R_ENUM, OPT_PROV_ENUM,
53 const OPTIONS pkeyutl_options[] = {
54 OPT_SECTION("General"),
55 {"help", OPT_HELP, '-', "Display this summary"},
56 #ifndef OPENSSL_NO_ENGINE
57 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
58 {"engine_impl", OPT_ENGINE_IMPL, '-',
59 "Also use engine given by -engine for crypto operations"},
61 {"sign", OPT_SIGN, '-', "Sign input data with private key"},
62 {"verify", OPT_VERIFY, '-', "Verify with public key"},
63 {"encrypt", OPT_ENCRYPT, '-', "Encrypt input data with public key"},
64 {"decrypt", OPT_DECRYPT, '-', "Decrypt input data with private key"},
65 {"derive", OPT_DERIVE, '-', "Derive shared secret"},
68 {"in", OPT_IN, '<', "Input file - default stdin"},
69 {"rawin", OPT_RAWIN, '-', "Indicate the input data is in raw form"},
70 {"pubin", OPT_PUBIN, '-', "Input is a public key"},
71 {"inkey", OPT_INKEY, 's', "Input private key file"},
72 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
73 {"peerkey", OPT_PEERKEY, 's', "Peer key file used in key derivation"},
74 {"peerform", OPT_PEERFORM, 'E', "Peer key format - default PEM"},
75 {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},
76 {"rev", OPT_REV, '-', "Reverse the order of the input buffer"},
77 {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},
78 {"keyform", OPT_KEYFORM, 'E', "Private key format - default PEM"},
80 OPT_SECTION("Output"),
81 {"out", OPT_OUT, '>', "Output file - default stdout"},
82 {"asn1parse", OPT_ASN1PARSE, '-', "asn1parse the output data"},
83 {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},
84 {"verifyrecover", OPT_VERIFYRECOVER, '-',
85 "Verify with public key, recover original data"},
87 OPT_SECTION("Signing/Derivation"),
88 {"digest", OPT_DIGEST, 's',
89 "Specify the digest algorithm when signing the raw input data"},
90 {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},
91 {"pkeyopt_passin", OPT_PKEYOPT_PASSIN, 's',
92 "Public key option that is read as a passphrase argument opt:passphrase"},
93 {"kdf", OPT_KDF, 's', "Use KDF algorithm"},
94 {"kdflen", OPT_KDFLEN, 'p', "KDF algorithm output length"},
101 int pkeyutl_main(int argc, char **argv)
103 BIO *in = NULL, *out = NULL;
105 EVP_PKEY_CTX *ctx = NULL;
106 EVP_PKEY *pkey = NULL;
107 char *infile = NULL, *outfile = NULL, *sigfile = NULL, *passinarg = NULL;
108 char hexdump = 0, asn1parse = 0, rev = 0, *prog;
109 unsigned char *buf_in = NULL, *buf_out = NULL, *sig = NULL;
111 int buf_inlen = 0, siglen = -1, keyform = FORMAT_PEM, peerform = FORMAT_PEM;
112 int keysize = -1, pkey_op = EVP_PKEY_OP_SIGN, key_type = KEY_PRIVKEY;
114 int ret = 1, rv = -1;
116 const char *inkey = NULL;
117 const char *peerkey = NULL;
118 const char *kdfalg = NULL;
120 STACK_OF(OPENSSL_STRING) *pkeyopts = NULL;
121 STACK_OF(OPENSSL_STRING) *pkeyopts_passin = NULL;
123 const EVP_MD *md = NULL;
126 prog = opt_init(argc, argv, pkeyutl_options);
127 while ((o = opt_next()) != OPT_EOF) {
132 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
135 opt_help(pkeyutl_options);
147 case OPT_ENGINE_IMPL:
157 passinarg = opt_arg();
160 if (!opt_format(opt_arg(), OPT_FMT_PDE, &peerform))
164 if (!opt_format(opt_arg(), OPT_FMT_PDE, &keyform))
172 if (!opt_provider(o))
176 e = setup_engine(opt_arg(), 0);
179 key_type = KEY_PUBKEY;
191 pkey_op = EVP_PKEY_OP_SIGN;
194 pkey_op = EVP_PKEY_OP_VERIFY;
196 case OPT_VERIFYRECOVER:
197 pkey_op = EVP_PKEY_OP_VERIFYRECOVER;
200 pkey_op = EVP_PKEY_OP_ENCRYPT;
203 pkey_op = EVP_PKEY_OP_DECRYPT;
206 pkey_op = EVP_PKEY_OP_DERIVE;
209 pkey_op = EVP_PKEY_OP_DERIVE;
214 kdflen = atoi(opt_arg());
220 if ((pkeyopts == NULL &&
221 (pkeyopts = sk_OPENSSL_STRING_new_null()) == NULL) ||
222 sk_OPENSSL_STRING_push(pkeyopts, opt_arg()) == 0) {
223 BIO_puts(bio_err, "out of memory\n");
227 case OPT_PKEYOPT_PASSIN:
228 if ((pkeyopts_passin == NULL &&
229 (pkeyopts_passin = sk_OPENSSL_STRING_new_null()) == NULL) ||
230 sk_OPENSSL_STRING_push(pkeyopts_passin, opt_arg()) == 0) {
231 BIO_puts(bio_err, "out of memory\n");
239 if (!opt_md(opt_arg(), &md))
244 argc = opt_num_rest();
248 if (rawin && pkey_op != EVP_PKEY_OP_SIGN && pkey_op != EVP_PKEY_OP_VERIFY) {
250 "%s: -rawin can only be used with -sign or -verify\n",
255 if (md != NULL && !rawin) {
257 "%s: -digest can only be used with -rawin\n",
263 BIO_printf(bio_err, "%s: -rev cannot be used with raw input\n",
268 if (kdfalg != NULL) {
271 "%s: no KDF length given (-kdflen parameter).\n", prog);
274 } else if (inkey == NULL) {
276 "%s: no private key given (-inkey parameter).\n", prog);
278 } else if (peerkey != NULL && pkey_op != EVP_PKEY_OP_DERIVE) {
280 "%s: no peer key given (-peerkey parameter).\n", prog);
283 ctx = init_ctx(kdfalg, &keysize, inkey, keyform, key_type,
284 passinarg, pkey_op, e, engine_impl, rawin, &pkey);
286 BIO_printf(bio_err, "%s: Error initializing context\n", prog);
287 ERR_print_errors(bio_err);
290 if (peerkey != NULL && !setup_peer(ctx, peerform, peerkey, e)) {
291 BIO_printf(bio_err, "%s: Error setting up peer key\n", prog);
292 ERR_print_errors(bio_err);
295 if (pkeyopts != NULL) {
296 int num = sk_OPENSSL_STRING_num(pkeyopts);
299 for (i = 0; i < num; ++i) {
300 const char *opt = sk_OPENSSL_STRING_value(pkeyopts, i);
302 if (pkey_ctrl_string(ctx, opt) <= 0) {
303 BIO_printf(bio_err, "%s: Can't set parameter \"%s\":\n",
305 ERR_print_errors(bio_err);
310 if (pkeyopts_passin != NULL) {
311 int num = sk_OPENSSL_STRING_num(pkeyopts_passin);
314 for (i = 0; i < num; i++) {
315 char *opt = sk_OPENSSL_STRING_value(pkeyopts_passin, i);
316 char *passin = strchr(opt, ':');
319 if (passin == NULL) {
320 /* Get password interactively */
321 char passwd_buf[4096];
322 BIO_snprintf(passwd_buf, sizeof(passwd_buf), "Enter %s: ", opt);
323 EVP_read_pw_string(passwd_buf, sizeof(passwd_buf) - 1,
325 passwd = OPENSSL_strdup(passwd_buf);
326 if (passwd == NULL) {
327 BIO_puts(bio_err, "out of memory\n");
331 /* Get password as a passin argument: First split option name
332 * and passphrase argument into two strings */
335 if (app_passwd(passin, NULL, &passwd, NULL) == 0) {
336 BIO_printf(bio_err, "failed to get '%s'\n", opt);
341 if (EVP_PKEY_CTX_ctrl_str(ctx, opt, passwd) <= 0) {
342 BIO_printf(bio_err, "%s: Can't set parameter \"%s\":\n",
346 OPENSSL_free(passwd);
350 if (sigfile != NULL && (pkey_op != EVP_PKEY_OP_VERIFY)) {
352 "%s: Signature file specified for non verify\n", prog);
356 if (sigfile == NULL && (pkey_op == EVP_PKEY_OP_VERIFY)) {
358 "%s: No signature file specified for verify\n", prog);
362 if (pkey_op != EVP_PKEY_OP_DERIVE) {
363 in = bio_open_default(infile, 'r', FORMAT_BINARY);
364 if (infile != NULL) {
367 if (stat(infile, &st) == 0 && st.st_size <= INT_MAX)
368 filesize = (int)st.st_size;
373 out = bio_open_default(outfile, 'w', FORMAT_BINARY);
377 if (sigfile != NULL) {
378 BIO *sigbio = BIO_new_file(sigfile, "rb");
380 if (sigbio == NULL) {
381 BIO_printf(bio_err, "Can't open signature file %s\n", sigfile);
384 siglen = bio_to_mem(&sig, keysize * 10, sigbio);
387 BIO_printf(bio_err, "Error reading signature data\n");
392 /* Raw input data is handled elsewhere */
393 if (in != NULL && !rawin) {
394 /* Read the input data */
395 buf_inlen = bio_to_mem(&buf_in, keysize * 10, in);
397 BIO_printf(bio_err, "Error reading input Data\n");
403 size_t l = (size_t)buf_inlen;
404 for (i = 0; i < l / 2; i++) {
406 buf_in[i] = buf_in[l - 1 - i];
407 buf_in[l - 1 - i] = ctmp;
412 /* Sanity check the input if the input is not raw */
414 && buf_inlen > EVP_MAX_MD_SIZE
415 && (pkey_op == EVP_PKEY_OP_SIGN
416 || pkey_op == EVP_PKEY_OP_VERIFY)) {
418 "Error: The input data looks too long to be a hash\n");
422 if (pkey_op == EVP_PKEY_OP_VERIFY) {
424 rv = do_raw_keyop(pkey_op, ctx, md, pkey, in, filesize, sig, siglen,
427 rv = EVP_PKEY_verify(ctx, sig, (size_t)siglen,
428 buf_in, (size_t)buf_inlen);
431 BIO_puts(out, "Signature Verified Successfully\n");
434 BIO_puts(out, "Signature Verification Failure\n");
443 /* rawin allocates the buffer in do_raw_keyop() */
444 rv = do_raw_keyop(pkey_op, ctx, md, pkey, in, filesize, NULL, 0,
445 &buf_out, (size_t *)&buf_outlen);
447 rv = do_keyop(ctx, pkey_op, NULL, (size_t *)&buf_outlen,
448 buf_in, (size_t)buf_inlen);
449 if (rv > 0 && buf_outlen != 0) {
450 buf_out = app_malloc(buf_outlen, "buffer output");
451 rv = do_keyop(ctx, pkey_op,
452 buf_out, (size_t *)&buf_outlen,
453 buf_in, (size_t)buf_inlen);
458 if (pkey_op != EVP_PKEY_OP_DERIVE) {
459 BIO_puts(bio_err, "Public Key operation error\n");
461 BIO_puts(bio_err, "Key derivation failed\n");
463 ERR_print_errors(bio_err);
469 if (!ASN1_parse_dump(out, buf_out, buf_outlen, 1, -1))
470 ERR_print_errors(bio_err);
471 } else if (hexdump) {
472 BIO_dump(out, (char *)buf_out, buf_outlen);
474 BIO_write(out, buf_out, buf_outlen);
478 EVP_PKEY_CTX_free(ctx);
482 OPENSSL_free(buf_in);
483 OPENSSL_free(buf_out);
485 sk_OPENSSL_STRING_free(pkeyopts);
486 sk_OPENSSL_STRING_free(pkeyopts_passin);
490 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
491 const char *keyfile, int keyform, int key_type,
492 char *passinarg, int pkey_op, ENGINE *e,
493 const int engine_impl, int rawin,
496 EVP_PKEY *pkey = NULL;
497 EVP_PKEY_CTX *ctx = NULL;
502 if (((pkey_op == EVP_PKEY_OP_SIGN) || (pkey_op == EVP_PKEY_OP_DECRYPT)
503 || (pkey_op == EVP_PKEY_OP_DERIVE))
504 && (key_type != KEY_PRIVKEY && kdfalg == NULL)) {
505 BIO_printf(bio_err, "A private key is needed for this operation\n");
508 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
509 BIO_printf(bio_err, "Error getting password\n");
514 pkey = load_key(keyfile, keyform, 0, passin, e, "Private Key");
518 pkey = load_pubkey(keyfile, keyform, 0, NULL, e, "Public Key");
522 x = load_cert(keyfile, keyform, "Certificate");
524 pkey = X509_get_pubkey(x);
534 #ifndef OPENSSL_NO_ENGINE
539 if (kdfalg != NULL) {
540 int kdfnid = OBJ_sn2nid(kdfalg);
542 if (kdfnid == NID_undef) {
543 kdfnid = OBJ_ln2nid(kdfalg);
544 if (kdfnid == NID_undef) {
545 BIO_printf(bio_err, "The given KDF \"%s\" is unknown.\n",
550 ctx = EVP_PKEY_CTX_new_id(kdfnid, impl);
555 *pkeysize = EVP_PKEY_size(pkey);
556 ctx = EVP_PKEY_CTX_new(pkey, impl);
566 * If rawin then we don't need to actually initialise the EVP_PKEY_CTX
567 * itself. That will get initialised during EVP_DigestSignInit or
568 * EVP_DigestVerifyInit.
574 case EVP_PKEY_OP_SIGN:
575 rv = EVP_PKEY_sign_init(ctx);
578 case EVP_PKEY_OP_VERIFY:
579 rv = EVP_PKEY_verify_init(ctx);
582 case EVP_PKEY_OP_VERIFYRECOVER:
583 rv = EVP_PKEY_verify_recover_init(ctx);
586 case EVP_PKEY_OP_ENCRYPT:
587 rv = EVP_PKEY_encrypt_init(ctx);
590 case EVP_PKEY_OP_DECRYPT:
591 rv = EVP_PKEY_decrypt_init(ctx);
594 case EVP_PKEY_OP_DERIVE:
595 rv = EVP_PKEY_derive_init(ctx);
601 EVP_PKEY_CTX_free(ctx);
606 OPENSSL_free(passin);
611 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
614 EVP_PKEY *peer = NULL;
615 ENGINE *engine = NULL;
618 if (peerform == FORMAT_ENGINE)
620 peer = load_pubkey(file, peerform, 0, NULL, engine, "Peer Key");
622 BIO_printf(bio_err, "Error reading peer key %s\n", file);
623 ERR_print_errors(bio_err);
627 ret = EVP_PKEY_derive_set_peer(ctx, peer);
631 ERR_print_errors(bio_err);
635 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
636 unsigned char *out, size_t *poutlen,
637 const unsigned char *in, size_t inlen)
641 case EVP_PKEY_OP_VERIFYRECOVER:
642 rv = EVP_PKEY_verify_recover(ctx, out, poutlen, in, inlen);
645 case EVP_PKEY_OP_SIGN:
646 rv = EVP_PKEY_sign(ctx, out, poutlen, in, inlen);
649 case EVP_PKEY_OP_ENCRYPT:
650 rv = EVP_PKEY_encrypt(ctx, out, poutlen, in, inlen);
653 case EVP_PKEY_OP_DECRYPT:
654 rv = EVP_PKEY_decrypt(ctx, out, poutlen, in, inlen);
657 case EVP_PKEY_OP_DERIVE:
658 rv = EVP_PKEY_derive(ctx, out, poutlen);
665 #define TBUF_MAXSIZE 2048
667 static int do_raw_keyop(int pkey_op, EVP_PKEY_CTX *ctx,
668 const EVP_MD *md, EVP_PKEY *pkey, BIO *in,
669 int filesize, unsigned char *sig, int siglen,
670 unsigned char **out, size_t *poutlen)
673 EVP_MD_CTX *mctx = NULL;
674 unsigned char tbuf[TBUF_MAXSIZE];
675 unsigned char *mbuf = NULL;
678 if ((mctx = EVP_MD_CTX_new()) == NULL) {
679 BIO_printf(bio_err, "Error: out of memory\n");
682 EVP_MD_CTX_set_pkey_ctx(mctx, ctx);
684 /* Some algorithms only support oneshot digests */
685 if (EVP_PKEY_id(pkey) == EVP_PKEY_ED25519
686 || EVP_PKEY_id(pkey) == EVP_PKEY_ED448) {
689 "Error: unable to determine file size for oneshot operation\n");
692 mbuf = app_malloc(filesize, "oneshot sign/verify buffer");
694 case EVP_PKEY_OP_VERIFY:
695 if (EVP_DigestVerifyInit(mctx, NULL, md, NULL, pkey) != 1)
697 buf_len = BIO_read(in, mbuf, filesize);
698 if (buf_len != filesize) {
699 BIO_printf(bio_err, "Error reading raw input data\n");
702 rv = EVP_DigestVerify(mctx, sig, (size_t)siglen, mbuf, buf_len);
704 case EVP_PKEY_OP_SIGN:
705 if (EVP_DigestSignInit(mctx, NULL, md, NULL, pkey) != 1)
707 buf_len = BIO_read(in, mbuf, filesize);
708 if (buf_len != filesize) {
709 BIO_printf(bio_err, "Error reading raw input data\n");
712 rv = EVP_DigestSign(mctx, NULL, poutlen, mbuf, buf_len);
713 if (rv == 1 && out != NULL) {
714 *out = app_malloc(*poutlen, "buffer output");
715 rv = EVP_DigestSign(mctx, *out, poutlen, mbuf, buf_len);
723 case EVP_PKEY_OP_VERIFY:
724 if (EVP_DigestVerifyInit(mctx, NULL, md, NULL, pkey) != 1)
727 buf_len = BIO_read(in, tbuf, TBUF_MAXSIZE);
731 BIO_printf(bio_err, "Error reading raw input data\n");
734 rv = EVP_DigestVerifyUpdate(mctx, tbuf, (size_t)buf_len);
736 BIO_printf(bio_err, "Error verifying raw input data\n");
740 rv = EVP_DigestVerifyFinal(mctx, sig, (size_t)siglen);
742 case EVP_PKEY_OP_SIGN:
743 if (EVP_DigestSignInit(mctx, NULL, md, NULL, pkey) != 1)
746 buf_len = BIO_read(in, tbuf, TBUF_MAXSIZE);
750 BIO_printf(bio_err, "Error reading raw input data\n");
753 rv = EVP_DigestSignUpdate(mctx, tbuf, (size_t)buf_len);
755 BIO_printf(bio_err, "Error signing raw input data\n");
759 rv = EVP_DigestSignFinal(mctx, NULL, poutlen);
760 if (rv == 1 && out != NULL) {
761 *out = app_malloc(*poutlen, "buffer output");
762 rv = EVP_DigestSignFinal(mctx, *out, poutlen);
769 EVP_MD_CTX_free(mctx);