Change the transfer perl module so the real module gets properly registered
[openssl.git] / apps / pkeyutl.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 2006.
4  */
5 /* ====================================================================
6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #include "apps.h"
60 #include <string.h>
61 #include <openssl/err.h>
62 #include <openssl/pem.h>
63 #include <openssl/evp.h>
64
65 #define KEY_PRIVKEY     1
66 #define KEY_PUBKEY      2
67 #define KEY_CERT        3
68
69 static EVP_PKEY_CTX *init_ctx(int *pkeysize,
70                               const char *keyfile, int keyform, int key_type,
71                               char *passinarg, int pkey_op, ENGINE *e);
72
73 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
74                       ENGINE *e);
75
76 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
77                     unsigned char *out, size_t *poutlen,
78                     unsigned char *in, size_t inlen);
79
80 typedef enum OPTION_choice {
81     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
82     OPT_ENGINE, OPT_IN, OPT_OUT,
83     OPT_PUBIN, OPT_CERTIN, OPT_ASN1PARSE, OPT_HEXDUMP, OPT_SIGN,
84     OPT_VERIFY, OPT_VERIFYRECOVER, OPT_REV, OPT_ENCRYPT, OPT_DECRYPT,
85     OPT_DERIVE, OPT_SIGFILE, OPT_INKEY, OPT_PEERKEY, OPT_PASSIN,
86     OPT_PEERFORM, OPT_KEYFORM, OPT_PKEYOPT
87 } OPTION_CHOICE;
88
89 OPTIONS pkeyutl_options[] = {
90     {"help", OPT_HELP, '-', "Display this summary"},
91     {"in", OPT_IN, '<', "Input file"},
92     {"out", OPT_OUT, '>', "Output file"},
93     {"pubin", OPT_PUBIN, '-', "Input is a public key"},
94     {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},
95     {"asn1parse", OPT_ASN1PARSE, '-', "asn1parse the output data"},
96     {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},
97     {"sign", OPT_SIGN, '-', "Sign with private key"},
98     {"verify", OPT_VERIFY, '-', "Verify with public key"},
99     {"verifyrecover", OPT_VERIFYRECOVER, '-',
100      "Verify with public key, recover original data"},
101     {"rev", OPT_REV, '-', "Reverse the input buffer"},
102     {"encrypt", OPT_ENCRYPT, '-', "Encrypt with public key"},
103     {"decrypt", OPT_DECRYPT, '-', "Decrypt with private key"},
104     {"derive", OPT_DERIVE, '-', "Derive shared secret"},
105     {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},
106     {"inkey", OPT_INKEY, 's', "Input key"},
107     {"peerkey", OPT_PEERKEY, 's', "Peer key file used in key derivation"},
108     {"passin", OPT_PASSIN, 's', "Pass phrase source"},
109     {"peerform", OPT_PEERFORM, 'E', "Peer key format - default PEM"},
110     {"keyform", OPT_KEYFORM, 'E', "Private key format - default PEM"},
111     {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},
112 #ifndef OPENSSL_NO_ENGINE
113     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
114 #endif
115     {NULL}
116 };
117
118 int pkeyutl_main(int argc, char **argv)
119 {
120     BIO *in = NULL, *out = NULL;
121     ENGINE *e = NULL;
122     EVP_PKEY_CTX *ctx = NULL;
123     char *infile = NULL, *outfile = NULL, *sigfile = NULL, *passinarg = NULL;
124     char hexdump = 0, asn1parse = 0, rev = 0, *prog;
125     unsigned char *buf_in = NULL, *buf_out = NULL, *sig = NULL;
126     OPTION_CHOICE o;
127     int buf_inlen = 0, siglen = -1, keyform = FORMAT_PEM, peerform =
128         FORMAT_PEM;
129     int keysize = -1, pkey_op = EVP_PKEY_OP_SIGN, key_type = KEY_PRIVKEY;
130     int ret = 1, rv = -1;
131     size_t buf_outlen;
132     const char *inkey = NULL;
133     const char *peerkey = NULL;
134     STACK_OF(OPENSSL_STRING) *pkeyopts = NULL;
135
136     prog = opt_init(argc, argv, pkeyutl_options);
137     while ((o = opt_next()) != OPT_EOF) {
138         switch (o) {
139         case OPT_EOF:
140         case OPT_ERR:
141  opthelp:
142             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
143             goto end;
144         case OPT_HELP:
145             opt_help(pkeyutl_options);
146             ret = 0;
147             goto end;
148         case OPT_IN:
149             infile = opt_arg();
150             break;
151         case OPT_OUT:
152             outfile = opt_arg();
153             break;
154         case OPT_SIGFILE:
155             sigfile = opt_arg();
156             break;
157         case OPT_INKEY:
158             inkey = opt_arg();
159             break;
160         case OPT_PEERKEY:
161             peerkey = opt_arg();
162             break;
163         case OPT_PASSIN:
164             passinarg = opt_arg();
165             break;
166         case OPT_PEERFORM:
167             if (!opt_format(opt_arg(), OPT_FMT_PDE, &peerform))
168                 goto opthelp;
169             break;
170         case OPT_KEYFORM:
171             if (!opt_format(opt_arg(), OPT_FMT_PDE, &keyform))
172                 goto opthelp;
173             break;
174         case OPT_ENGINE:
175             e = setup_engine(opt_arg(), 0);
176             break;
177         case OPT_PUBIN:
178             key_type = KEY_PUBKEY;
179             break;
180         case OPT_CERTIN:
181             key_type = KEY_CERT;
182             break;
183         case OPT_ASN1PARSE:
184             asn1parse = 1;
185             break;
186         case OPT_HEXDUMP:
187             hexdump = 1;
188             break;
189         case OPT_SIGN:
190             pkey_op = EVP_PKEY_OP_SIGN;
191             break;
192         case OPT_VERIFY:
193             pkey_op = EVP_PKEY_OP_VERIFY;
194             break;
195         case OPT_VERIFYRECOVER:
196             pkey_op = EVP_PKEY_OP_VERIFYRECOVER;
197             break;
198         case OPT_ENCRYPT:
199             pkey_op = EVP_PKEY_OP_ENCRYPT;
200             break;
201         case OPT_DECRYPT:
202             pkey_op = EVP_PKEY_OP_DECRYPT;
203             break;
204         case OPT_DERIVE:
205             pkey_op = EVP_PKEY_OP_DERIVE;
206             break;
207         case OPT_REV:
208             rev = 1;
209             break;
210         case OPT_PKEYOPT:
211             if ((pkeyopts == NULL &&
212                  (pkeyopts = sk_OPENSSL_STRING_new_null()) == NULL) ||
213                 sk_OPENSSL_STRING_push(pkeyopts, *++argv) == 0) {
214                 BIO_puts(bio_err, "out of memory\n");
215                 goto end;
216             }
217             break;
218         }
219     }
220     argc = opt_num_rest();
221     argv = opt_rest();
222
223     if (inkey == NULL ||
224         (peerkey != NULL && pkey_op != EVP_PKEY_OP_DERIVE))
225         goto opthelp;
226
227     ctx = init_ctx(&keysize, inkey, keyform, key_type,
228                    passinarg, pkey_op, e);
229     if (ctx == NULL) {
230         BIO_printf(bio_err, "%s: Error initializing context\n", prog);
231         ERR_print_errors(bio_err);
232         goto end;
233     }
234     if (peerkey != NULL && !setup_peer(ctx, peerform, peerkey, e)) {
235         BIO_printf(bio_err, "%s: Error setting up peer key\n", prog);
236         ERR_print_errors(bio_err);
237         goto end;
238     }
239     if (pkeyopts != NULL) {
240         int num = sk_OPENSSL_STRING_num(pkeyopts);
241         int i;
242
243         for (i = 0; i < num; ++i) {
244             const char *opt = sk_OPENSSL_STRING_value(pkeyopts, i);
245
246             if (pkey_ctrl_string(ctx, opt) <= 0) {
247                 BIO_printf(bio_err, "%s: Can't set parameter:\n", prog);
248                 ERR_print_errors(bio_err);
249                 goto end;
250             }
251         }
252     }
253
254     if (sigfile && (pkey_op != EVP_PKEY_OP_VERIFY)) {
255         BIO_printf(bio_err,
256                    "%s: Signature file specified for non verify\n", prog);
257         goto end;
258     }
259
260     if (!sigfile && (pkey_op == EVP_PKEY_OP_VERIFY)) {
261         BIO_printf(bio_err,
262                    "%s: No signature file specified for verify\n", prog);
263         goto end;
264     }
265
266 /* FIXME: seed PRNG only if needed */
267     app_RAND_load_file(NULL, 0);
268
269     if (pkey_op != EVP_PKEY_OP_DERIVE) {
270         in = bio_open_default(infile, 'r', FORMAT_BINARY);
271         if (in == NULL)
272             goto end;
273     }
274     out = bio_open_default(outfile, 'w', FORMAT_BINARY);
275     if (out == NULL)
276         goto end;
277
278     if (sigfile) {
279         BIO *sigbio = BIO_new_file(sigfile, "rb");
280         if (!sigbio) {
281             BIO_printf(bio_err, "Can't open signature file %s\n", sigfile);
282             goto end;
283         }
284         siglen = bio_to_mem(&sig, keysize * 10, sigbio);
285         BIO_free(sigbio);
286         if (siglen < 0) {
287             BIO_printf(bio_err, "Error reading signature data\n");
288             goto end;
289         }
290     }
291
292     if (in) {
293         /* Read the input data */
294         buf_inlen = bio_to_mem(&buf_in, keysize * 10, in);
295         if (buf_inlen < 0) {
296             BIO_printf(bio_err, "Error reading input Data\n");
297             exit(1);
298         }
299         if (rev) {
300             size_t i;
301             unsigned char ctmp;
302             size_t l = (size_t)buf_inlen;
303             for (i = 0; i < l / 2; i++) {
304                 ctmp = buf_in[i];
305                 buf_in[i] = buf_in[l - 1 - i];
306                 buf_in[l - 1 - i] = ctmp;
307             }
308         }
309     }
310
311     if (pkey_op == EVP_PKEY_OP_VERIFY) {
312         rv = EVP_PKEY_verify(ctx, sig, (size_t)siglen,
313                              buf_in, (size_t)buf_inlen);
314         if (rv == 1) {
315             BIO_puts(out, "Signature Verified Successfully\n");
316             ret = 0;
317         } else
318             BIO_puts(out, "Signature Verification Failure\n");
319         goto end;
320     }
321     rv = do_keyop(ctx, pkey_op, NULL, (size_t *)&buf_outlen,
322                   buf_in, (size_t)buf_inlen);
323     if (rv > 0 && buf_outlen != 0) {
324         buf_out = app_malloc(buf_outlen, "buffer output");
325         rv = do_keyop(ctx, pkey_op,
326                       buf_out, (size_t *)&buf_outlen,
327                       buf_in, (size_t)buf_inlen);
328     }
329     if (rv < 0) {
330         ERR_print_errors(bio_err);
331         goto end;
332     }
333     ret = 0;
334
335     if (asn1parse) {
336         if (!ASN1_parse_dump(out, buf_out, buf_outlen, 1, -1))
337             ERR_print_errors(bio_err);
338     } else if (hexdump)
339         BIO_dump(out, (char *)buf_out, buf_outlen);
340     else
341         BIO_write(out, buf_out, buf_outlen);
342
343  end:
344     EVP_PKEY_CTX_free(ctx);
345     BIO_free(in);
346     BIO_free_all(out);
347     OPENSSL_free(buf_in);
348     OPENSSL_free(buf_out);
349     OPENSSL_free(sig);
350     sk_OPENSSL_STRING_free(pkeyopts);
351     return ret;
352 }
353
354 static EVP_PKEY_CTX *init_ctx(int *pkeysize,
355                               const char *keyfile, int keyform, int key_type,
356                               char *passinarg, int pkey_op, ENGINE *e)
357 {
358     EVP_PKEY *pkey = NULL;
359     EVP_PKEY_CTX *ctx = NULL;
360     char *passin = NULL;
361     int rv = -1;
362     X509 *x;
363     if (((pkey_op == EVP_PKEY_OP_SIGN) || (pkey_op == EVP_PKEY_OP_DECRYPT)
364          || (pkey_op == EVP_PKEY_OP_DERIVE))
365         && (key_type != KEY_PRIVKEY)) {
366         BIO_printf(bio_err, "A private key is needed for this operation\n");
367         goto end;
368     }
369     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
370         BIO_printf(bio_err, "Error getting password\n");
371         goto end;
372     }
373     switch (key_type) {
374     case KEY_PRIVKEY:
375         pkey = load_key(keyfile, keyform, 0, passin, e, "Private Key");
376         break;
377
378     case KEY_PUBKEY:
379         pkey = load_pubkey(keyfile, keyform, 0, NULL, e, "Public Key");
380         break;
381
382     case KEY_CERT:
383         x = load_cert(keyfile, keyform, NULL, e, "Certificate");
384         if (x) {
385             pkey = X509_get_pubkey(x);
386             X509_free(x);
387         }
388         break;
389
390     }
391
392     *pkeysize = EVP_PKEY_size(pkey);
393
394     if (!pkey)
395         goto end;
396
397     ctx = EVP_PKEY_CTX_new(pkey, e);
398
399     EVP_PKEY_free(pkey);
400
401     if (ctx == NULL)
402         goto end;
403
404     switch (pkey_op) {
405     case EVP_PKEY_OP_SIGN:
406         rv = EVP_PKEY_sign_init(ctx);
407         break;
408
409     case EVP_PKEY_OP_VERIFY:
410         rv = EVP_PKEY_verify_init(ctx);
411         break;
412
413     case EVP_PKEY_OP_VERIFYRECOVER:
414         rv = EVP_PKEY_verify_recover_init(ctx);
415         break;
416
417     case EVP_PKEY_OP_ENCRYPT:
418         rv = EVP_PKEY_encrypt_init(ctx);
419         break;
420
421     case EVP_PKEY_OP_DECRYPT:
422         rv = EVP_PKEY_decrypt_init(ctx);
423         break;
424
425     case EVP_PKEY_OP_DERIVE:
426         rv = EVP_PKEY_derive_init(ctx);
427         break;
428     }
429
430     if (rv <= 0) {
431         EVP_PKEY_CTX_free(ctx);
432         ctx = NULL;
433     }
434
435  end:
436     OPENSSL_free(passin);
437     return ctx;
438
439 }
440
441 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file,
442                       ENGINE* e)
443 {
444     EVP_PKEY *peer = NULL;
445     ENGINE* engine = NULL;
446     int ret;
447
448     if (peerform == FORMAT_ENGINE)
449         engine = e;
450     peer = load_pubkey(file, peerform, 0, NULL, engine, "Peer Key");
451     if (!peer) {
452         BIO_printf(bio_err, "Error reading peer key %s\n", file);
453         ERR_print_errors(bio_err);
454         return 0;
455     }
456
457     ret = EVP_PKEY_derive_set_peer(ctx, peer);
458
459     EVP_PKEY_free(peer);
460     if (ret <= 0)
461         ERR_print_errors(bio_err);
462     return ret;
463 }
464
465 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
466                     unsigned char *out, size_t *poutlen,
467                     unsigned char *in, size_t inlen)
468 {
469     int rv = 0;
470     switch (pkey_op) {
471     case EVP_PKEY_OP_VERIFYRECOVER:
472         rv = EVP_PKEY_verify_recover(ctx, out, poutlen, in, inlen);
473         break;
474
475     case EVP_PKEY_OP_SIGN:
476         rv = EVP_PKEY_sign(ctx, out, poutlen, in, inlen);
477         break;
478
479     case EVP_PKEY_OP_ENCRYPT:
480         rv = EVP_PKEY_encrypt(ctx, out, poutlen, in, inlen);
481         break;
482
483     case EVP_PKEY_OP_DECRYPT:
484         rv = EVP_PKEY_decrypt(ctx, out, poutlen, in, inlen);
485         break;
486
487     case EVP_PKEY_OP_DERIVE:
488         rv = EVP_PKEY_derive(ctx, out, poutlen);
489         break;
490
491     }
492     return rv;
493 }