58d2550d213e0879f82c7744bb183a993445a0ae
[openssl.git] / apps / enc.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
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.
7  *
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).
14  *
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.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
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)"
39  *
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
50  * SUCH DAMAGE.
51  *
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.]
56  */
57
58 #include <stdio.h>
59 #include <stdlib.h>
60 #include <string.h>
61 #include "apps.h"
62 #include <openssl/bio.h>
63 #include <openssl/err.h>
64 #include <openssl/evp.h>
65 #include <openssl/objects.h>
66 #include <openssl/x509.h>
67 #include <openssl/rand.h>
68 #include <openssl/pem.h>
69 #ifndef OPENSSL_NO_COMP
70 # include <openssl/comp.h>
71 #endif
72 #include <ctype.h>
73
74 #undef SIZE
75 #undef BSIZE
76 #define SIZE    (512)
77 #define BSIZE   (8*1024)
78
79 static int set_hex(char *in, unsigned char *out, int size);
80 static void show_ciphers(const OBJ_NAME *name, void *bio_);
81
82 typedef enum OPTION_choice {
83     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
84     OPT_E, OPT_IN, OPT_OUT, OPT_PASS, OPT_ENGINE, OPT_D, OPT_P, OPT_V,
85     OPT_NOPAD, OPT_SALT, OPT_NOSALT, OPT_DEBUG, OPT_UPPER_P, OPT_UPPER_A,
86     OPT_A, OPT_Z, OPT_BUFSIZE, OPT_K, OPT_KFILE, OPT_UPPER_K, OPT_NONE,
87     OPT_UPPER_S, OPT_IV, OPT_MD, OPT_CIPHER
88 } OPTION_CHOICE;
89
90 OPTIONS enc_options[] = {
91     {"help", OPT_HELP, '-', "Display this summary"},
92     {"in", OPT_IN, '<', "Input file"},
93     {"out", OPT_OUT, '>', "Output file"},
94     {"pass", OPT_PASS, 's', "Passphrase source"},
95     {"e", OPT_E, '-', "Encrypt"},
96     {"d", OPT_D, '-', "Decrypt"},
97     {"p", OPT_P, '-', "Print the iv/key"},
98     {"P", OPT_UPPER_P, '-', "Print the iv/key and exit"},
99     {"v", OPT_V, '-'},
100     {"nopad", OPT_NOPAD, '-', "Disable standard block padding"},
101     {"salt", OPT_SALT, '-'},
102     {"nosalt", OPT_NOSALT, '-'},
103     {"debug", OPT_DEBUG, '-'},
104     {"A", OPT_UPPER_A, '-'},
105     {"a", OPT_A, '-', "base64 encode/decode, depending on encryption flag"},
106     {"base64", OPT_A, '-', "Base64 output as a single line"},
107     {"bufsize", OPT_BUFSIZE, 's', "Buffer size"},
108     {"k", OPT_K, 's', "Passphrase"},
109     {"kfile", OPT_KFILE, '<', "Fead passphrase from file"},
110     {"K", OPT_UPPER_K, 's', "Raw key, in hex"},
111     {"S", OPT_UPPER_S, 's', "Salt, in hex"},
112     {"iv", OPT_IV, 's', "IV in hex"},
113     {"md", OPT_MD, 's', "Use specified digest to create key from passphrase"},
114     {"none", OPT_NONE, '-', "Don't encrypt"},
115     {"", OPT_CIPHER, '-', "Any supported cipher"},
116 #ifdef ZLIB
117     {"z", OPT_Z, '-', "Use zlib as the 'encryption'"},
118 #endif
119 #ifndef OPENSSL_NO_ENGINE
120     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
121 #endif
122     {NULL}
123 };
124
125 int enc_main(int argc, char **argv)
126 {
127     static char buf[128];
128     static const char magic[] = "Salted__";
129     BIO *in = NULL, *out = NULL, *b64 = NULL, *benc = NULL, *rbio =
130         NULL, *wbio = NULL;
131     EVP_CIPHER_CTX *ctx = NULL;
132     const EVP_CIPHER *cipher = NULL, *c;
133     const EVP_MD *dgst = NULL;
134     char *hkey = NULL, *hiv = NULL, *hsalt = NULL, *p;
135     char *infile = NULL, *outfile = NULL, *prog;
136     char *str = NULL, *passarg = NULL, *pass = NULL, *strbuf = NULL;
137     char mbuf[sizeof magic - 1];
138     OPTION_CHOICE o;
139     int bsize = BSIZE, verbose = 0, debug = 0, olb64 = 0, nosalt = 0;
140     int enc = 1, printkey = 0, i, k;
141     int base64 = 0, informat = FORMAT_BINARY, outformat = FORMAT_BINARY;
142     int ret = 1, inl, nopad = 0;
143     unsigned char key[EVP_MAX_KEY_LENGTH], iv[EVP_MAX_IV_LENGTH];
144     unsigned char *buff = NULL, salt[PKCS5_SALT_LEN];
145     unsigned long n;
146 #ifdef ZLIB
147     int do_zlib = 0;
148     BIO *bzl = NULL;
149 #endif
150
151     /* first check the program name */
152     prog = opt_progname(argv[0]);
153     if (strcmp(prog, "base64") == 0)
154         base64 = 1;
155 #ifdef ZLIB
156     else if (strcmp(prog, "zlib") == 0)
157         do_zlib = 1;
158 #endif
159     else {
160         cipher = EVP_get_cipherbyname(prog);
161         if (cipher == NULL && strcmp(prog, "enc") != 0) {
162             BIO_printf(bio_err, "%s is not a known cipher\n", prog);
163             goto end;
164         }
165     }
166
167     prog = opt_init(argc, argv, enc_options);
168     while ((o = opt_next()) != OPT_EOF) {
169         switch (o) {
170         case OPT_EOF:
171         case OPT_ERR:
172  opthelp:
173             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
174             goto end;
175         case OPT_HELP:
176             opt_help(enc_options);
177             ret = 0;
178             BIO_printf(bio_err, "Cipher Types\n");
179             OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_CIPHER_METH,
180                                    show_ciphers, bio_err);
181             BIO_printf(bio_err, "\n");
182             goto end;
183         case OPT_E:
184             enc = 1;
185             break;
186         case OPT_IN:
187             infile = opt_arg();
188             break;
189         case OPT_OUT:
190             outfile = opt_arg();
191             break;
192         case OPT_PASS:
193             passarg = opt_arg();
194             break;
195         case OPT_ENGINE:
196             (void)setup_engine(opt_arg(), 0);
197             break;
198         case OPT_D:
199             enc = 0;
200             break;
201         case OPT_P:
202             printkey = 1;
203             break;
204         case OPT_V:
205             verbose = 1;
206             break;
207         case OPT_NOPAD:
208             nopad = 1;
209             break;
210         case OPT_SALT:
211             nosalt = 0;
212             break;
213         case OPT_NOSALT:
214             nosalt = 1;
215             break;
216         case OPT_DEBUG:
217             debug = 1;
218             break;
219         case OPT_UPPER_P:
220             printkey = 2;
221             break;
222         case OPT_UPPER_A:
223             olb64 = 1;
224             break;
225         case OPT_A:
226             base64 = 1;
227             break;
228         case OPT_Z:
229 #ifdef ZLIB
230             do_zlib = 1;
231 #endif
232             break;
233         case OPT_BUFSIZE:
234             p = opt_arg();
235             i = (int)strlen(p) - 1;
236             k = i >= 1 && p[i] == 'k';
237             if (k)
238                 p[i] = '\0';
239             if (!opt_ulong(opt_arg(), &n))
240                 goto opthelp;
241             if (k)
242                 n *= 1024;
243             bsize = (int)n;
244             break;
245         case OPT_K:
246             str = opt_arg();
247             break;
248         case OPT_KFILE:
249             in = bio_open_default(opt_arg(), 'r', FORMAT_TEXT);
250             if (in == NULL)
251                 goto opthelp;
252             i = BIO_gets(in, buf, sizeof buf);
253             BIO_free(in);
254             in = NULL;
255             if (i <= 0) {
256                 BIO_printf(bio_err,
257                            "%s Can't read key from %s\n", prog, opt_arg());
258                 goto opthelp;
259             }
260             while (--i > 0 && (buf[i] == '\r' || buf[i] == '\n'))
261                 buf[i] = '\0';
262             if (i <= 0) {
263                 BIO_printf(bio_err, "%s: zero length password\n", prog);
264                 goto opthelp;
265             }
266             str = buf;
267             break;
268         case OPT_UPPER_K:
269             hkey = opt_arg();
270             break;
271         case OPT_UPPER_S:
272             hsalt = opt_arg();
273             break;
274         case OPT_IV:
275             hiv = opt_arg();
276             break;
277         case OPT_MD:
278             if (!opt_md(opt_arg(), &dgst))
279                 goto opthelp;
280             break;
281         case OPT_CIPHER:
282             if (!opt_cipher(opt_unknown(), &c))
283                 goto opthelp;
284             cipher = c;
285             break;
286         case OPT_NONE:
287             cipher = NULL;
288             break;
289         }
290     }
291     argc = opt_num_rest();
292     argv = opt_rest();
293
294     if (cipher && EVP_CIPHER_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) {
295         BIO_printf(bio_err, "%s: AEAD ciphers not supported\n", prog);
296         goto end;
297     }
298
299     if (cipher && (EVP_CIPHER_mode(cipher) == EVP_CIPH_XTS_MODE)) {
300         BIO_printf(bio_err, "%s XTS ciphers not supported\n", prog);
301         goto end;
302     }
303
304     if (dgst == NULL)
305         dgst = EVP_sha256();
306
307     /* It must be large enough for a base64 encoded line */
308     if (base64 && bsize < 80)
309         bsize = 80;
310     if (verbose)
311         BIO_printf(bio_err, "bufsize=%d\n", bsize);
312
313     if (base64) {
314         if (enc)
315             outformat = FORMAT_BASE64;
316         else
317             informat = FORMAT_BASE64;
318     }
319
320     strbuf = app_malloc(SIZE, "strbuf");
321     buff = app_malloc(EVP_ENCODE_LENGTH(bsize), "evp buffer");
322
323     if (debug) {
324         BIO_set_callback(in, BIO_debug_callback);
325         BIO_set_callback(out, BIO_debug_callback);
326         BIO_set_callback_arg(in, (char *)bio_err);
327         BIO_set_callback_arg(out, (char *)bio_err);
328     }
329
330     if (infile == NULL) {
331         unbuffer(stdin);
332         in = dup_bio_in(informat);
333     } else
334         in = bio_open_default(infile, 'r', informat);
335     if (in == NULL)
336         goto end;
337
338     if (!str && passarg) {
339         if (!app_passwd(passarg, NULL, &pass, NULL)) {
340             BIO_printf(bio_err, "Error getting password\n");
341             goto end;
342         }
343         str = pass;
344     }
345
346     if ((str == NULL) && (cipher != NULL) && (hkey == NULL)) {
347         for (;;) {
348             char prompt[200];
349
350             BIO_snprintf(prompt, sizeof prompt, "enter %s %s password:",
351                          OBJ_nid2ln(EVP_CIPHER_nid(cipher)),
352                          (enc) ? "encryption" : "decryption");
353             strbuf[0] = '\0';
354             i = EVP_read_pw_string((char *)strbuf, SIZE, prompt, enc);
355             if (i == 0) {
356                 if (strbuf[0] == '\0') {
357                     ret = 1;
358                     goto end;
359                 }
360                 str = strbuf;
361                 break;
362             }
363             if (i < 0) {
364                 BIO_printf(bio_err, "bad password read\n");
365                 goto end;
366             }
367         }
368     }
369
370     out = bio_open_default(outfile, 'w', outformat);
371     if (out == NULL)
372         goto end;
373
374     rbio = in;
375     wbio = out;
376
377 #ifdef ZLIB
378     if (do_zlib) {
379         if ((bzl = BIO_new(BIO_f_zlib())) == NULL)
380             goto end;
381         if (enc)
382             wbio = BIO_push(bzl, wbio);
383         else
384             rbio = BIO_push(bzl, rbio);
385     }
386 #endif
387
388     if (base64) {
389         if ((b64 = BIO_new(BIO_f_base64())) == NULL)
390             goto end;
391         if (debug) {
392             BIO_set_callback(b64, BIO_debug_callback);
393             BIO_set_callback_arg(b64, (char *)bio_err);
394         }
395         if (olb64)
396             BIO_set_flags(b64, BIO_FLAGS_BASE64_NO_NL);
397         if (enc)
398             wbio = BIO_push(b64, wbio);
399         else
400             rbio = BIO_push(b64, rbio);
401     }
402
403     if (cipher != NULL) {
404         /*
405          * Note that str is NULL if a key was passed on the command line, so
406          * we get no salt in that case. Is this a bug?
407          */
408         if (str != NULL) {
409             /*
410              * Salt handling: if encrypting generate a salt and write to
411              * output BIO. If decrypting read salt from input BIO.
412              */
413             unsigned char *sptr;
414             if (nosalt)
415                 sptr = NULL;
416             else {
417                 if (enc) {
418                     if (hsalt) {
419                         if (!set_hex(hsalt, salt, sizeof salt)) {
420                             BIO_printf(bio_err, "invalid hex salt value\n");
421                             goto end;
422                         }
423                     } else if (RAND_bytes(salt, sizeof salt) <= 0)
424                         goto end;
425                     /*
426                      * If -P option then don't bother writing
427                      */
428                     if ((printkey != 2)
429                         && (BIO_write(wbio, magic,
430                                       sizeof magic - 1) != sizeof magic - 1
431                             || BIO_write(wbio,
432                                          (char *)salt,
433                                          sizeof salt) != sizeof salt)) {
434                         BIO_printf(bio_err, "error writing output file\n");
435                         goto end;
436                     }
437                 } else if (BIO_read(rbio, mbuf, sizeof mbuf) != sizeof mbuf
438                            || BIO_read(rbio,
439                                        (unsigned char *)salt,
440                                        sizeof salt) != sizeof salt) {
441                     BIO_printf(bio_err, "error reading input file\n");
442                     goto end;
443                 } else if (memcmp(mbuf, magic, sizeof magic - 1)) {
444                     BIO_printf(bio_err, "bad magic number\n");
445                     goto end;
446                 }
447
448                 sptr = salt;
449             }
450
451             if (!EVP_BytesToKey(cipher, dgst, sptr,
452                                 (unsigned char *)str,
453                                 strlen(str), 1, key, iv)) {
454                 BIO_printf(bio_err, "EVP_BytesToKey failed\n");
455                 goto end;
456             }
457             /*
458              * zero the complete buffer or the string passed from the command
459              * line bug picked up by Larry J. Hughes Jr. <hughes@indiana.edu>
460              */
461             if (str == strbuf)
462                 OPENSSL_cleanse(str, SIZE);
463             else
464                 OPENSSL_cleanse(str, strlen(str));
465         }
466         if (hiv != NULL) {
467             int siz = EVP_CIPHER_iv_length(cipher);
468             if (siz == 0) {
469                 BIO_printf(bio_err, "warning: iv not use by this cipher\n");
470             } else if (!set_hex(hiv, iv, sizeof iv)) {
471                 BIO_printf(bio_err, "invalid hex iv value\n");
472                 goto end;
473             }
474         }
475         if ((hiv == NULL) && (str == NULL)
476             && EVP_CIPHER_iv_length(cipher) != 0) {
477             /*
478              * No IV was explicitly set and no IV was generated during
479              * EVP_BytesToKey. Hence the IV is undefined, making correct
480              * decryption impossible.
481              */
482             BIO_printf(bio_err, "iv undefined\n");
483             goto end;
484         }
485         if ((hkey != NULL) && !set_hex(hkey, key, EVP_CIPHER_key_length(cipher))) {
486             BIO_printf(bio_err, "invalid hex key value\n");
487             goto end;
488         }
489
490         if ((benc = BIO_new(BIO_f_cipher())) == NULL)
491             goto end;
492
493         /*
494          * Since we may be changing parameters work on the encryption context
495          * rather than calling BIO_set_cipher().
496          */
497
498         BIO_get_cipher_ctx(benc, &ctx);
499
500         if (!EVP_CipherInit_ex(ctx, cipher, NULL, NULL, NULL, enc)) {
501             BIO_printf(bio_err, "Error setting cipher %s\n",
502                        EVP_CIPHER_name(cipher));
503             ERR_print_errors(bio_err);
504             goto end;
505         }
506
507         if (nopad)
508             EVP_CIPHER_CTX_set_padding(ctx, 0);
509
510         if (!EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, enc)) {
511             BIO_printf(bio_err, "Error setting cipher %s\n",
512                        EVP_CIPHER_name(cipher));
513             ERR_print_errors(bio_err);
514             goto end;
515         }
516
517         if (debug) {
518             BIO_set_callback(benc, BIO_debug_callback);
519             BIO_set_callback_arg(benc, (char *)bio_err);
520         }
521
522         if (printkey) {
523             if (!nosalt) {
524                 printf("salt=");
525                 for (i = 0; i < (int)sizeof(salt); i++)
526                     printf("%02X", salt[i]);
527                 printf("\n");
528             }
529             if (cipher->key_len > 0) {
530                 printf("key=");
531                 for (i = 0; i < cipher->key_len; i++)
532                     printf("%02X", key[i]);
533                 printf("\n");
534             }
535             if (cipher->iv_len > 0) {
536                 printf("iv =");
537                 for (i = 0; i < cipher->iv_len; i++)
538                     printf("%02X", iv[i]);
539                 printf("\n");
540             }
541             if (printkey == 2) {
542                 ret = 0;
543                 goto end;
544             }
545         }
546     }
547
548     /* Only encrypt/decrypt as we write the file */
549     if (benc != NULL)
550         wbio = BIO_push(benc, wbio);
551
552     for (;;) {
553         inl = BIO_read(rbio, (char *)buff, bsize);
554         if (inl <= 0)
555             break;
556         if (BIO_write(wbio, (char *)buff, inl) != inl) {
557             BIO_printf(bio_err, "error writing output file\n");
558             goto end;
559         }
560     }
561     if (!BIO_flush(wbio)) {
562         BIO_printf(bio_err, "bad decrypt\n");
563         goto end;
564     }
565
566     ret = 0;
567     if (verbose) {
568         BIO_printf(bio_err, "bytes read   :%8"PRIu64"\n", BIO_number_read(in));
569         BIO_printf(bio_err, "bytes written:%8"PRIu64"\n", BIO_number_written(out));
570     }
571  end:
572     ERR_print_errors(bio_err);
573     OPENSSL_free(strbuf);
574     OPENSSL_free(buff);
575     BIO_free(in);
576     BIO_free_all(out);
577     BIO_free(benc);
578     BIO_free(b64);
579 #ifdef ZLIB
580     BIO_free(bzl);
581 #endif
582     OPENSSL_free(pass);
583     return (ret);
584 }
585
586 static void show_ciphers(const OBJ_NAME *name, void *bio_)
587 {
588     BIO *bio = bio_;
589     static int n;
590
591     if (!islower((unsigned char)*name->name))
592         return;
593
594     BIO_printf(bio, "-%-25s", name->name);
595     if (++n == 3) {
596         BIO_printf(bio, "\n");
597         n = 0;
598     } else
599         BIO_printf(bio, " ");
600 }
601
602 static int set_hex(char *in, unsigned char *out, int size)
603 {
604     int i, n;
605     unsigned char j;
606
607     n = strlen(in);
608     if (n > (size * 2)) {
609         BIO_printf(bio_err, "hex string is too long\n");
610         return (0);
611     }
612     memset(out, 0, size);
613     for (i = 0; i < n; i++) {
614         j = (unsigned char)*in;
615         *(in++) = '\0';
616         if (j == 0)
617             break;
618         if (!isxdigit(j)) {
619             BIO_printf(bio_err, "non-hex digit\n");
620             return (0);
621         }
622         j = (unsigned char)app_hex(j);
623         if (i & 1)
624             out[i / 2] |= j;
625         else
626             out[i / 2] = (j << 4);
627     }
628     return (1);
629 }