2 * Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
12 #include <openssl/err.h>
13 #include <openssl/pem.h>
14 #include <openssl/evp.h>
21 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
22 const char *keyfile, int keyform, int key_type,
23 char *passinarg, int pkey_op, ENGINE *e,
26 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
29 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
30 unsigned char *out, size_t *poutlen,
31 const unsigned char *in, size_t inlen);
33 typedef enum OPTION_choice {
34 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
35 OPT_ENGINE, OPT_ENGINE_IMPL, OPT_IN, OPT_OUT,
36 OPT_PUBIN, OPT_CERTIN, OPT_ASN1PARSE, OPT_HEXDUMP, OPT_SIGN,
37 OPT_VERIFY, OPT_VERIFYRECOVER, OPT_REV, OPT_ENCRYPT, OPT_DECRYPT,
38 OPT_DERIVE, OPT_SIGFILE, OPT_INKEY, OPT_PEERKEY, OPT_PASSIN,
39 OPT_PEERFORM, OPT_KEYFORM, OPT_PKEYOPT, OPT_KDF, OPT_KDFLEN,
43 const OPTIONS pkeyutl_options[] = {
44 {"help", OPT_HELP, '-', "Display this summary"},
45 {"in", OPT_IN, '<', "Input file - default stdin"},
46 {"out", OPT_OUT, '>', "Output file - default stdout"},
47 {"pubin", OPT_PUBIN, '-', "Input is a public key"},
48 {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},
49 {"asn1parse", OPT_ASN1PARSE, '-', "asn1parse the output data"},
50 {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},
51 {"sign", OPT_SIGN, '-', "Sign input data with private key"},
52 {"verify", OPT_VERIFY, '-', "Verify with public key"},
53 {"verifyrecover", OPT_VERIFYRECOVER, '-',
54 "Verify with public key, recover original data"},
55 {"rev", OPT_REV, '-', "Reverse the order of the input buffer"},
56 {"encrypt", OPT_ENCRYPT, '-', "Encrypt input data with public key"},
57 {"decrypt", OPT_DECRYPT, '-', "Decrypt input data with private key"},
58 {"derive", OPT_DERIVE, '-', "Derive shared secret"},
59 {"kdf", OPT_KDF, 's', "Use KDF algorithm"},
60 {"kdflen", OPT_KDFLEN, 'p', "KDF algorithm output length"},
61 {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},
62 {"inkey", OPT_INKEY, 's', "Input private key file"},
63 {"peerkey", OPT_PEERKEY, 's', "Peer key file used in key derivation"},
64 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
65 {"peerform", OPT_PEERFORM, 'E', "Peer key format - default PEM"},
66 {"keyform", OPT_KEYFORM, 'E', "Private key format - default PEM"},
67 {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},
69 #ifndef OPENSSL_NO_ENGINE
70 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
71 {"engine_impl", OPT_ENGINE_IMPL, '-',
72 "Also use engine given by -engine for crypto operations"},
77 int pkeyutl_main(int argc, char **argv)
79 BIO *in = NULL, *out = NULL;
81 EVP_PKEY_CTX *ctx = NULL;
82 char *infile = NULL, *outfile = NULL, *sigfile = NULL, *passinarg = NULL;
83 char hexdump = 0, asn1parse = 0, rev = 0, *prog;
84 unsigned char *buf_in = NULL, *buf_out = NULL, *sig = NULL;
86 int buf_inlen = 0, siglen = -1, keyform = FORMAT_PEM, peerform =
88 int keysize = -1, pkey_op = EVP_PKEY_OP_SIGN, key_type = KEY_PRIVKEY;
92 const char *inkey = NULL;
93 const char *peerkey = NULL;
94 const char *kdfalg = NULL;
96 STACK_OF(OPENSSL_STRING) *pkeyopts = NULL;
98 prog = opt_init(argc, argv, pkeyutl_options);
99 while ((o = opt_next()) != OPT_EOF) {
104 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
107 opt_help(pkeyutl_options);
119 case OPT_ENGINE_IMPL:
129 passinarg = opt_arg();
132 if (!opt_format(opt_arg(), OPT_FMT_PDE, &peerform))
136 if (!opt_format(opt_arg(), OPT_FMT_PDE, &keyform))
144 e = setup_engine(opt_arg(), 0);
147 key_type = KEY_PUBKEY;
159 pkey_op = EVP_PKEY_OP_SIGN;
162 pkey_op = EVP_PKEY_OP_VERIFY;
164 case OPT_VERIFYRECOVER:
165 pkey_op = EVP_PKEY_OP_VERIFYRECOVER;
168 pkey_op = EVP_PKEY_OP_ENCRYPT;
171 pkey_op = EVP_PKEY_OP_DECRYPT;
174 pkey_op = EVP_PKEY_OP_DERIVE;
177 pkey_op = EVP_PKEY_OP_DERIVE;
182 kdflen = atoi(opt_arg());
188 if ((pkeyopts == NULL &&
189 (pkeyopts = sk_OPENSSL_STRING_new_null()) == NULL) ||
190 sk_OPENSSL_STRING_push(pkeyopts, opt_arg()) == 0) {
191 BIO_puts(bio_err, "out of memory\n");
197 argc = opt_num_rest();
201 if (kdfalg != NULL) {
204 } else if ((inkey == NULL)
205 || (peerkey != NULL && pkey_op != EVP_PKEY_OP_DERIVE)) {
208 ctx = init_ctx(kdfalg, &keysize, inkey, keyform, key_type,
209 passinarg, pkey_op, e, engine_impl);
211 BIO_printf(bio_err, "%s: Error initializing context\n", prog);
212 ERR_print_errors(bio_err);
215 if (peerkey != NULL && !setup_peer(ctx, peerform, peerkey, e)) {
216 BIO_printf(bio_err, "%s: Error setting up peer key\n", prog);
217 ERR_print_errors(bio_err);
220 if (pkeyopts != NULL) {
221 int num = sk_OPENSSL_STRING_num(pkeyopts);
224 for (i = 0; i < num; ++i) {
225 const char *opt = sk_OPENSSL_STRING_value(pkeyopts, i);
227 if (pkey_ctrl_string(ctx, opt) <= 0) {
228 BIO_printf(bio_err, "%s: Can't set parameter:\n", prog);
229 ERR_print_errors(bio_err);
235 if (sigfile != NULL && (pkey_op != EVP_PKEY_OP_VERIFY)) {
237 "%s: Signature file specified for non verify\n", prog);
241 if (sigfile == NULL && (pkey_op == EVP_PKEY_OP_VERIFY)) {
243 "%s: No signature file specified for verify\n", prog);
247 if (pkey_op != EVP_PKEY_OP_DERIVE) {
248 in = bio_open_default(infile, 'r', FORMAT_BINARY);
252 out = bio_open_default(outfile, 'w', FORMAT_BINARY);
256 if (sigfile != NULL) {
257 BIO *sigbio = BIO_new_file(sigfile, "rb");
259 if (sigbio == NULL) {
260 BIO_printf(bio_err, "Can't open signature file %s\n", sigfile);
263 siglen = bio_to_mem(&sig, keysize * 10, sigbio);
266 BIO_printf(bio_err, "Error reading signature data\n");
272 /* Read the input data */
273 buf_inlen = bio_to_mem(&buf_in, keysize * 10, in);
275 BIO_printf(bio_err, "Error reading input Data\n");
281 size_t l = (size_t)buf_inlen;
282 for (i = 0; i < l / 2; i++) {
284 buf_in[i] = buf_in[l - 1 - i];
285 buf_in[l - 1 - i] = ctmp;
290 if (pkey_op == EVP_PKEY_OP_VERIFY) {
291 rv = EVP_PKEY_verify(ctx, sig, (size_t)siglen,
292 buf_in, (size_t)buf_inlen);
294 BIO_puts(out, "Signature Verified Successfully\n");
297 BIO_puts(out, "Signature Verification Failure\n");
305 rv = do_keyop(ctx, pkey_op, NULL, (size_t *)&buf_outlen,
306 buf_in, (size_t)buf_inlen);
308 if (rv > 0 && buf_outlen != 0) {
309 buf_out = app_malloc(buf_outlen, "buffer output");
310 rv = do_keyop(ctx, pkey_op,
311 buf_out, (size_t *)&buf_outlen,
312 buf_in, (size_t)buf_inlen);
315 BIO_puts(bio_err, "Public Key operation error\n");
316 ERR_print_errors(bio_err);
322 if (!ASN1_parse_dump(out, buf_out, buf_outlen, 1, -1))
323 ERR_print_errors(bio_err);
324 } else if (hexdump) {
325 BIO_dump(out, (char *)buf_out, buf_outlen);
327 BIO_write(out, buf_out, buf_outlen);
331 EVP_PKEY_CTX_free(ctx);
335 OPENSSL_free(buf_in);
336 OPENSSL_free(buf_out);
338 sk_OPENSSL_STRING_free(pkeyopts);
342 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
343 const char *keyfile, int keyform, int key_type,
344 char *passinarg, int pkey_op, ENGINE *e,
345 const int engine_impl)
347 EVP_PKEY *pkey = NULL;
348 EVP_PKEY_CTX *ctx = NULL;
353 if (((pkey_op == EVP_PKEY_OP_SIGN) || (pkey_op == EVP_PKEY_OP_DECRYPT)
354 || (pkey_op == EVP_PKEY_OP_DERIVE))
355 && (key_type != KEY_PRIVKEY && kdfalg == NULL)) {
356 BIO_printf(bio_err, "A private key is needed for this operation\n");
359 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
360 BIO_printf(bio_err, "Error getting password\n");
365 pkey = load_key(keyfile, keyform, 0, passin, e, "Private Key");
369 pkey = load_pubkey(keyfile, keyform, 0, NULL, e, "Public Key");
373 x = load_cert(keyfile, keyform, "Certificate");
375 pkey = X509_get_pubkey(x);
385 #ifndef OPENSSL_NO_ENGINE
390 if (kdfalg != NULL) {
391 int kdfnid = OBJ_sn2nid(kdfalg);
393 if (kdfnid == NID_undef) {
394 kdfnid = OBJ_ln2nid(kdfalg);
395 if (kdfnid == NID_undef)
398 ctx = EVP_PKEY_CTX_new_id(kdfnid, impl);
402 *pkeysize = EVP_PKEY_size(pkey);
403 ctx = EVP_PKEY_CTX_new(pkey, impl);
411 case EVP_PKEY_OP_SIGN:
412 rv = EVP_PKEY_sign_init(ctx);
415 case EVP_PKEY_OP_VERIFY:
416 rv = EVP_PKEY_verify_init(ctx);
419 case EVP_PKEY_OP_VERIFYRECOVER:
420 rv = EVP_PKEY_verify_recover_init(ctx);
423 case EVP_PKEY_OP_ENCRYPT:
424 rv = EVP_PKEY_encrypt_init(ctx);
427 case EVP_PKEY_OP_DECRYPT:
428 rv = EVP_PKEY_decrypt_init(ctx);
431 case EVP_PKEY_OP_DERIVE:
432 rv = EVP_PKEY_derive_init(ctx);
437 EVP_PKEY_CTX_free(ctx);
442 OPENSSL_free(passin);
447 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
450 EVP_PKEY *peer = NULL;
451 ENGINE* engine = NULL;
454 if (peerform == FORMAT_ENGINE)
456 peer = load_pubkey(file, peerform, 0, NULL, engine, "Peer Key");
458 BIO_printf(bio_err, "Error reading peer key %s\n", file);
459 ERR_print_errors(bio_err);
463 ret = EVP_PKEY_derive_set_peer(ctx, peer);
467 ERR_print_errors(bio_err);
471 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
472 unsigned char *out, size_t *poutlen,
473 const unsigned char *in, size_t inlen)
477 case EVP_PKEY_OP_VERIFYRECOVER:
478 rv = EVP_PKEY_verify_recover(ctx, out, poutlen, in, inlen);
481 case EVP_PKEY_OP_SIGN:
482 rv = EVP_PKEY_sign(ctx, out, poutlen, in, inlen);
485 case EVP_PKEY_OP_ENCRYPT:
486 rv = EVP_PKEY_encrypt(ctx, out, poutlen, in, inlen);
489 case EVP_PKEY_OP_DECRYPT:
490 rv = EVP_PKEY_decrypt(ctx, out, poutlen, in, inlen);
493 case EVP_PKEY_OP_DERIVE:
494 rv = EVP_PKEY_derive(ctx, out, poutlen);