apps/enc.c

   1 /*
   2  * Copyright 1995-2017 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 <stdio.h>
  11 #include <stdlib.h>
  12 #include <string.h>
  13 #include <limits.h>
  14 #include "apps.h"
  15 #include <openssl/bio.h>
  16 #include <openssl/err.h>
  17 #include <openssl/evp.h>
  18 #include <openssl/objects.h>
  19 #include <openssl/x509.h>
  20 #include <openssl/rand.h>
  21 #include <openssl/pem.h>
  22 #ifndef OPENSSL_NO_COMP
  23 # include <openssl/comp.h>
  24 #endif
  25 #include <ctype.h>
  26
  27 #undef SIZE
  28 #undef BSIZE
  29 #define SIZE    (512)
  30 #define BSIZE   (8*1024)
  31
  32 static int set_hex(char *in, unsigned char *out, int size);
  33 static void show_ciphers(const OBJ_NAME *name, void *bio_);
  34
  35 struct doall_enc_ciphers {
  36     BIO *bio;
  37     int n;
  38 };
  39
  40 typedef enum OPTION_choice {
  41     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  42     OPT_LIST,
  43     OPT_E, OPT_IN, OPT_OUT, OPT_PASS, OPT_ENGINE, OPT_D, OPT_P, OPT_V,
  44     OPT_NOPAD, OPT_SALT, OPT_NOSALT, OPT_DEBUG, OPT_UPPER_P, OPT_UPPER_A,
  45     OPT_A, OPT_Z, OPT_BUFSIZE, OPT_K, OPT_KFILE, OPT_UPPER_K, OPT_NONE,
  46     OPT_UPPER_S, OPT_IV, OPT_MD, OPT_CIPHER
  47 } OPTION_CHOICE;
  48
  49 OPTIONS enc_options[] = {
  50     {"help", OPT_HELP, '-', "Display this summary"},
  51     {"ciphers", OPT_LIST, '-', "List ciphers"},
  52     {"in", OPT_IN, '<', "Input file"},
  53     {"out", OPT_OUT, '>', "Output file"},
  54     {"pass", OPT_PASS, 's', "Passphrase source"},
  55     {"e", OPT_E, '-', "Encrypt"},
  56     {"d", OPT_D, '-', "Decrypt"},
  57     {"p", OPT_P, '-', "Print the iv/key"},
  58     {"P", OPT_UPPER_P, '-', "Print the iv/key and exit"},
  59     {"v", OPT_V, '-', "Verbose output"},
  60     {"nopad", OPT_NOPAD, '-', "Disable standard block padding"},
  61     {"salt", OPT_SALT, '-', "Use salt in the KDF (default)"},
  62     {"nosalt", OPT_NOSALT, '-', "Do not use salt in the KDF"},
  63     {"debug", OPT_DEBUG, '-', "Print debug info"},
  64     {"a", OPT_A, '-', "Base64 encode/decode, depending on encryption flag"},
  65     {"base64", OPT_A, '-', "Same as option -a"},
  66     {"A", OPT_UPPER_A, '-',
  67      "Used with -[base64|a] to specify base64 buffer as a single line"},
  68     {"bufsize", OPT_BUFSIZE, 's', "Buffer size"},
  69     {"k", OPT_K, 's', "Passphrase"},
  70     {"kfile", OPT_KFILE, '<', "Read passphrase from file"},
  71     {"K", OPT_UPPER_K, 's', "Raw key, in hex"},
  72     {"S", OPT_UPPER_S, 's', "Salt, in hex"},
  73     {"iv", OPT_IV, 's', "IV in hex"},
  74     {"md", OPT_MD, 's', "Use specified digest to create a key from the passphrase"},
  75     {"none", OPT_NONE, '-', "Don't encrypt"},
  76     {"", OPT_CIPHER, '-', "Any supported cipher"},
  77 #ifdef ZLIB
  78     {"z", OPT_Z, '-', "Use zlib as the 'encryption'"},
  79 #endif
  80 #ifndef OPENSSL_NO_ENGINE
  81     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
  82 #endif
  83     {NULL}
  84 };
  85
  86 int enc_main(int argc, char **argv)
  87 {
  88     static char buf[128];
  89     static const char magic[] = "Salted__";
  90     ENGINE *e = NULL;
  91     BIO *in = NULL, *out = NULL, *b64 = NULL, *benc = NULL, *rbio =
  92         NULL, *wbio = NULL;
  93     EVP_CIPHER_CTX *ctx = NULL;
  94     const EVP_CIPHER *cipher = NULL, *c;
  95     const EVP_MD *dgst = NULL;
  96     char *hkey = NULL, *hiv = NULL, *hsalt = NULL, *p;
  97     char *infile = NULL, *outfile = NULL, *prog;
  98     char *str = NULL, *passarg = NULL, *pass = NULL, *strbuf = NULL;
  99     char mbuf[sizeof(magic) - 1];
 100     OPTION_CHOICE o;
 101     int bsize = BSIZE, verbose = 0, debug = 0, olb64 = 0, nosalt = 0;
 102     int enc = 1, printkey = 0, i, k;
 103     int base64 = 0, informat = FORMAT_BINARY, outformat = FORMAT_BINARY;
 104     int ret = 1, inl, nopad = 0;
 105     unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH];
 106     unsigned char *buff = NULL, salt[PKCS5_SALT_LEN];
 107     long n;
 108     struct doall_enc_ciphers dec;
 109 #ifdef ZLIB
 110     int do_zlib = 0;
 111     BIO *bzl = NULL;
 112 #endif
 113
 114     /* first check the program name */
 115     prog = opt_progname(argv[0]);
 116     if (strcmp(prog, "base64") == 0)
 117         base64 = 1;
 118 #ifdef ZLIB
 119     else if (strcmp(prog, "zlib") == 0)
 120         do_zlib = 1;
 121 #endif
 122     else {
 123         cipher = EVP_get_cipherbyname(prog);
 124         if (cipher == NULL && strcmp(prog, "enc") != 0) {
 125             BIO_printf(bio_err, "%s is not a known cipher\n", prog);
 126             goto end;
 127         }
 128     }
 129
 130     prog = opt_init(argc, argv, enc_options);
 131     while ((o = opt_next()) != OPT_EOF) {
 132         switch (o) {
 133         case OPT_EOF:
 134         case OPT_ERR:
 135  opthelp:
 136             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
 137             goto end;
 138         case OPT_HELP:
 139             opt_help(enc_options);
 140             ret = 0;
 141             goto end;
 142         case OPT_LIST:
 143             BIO_printf(bio_out, "Supported ciphers:\n");
 144             dec.bio = bio_out;
 145             dec.n = 0;
 146             OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
 147                                    show_ciphers, &dec);
 148             BIO_printf(bio_out, "\n");
 149             ret = 0;
 150             goto end;
 151         case OPT_E:
 152             enc = 1;
 153             break;
 154         case OPT_IN:
 155             infile = opt_arg();
 156             break;
 157         case OPT_OUT:
 158             outfile = opt_arg();
 159             break;
 160         case OPT_PASS:
 161             passarg = opt_arg();
 162             break;
 163         case OPT_ENGINE:
 164             e = setup_engine(opt_arg(), 0);
 165             break;
 166         case OPT_D:
 167             enc = 0;
 168             break;
 169         case OPT_P:
 170             printkey = 1;
 171             break;
 172         case OPT_V:
 173             verbose = 1;
 174             break;
 175         case OPT_NOPAD:
 176             nopad = 1;
 177             break;
 178         case OPT_SALT:
 179             nosalt = 0;
 180             break;
 181         case OPT_NOSALT:
 182             nosalt = 1;
 183             break;
 184         case OPT_DEBUG:
 185             debug = 1;
 186             break;
 187         case OPT_UPPER_P:
 188             printkey = 2;
 189             break;
 190         case OPT_UPPER_A:
 191             olb64 = 1;
 192             break;
 193         case OPT_A:
 194             base64 = 1;
 195             break;
 196         case OPT_Z:
 197 #ifdef ZLIB
 198             do_zlib = 1;
 199 #endif
 200             break;
 201         case OPT_BUFSIZE:
 202             p = opt_arg();
 203             i = (int)strlen(p) - 1;
 204             k = i >= 1 && p[i] == 'k';
 205             if (k)
 206                 p[i] = '\0';
 207             if (!opt_long(opt_arg(), &n)
 208                     || n < 0 || (k && n >= LONG_MAX / 1024))
 209                 goto opthelp;
 210             if (k)
 211                 n *= 1024;
 212             bsize = (int)n;
 213             break;
 214         case OPT_K:
 215             str = opt_arg();
 216             break;
 217         case OPT_KFILE:
 218             in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
 219             if (in == NULL)
 220                 goto opthelp;
 221             i = BIO_gets(in, buf, sizeof(buf));
 222             BIO_free(in);
 223             in = NULL;
 224             if (i <= 0) {
 225                 BIO_printf(bio_err,
 226                            "%s Can't read key from %s\n", prog, opt_arg());
 227                 goto opthelp;
 228             }
 229             while (--i > 0 && (buf[i] == '\r' || buf[i] == '\n'))
 230                 buf[i] = '\0';
 231             if (i <= 0) {
 232                 BIO_printf(bio_err, "%s: zero length password\n", prog);
 233                 goto opthelp;
 234             }
 235             str = buf;
 236             break;
 237         case OPT_UPPER_K:
 238             hkey = opt_arg();
 239             break;
 240         case OPT_UPPER_S:
 241             hsalt = opt_arg();
 242             break;
 243         case OPT_IV:
 244             hiv = opt_arg();
 245             break;
 246         case OPT_MD:
 247             if (!opt_md(opt_arg(), &dgst))
 248                 goto opthelp;
 249             break;
 250         case OPT_CIPHER:
 251             if (!opt_cipher(opt_unknown(), &c))
 252                 goto opthelp;
 253             cipher = c;
 254             break;
 255         case OPT_NONE:
 256             cipher = NULL;
 257             break;
 258         }
 259     }
 260     if (opt_num_rest() != 0) {
 261         BIO_printf(bio_err, "Extra arguments given.\n");
 262         goto opthelp;
 263     }
 264
 265     if (cipher && EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) {
 266         BIO_printf(bio_err, "%s: AEAD ciphers not supported\n", prog);
 267         goto end;
 268     }
 269
 270     if (cipher && (EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)) {
 271         BIO_printf(bio_err, "%s XTS ciphers not supported\n", prog);
 272         goto end;
 273     }
 274
 275     if (dgst == NULL)
 276         dgst = EVP_sha256();
 277
 278     /* It must be large enough for a base64 encoded line */
 279     if (base64 && bsize < 80)
 280         bsize = 80;
 281     if (verbose)
 282         BIO_printf(bio_err, "bufsize=%d\n", bsize);
 283
 284 #ifdef ZLIB
 285     if (!do_zlib)
 286 #endif
 287         if (base64) {
 288             if (enc)
 289                 outformat = FORMAT_BASE64;
 290             else
 291                 informat = FORMAT_BASE64;
 292         }
 293
 294     strbuf = app_malloc(SIZE, "strbuf");
 295     buff = app_malloc(EVP_ENCODE_LENGTH(bsize), "evp buffer");
 296
 297     if (infile == NULL) {
 298         in = dup_bio_in(informat);
 299     } else
 300         in = bio_open_default(infile, 'r', informat);
 301     if (in == NULL)
 302         goto end;
 303
 304     if (!str && passarg) {
 305         if (!app_passwd(passarg, NULL, &pass, NULL)) {
 306             BIO_printf(bio_err, "Error getting password\n");
 307             goto end;
 308         }
 309         str = pass;
 310     }
 311
 312     if ((str == NULL) && (cipher != NULL) && (hkey == NULL)) {
 313         if (1) {
 314 #ifndef OPENSSL_NO_UI
 315             for (;;) {
 316                 char prompt[200];
 317
 318                 BIO_snprintf(prompt, sizeof(prompt), "enter %s %s password:",
 319                              OBJ_nid2ln(EVP_CIPHER_nid(cipher)),
 320                              (enc) ? "encryption" : "decryption");
 321                 strbuf[0] = '\0';
 322                 i = EVP_read_pw_string((char *)strbuf, SIZE, prompt, enc);
 323                 if (i == 0) {
 324                     if (strbuf[0] == '\0') {
 325                         ret = 1;
 326                         goto end;
 327                     }
 328                     str = strbuf;
 329                     break;
 330                 }
 331                 if (i < 0) {
 332                     BIO_printf(bio_err, "bad password read\n");
 333                     goto end;
 334                 }
 335             }
 336         } else {
 337 #endif
 338             BIO_printf(bio_err, "password required\n");
 339             goto end;
 340         }
 341     }
 342
 343     out = bio_open_default(outfile, 'w', outformat);
 344     if (out == NULL)
 345         goto end;
 346
 347     if (debug) {
 348         BIO_set_callback(in, BIO_debug_callback);
 349         BIO_set_callback(out, BIO_debug_callback);
 350         BIO_set_callback_arg(in, (char *)bio_err);
 351         BIO_set_callback_arg(out, (char *)bio_err);
 352     }
 353
 354     rbio = in;
 355     wbio = out;
 356
 357 #ifdef ZLIB
 358     if (do_zlib) {
 359         if ((bzl = BIO_new(BIO_f_zlib())) == NULL)
 360             goto end;
 361         if (debug) {
 362             BIO_set_callback(bzl, BIO_debug_callback);
 363             BIO_set_callback_arg(bzl, (char *)bio_err);
 364         }
 365         if (enc)
 366             wbio = BIO_push(bzl, wbio);
 367         else
 368             rbio = BIO_push(bzl, rbio);
 369     }
 370 #endif
 371
 372     if (base64) {
 373         if ((b64 = BIO_new(BIO_f_base64())) == NULL)
 374             goto end;
 375         if (debug) {
 376             BIO_set_callback(b64, BIO_debug_callback);
 377             BIO_set_callback_arg(b64, (char *)bio_err);
 378         }
 379         if (olb64)
 380             BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
 381         if (enc)
 382             wbio = BIO_push(b64, wbio);
 383         else
 384             rbio = BIO_push(b64, rbio);
 385     }
 386
 387     if (cipher != NULL) {
 388         /*
 389          * Note that str is NULL if a key was passed on the command line, so
 390          * we get no salt in that case. Is this a bug?
 391          */
 392         if (str != NULL) {
 393             /*
 394              * Salt handling: if encrypting generate a salt and write to
 395              * output BIO. If decrypting read salt from input BIO.
 396              */
 397             unsigned char *sptr;
 398             size_t str_len = strlen(str);
 399
 400             if (nosalt)
 401                 sptr = NULL;
 402             else {
 403                 if (enc) {
 404                     if (hsalt) {
 405                         if (!set_hex(hsalt, salt, sizeof(salt))) {
 406                             BIO_printf(bio_err, "invalid hex salt value\n");
 407                             goto end;
 408                         }
 409                     } else if (RAND_bytes(salt, sizeof(salt)) <= 0)
 410                         goto end;
 411                     /*
 412                      * If -P option then don't bother writing
 413                      */
 414                     if ((printkey != 2)
 415                         && (BIO_write(wbio, magic,
 416                                       sizeof(magic) - 1) != sizeof(magic) - 1
 417                             || BIO_write(wbio,
 418                                          (char *)salt,
 419                                          sizeof(salt)) != sizeof(salt))) {
 420                         BIO_printf(bio_err, "error writing output file\n");
 421                         goto end;
 422                     }
 423                 } else if (BIO_read(rbio, mbuf, sizeof(mbuf)) != sizeof(mbuf)
 424                            || BIO_read(rbio,
 425                                        (unsigned char *)salt,
 426                                        sizeof(salt)) != sizeof(salt)) {
 427                     BIO_printf(bio_err, "error reading input file\n");
 428                     goto end;
 429                 } else if (memcmp(mbuf, magic, sizeof(magic) - 1)) {
 430                     BIO_printf(bio_err, "bad magic number\n");
 431                     goto end;
 432                 }
 433
 434                 sptr = salt;
 435             }
 436
 437             if (!EVP_BytesToKey(cipher, dgst, sptr,
 438                                 (unsigned char *)str,
 439                                 str_len, 1, key, iv)) {
 440                 BIO_printf(bio_err, "EVP_BytesToKey failed\n");
 441                 goto end;
 442             }
 443             /*
 444              * zero the complete buffer or the string passed from the command
 445              * line bug picked up by Larry J. Hughes Jr. <hughes@indiana.edu>
 446              */
 447             if (str == strbuf)
 448                 OPENSSL_cleanse(str, SIZE);
 449             else
 450                 OPENSSL_cleanse(str, str_len);
 451         }
 452         if (hiv != NULL) {
 453             int siz = EVP_CIPHER_iv_length(cipher);
 454             if (siz == 0) {
 455                 BIO_printf(bio_err, "warning: iv not use by this cipher\n");
 456             } else if (!set_hex(hiv, iv, sizeof(iv))) {
 457                 BIO_printf(bio_err, "invalid hex iv value\n");
 458                 goto end;
 459             }
 460         }
 461         if ((hiv == NULL) && (str == NULL)
 462             && EVP_CIPHER_iv_length(cipher) != 0) {
 463             /*
 464              * No IV was explicitly set and no IV was generated during
 465              * EVP_BytesToKey. Hence the IV is undefined, making correct
 466              * decryption impossible.
 467              */
 468             BIO_printf(bio_err, "iv undefined\n");
 469             goto end;
 470         }
 471         if ((hkey != NULL) && !set_hex(hkey, key, EVP_CIPHER_key_length(cipher))) {
 472             BIO_printf(bio_err, "invalid hex key value\n");
 473             goto end;
 474         }
 475
 476         if ((benc = BIO_new(BIO_f_cipher())) == NULL)
 477             goto end;
 478
 479         /*
 480          * Since we may be changing parameters work on the encryption context
 481          * rather than calling BIO_set_cipher().
 482          */
 483
 484         BIO_get_cipher_ctx(benc, &ctx);
 485
 486         if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, enc)) {
 487             BIO_printf(bio_err, "Error setting cipher %s\n",
 488                        EVP_CIPHER_name(cipher));
 489             ERR_print_errors(bio_err);
 490             goto end;
 491         }
 492
 493         if (nopad)
 494             EVP_CIPHER_CTX_set_padding(ctx, 0);
 495
 496         if (!EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, enc)) {
 497             BIO_printf(bio_err, "Error setting cipher %s\n",
 498                        EVP_CIPHER_name(cipher));
 499             ERR_print_errors(bio_err);
 500             goto end;
 501         }
 502
 503         if (debug) {
 504             BIO_set_callback(benc, BIO_debug_callback);
 505             BIO_set_callback_arg(benc, (char *)bio_err);
 506         }
 507
 508         if (printkey) {
 509             if (!nosalt) {
 510                 printf("salt=");
 511                 for (i = 0; i < (int)sizeof(salt); i++)
 512                     printf("%02X", salt[i]);
 513                 printf("\n");
 514             }
 515             if (EVP_CIPHER_key_length(cipher) > 0) {
 516                 printf("key=");
 517                 for (i = 0; i < EVP_CIPHER_key_length(cipher); i++)
 518                     printf("%02X", key[i]);
 519                 printf("\n");
 520             }
 521             if (EVP_CIPHER_iv_length(cipher) > 0) {
 522                 printf("iv =");
 523                 for (i = 0; i < EVP_CIPHER_iv_length(cipher); i++)
 524                     printf("%02X", iv[i]);
 525                 printf("\n");
 526             }
 527             if (printkey == 2) {
 528                 ret = 0;
 529                 goto end;
 530             }
 531         }
 532     }
 533
 534     /* Only encrypt/decrypt as we write the file */
 535     if (benc != NULL)
 536         wbio = BIO_push(benc, wbio);
 537
 538     for (;;) {
 539         inl = BIO_read(rbio, (char *)buff, bsize);
 540         if (inl <= 0)
 541             break;
 542         if (BIO_write(wbio, (char *)buff, inl) != inl) {
 543             BIO_printf(bio_err, "error writing output file\n");
 544             goto end;
 545         }
 546     }
 547     if (!BIO_flush(wbio)) {
 548         BIO_printf(bio_err, "bad decrypt\n");
 549         goto end;
 550     }
 551
 552     ret = 0;
 553     if (verbose) {
 554         BIO_printf(bio_err, "bytes read   :%8"BIO_PRI64"u\n", BIO_number_read(in));
 555         BIO_printf(bio_err, "bytes written:%8"BIO_PRI64"u\n", BIO_number_written(out));
 556     }
 557  end:
 558     ERR_print_errors(bio_err);
 559     OPENSSL_free(strbuf);
 560     OPENSSL_free(buff);
 561     BIO_free(in);
 562     BIO_free_all(out);
 563     BIO_free(benc);
 564     BIO_free(b64);
 565 #ifdef ZLIB
 566     BIO_free(bzl);
 567 #endif
 568     release_engine(e);
 569     OPENSSL_free(pass);
 570     return (ret);
 571 }
 572
 573 static void show_ciphers(const OBJ_NAME *name, void *arg)
 574 {
 575     struct doall_enc_ciphers *dec = (struct doall_enc_ciphers *)arg;
 576     const EVP_CIPHER *cipher;
 577
 578     if (!islower((unsigned char)*name->name))
 579         return;
 580
 581     /* Filter out ciphers that we cannot use */
 582     cipher = EVP_get_cipherbyname(name->name);
 583     if (cipher == NULL ||
 584             (EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) != 0 ||
 585             EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)
 586         return;
 587
 588     BIO_printf(dec->bio, "-%-25s", name->name);
 589     if (++dec->n == 3) {
 590         BIO_printf(dec->bio, "\n");
 591         dec->n = 0;
 592     } else
 593         BIO_printf(dec->bio, " ");
 594 }
 595
 596 static int set_hex(char *in, unsigned char *out, int size)
 597 {
 598     int i, n;
 599     unsigned char j;
 600
 601     n = strlen(in);
 602     if (n > (size * 2)) {
 603         BIO_printf(bio_err, "hex string is too long\n");
 604         return (0);
 605     }
 606     memset(out, 0, size);
 607     for (i = 0; i < n; i++) {
 608         j = (unsigned char)*in;
 609         *(in++) = '\0';
 610         if (j == 0)
 611             break;
 612         if (!isxdigit(j)) {
 613             BIO_printf(bio_err, "non-hex digit\n");
 614             return (0);
 615         }
 616         j = (unsigned char)OPENSSL_hexchar2int(j);
 617         if (i & 1)
 618             out[i / 2] |= j;
 619         else
 620             out[i / 2] = (j << 4);
 621     }
 622     return (1);
 623 }