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>
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 OSSL_LIB_CTX
*libctx
);
29 static int setup_peer(EVP_PKEY_CTX
*ctx
, int peerform
, const char *file
,
32 static int do_keyop(EVP_PKEY_CTX
*ctx
, int pkey_op
,
33 unsigned char *out
, size_t *poutlen
,
34 const unsigned char *in
, size_t inlen
);
36 static int do_raw_keyop(int pkey_op
, EVP_PKEY_CTX
*ctx
,
37 const EVP_MD
*md
, EVP_PKEY
*pkey
, BIO
*in
,
38 int filesize
, unsigned char *sig
, int siglen
,
39 unsigned char **out
, size_t *poutlen
);
41 typedef enum OPTION_choice
{
42 OPT_ERR
= -1, OPT_EOF
= 0, OPT_HELP
,
43 OPT_ENGINE
, OPT_ENGINE_IMPL
, OPT_IN
, OPT_OUT
,
44 OPT_PUBIN
, OPT_CERTIN
, OPT_ASN1PARSE
, OPT_HEXDUMP
, OPT_SIGN
,
45 OPT_VERIFY
, OPT_VERIFYRECOVER
, OPT_REV
, OPT_ENCRYPT
, OPT_DECRYPT
,
46 OPT_DERIVE
, OPT_SIGFILE
, OPT_INKEY
, OPT_PEERKEY
, OPT_PASSIN
,
47 OPT_PEERFORM
, OPT_KEYFORM
, OPT_PKEYOPT
, OPT_PKEYOPT_PASSIN
, OPT_KDF
,
48 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"},
69 {"in", OPT_IN
, '<', "Input file - default stdin"},
70 {"rawin", OPT_RAWIN
, '-', "Indicate the input data is in raw form"},
71 {"pubin", OPT_PUBIN
, '-', "Input is a public key"},
72 {"inkey", OPT_INKEY
, 's', "Input private key file"},
73 {"passin", OPT_PASSIN
, 's', "Input file pass phrase source"},
74 {"peerkey", OPT_PEERKEY
, 's', "Peer key file used in key derivation"},
75 {"peerform", OPT_PEERFORM
, 'E', "Peer key format (DER/PEM/P12/ENGINE)"},
76 {"certin", OPT_CERTIN
, '-', "Input is a cert with a public key"},
77 {"rev", OPT_REV
, '-', "Reverse the order of the input buffer"},
78 {"sigfile", OPT_SIGFILE
, '<', "Signature file (verify operation only)"},
79 {"keyform", OPT_KEYFORM
, 'E', "Private key format (ENGINE, other values ignored)"},
81 OPT_SECTION("Output"),
82 {"out", OPT_OUT
, '>', "Output file - default stdout"},
83 {"asn1parse", OPT_ASN1PARSE
, '-', "asn1parse the output data"},
84 {"hexdump", OPT_HEXDUMP
, '-', "Hex dump output"},
85 {"verifyrecover", OPT_VERIFYRECOVER
, '-',
86 "Verify with public key, recover original data"},
88 OPT_SECTION("Signing/Derivation"),
89 {"digest", OPT_DIGEST
, 's',
90 "Specify the digest algorithm when signing the raw input data"},
91 {"pkeyopt", OPT_PKEYOPT
, 's', "Public key options as opt:value"},
92 {"pkeyopt_passin", OPT_PKEYOPT_PASSIN
, 's',
93 "Public key option that is read as a passphrase argument opt:passphrase"},
94 {"kdf", OPT_KDF
, 's', "Use KDF algorithm"},
95 {"kdflen", OPT_KDFLEN
, 'p', "KDF algorithm output length"},
102 int pkeyutl_main(int argc
, char **argv
)
105 BIO
*in
= NULL
, *out
= NULL
;
107 EVP_PKEY_CTX
*ctx
= NULL
;
108 EVP_PKEY
*pkey
= NULL
;
109 char *infile
= NULL
, *outfile
= NULL
, *sigfile
= NULL
, *passinarg
= NULL
;
110 char hexdump
= 0, asn1parse
= 0, rev
= 0, *prog
;
111 unsigned char *buf_in
= NULL
, *buf_out
= NULL
, *sig
= NULL
;
113 int buf_inlen
= 0, siglen
= -1, keyform
= FORMAT_PEM
, peerform
= FORMAT_PEM
;
114 int keysize
= -1, pkey_op
= EVP_PKEY_OP_SIGN
, key_type
= KEY_PRIVKEY
;
116 int ret
= 1, rv
= -1;
118 const char *inkey
= NULL
;
119 const char *peerkey
= NULL
;
120 const char *kdfalg
= NULL
;
122 STACK_OF(OPENSSL_STRING
) *pkeyopts
= NULL
;
123 STACK_OF(OPENSSL_STRING
) *pkeyopts_passin
= NULL
;
125 const EVP_MD
*md
= NULL
;
127 OSSL_LIB_CTX
*libctx
= app_get0_libctx();
129 prog
= opt_init(argc
, argv
, pkeyutl_options
);
130 while ((o
= opt_next()) != OPT_EOF
) {
135 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
138 opt_help(pkeyutl_options
);
150 case OPT_ENGINE_IMPL
:
160 passinarg
= opt_arg();
163 if (!opt_format(opt_arg(), OPT_FMT_ANY
, &peerform
))
167 if (!opt_format(opt_arg(), OPT_FMT_ANY
, &keyform
))
175 conf
= app_load_config_modules(opt_arg());
180 if (!opt_provider(o
))
184 e
= setup_engine(opt_arg(), 0);
187 key_type
= KEY_PUBKEY
;
199 pkey_op
= EVP_PKEY_OP_SIGN
;
202 pkey_op
= EVP_PKEY_OP_VERIFY
;
204 case OPT_VERIFYRECOVER
:
205 pkey_op
= EVP_PKEY_OP_VERIFYRECOVER
;
208 pkey_op
= EVP_PKEY_OP_ENCRYPT
;
211 pkey_op
= EVP_PKEY_OP_DECRYPT
;
214 pkey_op
= EVP_PKEY_OP_DERIVE
;
217 pkey_op
= EVP_PKEY_OP_DERIVE
;
222 kdflen
= atoi(opt_arg());
228 if ((pkeyopts
== NULL
&&
229 (pkeyopts
= sk_OPENSSL_STRING_new_null()) == NULL
) ||
230 sk_OPENSSL_STRING_push(pkeyopts
, opt_arg()) == 0) {
231 BIO_puts(bio_err
, "out of memory\n");
235 case OPT_PKEYOPT_PASSIN
:
236 if ((pkeyopts_passin
== NULL
&&
237 (pkeyopts_passin
= sk_OPENSSL_STRING_new_null()) == NULL
) ||
238 sk_OPENSSL_STRING_push(pkeyopts_passin
, opt_arg()) == 0) {
239 BIO_puts(bio_err
, "out of memory\n");
247 if (!opt_md(opt_arg(), &md
))
253 /* No extra arguments. */
254 argc
= opt_num_rest();
260 if (rawin
&& pkey_op
!= EVP_PKEY_OP_SIGN
&& pkey_op
!= EVP_PKEY_OP_VERIFY
) {
262 "%s: -rawin can only be used with -sign or -verify\n",
267 if (md
!= NULL
&& !rawin
) {
269 "%s: -digest can only be used with -rawin\n",
275 BIO_printf(bio_err
, "%s: -rev cannot be used with raw input\n",
280 if (kdfalg
!= NULL
) {
283 "%s: no KDF length given (-kdflen parameter).\n", prog
);
286 } else if (inkey
== NULL
) {
288 "%s: no private key given (-inkey parameter).\n", prog
);
290 } else if (peerkey
!= NULL
&& pkey_op
!= EVP_PKEY_OP_DERIVE
) {
292 "%s: no peer key given (-peerkey parameter).\n", prog
);
295 ctx
= init_ctx(kdfalg
, &keysize
, inkey
, keyform
, key_type
,
296 passinarg
, pkey_op
, e
, engine_impl
, rawin
, &pkey
,
299 BIO_printf(bio_err
, "%s: Error initializing context\n", prog
);
300 ERR_print_errors(bio_err
);
303 if (peerkey
!= NULL
&& !setup_peer(ctx
, peerform
, peerkey
, e
)) {
304 BIO_printf(bio_err
, "%s: Error setting up peer key\n", prog
);
305 ERR_print_errors(bio_err
);
308 if (pkeyopts
!= NULL
) {
309 int num
= sk_OPENSSL_STRING_num(pkeyopts
);
312 for (i
= 0; i
< num
; ++i
) {
313 const char *opt
= sk_OPENSSL_STRING_value(pkeyopts
, i
);
315 if (pkey_ctrl_string(ctx
, opt
) <= 0) {
316 BIO_printf(bio_err
, "%s: Can't set parameter \"%s\":\n",
318 ERR_print_errors(bio_err
);
323 if (pkeyopts_passin
!= NULL
) {
324 int num
= sk_OPENSSL_STRING_num(pkeyopts_passin
);
327 for (i
= 0; i
< num
; i
++) {
328 char *opt
= sk_OPENSSL_STRING_value(pkeyopts_passin
, i
);
329 char *passin
= strchr(opt
, ':');
332 if (passin
== NULL
) {
333 /* Get password interactively */
334 char passwd_buf
[4096];
337 BIO_snprintf(passwd_buf
, sizeof(passwd_buf
), "Enter %s: ", opt
);
338 r
= EVP_read_pw_string(passwd_buf
, sizeof(passwd_buf
) - 1,
342 BIO_puts(bio_err
, "user abort\n");
344 BIO_puts(bio_err
, "entry failed\n");
347 passwd
= OPENSSL_strdup(passwd_buf
);
348 if (passwd
== NULL
) {
349 BIO_puts(bio_err
, "out of memory\n");
353 /* Get password as a passin argument: First split option name
354 * and passphrase argument into two strings */
357 if (app_passwd(passin
, NULL
, &passwd
, NULL
) == 0) {
358 BIO_printf(bio_err
, "failed to get '%s'\n", opt
);
363 if (EVP_PKEY_CTX_ctrl_str(ctx
, opt
, passwd
) <= 0) {
364 BIO_printf(bio_err
, "%s: Can't set parameter \"%s\":\n",
368 OPENSSL_free(passwd
);
372 if (sigfile
!= NULL
&& (pkey_op
!= EVP_PKEY_OP_VERIFY
)) {
374 "%s: Signature file specified for non verify\n", prog
);
378 if (sigfile
== NULL
&& (pkey_op
== EVP_PKEY_OP_VERIFY
)) {
380 "%s: No signature file specified for verify\n", prog
);
384 if (pkey_op
!= EVP_PKEY_OP_DERIVE
) {
385 in
= bio_open_default(infile
, 'r', FORMAT_BINARY
);
386 if (infile
!= NULL
) {
389 if (stat(infile
, &st
) == 0 && st
.st_size
<= INT_MAX
)
390 filesize
= (int)st
.st_size
;
395 out
= bio_open_default(outfile
, 'w', FORMAT_BINARY
);
399 if (sigfile
!= NULL
) {
400 BIO
*sigbio
= BIO_new_file(sigfile
, "rb");
402 if (sigbio
== NULL
) {
403 BIO_printf(bio_err
, "Can't open signature file %s\n", sigfile
);
406 siglen
= bio_to_mem(&sig
, keysize
* 10, sigbio
);
409 BIO_printf(bio_err
, "Error reading signature data\n");
414 /* Raw input data is handled elsewhere */
415 if (in
!= NULL
&& !rawin
) {
416 /* Read the input data */
417 buf_inlen
= bio_to_mem(&buf_in
, keysize
* 10, in
);
419 BIO_printf(bio_err
, "Error reading input Data\n");
425 size_t l
= (size_t)buf_inlen
;
426 for (i
= 0; i
< l
/ 2; i
++) {
428 buf_in
[i
] = buf_in
[l
- 1 - i
];
429 buf_in
[l
- 1 - i
] = ctmp
;
434 /* Sanity check the input if the input is not raw */
436 && buf_inlen
> EVP_MAX_MD_SIZE
437 && (pkey_op
== EVP_PKEY_OP_SIGN
438 || pkey_op
== EVP_PKEY_OP_VERIFY
)) {
440 "Error: The input data looks too long to be a hash\n");
444 if (pkey_op
== EVP_PKEY_OP_VERIFY
) {
446 rv
= do_raw_keyop(pkey_op
, ctx
, md
, pkey
, in
, filesize
, sig
, siglen
,
449 rv
= EVP_PKEY_verify(ctx
, sig
, (size_t)siglen
,
450 buf_in
, (size_t)buf_inlen
);
453 BIO_puts(out
, "Signature Verified Successfully\n");
456 BIO_puts(out
, "Signature Verification Failure\n");
465 /* rawin allocates the buffer in do_raw_keyop() */
466 rv
= do_raw_keyop(pkey_op
, ctx
, md
, pkey
, in
, filesize
, NULL
, 0,
467 &buf_out
, (size_t *)&buf_outlen
);
469 rv
= do_keyop(ctx
, pkey_op
, NULL
, (size_t *)&buf_outlen
,
470 buf_in
, (size_t)buf_inlen
);
471 if (rv
> 0 && buf_outlen
!= 0) {
472 buf_out
= app_malloc(buf_outlen
, "buffer output");
473 rv
= do_keyop(ctx
, pkey_op
,
474 buf_out
, (size_t *)&buf_outlen
,
475 buf_in
, (size_t)buf_inlen
);
480 if (pkey_op
!= EVP_PKEY_OP_DERIVE
) {
481 BIO_puts(bio_err
, "Public Key operation error\n");
483 BIO_puts(bio_err
, "Key derivation failed\n");
485 ERR_print_errors(bio_err
);
491 if (!ASN1_parse_dump(out
, buf_out
, buf_outlen
, 1, -1))
492 ERR_print_errors(bio_err
);
493 } else if (hexdump
) {
494 BIO_dump(out
, (char *)buf_out
, buf_outlen
);
496 BIO_write(out
, buf_out
, buf_outlen
);
500 EVP_PKEY_CTX_free(ctx
);
504 OPENSSL_free(buf_in
);
505 OPENSSL_free(buf_out
);
507 sk_OPENSSL_STRING_free(pkeyopts
);
508 sk_OPENSSL_STRING_free(pkeyopts_passin
);
513 static EVP_PKEY_CTX
*init_ctx(const char *kdfalg
, int *pkeysize
,
514 const char *keyfile
, int keyform
, int key_type
,
515 char *passinarg
, int pkey_op
, ENGINE
*e
,
516 const int engine_impl
, int rawin
,
518 OSSL_LIB_CTX
*libctx
)
520 EVP_PKEY
*pkey
= NULL
;
521 EVP_PKEY_CTX
*ctx
= NULL
;
527 if (((pkey_op
== EVP_PKEY_OP_SIGN
) || (pkey_op
== EVP_PKEY_OP_DECRYPT
)
528 || (pkey_op
== EVP_PKEY_OP_DERIVE
))
529 && (key_type
!= KEY_PRIVKEY
&& kdfalg
== NULL
)) {
530 BIO_printf(bio_err
, "A private key is needed for this operation\n");
533 if (!app_passwd(passinarg
, NULL
, &passin
, NULL
)) {
534 BIO_printf(bio_err
, "Error getting password\n");
539 pkey
= load_key(keyfile
, keyform
, 0, passin
, e
, "private key");
543 pkey
= load_pubkey(keyfile
, keyform
, 0, NULL
, e
, "public key");
547 x
= load_cert(keyfile
, "Certificate");
549 pkey
= X509_get_pubkey(x
);
559 #ifndef OPENSSL_NO_ENGINE
564 if (kdfalg
!= NULL
) {
565 int kdfnid
= OBJ_sn2nid(kdfalg
);
567 if (kdfnid
== NID_undef
) {
568 kdfnid
= OBJ_ln2nid(kdfalg
);
569 if (kdfnid
== NID_undef
) {
570 BIO_printf(bio_err
, "The given KDF \"%s\" is unknown.\n",
576 ctx
= EVP_PKEY_CTX_new_id(kdfnid
, impl
);
578 ctx
= EVP_PKEY_CTX_new_from_name(libctx
, kdfalg
, app_get0_propq());
583 *pkeysize
= EVP_PKEY_size(pkey
);
585 ctx
= EVP_PKEY_CTX_new(pkey
, impl
);
587 ctx
= EVP_PKEY_CTX_new_from_pkey(libctx
, pkey
, app_get0_propq());
597 * If rawin then we don't need to actually initialise the EVP_PKEY_CTX
598 * itself. That will get initialised during EVP_DigestSignInit or
599 * EVP_DigestVerifyInit.
605 case EVP_PKEY_OP_SIGN
:
606 rv
= EVP_PKEY_sign_init(ctx
);
609 case EVP_PKEY_OP_VERIFY
:
610 rv
= EVP_PKEY_verify_init(ctx
);
613 case EVP_PKEY_OP_VERIFYRECOVER
:
614 rv
= EVP_PKEY_verify_recover_init(ctx
);
617 case EVP_PKEY_OP_ENCRYPT
:
618 rv
= EVP_PKEY_encrypt_init(ctx
);
621 case EVP_PKEY_OP_DECRYPT
:
622 rv
= EVP_PKEY_decrypt_init(ctx
);
625 case EVP_PKEY_OP_DERIVE
:
626 rv
= EVP_PKEY_derive_init(ctx
);
632 EVP_PKEY_CTX_free(ctx
);
637 OPENSSL_free(passin
);
642 static int setup_peer(EVP_PKEY_CTX
*ctx
, int peerform
, const char *file
,
645 EVP_PKEY
*peer
= NULL
;
646 ENGINE
*engine
= NULL
;
649 if (peerform
== FORMAT_ENGINE
)
651 peer
= load_pubkey(file
, peerform
, 0, NULL
, engine
, "peer key");
653 BIO_printf(bio_err
, "Error reading peer key %s\n", file
);
654 ERR_print_errors(bio_err
);
658 ret
= EVP_PKEY_derive_set_peer(ctx
, peer
);
662 ERR_print_errors(bio_err
);
666 static int do_keyop(EVP_PKEY_CTX
*ctx
, int pkey_op
,
667 unsigned char *out
, size_t *poutlen
,
668 const unsigned char *in
, size_t inlen
)
672 case EVP_PKEY_OP_VERIFYRECOVER
:
673 rv
= EVP_PKEY_verify_recover(ctx
, out
, poutlen
, in
, inlen
);
676 case EVP_PKEY_OP_SIGN
:
677 rv
= EVP_PKEY_sign(ctx
, out
, poutlen
, in
, inlen
);
680 case EVP_PKEY_OP_ENCRYPT
:
681 rv
= EVP_PKEY_encrypt(ctx
, out
, poutlen
, in
, inlen
);
684 case EVP_PKEY_OP_DECRYPT
:
685 rv
= EVP_PKEY_decrypt(ctx
, out
, poutlen
, in
, inlen
);
688 case EVP_PKEY_OP_DERIVE
:
689 rv
= EVP_PKEY_derive(ctx
, out
, poutlen
);
696 #define TBUF_MAXSIZE 2048
698 static int do_raw_keyop(int pkey_op
, EVP_PKEY_CTX
*ctx
,
699 const EVP_MD
*md
, EVP_PKEY
*pkey
, BIO
*in
,
700 int filesize
, unsigned char *sig
, int siglen
,
701 unsigned char **out
, size_t *poutlen
)
704 EVP_MD_CTX
*mctx
= NULL
;
705 unsigned char tbuf
[TBUF_MAXSIZE
];
706 unsigned char *mbuf
= NULL
;
709 if ((mctx
= EVP_MD_CTX_new()) == NULL
) {
710 BIO_printf(bio_err
, "Error: out of memory\n");
713 EVP_MD_CTX_set_pkey_ctx(mctx
, ctx
);
715 /* Some algorithms only support oneshot digests */
716 if (EVP_PKEY_id(pkey
) == EVP_PKEY_ED25519
717 || EVP_PKEY_id(pkey
) == EVP_PKEY_ED448
) {
720 "Error: unable to determine file size for oneshot operation\n");
723 mbuf
= app_malloc(filesize
, "oneshot sign/verify buffer");
725 case EVP_PKEY_OP_VERIFY
:
726 if (EVP_DigestVerifyInit(mctx
, NULL
, md
, NULL
, pkey
) != 1)
728 buf_len
= BIO_read(in
, mbuf
, filesize
);
729 if (buf_len
!= filesize
) {
730 BIO_printf(bio_err
, "Error reading raw input data\n");
733 rv
= EVP_DigestVerify(mctx
, sig
, (size_t)siglen
, mbuf
, buf_len
);
735 case EVP_PKEY_OP_SIGN
:
736 if (EVP_DigestSignInit(mctx
, NULL
, md
, NULL
, pkey
) != 1)
738 buf_len
= BIO_read(in
, mbuf
, filesize
);
739 if (buf_len
!= filesize
) {
740 BIO_printf(bio_err
, "Error reading raw input data\n");
743 rv
= EVP_DigestSign(mctx
, NULL
, poutlen
, mbuf
, buf_len
);
744 if (rv
== 1 && out
!= NULL
) {
745 *out
= app_malloc(*poutlen
, "buffer output");
746 rv
= EVP_DigestSign(mctx
, *out
, poutlen
, mbuf
, buf_len
);
754 case EVP_PKEY_OP_VERIFY
:
755 if (EVP_DigestVerifyInit(mctx
, NULL
, md
, NULL
, pkey
) != 1)
758 buf_len
= BIO_read(in
, tbuf
, TBUF_MAXSIZE
);
762 BIO_printf(bio_err
, "Error reading raw input data\n");
765 rv
= EVP_DigestVerifyUpdate(mctx
, tbuf
, (size_t)buf_len
);
767 BIO_printf(bio_err
, "Error verifying raw input data\n");
771 rv
= EVP_DigestVerifyFinal(mctx
, sig
, (size_t)siglen
);
773 case EVP_PKEY_OP_SIGN
:
774 if (EVP_DigestSignInit(mctx
, NULL
, md
, NULL
, pkey
) != 1)
777 buf_len
= BIO_read(in
, tbuf
, TBUF_MAXSIZE
);
781 BIO_printf(bio_err
, "Error reading raw input data\n");
784 rv
= EVP_DigestSignUpdate(mctx
, tbuf
, (size_t)buf_len
);
786 BIO_printf(bio_err
, "Error signing raw input data\n");
790 rv
= EVP_DigestSignFinal(mctx
, NULL
, poutlen
);
791 if (rv
== 1 && out
!= NULL
) {
792 *out
= app_malloc(*poutlen
, "buffer output");
793 rv
= EVP_DigestSignFinal(mctx
, *out
, poutlen
);
800 EVP_MD_CTX_free(mctx
);