2 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
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>
31 #define BSIZE (8*1024)
33 static int set_hex(const char *in, unsigned char *out, int size);
34 static void show_ciphers(const OBJ_NAME *name, void *bio_);
36 struct doall_enc_ciphers {
41 typedef enum OPTION_choice {
42 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
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_ITER, OPT_PBKDF2, OPT_CIPHER,
48 OPT_R_ENUM, OPT_PROV_ENUM
51 const OPTIONS enc_options[] = {
52 OPT_SECTION("General"),
53 {"help", OPT_HELP, '-', "Display this summary"},
54 {"list", OPT_LIST, '-', "List ciphers"},
55 #ifndef OPENSSL_NO_DEPRECATED_3_0
56 {"ciphers", OPT_LIST, '-', "Alias for -list"},
58 {"e", OPT_E, '-', "Encrypt"},
59 {"d", OPT_D, '-', "Decrypt"},
60 {"p", OPT_P, '-', "Print the iv/key"},
61 {"P", OPT_UPPER_P, '-', "Print the iv/key and exit"},
62 #ifndef OPENSSL_NO_ENGINE
63 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
67 {"in", OPT_IN, '<', "Input file"},
68 {"k", OPT_K, 's', "Passphrase"},
69 {"kfile", OPT_KFILE, '<', "Read passphrase from file"},
71 OPT_SECTION("Output"),
72 {"out", OPT_OUT, '>', "Output file"},
73 {"pass", OPT_PASS, 's', "Passphrase source"},
74 {"v", OPT_V, '-', "Verbose output"},
75 {"a", OPT_A, '-', "Base64 encode/decode, depending on encryption flag"},
76 {"base64", OPT_A, '-', "Same as option -a"},
77 {"A", OPT_UPPER_A, '-',
78 "Used with -[base64|a] to specify base64 buffer as a single line"},
80 OPT_SECTION("Encryption"),
81 {"nopad", OPT_NOPAD, '-', "Disable standard block padding"},
82 {"salt", OPT_SALT, '-', "Use salt in the KDF (default)"},
83 {"nosalt", OPT_NOSALT, '-', "Do not use salt in the KDF"},
84 {"debug", OPT_DEBUG, '-', "Print debug info"},
86 {"bufsize", OPT_BUFSIZE, 's', "Buffer size"},
87 {"K", OPT_UPPER_K, 's', "Raw key, in hex"},
88 {"S", OPT_UPPER_S, 's', "Salt, in hex"},
89 {"iv", OPT_IV, 's', "IV in hex"},
90 {"md", OPT_MD, 's', "Use specified digest to create a key from the passphrase"},
91 {"iter", OPT_ITER, 'p', "Specify the iteration count and force use of PBKDF2"},
92 {"pbkdf2", OPT_PBKDF2, '-', "Use password-based key derivation function 2"},
93 {"none", OPT_NONE, '-', "Don't encrypt"},
95 {"z", OPT_Z, '-', "Use zlib as the 'encryption'"},
97 {"", OPT_CIPHER, '-', "Any supported cipher"},
104 int enc_main(int argc, char **argv)
106 static char buf[128];
107 static const char magic[] = "Salted__";
109 BIO *in = NULL, *out = NULL, *b64 = NULL, *benc = NULL, *rbio =
111 EVP_CIPHER_CTX *ctx = NULL;
112 const EVP_CIPHER *cipher = NULL, *c;
113 const EVP_MD *dgst = NULL;
114 char *hkey = NULL, *hiv = NULL, *hsalt = NULL, *p;
115 char *infile = NULL, *outfile = NULL, *prog;
116 char *str = NULL, *passarg = NULL, *pass = NULL, *strbuf = NULL;
117 char mbuf[sizeof(magic) - 1];
119 int bsize = BSIZE, verbose = 0, debug = 0, olb64 = 0, nosalt = 0;
120 int enc = 1, printkey = 0, i, k;
121 int base64 = 0, informat = FORMAT_BINARY, outformat = FORMAT_BINARY;
122 int ret = 1, inl, nopad = 0;
123 unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH];
124 unsigned char *buff = NULL, salt[PKCS5_SALT_LEN];
128 struct doall_enc_ciphers dec;
134 /* first check the program name */
135 prog = opt_progname(argv[0]);
136 if (strcmp(prog, "base64") == 0) {
139 } else if (strcmp(prog, "zlib") == 0) {
143 cipher = EVP_get_cipherbyname(prog);
144 if (cipher == NULL && strcmp(prog, "enc") != 0) {
145 BIO_printf(bio_err, "%s is not a known cipher\n", prog);
150 prog = opt_init(argc, argv, enc_options);
151 while ((o = opt_next()) != OPT_EOF) {
156 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
159 opt_help(enc_options);
163 BIO_printf(bio_out, "Supported ciphers:\n");
166 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
168 BIO_printf(bio_out, "\n");
184 e = setup_engine(opt_arg(), 0);
223 i = (int)strlen(p) - 1;
224 k = i >= 1 && p[i] == 'k';
227 if (!opt_long(opt_arg(), &n)
228 || n < 0 || (k && n >= LONG_MAX / 1024))
238 in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
241 i = BIO_gets(in, buf, sizeof(buf));
246 "%s Can't read key from %s\n", prog, opt_arg());
249 while (--i > 0 && (buf[i] == '\r' || buf[i] == '\n'))
252 BIO_printf(bio_err, "%s: zero length password\n", prog);
267 if (!opt_md(opt_arg(), &dgst))
271 if (!opt_cipher(opt_unknown(), &c))
276 if (!opt_int(opt_arg(), &iter))
282 if (iter == 0) /* do not overwrite a chosen value */
293 if (!opt_provider(o))
299 /* No extra arguments. */
300 argc = opt_num_rest();
304 if (cipher && EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) {
305 BIO_printf(bio_err, "%s: AEAD ciphers not supported\n", prog);
309 if (cipher && (EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)) {
310 BIO_printf(bio_err, "%s XTS ciphers not supported\n", prog);
320 /* It must be large enough for a base64 encoded line */
321 if (base64 && bsize < 80)
324 BIO_printf(bio_err, "bufsize=%d\n", bsize);
331 outformat = FORMAT_BASE64;
333 informat = FORMAT_BASE64;
336 strbuf = app_malloc(SIZE, "strbuf");
337 buff = app_malloc(EVP_ENCODE_LENGTH(bsize), "evp buffer");
339 if (infile == NULL) {
340 in = dup_bio_in(informat);
342 in = bio_open_default(infile, 'r', informat);
347 if (str == NULL && passarg != NULL) {
348 if (!app_passwd(passarg, NULL, &pass, NULL)) {
349 BIO_printf(bio_err, "Error getting password\n");
355 if ((str == NULL) && (cipher != NULL) && (hkey == NULL)) {
357 #ifndef OPENSSL_NO_UI_CONSOLE
361 BIO_snprintf(prompt, sizeof(prompt), "enter %s %s password:",
362 OBJ_nid2ln(EVP_CIPHER_nid(cipher)),
363 (enc) ? "encryption" : "decryption");
365 i = EVP_read_pw_string((char *)strbuf, SIZE, prompt, enc);
367 if (strbuf[0] == '\0') {
375 BIO_printf(bio_err, "bad password read\n");
381 BIO_printf(bio_err, "password required\n");
386 out = bio_open_default(outfile, 'w', outformat);
391 BIO_set_callback(in, BIO_debug_callback);
392 BIO_set_callback(out, BIO_debug_callback);
393 BIO_set_callback_arg(in, (char *)bio_err);
394 BIO_set_callback_arg(out, (char *)bio_err);
402 if ((bzl = BIO_new(BIO_f_zlib())) == NULL)
405 BIO_set_callback(bzl, BIO_debug_callback);
406 BIO_set_callback_arg(bzl, (char *)bio_err);
409 wbio = BIO_push(bzl, wbio);
411 rbio = BIO_push(bzl, rbio);
416 if ((b64 = BIO_new(BIO_f_base64())) == NULL)
419 BIO_set_callback(b64, BIO_debug_callback);
420 BIO_set_callback_arg(b64, (char *)bio_err);
423 BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
425 wbio = BIO_push(b64, wbio);
427 rbio = BIO_push(b64, rbio);
430 if (cipher != NULL) {
432 * Note that str is NULL if a key was passed on the command line, so
433 * we get no salt in that case. Is this a bug?
437 * Salt handling: if encrypting generate a salt and write to
438 * output BIO. If decrypting read salt from input BIO.
441 size_t str_len = strlen(str);
448 if (!set_hex(hsalt, salt, sizeof(salt))) {
449 BIO_printf(bio_err, "invalid hex salt value\n");
452 } else if (RAND_bytes(salt, sizeof(salt)) <= 0) {
456 * If -P option then don't bother writing
459 && (BIO_write(wbio, magic,
460 sizeof(magic) - 1) != sizeof(magic) - 1
463 sizeof(salt)) != sizeof(salt))) {
464 BIO_printf(bio_err, "error writing output file\n");
467 } else if (BIO_read(rbio, mbuf, sizeof(mbuf)) != sizeof(mbuf)
469 (unsigned char *)salt,
470 sizeof(salt)) != sizeof(salt)) {
471 BIO_printf(bio_err, "error reading input file\n");
473 } else if (memcmp(mbuf, magic, sizeof(magic) - 1)) {
474 BIO_printf(bio_err, "bad magic number\n");
482 * derive key and default iv
483 * concatenated into a temporary buffer
485 unsigned char tmpkeyiv[EVP_MAX_KEY_LENGTH + EVP_MAX_IV_LENGTH];
486 int iklen = EVP_CIPHER_key_length(cipher);
487 int ivlen = EVP_CIPHER_iv_length(cipher);
488 /* not needed if HASH_UPDATE() is fixed : */
489 int islen = (sptr != NULL ? sizeof(salt) : 0);
490 if (!PKCS5_PBKDF2_HMAC(str, str_len, sptr, islen,
491 iter, dgst, iklen+ivlen, tmpkeyiv)) {
492 BIO_printf(bio_err, "PKCS5_PBKDF2_HMAC failed\n");
495 /* split and move data back to global buffer */
496 memcpy(key, tmpkeyiv, iklen);
497 memcpy(iv, tmpkeyiv+iklen, ivlen);
499 BIO_printf(bio_err, "*** WARNING : "
500 "deprecated key derivation used.\n"
501 "Using -iter or -pbkdf2 would be better.\n");
502 if (!EVP_BytesToKey(cipher, dgst, sptr,
503 (unsigned char *)str, str_len,
505 BIO_printf(bio_err, "EVP_BytesToKey failed\n");
510 * zero the complete buffer or the string passed from the command
514 OPENSSL_cleanse(str, SIZE);
516 OPENSSL_cleanse(str, str_len);
519 int siz = EVP_CIPHER_iv_length(cipher);
521 BIO_printf(bio_err, "warning: iv not used by this cipher\n");
522 } else if (!set_hex(hiv, iv, siz)) {
523 BIO_printf(bio_err, "invalid hex iv value\n");
527 if ((hiv == NULL) && (str == NULL)
528 && EVP_CIPHER_iv_length(cipher) != 0) {
530 * No IV was explicitly set and no IV was generated.
531 * Hence the IV is undefined, making correct decryption impossible.
533 BIO_printf(bio_err, "iv undefined\n");
537 if (!set_hex(hkey, key, EVP_CIPHER_key_length(cipher))) {
538 BIO_printf(bio_err, "invalid hex key value\n");
541 /* wiping secret data as we no longer need it */
545 if ((benc = BIO_new(BIO_f_cipher())) == NULL)
549 * Since we may be changing parameters work on the encryption context
550 * rather than calling BIO_set_cipher().
553 BIO_get_cipher_ctx(benc, &ctx);
555 if (!EVP_CipherInit_ex(ctx, cipher, e, NULL, NULL, enc)) {
556 BIO_printf(bio_err, "Error setting cipher %s\n",
557 EVP_CIPHER_name(cipher));
558 ERR_print_errors(bio_err);
563 EVP_CIPHER_CTX_set_padding(ctx, 0);
565 if (!EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, enc)) {
566 BIO_printf(bio_err, "Error setting cipher %s\n",
567 EVP_CIPHER_name(cipher));
568 ERR_print_errors(bio_err);
573 BIO_set_callback(benc, BIO_debug_callback);
574 BIO_set_callback_arg(benc, (char *)bio_err);
580 for (i = 0; i < (int)sizeof(salt); i++)
581 printf("%02X", salt[i]);
584 if (EVP_CIPHER_key_length(cipher) > 0) {
586 for (i = 0; i < EVP_CIPHER_key_length(cipher); i++)
587 printf("%02X", key[i]);
590 if (EVP_CIPHER_iv_length(cipher) > 0) {
592 for (i = 0; i < EVP_CIPHER_iv_length(cipher); i++)
593 printf("%02X", iv[i]);
603 /* Only encrypt/decrypt as we write the file */
605 wbio = BIO_push(benc, wbio);
607 while (BIO_pending(rbio) || !BIO_eof(rbio)) {
608 inl = BIO_read(rbio, (char *)buff, bsize);
611 if (BIO_write(wbio, (char *)buff, inl) != inl) {
612 BIO_printf(bio_err, "error writing output file\n");
616 if (!BIO_flush(wbio)) {
617 BIO_printf(bio_err, "bad decrypt\n");
623 BIO_printf(bio_err, "bytes read : %8ju\n", BIO_number_read(in));
624 BIO_printf(bio_err, "bytes written: %8ju\n", BIO_number_written(out));
627 ERR_print_errors(bio_err);
628 OPENSSL_free(strbuf);
642 static void show_ciphers(const OBJ_NAME *name, void *arg)
644 struct doall_enc_ciphers *dec = (struct doall_enc_ciphers *)arg;
645 const EVP_CIPHER *cipher;
647 if (!islower((unsigned char)*name->name))
650 /* Filter out ciphers that we cannot use */
651 cipher = EVP_get_cipherbyname(name->name);
652 if (cipher == NULL ||
653 (EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) != 0 ||
654 EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)
657 BIO_printf(dec->bio, "-%-25s", name->name);
659 BIO_printf(dec->bio, "\n");
662 BIO_printf(dec->bio, " ");
665 static int set_hex(const char *in, unsigned char *out, int size)
673 BIO_printf(bio_err, "hex string is too long, ignoring excess\n");
674 n = i; /* ignore exceeding part */
676 BIO_printf(bio_err, "hex string is too short, padding with zero bytes to length\n");
679 memset(out, 0, size);
680 for (i = 0; i < n; i++) {
681 j = (unsigned char)*in++;
683 BIO_printf(bio_err, "non-hex digit\n");
686 j = (unsigned char)OPENSSL_hexchar2int(j);
690 out[i / 2] = (j << 4);