2 * Copyright 1995-2022 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 {
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, '-', "Compress or decompress encrypted data using zlib"},
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 EVP_CIPHER *cipher = NULL;
114 const char *digestname = NULL;
115 char *hkey = NULL, *hiv = NULL, *hsalt = NULL, *p;
116 char *infile = NULL, *outfile = NULL, *prog;
117 char *str = NULL, *passarg = NULL, *pass = NULL, *strbuf = NULL;
118 const char *ciphername = NULL;
119 char mbuf[sizeof(magic) - 1];
121 int bsize = BSIZE, verbose = 0, debug = 0, olb64 = 0, nosalt = 0;
122 int enc = 1, printkey = 0, i, k;
123 int base64 = 0, informat = FORMAT_BINARY, outformat = FORMAT_BINARY;
124 int ret = 1, inl, nopad = 0;
125 unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH];
126 unsigned char *buff = NULL, salt[PKCS5_SALT_LEN];
132 struct doall_enc_ciphers dec;
140 /* first check the command name */
141 if (strcmp(argv[0], "base64") == 0)
144 else if (strcmp(argv[0], "zlib") == 0)
147 #ifndef OPENSSL_NO_BROTLI
148 else if (strcmp(argv[0], "brotli") == 0)
151 else if (strcmp(argv[0], "enc") != 0)
152 ciphername = argv[0];
154 opt_set_unknown_name("cipher");
155 prog = opt_init(argc, argv, enc_options);
156 while ((o = opt_next()) != OPT_EOF) {
161 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
164 opt_help(enc_options);
168 BIO_printf(bio_out, "Supported ciphers:\n");
171 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
173 BIO_printf(bio_out, "\n");
189 e = setup_engine(opt_arg(), 0);
228 i = (int)strlen(p) - 1;
229 k = i >= 1 && p[i] == 'k';
232 if (!opt_long(opt_arg(), &n)
233 || n < 0 || (k && n >= LONG_MAX / 1024))
243 in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
246 i = BIO_gets(in, buf, sizeof(buf));
251 "%s Can't read key from %s\n", prog, opt_arg());
254 while (--i > 0 && (buf[i] == '\r' || buf[i] == '\n'))
257 BIO_printf(bio_err, "%s: zero length password\n", prog);
272 digestname = opt_arg();
275 ciphername = opt_unknown();
278 iter = opt_int_arg();
283 if (iter == 0) /* do not overwrite a chosen value */
294 if (!opt_provider(o))
300 /* No extra arguments. */
301 if (!opt_check_rest_arg(NULL))
303 if (!app_RAND_load())
306 /* Get the cipher name, either from progname (if set) or flag. */
307 if (!opt_cipher(ciphername, &cipher))
309 if (cipher && (EVP_CIPHER_mode(cipher) == EVP_CIPH_WRAP_MODE)) {
313 if (digestname != NULL) {
314 if (!opt_md(digestname, &dgst))
318 dgst = (EVP_MD *)EVP_sha256();
323 /* It must be large enough for a base64 encoded line */
324 if (base64 && bsize < 80)
327 BIO_printf(bio_err, "bufsize=%d\n", bsize);
338 outformat = FORMAT_BASE64;
340 informat = FORMAT_BASE64;
343 strbuf = app_malloc(SIZE, "strbuf");
344 buff = app_malloc(EVP_ENCODE_LENGTH(bsize), "evp buffer");
346 if (infile == NULL) {
347 if (!streamable && printkey != 2) { /* if just print key and exit, it's ok */
348 BIO_printf(bio_err, "Unstreamable cipher mode\n");
351 in = dup_bio_in(informat);
353 in = bio_open_default(infile, 'r', informat);
358 if (str == NULL && passarg != NULL) {
359 if (!app_passwd(passarg, NULL, &pass, NULL)) {
360 BIO_printf(bio_err, "Error getting password\n");
366 if ((str == NULL) && (cipher != NULL) && (hkey == NULL)) {
368 #ifndef OPENSSL_NO_UI_CONSOLE
372 BIO_snprintf(prompt, sizeof(prompt), "enter %s %s password:",
373 EVP_CIPHER_get0_name(cipher),
374 (enc) ? "encryption" : "decryption");
376 i = EVP_read_pw_string((char *)strbuf, SIZE, prompt, enc);
378 if (strbuf[0] == '\0') {
386 BIO_printf(bio_err, "bad password read\n");
392 BIO_printf(bio_err, "password required\n");
397 out = bio_open_default(outfile, 'w', outformat);
402 BIO_set_callback_ex(in, BIO_debug_callback_ex);
403 BIO_set_callback_ex(out, BIO_debug_callback_ex);
404 BIO_set_callback_arg(in, (char *)bio_err);
405 BIO_set_callback_arg(out, (char *)bio_err);
411 #ifndef OPENSSL_NO_COMP
414 if ((bzl = BIO_new(BIO_f_zlib())) == NULL)
417 BIO_set_callback_ex(bzl, BIO_debug_callback_ex);
418 BIO_set_callback_arg(bzl, (char *)bio_err);
421 wbio = BIO_push(bzl, wbio);
423 rbio = BIO_push(bzl, rbio);
428 if ((bbrot = BIO_new(BIO_f_brotli())) == NULL)
431 BIO_set_callback_ex(bbrot, BIO_debug_callback_ex);
432 BIO_set_callback_arg(bbrot, (char *)bio_err);
435 wbio = BIO_push(bbrot, wbio);
437 rbio = BIO_push(bbrot, rbio);
442 if ((b64 = BIO_new(BIO_f_base64())) == NULL)
445 BIO_set_callback_ex(b64, BIO_debug_callback_ex);
446 BIO_set_callback_arg(b64, (char *)bio_err);
449 BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
451 wbio = BIO_push(b64, wbio);
453 rbio = BIO_push(b64, rbio);
456 if (cipher != NULL) {
457 if (str != NULL) { /* a passphrase is available */
459 * Salt handling: if encrypting generate a salt if not supplied,
460 * and write to output BIO. If decrypting use salt from input BIO
461 * if not given with args
464 size_t str_len = strlen(str);
469 if (hsalt != NULL && !set_hex(hsalt, salt, sizeof(salt))) {
470 BIO_printf(bio_err, "invalid hex salt value\n");
473 if (enc) { /* encryption */
475 if (RAND_bytes(salt, sizeof(salt)) <= 0) {
476 BIO_printf(bio_err, "RAND_bytes failed\n");
480 * If -P option then don't bother writing.
481 * If salt is given, shouldn't either ?
484 && (BIO_write(wbio, magic,
485 sizeof(magic) - 1) != sizeof(magic) - 1
488 sizeof(salt)) != sizeof(salt))) {
489 BIO_printf(bio_err, "error writing output file\n");
493 } else { /* decryption */
495 if (BIO_read(rbio, mbuf, sizeof(mbuf)) != sizeof(mbuf)) {
496 BIO_printf(bio_err, "error reading input file\n");
499 if (memcmp(mbuf, magic, sizeof(mbuf)) == 0) { /* file IS salted */
500 if (BIO_read(rbio, salt,
501 sizeof(salt)) != sizeof(salt)) {
502 BIO_printf(bio_err, "error reading input file\n");
505 } else { /* file is NOT salted, NO salt available */
506 BIO_printf(bio_err, "bad magic number\n");
516 * derive key and default iv
517 * concatenated into a temporary buffer
519 unsigned char tmpkeyiv[EVP_MAX_KEY_LENGTH + EVP_MAX_IV_LENGTH];
520 int iklen = EVP_CIPHER_get_key_length(cipher);
521 int ivlen = EVP_CIPHER_get_iv_length(cipher);
522 /* not needed if HASH_UPDATE() is fixed : */
523 int islen = (sptr != NULL ? sizeof(salt) : 0);
524 if (!PKCS5_PBKDF2_HMAC(str, str_len, sptr, islen,
525 iter, dgst, iklen+ivlen, tmpkeyiv)) {
526 BIO_printf(bio_err, "PKCS5_PBKDF2_HMAC failed\n");
529 /* split and move data back to global buffer */
530 memcpy(key, tmpkeyiv, iklen);
531 memcpy(iv, tmpkeyiv+iklen, ivlen);
533 BIO_printf(bio_err, "*** WARNING : "
534 "deprecated key derivation used.\n"
535 "Using -iter or -pbkdf2 would be better.\n");
536 if (!EVP_BytesToKey(cipher, dgst, sptr,
537 (unsigned char *)str, str_len,
539 BIO_printf(bio_err, "EVP_BytesToKey failed\n");
544 * zero the complete buffer or the string passed from the command
548 OPENSSL_cleanse(str, SIZE);
550 OPENSSL_cleanse(str, str_len);
553 int siz = EVP_CIPHER_get_iv_length(cipher);
555 BIO_printf(bio_err, "warning: iv not used by this cipher\n");
556 } else if (!set_hex(hiv, iv, siz)) {
557 BIO_printf(bio_err, "invalid hex iv value\n");
561 if ((hiv == NULL) && (str == NULL)
562 && EVP_CIPHER_get_iv_length(cipher) != 0
565 * No IV was explicitly set and no IV was generated.
566 * Hence the IV is undefined, making correct decryption impossible.
568 BIO_printf(bio_err, "iv undefined\n");
572 if (!set_hex(hkey, key, EVP_CIPHER_get_key_length(cipher))) {
573 BIO_printf(bio_err, "invalid hex key value\n");
576 /* wiping secret data as we no longer need it */
580 if ((benc = BIO_new(BIO_f_cipher())) == NULL)
584 * Since we may be changing parameters work on the encryption context
585 * rather than calling BIO_set_cipher().
588 BIO_get_cipher_ctx(benc, &ctx);
591 EVP_CIPHER_CTX_set_flags(ctx, EVP_CIPHER_CTX_FLAG_WRAP_ALLOW);
593 if (!EVP_CipherInit_ex(ctx, cipher, e, NULL, NULL, enc)) {
594 BIO_printf(bio_err, "Error setting cipher %s\n",
595 EVP_CIPHER_get0_name(cipher));
596 ERR_print_errors(bio_err);
601 EVP_CIPHER_CTX_set_padding(ctx, 0);
603 if (!EVP_CipherInit_ex(ctx, NULL, NULL, key,
604 (hiv == NULL && wrap == 1 ? NULL : iv), enc)) {
605 BIO_printf(bio_err, "Error setting cipher %s\n",
606 EVP_CIPHER_get0_name(cipher));
607 ERR_print_errors(bio_err);
612 BIO_set_callback_ex(benc, BIO_debug_callback_ex);
613 BIO_set_callback_arg(benc, (char *)bio_err);
619 for (i = 0; i < (int)sizeof(salt); i++)
620 printf("%02X", salt[i]);
623 if (EVP_CIPHER_get_key_length(cipher) > 0) {
625 for (i = 0; i < EVP_CIPHER_get_key_length(cipher); i++)
626 printf("%02X", key[i]);
629 if (EVP_CIPHER_get_iv_length(cipher) > 0) {
631 for (i = 0; i < EVP_CIPHER_get_iv_length(cipher); i++)
632 printf("%02X", iv[i]);
642 /* Only encrypt/decrypt as we write the file */
644 wbio = BIO_push(benc, wbio);
646 while (BIO_pending(rbio) || !BIO_eof(rbio)) {
647 inl = BIO_read(rbio, (char *)buff, bsize);
650 if (!streamable && !BIO_eof(rbio)) { /* do not output data */
651 BIO_printf(bio_err, "Unstreamable cipher mode\n");
654 if (BIO_write(wbio, (char *)buff, inl) != inl) {
655 BIO_printf(bio_err, "error writing output file\n");
661 if (!BIO_flush(wbio)) {
662 BIO_printf(bio_err, "bad decrypt\n");
668 BIO_printf(bio_err, "bytes read : %8ju\n", BIO_number_read(in));
669 BIO_printf(bio_err, "bytes written: %8ju\n", BIO_number_written(out));
672 ERR_print_errors(bio_err);
673 OPENSSL_free(strbuf);
680 EVP_CIPHER_free(cipher);
690 static void show_ciphers(const OBJ_NAME *name, void *arg)
692 struct doall_enc_ciphers *dec = (struct doall_enc_ciphers *)arg;
693 const EVP_CIPHER *cipher;
695 if (!islower((unsigned char)*name->name))
698 /* Filter out ciphers that we cannot use */
699 cipher = EVP_get_cipherbyname(name->name);
701 || (EVP_CIPHER_get_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) != 0
702 || EVP_CIPHER_get_mode(cipher) == EVP_CIPH_XTS_MODE)
705 BIO_printf(dec->bio, "-%-25s", name->name);
707 BIO_printf(dec->bio, "\n");
710 BIO_printf(dec->bio, " ");
713 static int set_hex(const char *in, unsigned char *out, int size)
721 BIO_printf(bio_err, "hex string is too long, ignoring excess\n");
722 n = i; /* ignore exceeding part */
724 BIO_printf(bio_err, "hex string is too short, padding with zero bytes to length\n");
727 memset(out, 0, size);
728 for (i = 0; i < n; i++) {
729 j = (unsigned char)*in++;
731 BIO_printf(bio_err, "non-hex digit\n");
734 j = (unsigned char)OPENSSL_hexchar2int(j);
738 out[i / 2] = (j << 4);