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                               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
  75 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
  76                     unsigned char *out, size_t *poutlen,
  77                     unsigned char *in, size_t inlen);
  78
  79 typedef enum OPTION_choice {
  80     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  81     OPT_ENGINE, OPT_IN, OPT_OUT,
  82     OPT_PUBIN, OPT_CERTIN, OPT_ASN1PARSE, OPT_HEXDUMP, OPT_SIGN,
  83     OPT_VERIFY, OPT_VERIFYRECOVER, OPT_REV, OPT_ENCRYPT, OPT_DECRYPT,
  84     OPT_DERIVE, OPT_SIGFILE, OPT_INKEY, OPT_PEERKEY, OPT_PASSIN,
  85     OPT_PEERFORM, OPT_KEYFORM, OPT_PKEYOPT
  86 } OPTION_CHOICE;
  87
  88 OPTIONS pkeyutl_options[] = {
  89     {"help", OPT_HELP, '-', "Display this summary"},
  90     {"in", OPT_IN, '<', "Input file"},
  91     {"out", OPT_OUT, '>', "Output file"},
  92     {"pubin", OPT_PUBIN, '-', "Input is a public key"},
  93     {"certin", OPT_CERTIN, '-', "Input is a cert with a public key"},
  94     {"asn1parse", OPT_ASN1PARSE, '-'},
  95     {"hexdump", OPT_HEXDUMP, '-', "Hex dump output"},
  96     {"sign", OPT_SIGN, '-', "Sign with private key"},
  97     {"verify", OPT_VERIFY, '-', "Verify with public key"},
  98     {"verifyrecover", OPT_VERIFYRECOVER, '-',
  99      "Verify with public key, recover original data"},
 100     {"rev", OPT_REV, '-'},
 101     {"encrypt", OPT_ENCRYPT, '-', "Encrypt with public key"},
 102     {"decrypt", OPT_DECRYPT, '-', "Decrypt with private key"},
 103     {"derive", OPT_DERIVE, '-', "Derive shared secret"},
 104     {"sigfile", OPT_SIGFILE, '<', "Signature file (verify operation only)"},
 105     {"inkey", OPT_INKEY, 's', "Input key"},
 106     {"peerkey", OPT_PEERKEY, 's'},
 107     {"passin", OPT_PASSIN, 's', "Pass phrase source"},
 108     {"peerform", OPT_PEERFORM, 'F'},
 109     {"keyform", OPT_KEYFORM, 'F', "Private key format - default PEM"},
 110     {"pkeyopt", OPT_PKEYOPT, 's', "Public key options as opt:value"},
 111 #ifndef OPENSSL_NO_ENGINE
 112     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
 113 #endif
 114     {NULL}
 115 };
 116
 117 int pkeyutl_main(int argc, char **argv)
 118 {
 119     BIO *in = NULL, *out = NULL;
 120     ENGINE *e = NULL;
 121     EVP_PKEY_CTX *ctx = NULL;
 122     char *infile = NULL, *outfile = NULL, *sigfile = NULL, *passinarg = NULL;
 123     char hexdump = 0, asn1parse = 0, rev = 0, *prog;
 124     unsigned char *buf_in = NULL, *buf_out = NULL, *sig = NULL;
 125     OPTION_CHOICE o;
 126     int buf_inlen = 0, siglen = -1, keyform = FORMAT_PEM, peerform =
 127         FORMAT_PEM;
 128     int keysize = -1, pkey_op = EVP_PKEY_OP_SIGN, key_type = KEY_PRIVKEY;
 129     int ret = 1, rv = -1;
 130     size_t buf_outlen;
 131
 132     prog = opt_init(argc, argv, pkeyutl_options);
 133     while ((o = opt_next()) != OPT_EOF) {
 134         switch (o) {
 135         case OPT_EOF:
 136         case OPT_ERR:
 137  opthelp:
 138             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 139             goto end;
 140         case OPT_HELP:
 141             opt_help(pkeyutl_options);
 142             ret = 0;
 143             goto end;
 144         case OPT_IN:
 145             infile = opt_arg();
 146             break;
 147         case OPT_OUT:
 148             outfile = opt_arg();
 149             break;
 150         case OPT_SIGFILE:
 151             sigfile = opt_arg();
 152             break;
 153         case OPT_INKEY:
 154             ctx = init_ctx(&keysize, opt_arg(), keyform, key_type,
 155                            passinarg, pkey_op, e);
 156             if (ctx == NULL) {
 157                 BIO_puts(bio_err, "%s: Error initializing context\n");
 158                 ERR_print_errors(bio_err);
 159                 goto opthelp;
 160             }
 161             break;
 162         case OPT_PEERKEY:
 163             if (!setup_peer(ctx, peerform, opt_arg()))
 164                 goto opthelp;
 165             break;
 166         case OPT_PASSIN:
 167             passinarg = opt_arg();
 168             break;
 169         case OPT_PEERFORM:
 170             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &peerform))
 171                 goto opthelp;
 172             break;
 173         case OPT_KEYFORM:
 174             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &keyform))
 175                 goto opthelp;
 176             break;
 177         case OPT_ENGINE:
 178             e = setup_engine(opt_arg(), 0);
 179             break;
 180         case OPT_PUBIN:
 181             key_type = KEY_PUBKEY;
 182             break;
 183         case OPT_CERTIN:
 184             key_type = KEY_CERT;
 185             break;
 186         case OPT_ASN1PARSE:
 187             asn1parse = 1;
 188             break;
 189         case OPT_HEXDUMP:
 190             hexdump = 1;
 191             break;
 192         case OPT_SIGN:
 193             pkey_op = EVP_PKEY_OP_SIGN;
 194             break;
 195         case OPT_VERIFY:
 196             pkey_op = EVP_PKEY_OP_VERIFY;
 197             break;
 198         case OPT_VERIFYRECOVER:
 199             pkey_op = EVP_PKEY_OP_VERIFYRECOVER;
 200             break;
 201         case OPT_REV:
 202             rev = 1;
 203             break;
 204         case OPT_ENCRYPT:
 205             pkey_op = EVP_PKEY_OP_ENCRYPT;
 206             break;
 207         case OPT_DECRYPT:
 208             pkey_op = EVP_PKEY_OP_DECRYPT;
 209             break;
 210         case OPT_DERIVE:
 211             pkey_op = EVP_PKEY_OP_DERIVE;
 212             break;
 213         case OPT_PKEYOPT:
 214             if (ctx == NULL) {
 215                 BIO_printf(bio_err,
 216                            "%s: Must have -inkey before -pkeyopt\n", prog);
 217                 goto opthelp;
 218             }
 219             if (pkey_ctrl_string(ctx, opt_arg()) <= 0) {
 220                 BIO_printf(bio_err, "%s: Can't set parameter:\n", prog);
 221                 ERR_print_errors(bio_err);
 222                 goto end;
 223             }
 224             break;
 225         }
 226     }
 227     argc = opt_num_rest();
 228     argv = opt_rest();
 229
 230     if (ctx == NULL)
 231         goto opthelp;
 232
 233     if (!app_load_modules(NULL))
 234         goto end;
 235
 236     if (sigfile && (pkey_op != EVP_PKEY_OP_VERIFY)) {
 237         BIO_printf(bio_err,
 238                    "%s: Signature file specified for non verify\n", prog);
 239         goto end;
 240     }
 241
 242     if (!sigfile && (pkey_op == EVP_PKEY_OP_VERIFY)) {
 243         BIO_printf(bio_err,
 244                    "%s: No signature file specified for verify\n", prog);
 245         goto end;
 246     }
 247
 248 /* FIXME: seed PRNG only if needed */
 249     app_RAND_load_file(NULL, 0);
 250
 251     if (pkey_op != EVP_PKEY_OP_DERIVE) {
 252         in = bio_open_default(infile, "rb");
 253         if (in == NULL)
 254             goto end;
 255     }
 256     out = bio_open_default(outfile, "wb");
 257     if (out == NULL)
 258         goto end;
 259
 260     if (sigfile) {
 261         BIO *sigbio = BIO_new_file(sigfile, "rb");
 262         if (!sigbio) {
 263             BIO_printf(bio_err, "Can't open signature file %s\n", sigfile);
 264             goto end;
 265         }
 266         siglen = bio_to_mem(&sig, keysize * 10, sigbio);
 267         BIO_free(sigbio);
 268         if (siglen <= 0) {
 269             BIO_printf(bio_err, "Error reading signature data\n");
 270             goto end;
 271         }
 272     }
 273
 274     if (in) {
 275         /* Read the input data */
 276         buf_inlen = bio_to_mem(&buf_in, keysize * 10, in);
 277         if (buf_inlen <= 0) {
 278             BIO_printf(bio_err, "Error reading input Data\n");
 279             exit(1);
 280         }
 281         if (rev) {
 282             size_t i;
 283             unsigned char ctmp;
 284             size_t l = (size_t)buf_inlen;
 285             for (i = 0; i < l / 2; i++) {
 286                 ctmp = buf_in[i];
 287                 buf_in[i] = buf_in[l - 1 - i];
 288                 buf_in[l - 1 - i] = ctmp;
 289             }
 290         }
 291     }
 292
 293     if (pkey_op == EVP_PKEY_OP_VERIFY) {
 294         rv = EVP_PKEY_verify(ctx, sig, (size_t)siglen,
 295                              buf_in, (size_t)buf_inlen);
 296         if (rv == 1) {
 297             BIO_puts(out, "Signature Verified Successfully\n");
 298             ret = 0;
 299         } else
 300             BIO_puts(out, "Signature Verification Failure\n");
 301         goto end;
 302     }
 303     rv = do_keyop(ctx, pkey_op, NULL, (size_t *)&buf_outlen,
 304                   buf_in, (size_t)buf_inlen);
 305     if (rv > 0) {
 306         buf_out = app_malloc(buf_outlen, "buffer output");
 307         rv = do_keyop(ctx, pkey_op,
 308                       buf_out, (size_t *)&buf_outlen,
 309                       buf_in, (size_t)buf_inlen);
 310     }
 311     if (rv <= 0) {
 312         ERR_print_errors(bio_err);
 313         goto end;
 314     }
 315     ret = 0;
 316
 317     if (asn1parse) {
 318         if (!ASN1_parse_dump(out, buf_out, buf_outlen, 1, -1))
 319             ERR_print_errors(bio_err);
 320     } else if (hexdump)
 321         BIO_dump(out, (char *)buf_out, buf_outlen);
 322     else
 323         BIO_write(out, buf_out, buf_outlen);
 324
 325  end:
 326     EVP_PKEY_CTX_free(ctx);
 327     BIO_free(in);
 328     BIO_free_all(out);
 329     OPENSSL_free(buf_in);
 330     OPENSSL_free(buf_out);
 331     OPENSSL_free(sig);
 332     return ret;
 333 }
 334
 335 static EVP_PKEY_CTX *init_ctx(int *pkeysize,
 336                               char *keyfile, int keyform, int key_type,
 337                               char *passinarg, int pkey_op, ENGINE *e)
 338 {
 339     EVP_PKEY *pkey = NULL;
 340     EVP_PKEY_CTX *ctx = NULL;
 341     char *passin = NULL;
 342     int rv = -1;
 343     X509 *x;
 344     if (((pkey_op == EVP_PKEY_OP_SIGN) || (pkey_op == EVP_PKEY_OP_DECRYPT)
 345          || (pkey_op == EVP_PKEY_OP_DERIVE))
 346         && (key_type != KEY_PRIVKEY)) {
 347         BIO_printf(bio_err, "A private key is needed for this operation\n");
 348         goto end;
 349     }
 350     if (!app_passwd(passinarg, NULL, &passin, NULL)) {
 351         BIO_printf(bio_err, "Error getting password\n");
 352         goto end;
 353     }
 354     switch (key_type) {
 355     case KEY_PRIVKEY:
 356         pkey = load_key(keyfile, keyform, 0, passin, e, "Private Key");
 357         break;
 358
 359     case KEY_PUBKEY:
 360         pkey = load_pubkey(keyfile, keyform, 0, NULL, e, "Public Key");
 361         break;
 362
 363     case KEY_CERT:
 364         x = load_cert(keyfile, keyform, NULL, e, "Certificate");
 365         if (x) {
 366             pkey = X509_get_pubkey(x);
 367             X509_free(x);
 368         }
 369         break;
 370
 371     }
 372
 373     *pkeysize = EVP_PKEY_size(pkey);
 374
 375     if (!pkey)
 376         goto end;
 377
 378     ctx = EVP_PKEY_CTX_new(pkey, e);
 379
 380     EVP_PKEY_free(pkey);
 381
 382     if (!ctx)
 383         goto end;
 384
 385     switch (pkey_op) {
 386     case EVP_PKEY_OP_SIGN:
 387         rv = EVP_PKEY_sign_init(ctx);
 388         break;
 389
 390     case EVP_PKEY_OP_VERIFY:
 391         rv = EVP_PKEY_verify_init(ctx);
 392         break;
 393
 394     case EVP_PKEY_OP_VERIFYRECOVER:
 395         rv = EVP_PKEY_verify_recover_init(ctx);
 396         break;
 397
 398     case EVP_PKEY_OP_ENCRYPT:
 399         rv = EVP_PKEY_encrypt_init(ctx);
 400         break;
 401
 402     case EVP_PKEY_OP_DECRYPT:
 403         rv = EVP_PKEY_decrypt_init(ctx);
 404         break;
 405
 406     case EVP_PKEY_OP_DERIVE:
 407         rv = EVP_PKEY_derive_init(ctx);
 408         break;
 409     }
 410
 411     if (rv <= 0) {
 412         EVP_PKEY_CTX_free(ctx);
 413         ctx = NULL;
 414     }
 415
 416  end:
 417     OPENSSL_free(passin);
 418     return ctx;
 419
 420 }
 421
 422 static int setup_peer(EVP_PKEY_CTX *ctx, int peerform, const char *file)
 423 {
 424     EVP_PKEY *peer = NULL;
 425     int ret;
 426     if (!ctx) {
 427         BIO_puts(bio_err, "-peerkey command before -inkey\n");
 428         return 0;
 429     }
 430
 431     peer = load_pubkey(file, peerform, 0, NULL, NULL, "Peer Key");
 432
 433     if (!peer) {
 434         BIO_printf(bio_err, "Error reading peer key %s\n", file);
 435         ERR_print_errors(bio_err);
 436         return 0;
 437     }
 438
 439     ret = EVP_PKEY_derive_set_peer(ctx, peer);
 440
 441     EVP_PKEY_free(peer);
 442     if (ret <= 0)
 443         ERR_print_errors(bio_err);
 444     return ret;
 445 }
 446
 447 static int do_keyop(EVP_PKEY_CTX *ctx, int pkey_op,
 448                     unsigned char *out, size_t *poutlen,
 449                     unsigned char *in, size_t inlen)
 450 {
 451     int rv = 0;
 452     switch (pkey_op) {
 453     case EVP_PKEY_OP_VERIFYRECOVER:
 454         rv = EVP_PKEY_verify_recover(ctx, out, poutlen, in, inlen);
 455         break;
 456
 457     case EVP_PKEY_OP_SIGN:
 458         rv = EVP_PKEY_sign(ctx, out, poutlen, in, inlen);
 459         break;
 460
 461     case EVP_PKEY_OP_ENCRYPT:
 462         rv = EVP_PKEY_encrypt(ctx, out, poutlen, in, inlen);
 463         break;
 464
 465     case EVP_PKEY_OP_DECRYPT:
 466         rv = EVP_PKEY_decrypt(ctx, out, poutlen, in, inlen);
 467         break;
 468
 469     case EVP_PKEY_OP_DERIVE:
 470         rv = EVP_PKEY_derive(ctx, out, poutlen);
 471         break;
 472
 473     }
 474     return rv;
 475 }