Unify s_client/s_server srtp profiles option handling
[openssl.git] / apps / pkeyutl.c
1 /*
2  * Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include "apps.h"
11 #include "progs.h"
12 #include <string.h>
13 #include <openssl/err.h>
14 #include <openssl/pem.h>
15 #include <openssl/evp.h>
16
17 #define KEY_NONE        0
18 #define KEY_PRIVKEY     1
19 #define KEY_PUBKEY      2
20 #define KEY_CERT        3
21
22 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
23                               const char *keyfile, int keyform, int key_type,
24                               char *passinarg, int pkey_op, ENGINE *e,
25                               const int impl);
26
27 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
28                       ENGINE *e);
29
30 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
31                     unsigned char *out, size_t *poutlen,
32                     const unsigned char *in, size_t inlen);
33
34 typedef enum OPTION_choice {
35     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
36     OPT_ENGINE, OPT_ENGINE_IMPL, OPT_IN, OPT_OUT,
37     OPT_PUBIN, OPT_CERTIN, OPT_ASN1PARSE, OPT_HEXDUMP, OPT_SIGN,
38     OPT_VERIFY, OPT_VERIFYRECOVER, OPT_REV, OPT_ENCRYPT, OPT_DECRYPT,
39     OPT_DERIVE, OPT_SIGFILE, OPT_INKEY, OPT_PEERKEY, OPT_PASSIN,
40     OPT_PEERFORM, OPT_KEYFORM, OPT_PKEYOPT, OPT_KDF, OPT_KDFLEN,
41     OPT_R_ENUM
42 } OPTION_CHOICE;
43
44 const OPTIONS pkeyutl_options[] = {
45     {"help", OPT_HELP, '-', "Display this summary"},
46     {"in", OPT_IN, '<', "Input file - default stdin"},
47     {"out", OPT_OUT, '>', "Output file - default stdout"},
48     {"pubin", OPT_PUBIN, '-', "Input is a public key"},
49     {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},
50     {"asn1parse", OPT_ASN1PARSE, '-', "asn1parse the output data"},
51     {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},
52     {"sign", OPT_SIGN, '-', "Sign input data with private key"},
53     {"verify", OPT_VERIFY, '-', "Verify with public key"},
54     {"verifyrecover", OPT_VERIFYRECOVER, '-',
55      "Verify with public key, recover original data"},
56     {"rev", OPT_REV, '-', "Reverse the order of the input buffer"},
57     {"encrypt", OPT_ENCRYPT, '-', "Encrypt input data with public key"},
58     {"decrypt", OPT_DECRYPT, '-', "Decrypt input data with private key"},
59     {"derive", OPT_DERIVE, '-', "Derive shared secret"},
60     {"kdf", OPT_KDF, 's', "Use KDF algorithm"},
61     {"kdflen", OPT_KDFLEN, 'p', "KDF algorithm output length"},
62     {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},
63     {"inkey", OPT_INKEY, 's', "Input private key file"},
64     {"peerkey", OPT_PEERKEY, 's', "Peer key file used in key derivation"},
65     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
66     {"peerform", OPT_PEERFORM, 'E', "Peer key format - default PEM"},
67     {"keyform", OPT_KEYFORM, 'E', "Private key format - default PEM"},
68     {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},
69     OPT_R_OPTIONS,
70 #ifndef OPENSSL_NO_ENGINE
71     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
72     {"engine_impl", OPT_ENGINE_IMPL, '-',
73      "Also use engine given by -engine for crypto operations"},
74 #endif
75     {NULL}
76 };
77
78 int pkeyutl_main(int argc, char **argv)
79 {
80     BIO *in = NULL, *out = NULL;
81     ENGINE *e = NULL;
82     EVP_PKEY_CTX *ctx = NULL;
83     char *infile = NULL, *outfile = NULL, *sigfile = NULL, *passinarg = NULL;
84     char hexdump = 0, asn1parse = 0, rev = 0, *prog;
85     unsigned char *buf_in = NULL, *buf_out = NULL, *sig = NULL;
86     OPTION_CHOICE o;
87     int buf_inlen = 0, siglen = -1, keyform = FORMAT_PEM, peerform = FORMAT_PEM;
88     int keysize = -1, pkey_op = EVP_PKEY_OP_SIGN, key_type = KEY_PRIVKEY;
89     int engine_impl = 0;
90     int ret = 1, rv = -1;
91     size_t buf_outlen;
92     const char *inkey = NULL;
93     const char *peerkey = NULL;
94     const char *kdfalg = NULL;
95     int kdflen = 0;
96     STACK_OF(OPENSSL_STRING) *pkeyopts = NULL;
97
98     prog = opt_init(argc, argv, pkeyutl_options);
99     while ((o = opt_next()) != OPT_EOF) {
100         switch (o) {
101         case OPT_EOF:
102         case OPT_ERR:
103  opthelp:
104             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
105             goto end;
106         case OPT_HELP:
107             opt_help(pkeyutl_options);
108             ret = 0;
109             goto end;
110         case OPT_IN:
111             infile = opt_arg();
112             break;
113         case OPT_OUT:
114             outfile = opt_arg();
115             break;
116         case OPT_SIGFILE:
117             sigfile = opt_arg();
118             break;
119         case OPT_ENGINE_IMPL:
120             engine_impl = 1;
121             break;
122         case OPT_INKEY:
123             inkey = opt_arg();
124             break;
125         case OPT_PEERKEY:
126             peerkey = opt_arg();
127             break;
128         case OPT_PASSIN:
129             passinarg = opt_arg();
130             break;
131         case OPT_PEERFORM:
132             if (!opt_format(opt_arg(), OPT_FMT_PDE, &peerform))
133                 goto opthelp;
134             break;
135         case OPT_KEYFORM:
136             if (!opt_format(opt_arg(), OPT_FMT_PDE, &keyform))
137                 goto opthelp;
138             break;
139         case OPT_R_CASES:
140             if (!opt_rand(o))
141                 goto end;
142             break;
143         case OPT_ENGINE:
144             e = setup_engine(opt_arg(), 0);
145             break;
146         case OPT_PUBIN:
147             key_type = KEY_PUBKEY;
148             break;
149         case OPT_CERTIN:
150             key_type = KEY_CERT;
151             break;
152         case OPT_ASN1PARSE:
153             asn1parse = 1;
154             break;
155         case OPT_HEXDUMP:
156             hexdump = 1;
157             break;
158         case OPT_SIGN:
159             pkey_op = EVP_PKEY_OP_SIGN;
160             break;
161         case OPT_VERIFY:
162             pkey_op = EVP_PKEY_OP_VERIFY;
163             break;
164         case OPT_VERIFYRECOVER:
165             pkey_op = EVP_PKEY_OP_VERIFYRECOVER;
166             break;
167         case OPT_ENCRYPT:
168             pkey_op = EVP_PKEY_OP_ENCRYPT;
169             break;
170         case OPT_DECRYPT:
171             pkey_op = EVP_PKEY_OP_DECRYPT;
172             break;
173         case OPT_DERIVE:
174             pkey_op = EVP_PKEY_OP_DERIVE;
175             break;
176         case OPT_KDF:
177             pkey_op = EVP_PKEY_OP_DERIVE;
178             key_type = KEY_NONE;
179             kdfalg = opt_arg();
180             break;
181         case OPT_KDFLEN:
182             kdflen = atoi(opt_arg());
183             break;
184         case OPT_REV:
185             rev = 1;
186             break;
187         case OPT_PKEYOPT:
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");
192                 goto end;
193             }
194             break;
195         }
196     }
197     argc = opt_num_rest();
198     if (argc != 0)
199         goto opthelp;
200
201     if (kdfalg != NULL) {
202         if (kdflen == 0) {
203             BIO_printf(bio_err,
204                        "%s: no KDF length given (-kdflen parameter).\n", prog);
205             goto opthelp;
206         }
207     } else if (inkey == NULL) {
208         BIO_printf(bio_err,
209                    "%s: no private key given (-inkey parameter).\n", prog);
210         goto opthelp;
211     } else if (peerkey != NULL && pkey_op != EVP_PKEY_OP_DERIVE) {
212         BIO_printf(bio_err,
213                    "%s: no peer key given (-peerkey parameter).\n", prog);
214         goto opthelp;
215     }
216     ctx = init_ctx(kdfalg, &keysize, inkey, keyform, key_type,
217                    passinarg, pkey_op, e, engine_impl);
218     if (ctx == NULL) {
219         BIO_printf(bio_err, "%s: Error initializing context\n", prog);
220         ERR_print_errors(bio_err);
221         goto end;
222     }
223     if (peerkey != NULL && !setup_peer(ctx, peerform, peerkey, e)) {
224         BIO_printf(bio_err, "%s: Error setting up peer key\n", prog);
225         ERR_print_errors(bio_err);
226         goto end;
227     }
228     if (pkeyopts != NULL) {
229         int num = sk_OPENSSL_STRING_num(pkeyopts);
230         int i;
231
232         for (i = 0; i < num; ++i) {
233             const char *opt = sk_OPENSSL_STRING_value(pkeyopts, i);
234
235             if (pkey_ctrl_string(ctx, opt) <= 0) {
236                 BIO_printf(bio_err, "%s: Can't set parameter \"%s\":\n",
237                            prog, opt);
238                 ERR_print_errors(bio_err);
239                 goto end;
240             }
241         }
242     }
243
244     if (sigfile != NULL && (pkey_op != EVP_PKEY_OP_VERIFY)) {
245         BIO_printf(bio_err,
246                    "%s: Signature file specified for non verify\n", prog);
247         goto end;
248     }
249
250     if (sigfile == NULL && (pkey_op == EVP_PKEY_OP_VERIFY)) {
251         BIO_printf(bio_err,
252                    "%s: No signature file specified for verify\n", prog);
253         goto end;
254     }
255
256     if (pkey_op != EVP_PKEY_OP_DERIVE) {
257         in = bio_open_default(infile, 'r', FORMAT_BINARY);
258         if (in == NULL)
259             goto end;
260     }
261     out = bio_open_default(outfile, 'w', FORMAT_BINARY);
262     if (out == NULL)
263         goto end;
264
265     if (sigfile != NULL) {
266         BIO *sigbio = BIO_new_file(sigfile, "rb");
267
268         if (sigbio == NULL) {
269             BIO_printf(bio_err, "Can't open signature file %s\n", sigfile);
270             goto end;
271         }
272         siglen = bio_to_mem(&sig, keysize * 10, sigbio);
273         BIO_free(sigbio);
274         if (siglen < 0) {
275             BIO_printf(bio_err, "Error reading signature data\n");
276             goto end;
277         }
278     }
279
280     if (in != NULL) {
281         /* Read the input data */
282         buf_inlen = bio_to_mem(&buf_in, keysize * 10, in);
283         if (buf_inlen < 0) {
284             BIO_printf(bio_err, "Error reading input Data\n");
285             exit(1);
286         }
287         if (rev) {
288             size_t i;
289             unsigned char ctmp;
290             size_t l = (size_t)buf_inlen;
291             for (i = 0; i < l / 2; i++) {
292                 ctmp = buf_in[i];
293                 buf_in[i] = buf_in[l - 1 - i];
294                 buf_in[l - 1 - i] = ctmp;
295             }
296         }
297     }
298
299     if (pkey_op == EVP_PKEY_OP_VERIFY) {
300         rv = EVP_PKEY_verify(ctx, sig, (size_t)siglen,
301                              buf_in, (size_t)buf_inlen);
302         if (rv == 1) {
303             BIO_puts(out, "Signature Verified Successfully\n");
304             ret = 0;
305         } else {
306             BIO_puts(out, "Signature Verification Failure\n");
307         }
308         goto end;
309     }
310     if (kdflen != 0) {
311         buf_outlen = kdflen;
312         rv = 1;
313     } else {
314         rv = do_keyop(ctx, pkey_op, NULL, (size_t *)&buf_outlen,
315                       buf_in, (size_t)buf_inlen);
316     }
317     if (rv > 0 && buf_outlen != 0) {
318         buf_out = app_malloc(buf_outlen, "buffer output");
319         rv = do_keyop(ctx, pkey_op,
320                       buf_out, (size_t *)&buf_outlen,
321                       buf_in, (size_t)buf_inlen);
322     }
323     if (rv <= 0) {
324         if (pkey_op != EVP_PKEY_OP_DERIVE) {
325             BIO_puts(bio_err, "Public Key operation error\n");
326         } else {
327             BIO_puts(bio_err, "Key derivation failed\n");
328         }
329         ERR_print_errors(bio_err);
330         goto end;
331     }
332     ret = 0;
333
334     if (asn1parse) {
335         if (!ASN1_parse_dump(out, buf_out, buf_outlen, 1, -1))
336             ERR_print_errors(bio_err);
337     } else if (hexdump) {
338         BIO_dump(out, (char *)buf_out, buf_outlen);
339     } else {
340         BIO_write(out, buf_out, buf_outlen);
341     }
342
343  end:
344     EVP_PKEY_CTX_free(ctx);
345     release_engine(e);
346     BIO_free(in);
347     BIO_free_all(out);
348     OPENSSL_free(buf_in);
349     OPENSSL_free(buf_out);
350     OPENSSL_free(sig);
351     sk_OPENSSL_STRING_free(pkeyopts);
352     return ret;
353 }
354
355 static EVP_PKEY_CTX *init_ctx(const char *kdfalg, int *pkeysize,
356                               const char *keyfile, int keyform, int key_type,
357                               char *passinarg, int pkey_op, ENGINE *e,
358                               const int engine_impl)
359 {
360     EVP_PKEY *pkey = NULL;
361     EVP_PKEY_CTX *ctx = NULL;
362     ENGINE *impl = NULL;
363     char *passin = NULL;
364     int rv = -1;
365     X509 *x;
366     if (((pkey_op == EVP_PKEY_OP_SIGN) || (pkey_op == EVP_PKEY_OP_DECRYPT)
367          || (pkey_op == EVP_PKEY_OP_DERIVE))
368         && (key_type != KEY_PRIVKEY && kdfalg == NULL)) {
369         BIO_printf(bio_err, "A private key is needed for this operation\n");
370         goto end;
371     }
372     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
373         BIO_printf(bio_err, "Error getting password\n");
374         goto end;
375     }
376     switch (key_type) {
377     case KEY_PRIVKEY:
378         pkey = load_key(keyfile, keyform, 0, passin, e, "Private Key");
379         break;
380
381     case KEY_PUBKEY:
382         pkey = load_pubkey(keyfile, keyform, 0, NULL, e, "Public Key");
383         break;
384
385     case KEY_CERT:
386         x = load_cert(keyfile, keyform, "Certificate");
387         if (x) {
388             pkey = X509_get_pubkey(x);
389             X509_free(x);
390         }
391         break;
392
393     case KEY_NONE:
394         break;
395
396     }
397
398 #ifndef OPENSSL_NO_ENGINE
399     if (engine_impl)
400         impl = e;
401 #endif
402
403     if (kdfalg != NULL) {
404         int kdfnid = OBJ_sn2nid(kdfalg);
405
406         if (kdfnid == NID_undef) {
407             kdfnid = OBJ_ln2nid(kdfalg);
408             if (kdfnid == NID_undef) {
409                 BIO_printf(bio_err, "The given KDF \"%s\" is unknown.\n",
410                            kdfalg);
411                 goto end;
412             }
413         }
414         ctx = EVP_PKEY_CTX_new_id(kdfnid, impl);
415     } else {
416         if (pkey == NULL)
417             goto end;
418         *pkeysize = EVP_PKEY_size(pkey);
419         ctx = EVP_PKEY_CTX_new(pkey, impl);
420         EVP_PKEY_free(pkey);
421     }
422
423     if (ctx == NULL)
424         goto end;
425
426     switch (pkey_op) {
427     case EVP_PKEY_OP_SIGN:
428         rv = EVP_PKEY_sign_init(ctx);
429         break;
430
431     case EVP_PKEY_OP_VERIFY:
432         rv = EVP_PKEY_verify_init(ctx);
433         break;
434
435     case EVP_PKEY_OP_VERIFYRECOVER:
436         rv = EVP_PKEY_verify_recover_init(ctx);
437         break;
438
439     case EVP_PKEY_OP_ENCRYPT:
440         rv = EVP_PKEY_encrypt_init(ctx);
441         break;
442
443     case EVP_PKEY_OP_DECRYPT:
444         rv = EVP_PKEY_decrypt_init(ctx);
445         break;
446
447     case EVP_PKEY_OP_DERIVE:
448         rv = EVP_PKEY_derive_init(ctx);
449         break;
450     }
451
452     if (rv <= 0) {
453         EVP_PKEY_CTX_free(ctx);
454         ctx = NULL;
455     }
456
457  end:
458     OPENSSL_free(passin);
459     return ctx;
460
461 }
462
463 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
464                       ENGINE *e)
465 {
466     EVP_PKEY *peer = NULL;
467     ENGINE *engine = NULL;
468     int ret;
469
470     if (peerform == FORMAT_ENGINE)
471         engine = e;
472     peer = load_pubkey(file, peerform, 0, NULL, engine, "Peer Key");
473     if (peer == NULL) {
474         BIO_printf(bio_err, "Error reading peer key %s\n", file);
475         ERR_print_errors(bio_err);
476         return 0;
477     }
478
479     ret = EVP_PKEY_derive_set_peer(ctx, peer);
480
481     EVP_PKEY_free(peer);
482     if (ret <= 0)
483         ERR_print_errors(bio_err);
484     return ret;
485 }
486
487 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
488                     unsigned char *out, size_t *poutlen,
489                     const unsigned char *in, size_t inlen)
490 {
491     int rv = 0;
492     switch (pkey_op) {
493     case EVP_PKEY_OP_VERIFYRECOVER:
494         rv = EVP_PKEY_verify_recover(ctx, out, poutlen, in, inlen);
495         break;
496
497     case EVP_PKEY_OP_SIGN:
498         rv = EVP_PKEY_sign(ctx, out, poutlen, in, inlen);
499         break;
500
501     case EVP_PKEY_OP_ENCRYPT:
502         rv = EVP_PKEY_encrypt(ctx, out, poutlen, in, inlen);
503         break;
504
505     case EVP_PKEY_OP_DECRYPT:
506         rv = EVP_PKEY_decrypt(ctx, out, poutlen, in, inlen);
507         break;
508
509     case EVP_PKEY_OP_DERIVE:
510         rv = EVP_PKEY_derive(ctx, out, poutlen);
511         break;
512
513     }
514     return rv;
515 }