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