1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
63 #include <openssl/bio.h>
64 #include <openssl/err.h>
65 #include <openssl/evp.h>
66 #include <openssl/objects.h>
67 #include <openssl/x509.h>
68 #include <openssl/rand.h>
69 #include <openssl/pem.h>
70 #ifndef OPENSSL_NO_COMP
71 # include <openssl/comp.h>
78 #define BSIZE (8*1024)
80 static int set_hex(char *in, unsigned char *out, int size);
81 static void show_ciphers(const OBJ_NAME *name, void *bio_);
83 typedef enum OPTION_choice {
84 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
85 OPT_E, OPT_IN, OPT_OUT, OPT_PASS, OPT_ENGINE, OPT_D, OPT_P, OPT_V,
86 OPT_NOPAD, OPT_SALT, OPT_NOSALT, OPT_DEBUG, OPT_UPPER_P, OPT_UPPER_A,
87 OPT_A, OPT_Z, OPT_BUFSIZE, OPT_K, OPT_KFILE, OPT_UPPER_K, OPT_NONE,
88 OPT_UPPER_S, OPT_IV, OPT_MD, OPT_CIPHER
91 OPTIONS enc_options[] = {
92 {"help", OPT_HELP, '-', "Display this summary"},
93 {"in", OPT_IN, '<', "Input file"},
94 {"out", OPT_OUT, '>', "Output file"},
95 {"pass", OPT_PASS, 's', "Passphrase source"},
96 {"e", OPT_E, '-', "Encrypt"},
97 {"d", OPT_D, '-', "Decrypt"},
98 {"p", OPT_P, '-', "Print the iv/key"},
99 {"P", OPT_UPPER_P, '-', "Print the iv/key and exit"},
100 {"v", OPT_V, '-', "Verbose output"},
101 {"nopad", OPT_NOPAD, '-', "Disable standard block padding"},
102 {"salt", OPT_SALT, '-', "Use salt in the KDF (default)"},
103 {"nosalt", OPT_NOSALT, '-', "Do not use salt in the KDF"},
104 {"debug", OPT_DEBUG, '-', "Print debug info"},
105 {"a", OPT_A, '-', "Base64 encode/decode, depending on encryption flag"},
106 {"base64", OPT_A, '-', "Same as option -a"},
107 {"A", OPT_UPPER_A, '-',
108 "Used with -[base64|a] to specify base64 buffer as a single line"},
109 {"bufsize", OPT_BUFSIZE, 's', "Buffer size"},
110 {"k", OPT_K, 's', "Passphrase"},
111 {"kfile", OPT_KFILE, '<', "Fead passphrase from file"},
112 {"K", OPT_UPPER_K, 's', "Raw key, in hex"},
113 {"S", OPT_UPPER_S, 's', "Salt, in hex"},
114 {"iv", OPT_IV, 's', "IV in hex"},
115 {"md", OPT_MD, 's', "Use specified digest to create key from passphrase"},
116 {"none", OPT_NONE, '-', "Don't encrypt"},
117 {"", OPT_CIPHER, '-', "Any supported cipher"},
119 {"z", OPT_Z, '-', "Use zlib as the 'encryption'"},
121 #ifndef OPENSSL_NO_ENGINE
122 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
127 int enc_main(int argc, char **argv)
129 static char buf[128];
130 static const char magic[] = "Salted__";
131 BIO *in = NULL, *out = NULL, *b64 = NULL, *benc = NULL, *rbio =
133 EVP_CIPHER_CTX *ctx = NULL;
134 const EVP_CIPHER *cipher = NULL, *c;
135 const EVP_MD *dgst = NULL;
136 char *hkey = NULL, *hiv = NULL, *hsalt = NULL, *p;
137 char *infile = NULL, *outfile = NULL, *prog;
138 char *str = NULL, *passarg = NULL, *pass = NULL, *strbuf = NULL;
139 char mbuf[sizeof magic - 1];
141 int bsize = BSIZE, verbose = 0, debug = 0, olb64 = 0, nosalt = 0;
142 int enc = 1, printkey = 0, i, k;
143 int base64 = 0, informat = FORMAT_BINARY, outformat = FORMAT_BINARY;
144 int ret = 1, inl, nopad = 0;
145 unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH];
146 unsigned char *buff = NULL, salt[PKCS5_SALT_LEN];
153 /* first check the program name */
154 prog = opt_progname(argv[0]);
155 if (strcmp(prog, "base64") == 0)
158 else if (strcmp(prog, "zlib") == 0)
162 cipher = EVP_get_cipherbyname(prog);
163 if (cipher == NULL && strcmp(prog, "enc") != 0) {
164 BIO_printf(bio_err, "%s is not a known cipher\n", prog);
169 prog = opt_init(argc, argv, enc_options);
170 while ((o = opt_next()) != OPT_EOF) {
175 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
178 opt_help(enc_options);
180 BIO_printf(bio_err, "Cipher Types\n");
181 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
182 show_ciphers, bio_err);
183 BIO_printf(bio_err, "\n");
198 (void)setup_engine(opt_arg(), 0);
237 i = (int)strlen(p) - 1;
238 k = i >= 1 && p[i] == 'k';
241 if (!opt_long(opt_arg(), &n)
242 || n < 0 || (k && n >= LONG_MAX / 1024))
252 in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
255 i = BIO_gets(in, buf, sizeof buf);
260 "%s Can't read key from %s\n", prog, opt_arg());
263 while (--i > 0 && (buf[i] == '\r' || buf[i] == '\n'))
266 BIO_printf(bio_err, "%s: zero length password\n", prog);
281 if (!opt_md(opt_arg(), &dgst))
285 if (!opt_cipher(opt_unknown(), &c))
294 argc = opt_num_rest();
297 if (cipher && EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) {
298 BIO_printf(bio_err, "%s: AEAD ciphers not supported\n", prog);
302 if (cipher && (EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)) {
303 BIO_printf(bio_err, "%s XTS ciphers not supported\n", prog);
310 /* It must be large enough for a base64 encoded line */
311 if (base64 && bsize < 80)
314 BIO_printf(bio_err, "bufsize=%d\n", bsize);
318 outformat = FORMAT_BASE64;
320 informat = FORMAT_BASE64;
323 strbuf = app_malloc(SIZE, "strbuf");
324 buff = app_malloc(EVP_ENCODE_LENGTH(bsize), "evp buffer");
327 BIO_set_callback(in, BIO_debug_callback);
328 BIO_set_callback(out, BIO_debug_callback);
329 BIO_set_callback_arg(in, (char *)bio_err);
330 BIO_set_callback_arg(out, (char *)bio_err);
333 if (infile == NULL) {
335 in = dup_bio_in(informat);
337 in = bio_open_default(infile, 'r', informat);
341 if (!str && passarg) {
342 if (!app_passwd(passarg, NULL, &pass, NULL)) {
343 BIO_printf(bio_err, "Error getting password\n");
349 if ((str == NULL) && (cipher != NULL) && (hkey == NULL)) {
353 BIO_snprintf(prompt, sizeof prompt, "enter %s %s password:",
354 OBJ_nid2ln(EVP_CIPHER_nid(cipher)),
355 (enc) ? "encryption" : "decryption");
357 i = EVP_read_pw_string((char *)strbuf, SIZE, prompt, enc);
359 if (strbuf[0] == '\0') {
367 BIO_printf(bio_err, "bad password read\n");
373 out = bio_open_default(outfile, 'w', outformat);
382 if ((bzl = BIO_new(BIO_f_zlib())) == NULL)
385 wbio = BIO_push(bzl, wbio);
387 rbio = BIO_push(bzl, rbio);
392 if ((b64 = BIO_new(BIO_f_base64())) == NULL)
395 BIO_set_callback(b64, BIO_debug_callback);
396 BIO_set_callback_arg(b64, (char *)bio_err);
399 BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
401 wbio = BIO_push(b64, wbio);
403 rbio = BIO_push(b64, rbio);
406 if (cipher != NULL) {
408 * Note that str is NULL if a key was passed on the command line, so
409 * we get no salt in that case. Is this a bug?
413 * Salt handling: if encrypting generate a salt and write to
414 * output BIO. If decrypting read salt from input BIO.
422 if (!set_hex(hsalt, salt, sizeof salt)) {
423 BIO_printf(bio_err, "invalid hex salt value\n");
426 } else if (RAND_bytes(salt, sizeof salt) <= 0)
429 * If -P option then don't bother writing
432 && (BIO_write(wbio, magic,
433 sizeof magic - 1) != sizeof magic - 1
436 sizeof salt) != sizeof salt)) {
437 BIO_printf(bio_err, "error writing output file\n");
440 } else if (BIO_read(rbio, mbuf, sizeof mbuf) != sizeof mbuf
442 (unsigned char *)salt,
443 sizeof salt) != sizeof salt) {
444 BIO_printf(bio_err, "error reading input file\n");
446 } else if (memcmp(mbuf, magic, sizeof magic - 1)) {
447 BIO_printf(bio_err, "bad magic number\n");
454 if (!EVP_BytesToKey(cipher, dgst, sptr,
455 (unsigned char *)str,
456 strlen(str), 1, key, iv)) {
457 BIO_printf(bio_err, "EVP_BytesToKey failed\n");
461 * zero the complete buffer or the string passed from the command
462 * line bug picked up by Larry J. Hughes Jr. <hughes@indiana.edu>
465 OPENSSL_cleanse(str, SIZE);
467 OPENSSL_cleanse(str, strlen(str));
470 int siz = EVP_CIPHER_iv_length(cipher);
472 BIO_printf(bio_err, "warning: iv not use by this cipher\n");
473 } else if (!set_hex(hiv, iv, sizeof iv)) {
474 BIO_printf(bio_err, "invalid hex iv value\n");
478 if ((hiv == NULL) && (str == NULL)
479 && EVP_CIPHER_iv_length(cipher) != 0) {
481 * No IV was explicitly set and no IV was generated during
482 * EVP_BytesToKey. Hence the IV is undefined, making correct
483 * decryption impossible.
485 BIO_printf(bio_err, "iv undefined\n");
488 if ((hkey != NULL) && !set_hex(hkey, key, EVP_CIPHER_key_length(cipher))) {
489 BIO_printf(bio_err, "invalid hex key value\n");
493 if ((benc = BIO_new(BIO_f_cipher())) == NULL)
497 * Since we may be changing parameters work on the encryption context
498 * rather than calling BIO_set_cipher().
501 BIO_get_cipher_ctx(benc, &ctx);
503 if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, enc)) {
504 BIO_printf(bio_err, "Error setting cipher %s\n",
505 EVP_CIPHER_name(cipher));
506 ERR_print_errors(bio_err);
511 EVP_CIPHER_CTX_set_padding(ctx, 0);
513 if (!EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, enc)) {
514 BIO_printf(bio_err, "Error setting cipher %s\n",
515 EVP_CIPHER_name(cipher));
516 ERR_print_errors(bio_err);
521 BIO_set_callback(benc, BIO_debug_callback);
522 BIO_set_callback_arg(benc, (char *)bio_err);
528 for (i = 0; i < (int)sizeof(salt); i++)
529 printf("%02X", salt[i]);
532 if (EVP_CIPHER_key_length(cipher) > 0) {
534 for (i = 0; i < EVP_CIPHER_key_length(cipher); i++)
535 printf("%02X", key[i]);
538 if (EVP_CIPHER_iv_length(cipher) > 0) {
540 for (i = 0; i < EVP_CIPHER_iv_length(cipher); i++)
541 printf("%02X", iv[i]);
551 /* Only encrypt/decrypt as we write the file */
553 wbio = BIO_push(benc, wbio);
556 inl = BIO_read(rbio, (char *)buff, bsize);
559 if (BIO_write(wbio, (char *)buff, inl) != inl) {
560 BIO_printf(bio_err, "error writing output file\n");
564 if (!BIO_flush(wbio)) {
565 BIO_printf(bio_err, "bad decrypt\n");
571 BIO_printf(bio_err, "bytes read :%8"PRIu64"\n", BIO_number_read(in));
572 BIO_printf(bio_err, "bytes written:%8"PRIu64"\n", BIO_number_written(out));
575 ERR_print_errors(bio_err);
576 OPENSSL_free(strbuf);
589 static void show_ciphers(const OBJ_NAME *name, void *bio_)
594 if (!islower((unsigned char)*name->name))
597 BIO_printf(bio, "-%-25s", name->name);
599 BIO_printf(bio, "\n");
602 BIO_printf(bio, " ");
605 static int set_hex(char *in, unsigned char *out, int size)
611 if (n > (size * 2)) {
612 BIO_printf(bio_err, "hex string is too long\n");
615 memset(out, 0, size);
616 for (i = 0; i < n; i++) {
617 j = (unsigned char)*in;
622 BIO_printf(bio_err, "non-hex digit\n");
625 j = (unsigned char)app_hex(j);
629 out[i / 2] = (j << 4);