2 * Copyright 1995-2021 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
,
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
];
130 struct doall_enc_ciphers dec
;
136 /* first check the command name */
137 if (strcmp(argv
[0], "base64") == 0)
140 else if (strcmp(argv
[0], "zlib") == 0)
143 else if (strcmp(argv
[0], "enc") != 0)
144 ciphername
= argv
[0];
146 prog
= opt_init(argc
, argv
, enc_options
);
147 while ((o
= opt_next()) != OPT_EOF
) {
152 BIO_printf(bio_err
, "%s: Use -help for summary.\n", prog
);
155 opt_help(enc_options
);
159 BIO_printf(bio_out
, "Supported ciphers:\n");
162 OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH
,
164 BIO_printf(bio_out
, "\n");
180 e
= setup_engine(opt_arg(), 0);
219 i
= (int)strlen(p
) - 1;
220 k
= i
>= 1 && p
[i
] == 'k';
223 if (!opt_long(opt_arg(), &n
)
224 || n
< 0 || (k
&& n
>= LONG_MAX
/ 1024))
234 in
= bio_open_default(opt_arg(), 'r', FORMAT_TEXT
);
237 i
= BIO_gets(in
, buf
, sizeof(buf
));
242 "%s Can't read key from %s\n", prog
, opt_arg());
245 while (--i
> 0 && (buf
[i
] == '\r' || buf
[i
] == '\n'))
248 BIO_printf(bio_err
, "%s: zero length password\n", prog
);
263 digestname
= opt_arg();
266 ciphername
= opt_unknown();
269 if (!opt_int(opt_arg(), &iter
))
275 if (iter
== 0) /* do not overwrite a chosen value */
286 if (!opt_provider(o
))
292 /* No extra arguments. */
293 argc
= opt_num_rest();
296 if (!app_RAND_load())
299 /* Get the cipher name, either from progname (if set) or flag. */
300 if (ciphername
!= NULL
) {
301 if (!opt_cipher(ciphername
, &cipher
))
304 if (cipher
&& EVP_CIPHER_flags(cipher
) & EVP_CIPH_FLAG_AEAD_CIPHER
) {
305 BIO_printf(bio_err
, "%s: AEAD ciphers not supported\n", prog
);
308 if (cipher
&& (EVP_CIPHER_mode(cipher
) == EVP_CIPH_XTS_MODE
)) {
309 BIO_printf(bio_err
, "%s XTS ciphers not supported\n", prog
);
312 if (digestname
!= NULL
) {
313 if (!opt_md(digestname
, &dgst
))
317 dgst
= (EVP_MD
*)EVP_sha256();
322 /* It must be large enough for a base64 encoded line */
323 if (base64
&& bsize
< 80)
326 BIO_printf(bio_err
, "bufsize=%d\n", bsize
);
333 outformat
= FORMAT_BASE64
;
335 informat
= FORMAT_BASE64
;
338 strbuf
= app_malloc(SIZE
, "strbuf");
339 buff
= app_malloc(EVP_ENCODE_LENGTH(bsize
), "evp buffer");
341 if (infile
== NULL
) {
342 in
= dup_bio_in(informat
);
344 in
= bio_open_default(infile
, 'r', informat
);
349 if (str
== NULL
&& passarg
!= NULL
) {
350 if (!app_passwd(passarg
, NULL
, &pass
, NULL
)) {
351 BIO_printf(bio_err
, "Error getting password\n");
357 if ((str
== NULL
) && (cipher
!= NULL
) && (hkey
== NULL
)) {
359 #ifndef OPENSSL_NO_UI_CONSOLE
363 BIO_snprintf(prompt
, sizeof(prompt
), "enter %s %s password:",
364 EVP_CIPHER_name(cipher
),
365 (enc
) ? "encryption" : "decryption");
367 i
= EVP_read_pw_string((char *)strbuf
, SIZE
, prompt
, enc
);
369 if (strbuf
[0] == '\0') {
377 BIO_printf(bio_err
, "bad password read\n");
383 BIO_printf(bio_err
, "password required\n");
388 out
= bio_open_default(outfile
, 'w', outformat
);
393 BIO_set_callback(in
, BIO_debug_callback
);
394 BIO_set_callback(out
, BIO_debug_callback
);
395 BIO_set_callback_arg(in
, (char *)bio_err
);
396 BIO_set_callback_arg(out
, (char *)bio_err
);
404 if ((bzl
= BIO_new(BIO_f_zlib())) == NULL
)
407 BIO_set_callback(bzl
, BIO_debug_callback
);
408 BIO_set_callback_arg(bzl
, (char *)bio_err
);
411 wbio
= BIO_push(bzl
, wbio
);
413 rbio
= BIO_push(bzl
, rbio
);
418 if ((b64
= BIO_new(BIO_f_base64())) == NULL
)
421 BIO_set_callback(b64
, BIO_debug_callback
);
422 BIO_set_callback_arg(b64
, (char *)bio_err
);
425 BIO_set_flags(b64
, BIO_FLAGS_BASE64_NO_NL
);
427 wbio
= BIO_push(b64
, wbio
);
429 rbio
= BIO_push(b64
, rbio
);
432 if (cipher
!= NULL
) {
434 * Note that str is NULL if a key was passed on the command line, so
435 * we get no salt in that case. Is this a bug?
439 * Salt handling: if encrypting generate a salt and write to
440 * output BIO. If decrypting read salt from input BIO.
443 size_t str_len
= strlen(str
);
450 if (!set_hex(hsalt
, salt
, sizeof(salt
))) {
451 BIO_printf(bio_err
, "invalid hex salt value\n");
454 } else if (RAND_bytes(salt
, sizeof(salt
)) <= 0) {
458 * If -P option then don't bother writing
461 && (BIO_write(wbio
, magic
,
462 sizeof(magic
) - 1) != sizeof(magic
) - 1
465 sizeof(salt
)) != sizeof(salt
))) {
466 BIO_printf(bio_err
, "error writing output file\n");
469 } else if (BIO_read(rbio
, mbuf
, sizeof(mbuf
)) != sizeof(mbuf
)
471 (unsigned char *)salt
,
472 sizeof(salt
)) != sizeof(salt
)) {
473 BIO_printf(bio_err
, "error reading input file\n");
475 } else if (memcmp(mbuf
, magic
, sizeof(magic
) - 1)) {
476 BIO_printf(bio_err
, "bad magic number\n");
484 * derive key and default iv
485 * concatenated into a temporary buffer
487 unsigned char tmpkeyiv
[EVP_MAX_KEY_LENGTH
+ EVP_MAX_IV_LENGTH
];
488 int iklen
= EVP_CIPHER_key_length(cipher
);
489 int ivlen
= EVP_CIPHER_iv_length(cipher
);
490 /* not needed if HASH_UPDATE() is fixed : */
491 int islen
= (sptr
!= NULL
? sizeof(salt
) : 0);
492 if (!PKCS5_PBKDF2_HMAC(str
, str_len
, sptr
, islen
,
493 iter
, dgst
, iklen
+ivlen
, tmpkeyiv
)) {
494 BIO_printf(bio_err
, "PKCS5_PBKDF2_HMAC failed\n");
497 /* split and move data back to global buffer */
498 memcpy(key
, tmpkeyiv
, iklen
);
499 memcpy(iv
, tmpkeyiv
+iklen
, ivlen
);
501 BIO_printf(bio_err
, "*** WARNING : "
502 "deprecated key derivation used.\n"
503 "Using -iter or -pbkdf2 would be better.\n");
504 if (!EVP_BytesToKey(cipher
, dgst
, sptr
,
505 (unsigned char *)str
, str_len
,
507 BIO_printf(bio_err
, "EVP_BytesToKey failed\n");
512 * zero the complete buffer or the string passed from the command
516 OPENSSL_cleanse(str
, SIZE
);
518 OPENSSL_cleanse(str
, str_len
);
521 int siz
= EVP_CIPHER_iv_length(cipher
);
523 BIO_printf(bio_err
, "warning: iv not used by this cipher\n");
524 } else if (!set_hex(hiv
, iv
, siz
)) {
525 BIO_printf(bio_err
, "invalid hex iv value\n");
529 if ((hiv
== NULL
) && (str
== NULL
)
530 && EVP_CIPHER_iv_length(cipher
) != 0) {
532 * No IV was explicitly set and no IV was generated.
533 * Hence the IV is undefined, making correct decryption impossible.
535 BIO_printf(bio_err
, "iv undefined\n");
539 if (!set_hex(hkey
, key
, EVP_CIPHER_key_length(cipher
))) {
540 BIO_printf(bio_err
, "invalid hex key value\n");
543 /* wiping secret data as we no longer need it */
547 if ((benc
= BIO_new(BIO_f_cipher())) == NULL
)
551 * Since we may be changing parameters work on the encryption context
552 * rather than calling BIO_set_cipher().
555 BIO_get_cipher_ctx(benc
, &ctx
);
557 if (!EVP_CipherInit_ex(ctx
, cipher
, e
, NULL
, NULL
, enc
)) {
558 BIO_printf(bio_err
, "Error setting cipher %s\n",
559 EVP_CIPHER_name(cipher
));
560 ERR_print_errors(bio_err
);
565 EVP_CIPHER_CTX_set_padding(ctx
, 0);
567 if (!EVP_CipherInit_ex(ctx
, NULL
, NULL
, key
, iv
, enc
)) {
568 BIO_printf(bio_err
, "Error setting cipher %s\n",
569 EVP_CIPHER_name(cipher
));
570 ERR_print_errors(bio_err
);
575 BIO_set_callback(benc
, BIO_debug_callback
);
576 BIO_set_callback_arg(benc
, (char *)bio_err
);
582 for (i
= 0; i
< (int)sizeof(salt
); i
++)
583 printf("%02X", salt
[i
]);
586 if (EVP_CIPHER_key_length(cipher
) > 0) {
588 for (i
= 0; i
< EVP_CIPHER_key_length(cipher
); i
++)
589 printf("%02X", key
[i
]);
592 if (EVP_CIPHER_iv_length(cipher
) > 0) {
594 for (i
= 0; i
< EVP_CIPHER_iv_length(cipher
); i
++)
595 printf("%02X", iv
[i
]);
605 /* Only encrypt/decrypt as we write the file */
607 wbio
= BIO_push(benc
, wbio
);
609 while (BIO_pending(rbio
) || !BIO_eof(rbio
)) {
610 inl
= BIO_read(rbio
, (char *)buff
, bsize
);
613 if (BIO_write(wbio
, (char *)buff
, inl
) != inl
) {
614 BIO_printf(bio_err
, "error writing output file\n");
618 if (!BIO_flush(wbio
)) {
619 BIO_printf(bio_err
, "bad decrypt\n");
625 BIO_printf(bio_err
, "bytes read : %8ju\n", BIO_number_read(in
));
626 BIO_printf(bio_err
, "bytes written: %8ju\n", BIO_number_written(out
));
629 ERR_print_errors(bio_err
);
630 OPENSSL_free(strbuf
);
637 EVP_CIPHER_free(cipher
);
646 static void show_ciphers(const OBJ_NAME
*name
, void *arg
)
648 struct doall_enc_ciphers
*dec
= (struct doall_enc_ciphers
*)arg
;
649 const EVP_CIPHER
*cipher
;
651 if (!islower((unsigned char)*name
->name
))
654 /* Filter out ciphers that we cannot use */
655 cipher
= EVP_get_cipherbyname(name
->name
);
656 if (cipher
== NULL
||
657 (EVP_CIPHER_flags(cipher
) & EVP_CIPH_FLAG_AEAD_CIPHER
) != 0 ||
658 EVP_CIPHER_mode(cipher
) == EVP_CIPH_XTS_MODE
)
661 BIO_printf(dec
->bio
, "-%-25s", name
->name
);
663 BIO_printf(dec
->bio
, "\n");
666 BIO_printf(dec
->bio
, " ");
669 static int set_hex(const char *in
, unsigned char *out
, int size
)
677 BIO_printf(bio_err
, "hex string is too long, ignoring excess\n");
678 n
= i
; /* ignore exceeding part */
680 BIO_printf(bio_err
, "hex string is too short, padding with zero bytes to length\n");
683 memset(out
, 0, size
);
684 for (i
= 0; i
< n
; i
++) {
685 j
= (unsigned char)*in
++;
687 BIO_printf(bio_err
, "non-hex digit\n");
690 j
= (unsigned char)OPENSSL_hexchar2int(j
);
694 out
[i
/ 2] = (j
<< 4);