2 * Copyright 2006-2023 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>
23 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
24 const char *keyfile, int keyform, int key_type,
25 char *passinarg, int pkey_op, ENGINE *e,
26 const int impl, int rawin, EVP_PKEY **ppkey,
27 EVP_MD_CTX *mctx, const char *digestname,
28 OSSL_LIB_CTX *libctx, const char *propq);
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_MD_CTX *mctx,
38 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 {
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,
54 const OPTIONS pkeyutl_options[] = {
55 OPT_SECTION("General"),
56 {"help", OPT_HELP, '-', "Display this summary"},
57 #ifndef OPENSSL_NO_ENGINE
58 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
59 {"engine_impl", OPT_ENGINE_IMPL, '-',
60 "Also use engine given by -engine for crypto operations"},
62 {"sign", OPT_SIGN, '-', "Sign input data with private key"},
63 {"verify", OPT_VERIFY, '-', "Verify with public key"},
64 {"encrypt", OPT_ENCRYPT, '-', "Encrypt input data with public key"},
65 {"decrypt", OPT_DECRYPT, '-', "Decrypt input data with private key"},
66 {"derive", OPT_DERIVE, '-', "Derive shared secret"},
70 {"in", OPT_IN, '<', "Input file - default stdin"},
71 {"rawin", OPT_RAWIN, '-', "Indicate the input data is in raw form"},
72 {"inkey", OPT_INKEY, 's', "Input key, by default private key"},
73 {"pubin", OPT_PUBIN, '-', "Input key is a public key"},
74 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
75 {"peerkey", OPT_PEERKEY, 's', "Peer key file used in key derivation"},
76 {"peerform", OPT_PEERFORM, 'E', "Peer key format (DER/PEM/P12/ENGINE)"},
77 {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},
78 {"rev", OPT_REV, '-', "Reverse the order of the input buffer"},
79 {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},
80 {"keyform", OPT_KEYFORM, 'E', "Private key format (ENGINE, other values ignored)"},
82 OPT_SECTION("Output"),
83 {"out", OPT_OUT, '>', "Output file - default stdout"},
84 {"asn1parse", OPT_ASN1PARSE, '-', "asn1parse the output data"},
85 {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},
86 {"verifyrecover", OPT_VERIFYRECOVER, '-',
87 "Verify with public key, recover original data"},
89 OPT_SECTION("Signing/Derivation"),
90 {"digest", OPT_DIGEST, 's',
91 "Specify the digest algorithm when signing the raw input data"},
92 {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},
93 {"pkeyopt_passin", OPT_PKEYOPT_PASSIN, 's',
94 "Public key option that is read as a passphrase argument opt:passphrase"},
95 {"kdf", OPT_KDF, 's', "Use KDF algorithm"},
96 {"kdflen", OPT_KDFLEN, 'p', "KDF algorithm output length"},
103 int pkeyutl_main(int argc, char **argv)
106 BIO *in = NULL, *out = NULL;
108 EVP_PKEY_CTX *ctx = NULL;
109 EVP_PKEY *pkey = NULL;
110 char *infile = NULL, *outfile = NULL, *sigfile = NULL, *passinarg = NULL;
111 char hexdump = 0, asn1parse = 0, rev = 0, *prog;
112 unsigned char *buf_in = NULL, *buf_out = NULL, *sig = NULL;
114 int buf_inlen = 0, siglen = -1;
115 int keyform = FORMAT_UNDEF, peerform = FORMAT_UNDEF;
116 int keysize = -1, pkey_op = EVP_PKEY_OP_SIGN, key_type = KEY_PRIVKEY;
118 int ret = 1, rv = -1;
120 const char *inkey = NULL;
121 const char *peerkey = NULL;
122 const char *kdfalg = NULL, *digestname = NULL;
124 STACK_OF(OPENSSL_STRING) *pkeyopts = NULL;
125 STACK_OF(OPENSSL_STRING) *pkeyopts_passin = NULL;
127 EVP_MD_CTX *mctx = NULL;
130 OSSL_LIB_CTX *libctx = app_get0_libctx();
132 prog = opt_init(argc, argv, pkeyutl_options);
133 while ((o = opt_next()) != OPT_EOF) {
138 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
141 opt_help(pkeyutl_options);
153 case OPT_ENGINE_IMPL:
163 passinarg = opt_arg();
166 if (!opt_format(opt_arg(), OPT_FMT_ANY, &peerform))
170 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
178 conf = app_load_config_modules(opt_arg());
183 if (!opt_provider(o))
187 e = setup_engine(opt_arg(), 0);
190 key_type = KEY_PUBKEY;
202 pkey_op = EVP_PKEY_OP_SIGN;
205 pkey_op = EVP_PKEY_OP_VERIFY;
207 case OPT_VERIFYRECOVER:
208 pkey_op = EVP_PKEY_OP_VERIFYRECOVER;
211 pkey_op = EVP_PKEY_OP_ENCRYPT;
214 pkey_op = EVP_PKEY_OP_DECRYPT;
217 pkey_op = EVP_PKEY_OP_DERIVE;
220 pkey_op = EVP_PKEY_OP_DERIVE;
225 kdflen = atoi(opt_arg());
231 if ((pkeyopts == NULL &&
232 (pkeyopts = sk_OPENSSL_STRING_new_null()) == NULL) ||
233 sk_OPENSSL_STRING_push(pkeyopts, opt_arg()) == 0) {
234 BIO_puts(bio_err, "out of memory\n");
238 case OPT_PKEYOPT_PASSIN:
239 if ((pkeyopts_passin == NULL &&
240 (pkeyopts_passin = sk_OPENSSL_STRING_new_null()) == NULL) ||
241 sk_OPENSSL_STRING_push(pkeyopts_passin, opt_arg()) == 0) {
242 BIO_puts(bio_err, "out of memory\n");
250 digestname = opt_arg();
255 /* No extra arguments. */
256 if (!opt_check_rest_arg(NULL))
259 if (!app_RAND_load())
262 if (rawin && pkey_op != EVP_PKEY_OP_SIGN && pkey_op != EVP_PKEY_OP_VERIFY) {
264 "%s: -rawin can only be used with -sign or -verify\n",
269 if (digestname != NULL && !rawin) {
271 "%s: -digest can only be used with -rawin\n",
277 BIO_printf(bio_err, "%s: -rev cannot be used with raw input\n",
282 if (kdfalg != NULL) {
285 "%s: no KDF length given (-kdflen parameter).\n", prog);
288 } else if (inkey == NULL) {
290 "%s: no private key given (-inkey parameter).\n", prog);
292 } else if (peerkey != NULL && pkey_op != EVP_PKEY_OP_DERIVE) {
294 "%s: no peer key given (-peerkey parameter).\n", prog);
299 if ((mctx = EVP_MD_CTX_new()) == NULL) {
300 BIO_printf(bio_err, "Error: out of memory\n");
304 ctx = init_ctx(kdfalg, &keysize, inkey, keyform, key_type,
305 passinarg, pkey_op, e, engine_impl, rawin, &pkey,
306 mctx, digestname, libctx, app_get0_propq());
308 BIO_printf(bio_err, "%s: Error initializing context\n", prog);
311 if (peerkey != NULL && !setup_peer(ctx, peerform, peerkey, e)) {
312 BIO_printf(bio_err, "%s: Error setting up peer key\n", prog);
315 if (pkeyopts != NULL) {
316 int num = sk_OPENSSL_STRING_num(pkeyopts);
319 for (i = 0; i < num; ++i) {
320 const char *opt = sk_OPENSSL_STRING_value(pkeyopts, i);
322 if (pkey_ctrl_string(ctx, opt) <= 0) {
323 BIO_printf(bio_err, "%s: Can't set parameter \"%s\":\n",
329 if (pkeyopts_passin != NULL) {
330 int num = sk_OPENSSL_STRING_num(pkeyopts_passin);
333 for (i = 0; i < num; i++) {
334 char *opt = sk_OPENSSL_STRING_value(pkeyopts_passin, i);
335 char *passin = strchr(opt, ':');
338 if (passin == NULL) {
339 /* Get password interactively */
340 char passwd_buf[4096];
343 BIO_snprintf(passwd_buf, sizeof(passwd_buf), "Enter %s: ", opt);
344 r = EVP_read_pw_string(passwd_buf, sizeof(passwd_buf) - 1,
348 BIO_puts(bio_err, "user abort\n");
350 BIO_puts(bio_err, "entry failed\n");
353 passwd = OPENSSL_strdup(passwd_buf);
354 if (passwd == NULL) {
355 BIO_puts(bio_err, "out of memory\n");
359 /* Get password as a passin argument: First split option name
360 * and passphrase argument into two strings */
363 if (app_passwd(passin, NULL, &passwd, NULL) == 0) {
364 BIO_printf(bio_err, "failed to get '%s'\n", opt);
369 if (EVP_PKEY_CTX_ctrl_str(ctx, opt, passwd) <= 0) {
370 BIO_printf(bio_err, "%s: Can't set parameter \"%s\":\n",
374 OPENSSL_free(passwd);
378 if (sigfile != NULL && (pkey_op != EVP_PKEY_OP_VERIFY)) {
380 "%s: Signature file specified for non verify\n", prog);
384 if (sigfile == NULL && (pkey_op == EVP_PKEY_OP_VERIFY)) {
386 "%s: No signature file specified for verify\n", prog);
390 if (pkey_op != EVP_PKEY_OP_DERIVE) {
391 in = bio_open_default(infile, 'r', FORMAT_BINARY);
392 if (infile != NULL) {
395 if (stat(infile, &st) == 0 && st.st_size <= INT_MAX)
396 filesize = (int)st.st_size;
401 out = bio_open_default(outfile, 'w', FORMAT_BINARY);
405 if (sigfile != NULL) {
406 BIO *sigbio = BIO_new_file(sigfile, "rb");
408 if (sigbio == NULL) {
409 BIO_printf(bio_err, "Can't open signature file %s\n", sigfile);
412 siglen = bio_to_mem(&sig, keysize * 10, sigbio);
415 BIO_printf(bio_err, "Error reading signature data\n");
420 /* Raw input data is handled elsewhere */
421 if (in != NULL && !rawin) {
422 /* Read the input data */
423 buf_inlen = bio_to_mem(&buf_in, -1, in);
425 BIO_printf(bio_err, "Error reading input Data\n");
431 size_t l = (size_t)buf_inlen;
432 for (i = 0; i < l / 2; i++) {
434 buf_in[i] = buf_in[l - 1 - i];
435 buf_in[l - 1 - i] = ctmp;
440 /* Sanity check the input if the input is not raw */
442 && buf_inlen > EVP_MAX_MD_SIZE
443 && (pkey_op == EVP_PKEY_OP_SIGN
444 || pkey_op == EVP_PKEY_OP_VERIFY)) {
446 "Error: The input data looks too long to be a hash\n");
450 if (pkey_op == EVP_PKEY_OP_VERIFY) {
452 rv = do_raw_keyop(pkey_op, mctx, pkey, in, filesize, sig, siglen,
455 rv = EVP_PKEY_verify(ctx, sig, (size_t)siglen,
456 buf_in, (size_t)buf_inlen);
459 BIO_puts(out, "Signature Verified Successfully\n");
462 BIO_puts(out, "Signature Verification Failure\n");
467 /* rawin allocates the buffer in do_raw_keyop() */
468 rv = do_raw_keyop(pkey_op, mctx, pkey, in, filesize, NULL, 0,
469 &buf_out, (size_t *)&buf_outlen);
475 rv = do_keyop(ctx, pkey_op, NULL, (size_t *)&buf_outlen,
476 buf_in, (size_t)buf_inlen);
478 if (rv > 0 && buf_outlen != 0) {
479 buf_out = app_malloc(buf_outlen, "buffer output");
480 rv = do_keyop(ctx, pkey_op,
481 buf_out, (size_t *)&buf_outlen,
482 buf_in, (size_t)buf_inlen);
486 if (pkey_op != EVP_PKEY_OP_DERIVE) {
487 BIO_puts(bio_err, "Public Key operation error\n");
489 BIO_puts(bio_err, "Key derivation failed\n");
496 if (!ASN1_parse_dump(out, buf_out, buf_outlen, 1, -1))
497 ERR_print_errors(bio_err); /* but still return success */
498 } else if (hexdump) {
499 BIO_dump(out, (char *)buf_out, buf_outlen);
501 BIO_write(out, buf_out, buf_outlen);
506 ERR_print_errors(bio_err);
507 EVP_MD_CTX_free(mctx);
508 EVP_PKEY_CTX_free(ctx);
513 OPENSSL_free(buf_in);
514 OPENSSL_free(buf_out);
516 sk_OPENSSL_STRING_free(pkeyopts);
517 sk_OPENSSL_STRING_free(pkeyopts_passin);
522 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
523 const char *keyfile, int keyform, int key_type,
524 char *passinarg, int pkey_op, ENGINE *e,
525 const int engine_impl, int rawin,
526 EVP_PKEY **ppkey, EVP_MD_CTX *mctx, const char *digestname,
527 OSSL_LIB_CTX *libctx, const char *propq)
529 EVP_PKEY *pkey = NULL;
530 EVP_PKEY_CTX *ctx = NULL;
536 if (((pkey_op == EVP_PKEY_OP_SIGN) || (pkey_op == EVP_PKEY_OP_DECRYPT)
537 || (pkey_op == EVP_PKEY_OP_DERIVE))
538 && (key_type != KEY_PRIVKEY && kdfalg == NULL)) {
539 BIO_printf(bio_err, "A private key is needed for this operation\n");
542 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
543 BIO_printf(bio_err, "Error getting password\n");
548 pkey = load_key(keyfile, keyform, 0, passin, e, "private key");
552 pkey = load_pubkey(keyfile, keyform, 0, NULL, e, "public key");
556 x = load_cert(keyfile, keyform, "Certificate");
558 pkey = X509_get_pubkey(x);
568 #ifndef OPENSSL_NO_ENGINE
573 if (kdfalg != NULL) {
574 int kdfnid = OBJ_sn2nid(kdfalg);
576 if (kdfnid == NID_undef) {
577 kdfnid = OBJ_ln2nid(kdfalg);
578 if (kdfnid == NID_undef) {
579 BIO_printf(bio_err, "The given KDF \"%s\" is unknown.\n",
585 ctx = EVP_PKEY_CTX_new_id(kdfnid, impl);
587 ctx = EVP_PKEY_CTX_new_from_name(libctx, kdfalg, propq);
592 *pkeysize = EVP_PKEY_get_size(pkey);
594 ctx = EVP_PKEY_CTX_new(pkey, impl);
596 ctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, propq);
606 EVP_MD_CTX_set_pkey_ctx(mctx, ctx);
609 case EVP_PKEY_OP_SIGN:
610 rv = EVP_DigestSignInit_ex(mctx, NULL, digestname, libctx, propq,
614 case EVP_PKEY_OP_VERIFY:
615 rv = EVP_DigestVerifyInit_ex(mctx, NULL, digestname, libctx, propq,
622 case EVP_PKEY_OP_SIGN:
623 rv = EVP_PKEY_sign_init(ctx);
626 case EVP_PKEY_OP_VERIFY:
627 rv = EVP_PKEY_verify_init(ctx);
630 case EVP_PKEY_OP_VERIFYRECOVER:
631 rv = EVP_PKEY_verify_recover_init(ctx);
634 case EVP_PKEY_OP_ENCRYPT:
635 rv = EVP_PKEY_encrypt_init(ctx);
638 case EVP_PKEY_OP_DECRYPT:
639 rv = EVP_PKEY_decrypt_init(ctx);
642 case EVP_PKEY_OP_DERIVE:
643 rv = EVP_PKEY_derive_init(ctx);
649 EVP_PKEY_CTX_free(ctx);
654 OPENSSL_free(passin);
659 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
662 EVP_PKEY *peer = NULL;
663 ENGINE *engine = NULL;
666 if (peerform == FORMAT_ENGINE)
668 peer = load_pubkey(file, peerform, 0, NULL, engine, "peer key");
670 BIO_printf(bio_err, "Error reading peer key %s\n", file);
674 ret = EVP_PKEY_derive_set_peer(ctx, peer) > 0;
680 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
681 unsigned char *out, size_t *poutlen,
682 const unsigned char *in, size_t inlen)
686 case EVP_PKEY_OP_VERIFYRECOVER:
687 rv = EVP_PKEY_verify_recover(ctx, out, poutlen, in, inlen);
690 case EVP_PKEY_OP_SIGN:
691 rv = EVP_PKEY_sign(ctx, out, poutlen, in, inlen);
694 case EVP_PKEY_OP_ENCRYPT:
695 rv = EVP_PKEY_encrypt(ctx, out, poutlen, in, inlen);
698 case EVP_PKEY_OP_DECRYPT:
699 rv = EVP_PKEY_decrypt(ctx, out, poutlen, in, inlen);
702 case EVP_PKEY_OP_DERIVE:
703 rv = EVP_PKEY_derive(ctx, out, poutlen);
710 #define TBUF_MAXSIZE 2048
712 static int do_raw_keyop(int pkey_op, EVP_MD_CTX *mctx,
713 EVP_PKEY *pkey, BIO *in,
714 int filesize, unsigned char *sig, int siglen,
715 unsigned char **out, size_t *poutlen)
718 unsigned char tbuf[TBUF_MAXSIZE];
719 unsigned char *mbuf = NULL;
722 /* Some algorithms only support oneshot digests */
723 if (EVP_PKEY_get_id(pkey) == EVP_PKEY_ED25519
724 || EVP_PKEY_get_id(pkey) == EVP_PKEY_ED448) {
727 "Error: unable to determine file size for oneshot operation\n");
730 mbuf = app_malloc(filesize, "oneshot sign/verify buffer");
732 case EVP_PKEY_OP_VERIFY:
733 buf_len = BIO_read(in, mbuf, filesize);
734 if (buf_len != filesize) {
735 BIO_printf(bio_err, "Error reading raw input data\n");
738 rv = EVP_DigestVerify(mctx, sig, (size_t)siglen, mbuf, buf_len);
740 case EVP_PKEY_OP_SIGN:
741 buf_len = BIO_read(in, mbuf, filesize);
742 if (buf_len != filesize) {
743 BIO_printf(bio_err, "Error reading raw input data\n");
746 rv = EVP_DigestSign(mctx, NULL, poutlen, mbuf, buf_len);
747 if (rv == 1 && out != NULL) {
748 *out = app_malloc(*poutlen, "buffer output");
749 rv = EVP_DigestSign(mctx, *out, poutlen, mbuf, buf_len);
757 case EVP_PKEY_OP_VERIFY:
759 buf_len = BIO_read(in, tbuf, TBUF_MAXSIZE);
763 BIO_printf(bio_err, "Error reading raw input data\n");
766 rv = EVP_DigestVerifyUpdate(mctx, tbuf, (size_t)buf_len);
768 BIO_printf(bio_err, "Error verifying raw input data\n");
772 rv = EVP_DigestVerifyFinal(mctx, sig, (size_t)siglen);
774 case EVP_PKEY_OP_SIGN:
776 buf_len = BIO_read(in, tbuf, TBUF_MAXSIZE);
780 BIO_printf(bio_err, "Error reading raw input data\n");
783 rv = EVP_DigestSignUpdate(mctx, tbuf, (size_t)buf_len);
785 BIO_printf(bio_err, "Error signing raw input data\n");
789 rv = EVP_DigestSignFinal(mctx, NULL, poutlen);
790 if (rv == 1 && out != NULL) {
791 *out = app_malloc(*poutlen, "buffer output");
792 rv = EVP_DigestSignFinal(mctx, *out, poutlen);