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
))
295 if (cipher
&& EVP_CIPHER_flags(cipher
) & EVP_CIPH_FLAG_AEAD_CIPHER
) {
296 BIO_printf(bio_err
, "%s: AEAD ciphers not supported\n", prog
);
300 if (cipher
&& (EVP_CIPHER_mode(cipher
) == EVP_CIPH_XTS_MODE
)) {
301 BIO_printf(bio_err
, "%s XTS ciphers not supported\n", prog
);
308 /* It must be large enough for a base64 encoded line */
309 if (base64
&& bsize
< 80)
312 BIO_printf(bio_err
, "bufsize=%d\n", bsize
);
319 outformat
= FORMAT_BASE64
;
321 informat
= FORMAT_BASE64
;
324 strbuf
= app_malloc(SIZE
, "strbuf");
325 buff
= app_malloc(EVP_ENCODE_LENGTH(bsize
), "evp buffer");
327 if (infile
== NULL
) {
329 in
= dup_bio_in(informat
);
331 in
= bio_open_default(infile
, 'r', informat
);
335 if (!str
&& passarg
) {
336 if (!app_passwd(passarg
, NULL
, &pass
, NULL
)) {
337 BIO_printf(bio_err
, "Error getting password\n");
343 if ((str
== NULL
) && (cipher
!= NULL
) && (hkey
== NULL
)) {
345 #ifndef OPENSSL_NO_UI
349 BIO_snprintf(prompt
, sizeof prompt
, "enter %s %s password:",
350 OBJ_nid2ln(EVP_CIPHER_nid(cipher
)),
351 (enc
) ? "encryption" : "decryption");
353 i
= EVP_read_pw_string((char *)strbuf
, SIZE
, prompt
, enc
);
355 if (strbuf
[0] == '\0') {
363 BIO_printf(bio_err
, "bad password read\n");
369 BIO_printf(bio_err
, "password required\n");
374 out
= bio_open_default(outfile
, 'w', outformat
);
379 BIO_set_callback(in
, BIO_debug_callback
);
380 BIO_set_callback(out
, BIO_debug_callback
);
381 BIO_set_callback_arg(in
, (char *)bio_err
);
382 BIO_set_callback_arg(out
, (char *)bio_err
);
390 if ((bzl
= BIO_new(BIO_f_zlib())) == NULL
)
393 BIO_set_callback(bzl
, BIO_debug_callback
);
394 BIO_set_callback_arg(bzl
, (char *)bio_err
);
397 wbio
= BIO_push(bzl
, wbio
);
399 rbio
= BIO_push(bzl
, rbio
);
404 if ((b64
= BIO_new(BIO_f_base64())) == NULL
)
407 BIO_set_callback(b64
, BIO_debug_callback
);
408 BIO_set_callback_arg(b64
, (char *)bio_err
);
411 BIO_set_flags(b64
, BIO_FLAGS_BASE64_NO_NL
);
413 wbio
= BIO_push(b64
, wbio
);
415 rbio
= BIO_push(b64
, rbio
);
418 if (cipher
!= NULL
) {
420 * Note that str is NULL if a key was passed on the command line, so
421 * we get no salt in that case. Is this a bug?
425 * Salt handling: if encrypting generate a salt and write to
426 * output BIO. If decrypting read salt from input BIO.
434 if (!set_hex(hsalt
, salt
, sizeof salt
)) {
435 BIO_printf(bio_err
, "invalid hex salt value\n");
438 } else if (RAND_bytes(salt
, sizeof salt
) <= 0)
441 * If -P option then don't bother writing
444 && (BIO_write(wbio
, magic
,
445 sizeof magic
- 1) != sizeof magic
- 1
448 sizeof salt
) != sizeof salt
)) {
449 BIO_printf(bio_err
, "error writing output file\n");
452 } else if (BIO_read(rbio
, mbuf
, sizeof mbuf
) != sizeof mbuf
454 (unsigned char *)salt
,
455 sizeof salt
) != sizeof salt
) {
456 BIO_printf(bio_err
, "error reading input file\n");
458 } else if (memcmp(mbuf
, magic
, sizeof magic
- 1)) {
459 BIO_printf(bio_err
, "bad magic number\n");
466 if (!EVP_BytesToKey(cipher
, dgst
, sptr
,
467 (unsigned char *)str
,
468 strlen(str
), 1, key
, iv
)) {
469 BIO_printf(bio_err
, "EVP_BytesToKey failed\n");
473 * zero the complete buffer or the string passed from the command
474 * line bug picked up by Larry J. Hughes Jr. <hughes@indiana.edu>
477 OPENSSL_cleanse(str
, SIZE
);
479 OPENSSL_cleanse(str
, strlen(str
));
482 int siz
= EVP_CIPHER_iv_length(cipher
);
484 BIO_printf(bio_err
, "warning: iv not use by this cipher\n");
485 } else if (!set_hex(hiv
, iv
, sizeof iv
)) {
486 BIO_printf(bio_err
, "invalid hex iv value\n");
490 if ((hiv
== NULL
) && (str
== NULL
)
491 && EVP_CIPHER_iv_length(cipher
) != 0) {
493 * No IV was explicitly set and no IV was generated during
494 * EVP_BytesToKey. Hence the IV is undefined, making correct
495 * decryption impossible.
497 BIO_printf(bio_err
, "iv undefined\n");
500 if ((hkey
!= NULL
) && !set_hex(hkey
, key
, EVP_CIPHER_key_length(cipher
))) {
501 BIO_printf(bio_err
, "invalid hex key value\n");
505 if ((benc
= BIO_new(BIO_f_cipher())) == NULL
)
509 * Since we may be changing parameters work on the encryption context
510 * rather than calling BIO_set_cipher().
513 BIO_get_cipher_ctx(benc
, &ctx
);
515 if (!EVP_CipherInit_ex(ctx
, cipher
, NULL
, NULL
, NULL
, enc
)) {
516 BIO_printf(bio_err
, "Error setting cipher %s\n",
517 EVP_CIPHER_name(cipher
));
518 ERR_print_errors(bio_err
);
523 EVP_CIPHER_CTX_set_padding(ctx
, 0);
525 if (!EVP_CipherInit_ex(ctx
, NULL
, NULL
, key
, iv
, enc
)) {
526 BIO_printf(bio_err
, "Error setting cipher %s\n",
527 EVP_CIPHER_name(cipher
));
528 ERR_print_errors(bio_err
);
533 BIO_set_callback(benc
, BIO_debug_callback
);
534 BIO_set_callback_arg(benc
, (char *)bio_err
);
540 for (i
= 0; i
< (int)sizeof(salt
); i
++)
541 printf("%02X", salt
[i
]);
544 if (EVP_CIPHER_key_length(cipher
) > 0) {
546 for (i
= 0; i
< EVP_CIPHER_key_length(cipher
); i
++)
547 printf("%02X", key
[i
]);
550 if (EVP_CIPHER_iv_length(cipher
) > 0) {
552 for (i
= 0; i
< EVP_CIPHER_iv_length(cipher
); i
++)
553 printf("%02X", iv
[i
]);
563 /* Only encrypt/decrypt as we write the file */
565 wbio
= BIO_push(benc
, wbio
);
568 inl
= BIO_read(rbio
, (char *)buff
, bsize
);
571 if (BIO_write(wbio
, (char *)buff
, inl
) != inl
) {
572 BIO_printf(bio_err
, "error writing output file\n");
576 if (!BIO_flush(wbio
)) {
577 BIO_printf(bio_err
, "bad decrypt\n");
583 BIO_printf(bio_err
, "bytes read :%8"PRIu64
"\n", BIO_number_read(in
));
584 BIO_printf(bio_err
, "bytes written:%8"PRIu64
"\n", BIO_number_written(out
));
587 ERR_print_errors(bio_err
);
588 OPENSSL_free(strbuf
);
601 static void show_ciphers(const OBJ_NAME
*name
, void *bio_
)
606 if (!islower((unsigned char)*name
->name
))
609 BIO_printf(bio
, "-%-25s", name
->name
);
611 BIO_printf(bio
, "\n");
614 BIO_printf(bio
, " ");
617 static int set_hex(char *in
, unsigned char *out
, int size
)
623 if (n
> (size
* 2)) {
624 BIO_printf(bio_err
, "hex string is too long\n");
627 memset(out
, 0, size
);
628 for (i
= 0; i
< n
; i
++) {
629 j
= (unsigned char)*in
;
634 BIO_printf(bio_err
, "non-hex digit\n");
637 j
= (unsigned char)OPENSSL_hexchar2int(j
);
641 out
[i
/ 2] = (j
<< 4);