2 * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
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
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>
30 #define BSIZE (8*1024)
32 static int set_hex(char *in, unsigned char *out, int size);
33 static void show_ciphers(const OBJ_NAME *name, void *bio_);
35 struct doall_enc_ciphers {
40 typedef enum OPTION_choice {
41 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
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
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"},
78 {"z", OPT_Z, '-', "Use zlib as the 'encryption'"},
80 #ifndef OPENSSL_NO_ENGINE
81 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
86 int enc_main(int argc, char **argv)
89 static const char magic[] = "Salted__";
91 BIO *in = NULL, *out = NULL, *b64 = NULL, *benc = NULL, *rbio =
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];
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];
108 struct doall_enc_ciphers dec;
114 /* first check the program name */
115 prog = opt_progname(argv[0]);
116 if (strcmp(prog, "base64") == 0)
119 else if (strcmp(prog, "zlib") == 0)
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);
130 prog = opt_init(argc, argv, enc_options);
131 while ((o = opt_next()) != OPT_EOF) {
136 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
139 opt_help(enc_options);
143 BIO_printf(bio_out, "Supported ciphers:\n");
146 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
148 BIO_printf(bio_out, "\n");
164 e = setup_engine(opt_arg(), 0);
203 i = (int)strlen(p) - 1;
204 k = i >= 1 && p[i] == 'k';
207 if (!opt_long(opt_arg(), &n)
208 || n < 0 || (k && n >= LONG_MAX / 1024))
218 in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
221 i = BIO_gets(in, buf, sizeof buf);
226 "%s Can't read key from %s\n", prog, opt_arg());
229 while (--i > 0 && (buf[i] == '\r' || buf[i] == '\n'))
232 BIO_printf(bio_err, "%s: zero length password\n", prog);
247 if (!opt_md(opt_arg(), &dgst))
251 if (!opt_cipher(opt_unknown(), &c))
261 if (cipher && EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) {
262 BIO_printf(bio_err, "%s: AEAD ciphers not supported\n", prog);
266 if (cipher && (EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)) {
267 BIO_printf(bio_err, "%s XTS ciphers not supported\n", prog);
274 /* It must be large enough for a base64 encoded line */
275 if (base64 && bsize < 80)
278 BIO_printf(bio_err, "bufsize=%d\n", bsize);
285 outformat = FORMAT_BASE64;
287 informat = FORMAT_BASE64;
290 strbuf = app_malloc(SIZE, "strbuf");
291 buff = app_malloc(EVP_ENCODE_LENGTH(bsize), "evp buffer");
293 if (infile == NULL) {
295 in = dup_bio_in(informat);
297 in = bio_open_default(infile, 'r', informat);
301 if (!str && passarg) {
302 if (!app_passwd(passarg, NULL, &pass, NULL)) {
303 BIO_printf(bio_err, "Error getting password\n");
309 if ((str == NULL) && (cipher != NULL) && (hkey == NULL)) {
311 #ifndef OPENSSL_NO_UI
315 BIO_snprintf(prompt, sizeof prompt, "enter %s %s password:",
316 OBJ_nid2ln(EVP_CIPHER_nid(cipher)),
317 (enc) ? "encryption" : "decryption");
319 i = EVP_read_pw_string((char *)strbuf, SIZE, prompt, enc);
321 if (strbuf[0] == '\0') {
329 BIO_printf(bio_err, "bad password read\n");
335 BIO_printf(bio_err, "password required\n");
340 out = bio_open_default(outfile, 'w', outformat);
345 BIO_set_callback(in, BIO_debug_callback);
346 BIO_set_callback(out, BIO_debug_callback);
347 BIO_set_callback_arg(in, (char *)bio_err);
348 BIO_set_callback_arg(out, (char *)bio_err);
356 if ((bzl = BIO_new(BIO_f_zlib())) == NULL)
359 BIO_set_callback(bzl, BIO_debug_callback);
360 BIO_set_callback_arg(bzl, (char *)bio_err);
363 wbio = BIO_push(bzl, wbio);
365 rbio = BIO_push(bzl, rbio);
370 if ((b64 = BIO_new(BIO_f_base64())) == NULL)
373 BIO_set_callback(b64, BIO_debug_callback);
374 BIO_set_callback_arg(b64, (char *)bio_err);
377 BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
379 wbio = BIO_push(b64, wbio);
381 rbio = BIO_push(b64, rbio);
384 if (cipher != NULL) {
386 * Note that str is NULL if a key was passed on the command line, so
387 * we get no salt in that case. Is this a bug?
391 * Salt handling: if encrypting generate a salt and write to
392 * output BIO. If decrypting read salt from input BIO.
395 size_t str_len = strlen(str);
402 if (!set_hex(hsalt, salt, sizeof salt)) {
403 BIO_printf(bio_err, "invalid hex salt value\n");
406 } else if (RAND_bytes(salt, sizeof salt) <= 0)
409 * If -P option then don't bother writing
412 && (BIO_write(wbio, magic,
413 sizeof magic - 1) != sizeof magic - 1
416 sizeof salt) != sizeof salt)) {
417 BIO_printf(bio_err, "error writing output file\n");
420 } else if (BIO_read(rbio, mbuf, sizeof mbuf) != sizeof mbuf
422 (unsigned char *)salt,
423 sizeof salt) != sizeof salt) {
424 BIO_printf(bio_err, "error reading input file\n");
426 } else if (memcmp(mbuf, magic, sizeof magic - 1)) {
427 BIO_printf(bio_err, "bad magic number\n");
434 if (!EVP_BytesToKey(cipher, dgst, sptr,
435 (unsigned char *)str,
436 str_len, 1, key, iv)) {
437 BIO_printf(bio_err, "EVP_BytesToKey failed\n");
441 * zero the complete buffer or the string passed from the command
442 * line bug picked up by Larry J. Hughes Jr. <hughes@indiana.edu>
445 OPENSSL_cleanse(str, SIZE);
447 OPENSSL_cleanse(str, str_len);
450 int siz = EVP_CIPHER_iv_length(cipher);
452 BIO_printf(bio_err, "warning: iv not use by this cipher\n");
453 } else if (!set_hex(hiv, iv, sizeof iv)) {
454 BIO_printf(bio_err, "invalid hex iv value\n");
458 if ((hiv == NULL) && (str == NULL)
459 && EVP_CIPHER_iv_length(cipher) != 0) {
461 * No IV was explicitly set and no IV was generated during
462 * EVP_BytesToKey. Hence the IV is undefined, making correct
463 * decryption impossible.
465 BIO_printf(bio_err, "iv undefined\n");
468 if ((hkey != NULL) && !set_hex(hkey, key, EVP_CIPHER_key_length(cipher))) {
469 BIO_printf(bio_err, "invalid hex key value\n");
473 if ((benc = BIO_new(BIO_f_cipher())) == NULL)
477 * Since we may be changing parameters work on the encryption context
478 * rather than calling BIO_set_cipher().
481 BIO_get_cipher_ctx(benc, &ctx);
483 if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, enc)) {
484 BIO_printf(bio_err, "Error setting cipher %s\n",
485 EVP_CIPHER_name(cipher));
486 ERR_print_errors(bio_err);
491 EVP_CIPHER_CTX_set_padding(ctx, 0);
493 if (!EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, enc)) {
494 BIO_printf(bio_err, "Error setting cipher %s\n",
495 EVP_CIPHER_name(cipher));
496 ERR_print_errors(bio_err);
501 BIO_set_callback(benc, BIO_debug_callback);
502 BIO_set_callback_arg(benc, (char *)bio_err);
508 for (i = 0; i < (int)sizeof(salt); i++)
509 printf("%02X", salt[i]);
512 if (EVP_CIPHER_key_length(cipher) > 0) {
514 for (i = 0; i < EVP_CIPHER_key_length(cipher); i++)
515 printf("%02X", key[i]);
518 if (EVP_CIPHER_iv_length(cipher) > 0) {
520 for (i = 0; i < EVP_CIPHER_iv_length(cipher); i++)
521 printf("%02X", iv[i]);
531 /* Only encrypt/decrypt as we write the file */
533 wbio = BIO_push(benc, wbio);
536 inl = BIO_read(rbio, (char *)buff, bsize);
539 if (BIO_write(wbio, (char *)buff, inl) != inl) {
540 BIO_printf(bio_err, "error writing output file\n");
544 if (!BIO_flush(wbio)) {
545 BIO_printf(bio_err, "bad decrypt\n");
551 BIO_printf(bio_err, "bytes read :%8"PRIu64"\n", BIO_number_read(in));
552 BIO_printf(bio_err, "bytes written:%8"PRIu64"\n", BIO_number_written(out));
555 ERR_print_errors(bio_err);
556 OPENSSL_free(strbuf);
570 static void show_ciphers(const OBJ_NAME *name, void *arg)
572 struct doall_enc_ciphers *dec = (struct doall_enc_ciphers *)arg;
573 const EVP_CIPHER *cipher;
575 if (!islower((unsigned char)*name->name))
578 /* Filter out ciphers that we cannot use */
579 cipher = EVP_get_cipherbyname(name->name);
580 if (cipher == NULL ||
581 (EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) != 0 ||
582 EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)
585 BIO_printf(dec->bio, "-%-25s", name->name);
587 BIO_printf(dec->bio, "\n");
590 BIO_printf(dec->bio, " ");
593 static int set_hex(char *in, unsigned char *out, int size)
599 if (n > (size * 2)) {
600 BIO_printf(bio_err, "hex string is too long\n");
603 memset(out, 0, size);
604 for (i = 0; i < n; i++) {
605 j = (unsigned char)*in;
610 BIO_printf(bio_err, "non-hex digit\n");
613 j = (unsigned char)OPENSSL_hexchar2int(j);
617 out[i / 2] = (j << 4);