2 * Copyright 1995-2019 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
,
51 const OPTIONS enc_options
[] = {
52 {"help", OPT_HELP
, '-', "Display this summary"},
53 {"list", OPT_LIST
, '-', "List ciphers"},
55 {"ciphers", OPT_LIST
, '-', "Alias for -list"},
57 {"in", OPT_IN
, '<', "Input file"},
58 {"out", OPT_OUT
, '>', "Output file"},
59 {"pass", OPT_PASS
, 's', "Passphrase source"},
60 {"e", OPT_E
, '-', "Encrypt"},
61 {"d", OPT_D
, '-', "Decrypt"},
62 {"p", OPT_P
, '-', "Print the iv/key"},
63 {"P", OPT_UPPER_P
, '-', "Print the iv/key and exit"},
64 {"v", OPT_V
, '-', "Verbose output"},
65 {"nopad", OPT_NOPAD
, '-', "Disable standard block padding"},
66 {"salt", OPT_SALT
, '-', "Use salt in the KDF (default)"},
67 {"nosalt", OPT_NOSALT
, '-', "Do not use salt in the KDF"},
68 {"debug", OPT_DEBUG
, '-', "Print debug info"},
69 {"a", OPT_A
, '-', "Base64 encode/decode, depending on encryption flag"},
70 {"base64", OPT_A
, '-', "Same as option -a"},
71 {"A", OPT_UPPER_A
, '-',
72 "Used with -[base64|a] to specify base64 buffer as a single line"},
73 {"bufsize", OPT_BUFSIZE
, 's', "Buffer size"},
74 {"k", OPT_K
, 's', "Passphrase"},
75 {"kfile", OPT_KFILE
, '<', "Read passphrase from file"},
76 {"K", OPT_UPPER_K
, 's', "Raw key, in hex"},
77 {"S", OPT_UPPER_S
, 's', "Salt, in hex"},
78 {"iv", OPT_IV
, 's', "IV in hex"},
79 {"md", OPT_MD
, 's', "Use specified digest to create a key from the passphrase"},
80 {"iter", OPT_ITER
, 'p', "Specify the iteration count and force use of PBKDF2"},
81 {"pbkdf2", OPT_PBKDF2
, '-', "Use password-based key derivation function 2"},
82 {"none", OPT_NONE
, '-', "Don't encrypt"},
83 {"", OPT_CIPHER
, '-', "Any supported cipher"},
86 {"z", OPT_Z
, '-', "Use zlib as the 'encryption'"},
88 #ifndef OPENSSL_NO_ENGINE
89 {"engine", OPT_ENGINE
, 's', "Use engine, possibly a hardware device"},
94 int enc_main(int argc
, char **argv
)
97 static const char magic
[] = "Salted__";
99 BIO
*in
= NULL
, *out
= NULL
, *b64
= NULL
, *benc
= NULL
, *rbio
=
101 EVP_CIPHER_CTX
*ctx
= NULL
;
102 const EVP_CIPHER
*cipher
= NULL
, *c
;
103 const EVP_MD
*dgst
= NULL
;
104 char *hkey
= NULL
, *hiv
= NULL
, *hsalt
= NULL
, *p
;
105 char *infile
= NULL
, *outfile
= NULL
, *prog
;
106 char *str
= NULL
, *passarg
= NULL
, *pass
= NULL
, *strbuf
= NULL
;
107 char mbuf
[sizeof(magic
) - 1];
109 int bsize
= BSIZE
, verbose
= 0, debug
= 0, olb64
= 0, nosalt
= 0;
110 int enc
= 1, printkey
= 0, i
, k
;
111 int base64
= 0, informat
= FORMAT_BINARY
, outformat
= FORMAT_BINARY
;
112 int ret
= 1, inl
, nopad
= 0;
113 unsigned char key
[EVP_MAX_KEY_LENGTH
], iv
[EVP_MAX_IV_LENGTH
];
114 unsigned char *buff
= NULL
, salt
[PKCS5_SALT_LEN
];
118 struct doall_enc_ciphers dec
;
124 /* first check the program name */
125 prog
= opt_progname(argv
[0]);
126 if (strcmp(prog
, "base64") == 0) {
129 } else if (strcmp(prog
, "zlib") == 0) {
133 cipher
= EVP_get_cipherbyname(prog
);
134 if (cipher
== NULL
&& strcmp(prog
, "enc") != 0) {
135 BIO_printf(bio_err
, "%s is not a known cipher\n", prog
);
140 prog
= opt_init(argc
, argv
, enc_options
);
141 while ((o
= opt_next()) != OPT_EOF
) {
146 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
149 opt_help(enc_options
);
153 BIO_printf(bio_out
, "Supported ciphers:\n");
156 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH
,
158 BIO_printf(bio_out
, "\n");
174 e
= setup_engine(opt_arg(), 0);
213 i
= (int)strlen(p
) - 1;
214 k
= i
>= 1 && p
[i
] == 'k';
217 if (!opt_long(opt_arg(), &n
)
218 || n
< 0 || (k
&& n
>= LONG_MAX
/ 1024))
228 in
= bio_open_default(opt_arg(), 'r', FORMAT_TEXT
);
231 i
= BIO_gets(in
, buf
, sizeof(buf
));
236 "%s Can't read key from %s\n", prog
, opt_arg());
239 while (--i
> 0 && (buf
[i
] == '\r' || buf
[i
] == '\n'))
242 BIO_printf(bio_err
, "%s: zero length password\n", prog
);
257 if (!opt_md(opt_arg(), &dgst
))
261 if (!opt_cipher(opt_unknown(), &c
))
266 if (!opt_int(opt_arg(), &iter
))
272 if (iter
== 0) /* do not overwrite a chosen value */
284 if (opt_num_rest() != 0) {
285 BIO_printf(bio_err
, "Extra arguments given.\n");
289 if (cipher
&& EVP_CIPHER_flags(cipher
) & EVP_CIPH_FLAG_AEAD_CIPHER
) {
290 BIO_printf(bio_err
, "%s: AEAD ciphers not supported\n", prog
);
294 if (cipher
&& (EVP_CIPHER_mode(cipher
) == EVP_CIPH_XTS_MODE
)) {
295 BIO_printf(bio_err
, "%s XTS ciphers not supported\n", prog
);
305 /* It must be large enough for a base64 encoded line */
306 if (base64
&& bsize
< 80)
309 BIO_printf(bio_err
, "bufsize=%d\n", bsize
);
316 outformat
= FORMAT_BASE64
;
318 informat
= FORMAT_BASE64
;
321 strbuf
= app_malloc(SIZE
, "strbuf");
322 buff
= app_malloc(EVP_ENCODE_LENGTH(bsize
), "evp buffer");
324 if (infile
== NULL
) {
325 in
= dup_bio_in(informat
);
327 in
= bio_open_default(infile
, 'r', informat
);
332 if (str
== NULL
&& passarg
!= NULL
) {
333 if (!app_passwd(passarg
, NULL
, &pass
, NULL
)) {
334 BIO_printf(bio_err
, "Error getting password\n");
340 if ((str
== NULL
) && (cipher
!= NULL
) && (hkey
== NULL
)) {
342 #ifndef OPENSSL_NO_UI_CONSOLE
346 BIO_snprintf(prompt
, sizeof(prompt
), "enter %s %s password:",
347 OBJ_nid2ln(EVP_CIPHER_nid(cipher
)),
348 (enc
) ? "encryption" : "decryption");
350 i
= EVP_read_pw_string((char *)strbuf
, SIZE
, prompt
, enc
);
352 if (strbuf
[0] == '\0') {
360 BIO_printf(bio_err
, "bad password read\n");
366 BIO_printf(bio_err
, "password required\n");
371 out
= bio_open_default(outfile
, 'w', outformat
);
376 BIO_set_callback(in
, BIO_debug_callback
);
377 BIO_set_callback(out
, BIO_debug_callback
);
378 BIO_set_callback_arg(in
, (char *)bio_err
);
379 BIO_set_callback_arg(out
, (char *)bio_err
);
387 if ((bzl
= BIO_new(BIO_f_zlib())) == NULL
)
390 BIO_set_callback(bzl
, BIO_debug_callback
);
391 BIO_set_callback_arg(bzl
, (char *)bio_err
);
394 wbio
= BIO_push(bzl
, wbio
);
396 rbio
= BIO_push(bzl
, rbio
);
401 if ((b64
= BIO_new(BIO_f_base64())) == NULL
)
404 BIO_set_callback(b64
, BIO_debug_callback
);
405 BIO_set_callback_arg(b64
, (char *)bio_err
);
408 BIO_set_flags(b64
, BIO_FLAGS_BASE64_NO_NL
);
410 wbio
= BIO_push(b64
, wbio
);
412 rbio
= BIO_push(b64
, rbio
);
415 if (cipher
!= NULL
) {
417 * Note that str is NULL if a key was passed on the command line, so
418 * we get no salt in that case. Is this a bug?
422 * Salt handling: if encrypting generate a salt and write to
423 * output BIO. If decrypting read salt from input BIO.
426 size_t str_len
= strlen(str
);
433 if (!set_hex(hsalt
, salt
, sizeof(salt
))) {
434 BIO_printf(bio_err
, "invalid hex salt value\n");
437 } 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");
467 * derive key and default iv
468 * concatenated into a temporary buffer
470 unsigned char tmpkeyiv
[EVP_MAX_KEY_LENGTH
+ EVP_MAX_IV_LENGTH
];
471 int iklen
= EVP_CIPHER_key_length(cipher
);
472 int ivlen
= EVP_CIPHER_iv_length(cipher
);
473 /* not needed if HASH_UPDATE() is fixed : */
474 int islen
= (sptr
!= NULL
? sizeof(salt
) : 0);
475 if (!PKCS5_PBKDF2_HMAC(str
, str_len
, sptr
, islen
,
476 iter
, dgst
, iklen
+ivlen
, tmpkeyiv
)) {
477 BIO_printf(bio_err
, "PKCS5_PBKDF2_HMAC failed\n");
480 /* split and move data back to global buffer */
481 memcpy(key
, tmpkeyiv
, iklen
);
482 memcpy(iv
, tmpkeyiv
+iklen
, ivlen
);
484 BIO_printf(bio_err
, "*** WARNING : "
485 "deprecated key derivation used.\n"
486 "Using -iter or -pbkdf2 would be better.\n");
487 if (!EVP_BytesToKey(cipher
, dgst
, sptr
,
488 (unsigned char *)str
, str_len
,
490 BIO_printf(bio_err
, "EVP_BytesToKey failed\n");
495 * zero the complete buffer or the string passed from the command
499 OPENSSL_cleanse(str
, SIZE
);
501 OPENSSL_cleanse(str
, str_len
);
504 int siz
= EVP_CIPHER_iv_length(cipher
);
506 BIO_printf(bio_err
, "warning: iv not used by this cipher\n");
507 } else if (!set_hex(hiv
, iv
, siz
)) {
508 BIO_printf(bio_err
, "invalid hex iv value\n");
512 if ((hiv
== NULL
) && (str
== NULL
)
513 && EVP_CIPHER_iv_length(cipher
) != 0) {
515 * No IV was explicitly set and no IV was generated.
516 * Hence the IV is undefined, making correct decryption impossible.
518 BIO_printf(bio_err
, "iv undefined\n");
522 if (!set_hex(hkey
, key
, EVP_CIPHER_key_length(cipher
))) {
523 BIO_printf(bio_err
, "invalid hex key value\n");
526 /* wiping secret data as we no longer need it */
527 OPENSSL_cleanse(hkey
, strlen(hkey
));
530 if ((benc
= BIO_new(BIO_f_cipher())) == NULL
)
534 * Since we may be changing parameters work on the encryption context
535 * rather than calling BIO_set_cipher().
538 BIO_get_cipher_ctx(benc
, &ctx
);
540 if (!EVP_CipherInit_ex(ctx
, cipher
, NULL
, NULL
, NULL
, enc
)) {
541 BIO_printf(bio_err
, "Error setting cipher %s\n",
542 EVP_CIPHER_name(cipher
));
543 ERR_print_errors(bio_err
);
548 EVP_CIPHER_CTX_set_padding(ctx
, 0);
550 if (!EVP_CipherInit_ex(ctx
, NULL
, NULL
, key
, iv
, enc
)) {
551 BIO_printf(bio_err
, "Error setting cipher %s\n",
552 EVP_CIPHER_name(cipher
));
553 ERR_print_errors(bio_err
);
558 BIO_set_callback(benc
, BIO_debug_callback
);
559 BIO_set_callback_arg(benc
, (char *)bio_err
);
565 for (i
= 0; i
< (int)sizeof(salt
); i
++)
566 printf("%02X", salt
[i
]);
569 if (EVP_CIPHER_key_length(cipher
) > 0) {
571 for (i
= 0; i
< EVP_CIPHER_key_length(cipher
); i
++)
572 printf("%02X", key
[i
]);
575 if (EVP_CIPHER_iv_length(cipher
) > 0) {
577 for (i
= 0; i
< EVP_CIPHER_iv_length(cipher
); i
++)
578 printf("%02X", iv
[i
]);
588 /* Only encrypt/decrypt as we write the file */
590 wbio
= BIO_push(benc
, wbio
);
592 while (BIO_pending(rbio
) || !BIO_eof(rbio
)) {
593 inl
= BIO_read(rbio
, (char *)buff
, bsize
);
596 if (BIO_write(wbio
, (char *)buff
, inl
) != inl
) {
597 BIO_printf(bio_err
, "error writing output file\n");
601 if (!BIO_flush(wbio
)) {
602 BIO_printf(bio_err
, "bad decrypt\n");
608 BIO_printf(bio_err
, "bytes read : %8ju\n", BIO_number_read(in
));
609 BIO_printf(bio_err
, "bytes written: %8ju\n", BIO_number_written(out
));
612 ERR_print_errors(bio_err
);
613 OPENSSL_free(strbuf
);
627 static void show_ciphers(const OBJ_NAME
*name
, void *arg
)
629 struct doall_enc_ciphers
*dec
= (struct doall_enc_ciphers
*)arg
;
630 const EVP_CIPHER
*cipher
;
632 if (!islower((unsigned char)*name
->name
))
635 /* Filter out ciphers that we cannot use */
636 cipher
= EVP_get_cipherbyname(name
->name
);
637 if (cipher
== NULL
||
638 (EVP_CIPHER_flags(cipher
) & EVP_CIPH_FLAG_AEAD_CIPHER
) != 0 ||
639 EVP_CIPHER_mode(cipher
) == EVP_CIPH_XTS_MODE
)
642 BIO_printf(dec
->bio
, "-%-25s", name
->name
);
644 BIO_printf(dec
->bio
, "\n");
647 BIO_printf(dec
->bio
, " ");
650 static int set_hex(const char *in
, unsigned char *out
, int size
)
658 BIO_printf(bio_err
, "hex string is too long, ignoring excess\n");
659 n
= i
; /* ignore exceeding part */
661 BIO_printf(bio_err
, "hex string is too short, padding with zero bytes to length\n");
664 memset(out
, 0, size
);
665 for (i
= 0; i
< n
; i
++) {
666 j
= (unsigned char)*in
++;
668 BIO_printf(bio_err
, "non-hex digit\n");
671 j
= (unsigned char)OPENSSL_hexchar2int(j
);
675 out
[i
/ 2] = (j
<< 4);