tfcrypt.h

   1 /*
   2  * tfcrypt -- high security Threefish encryption tool.
   3  *
   4  * tfcrypt is copyrighted:
   5  * Copyright (C) 2012-2018 Andrey Rys. All rights reserved.
   6  *
   7  * tfcrypt is licensed to you under the terms of std. MIT/X11 license:
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining
  10  * a copy of this software and associated documentation files (the
  11  * "Software"), to deal in the Software without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  23  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  24  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  25  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  26  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27  */
  28
  29 #ifndef _TFCRYPT_H
  30 #define _TFCRYPT_H
  31
  32 #ifndef _BSD_SOURCE
  33 #define _BSD_SOURCE
  34 #endif
  35 #ifndef _XOPEN_SOURCE
  36 #define _XOPEN_SOURCE 700
  37 #endif
  38 #ifndef _LARGEFILE64_SOURCE
  39 #define _LARGEFILE64_SOURCE
  40 #endif
  41 #ifndef _FILE_OFFSET_BITS
  42 #define _FILE_OFFSET_BITS 64
  43 #endif
  44
  45 #ifndef _TFCRYPT_VERSION
  46 #error Version number may help you to identify missing functionality.
  47 #endif
  48
  49 #include <stdio.h>
  50 #include <string.h>
  51 #include <stdlib.h>
  52 #include <unistd.h>
  53 #include <errno.h>
  54 #include <libgen.h>
  55 #include <stdarg.h>
  56 #include <sys/types.h>
  57 #include <sys/stat.h>
  58 #include <limits.h>
  59 #include <fcntl.h>
  60 #include <signal.h>
  61 #include <sys/time.h>
  62 #include <stdint.h>
  63
  64 typedef void (*sighandler_t)(int);
  65
  66 #include "base64.h"
  67 #include "getpasswd.h"
  68 #include "tfdef.h"
  69 #include "skein.h"
  70 #include "tfe.h"
  71 #include "tfprng.h"
  72
  73 typedef short tfc_yesno;
  74 typedef TF_BYTE_TYPE tfc_byte;
  75 typedef unsigned long long tfc_fsize;
  76 typedef unsigned long long tfc_useconds;
  77
  78 #ifndef TFC_BLKSIZE
  79 #define TFC_BLKSIZE 65536
  80 #endif
  81
  82 #ifndef TFC_MAX_SALT
  83 #define TFC_MAX_SALT (2048 + TF_KEY_SIZE)
  84 #endif
  85
  86 #ifndef TFC_XTSBLOCKS
  87 #define TFC_XTSBLOCKS 32
  88 #endif
  89
  90 #ifndef TFC_B64_WIDTH
  91 #define TFC_B64_WIDTH 76
  92 #endif
  93 #define TFC_B64_EWIDTH (TFC_B64_WIDTH - (TFC_B64_WIDTH / 4))
  94 #define TFC_B64_DWIDTH TFC_BLKSIZE
  95
  96 #define NOSIZE ((size_t)-1)
  97 #define NOFSIZE ((tfc_fsize)-1)
  98 #define TFC_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  99
 100 #define TFC_KEY_BITS (do_tfcrypt1 == YES ? TF_MAX_BITS : TF_NR_KEY_BITS)
 101
 102 #define TFC_ASCII_TFC_MAC_FOURCC "%TF"
 103 #define TFC_ASCII_TFC_MAC_FOURCC_LEN (sizeof(TFC_ASCII_TFC_MAC_FOURCC)-1)
 104
 105 #define TFC_U(x) ((unsigned)x)
 106 #define TFC_DTOUSECS(x) ((x) * 1000000.0)
 107 #define TFC_UTODSECS(x) ((x) / 1000000.0)
 108
 109 #define TFC_DEFAULT_RANDSOURCE "/dev/urandom"
 110 #define TFC_STDIN_NAME "(stdin)"
 111 #define TFC_STDOUT_NAME "(stdout)"
 112
 113 #define TFC_TMPSIZE     (TF_BLOCK_SIZE * 4)
 114
 115 int xmhexdump(int to, const void *data, size_t szdata, int hgroup, int hexstr, int newline);
 116 #define mhexdump(data, szdata, group, newline) xmhexdump(1, data, szdata, group, do_full_hexdump, newline)
 117 #define mehexdump(data, szdata, group, newline) xmhexdump(2, data, szdata, group, do_full_hexdump, newline)
 118
 119 extern size_t nr_turns;
 120 extern int ctr_mode;
 121 extern size_t macbits;
 122 extern size_t tfc_saltsz;
 123 extern tfc_byte tfc_salt[TFC_MAX_SALT];
 124
 125 extern char *progname;
 126 extern int exitcode;
 127 extern tfc_byte key[TF_KEY_SIZE], ctr[TF_BLOCK_SIZE], xtskey[TF_KEY_SIZE], mackey[TF_FROM_BITS(TF_MAX_BITS)];
 128 extern struct skein sk;
 129 extern struct tfe_stream tfe;
 130 extern tfc_byte srcblk[TFC_BLKSIZE], dstblk[TFC_BLKSIZE], *pblk;
 131 extern tfc_byte macvrfy[SKEIN_DIGEST_SIZE], macresult[SKEIN_DIGEST_SIZE];
 132 extern tfc_byte tmpdata[TFC_TMPSIZE];
 133 extern char *randsource;
 134 extern tfc_fsize iseek_blocks, iseek, oseek, maxlen;
 135 extern tfc_fsize total_processed_src, total_processed_dst;
 136 extern tfc_fsize delta_processed;
 137 extern tfc_fsize genrandom_nr_bytes, genzero_nr_bytes;
 138 extern tfc_fsize rdpos;
 139 extern int sfd, kfd, dfd;
 140 extern struct stat s_stat;
 141 extern size_t blksize, xtsblocks;
 142 extern char pwdask[512], pwdagain[512];
 143 extern size_t lio, lrem, ldone, lblock;
 144 extern size_t maxkeylen, ctrsz;
 145 extern struct sigaction sigact;
 146 extern size_t sksum_turns;
 147 extern int do_edcrypt, do_stop, quiet, error_action;
 148 extern int counter_opt, mackey_opt, do_mac, do_outfmt, rawkey;
 149 extern int idx, write_flags;
 150 extern tfc_yesno catch_all_errors, password, overwrite_source, do_fsync, do_pad, do_tfcrypt1;
 151 extern tfc_yesno do_preserve_time, do_stats_in_gibs, do_statline_dynamic, do_less_stats;
 152 extern tfc_yesno no_repeat, do_full_hexdump, verbose, statline_was_shown;
 153 extern char *srcfname, *dstfname, *do_mac_file, *counter_file, *sksum_hashlist_file;
 154 extern char *saltf, *genkeyf, *mackeyf, *tweakf;
 155 extern char *pw_prompt, *mac_pw_prompt;
 156 extern tfc_useconds status_timer, bench_timer;
 157 extern tfc_useconds current_time, delta_time;
 158 extern struct getpasswd_state getps;
 159
 160 size_t xread(int fd, void *data, size_t szdata);
 161 size_t xwrite(int fd, const void *data, size_t szdata);
 162
 163 void xerror(tfc_yesno noexit, tfc_yesno noerrno, tfc_yesno nostats, const char *fmt, ...);
 164 void xexit(int status);
 165 void usage(void);
 166
 167 void tfc_vfsay(FILE *where, tfc_yesno addnl, const char *fmt, va_list ap);
 168 void tfc_nfsay(FILE *where, const char *fmt, ...);
 169 void tfc_esay(const char *fmt, ...);
 170 void tfc_say(const char *fmt, ...);
 171
 172 void tfc_printbase64(FILE *where, const void *p, size_t n, tfc_yesno nl);
 173 void tfc_data_to_words64(void *data, size_t szdata);
 174 tfc_fsize tfc_humanfsize(const char *s, char **stoi);
 175 const char *tfc_getscale(int scale);
 176 void tfc_describescale(tfc_fsize num, double *w, int *scale);
 177 size_t blk_len_adj(tfc_fsize filelen, tfc_fsize read_already, size_t blklen);
 178 tfc_yesno xor_shrink(void *dst, size_t szdst, const void *src, size_t szsrc);
 179 tfc_yesno str_empty(const char *str);
 180 void xclose(int fd);
 181 const char *tfc_modename(int mode);
 182 void tfc_getcurtime(tfc_useconds *tx);
 183 tfc_fsize tfc_fdsize(int fd);
 184 tfc_fsize tfc_fdgetpos(int fd);
 185 tfc_fsize tfc_fnamesize(char *fname, tfc_yesno noexit);
 186 tfc_fsize tfc_modifysize(tfc_fsize szmodify, const char *szspec);
 187 void fcopy_matime(int fd, const struct stat *st);
 188 tfc_yesno xfgets(char *s, size_t n, FILE *f);
 189 tfc_yesno isbase64(const char *s);
 190 void hex2bin(void *d, const char *s);
 191 void tfc_finirandom(void);
 192 void tfc_getrandom(void *buf, size_t sz);
 193 void exit_sigterm(int signal);
 194 void print_crypt_status(int signal);
 195 void change_status_width(int signal);
 196 void change_status_timer(int signal);
 197 void setup_next_alarm(tfc_useconds useconds);
 198 void skein(void *hash, size_t bits, const void *key, const void *data, size_t szdata);
 199 void tf_key_tweak_compat(void *key);
 200 tfc_yesno skeinfd(void *hash, size_t bits, const void *key, int fd, tfc_fsize readto);
 201
 202 void gen_write_bytes(const char *foutname, tfc_fsize offset, tfc_fsize nrbytes);
 203 void do_edbase64(char **fargv);
 204 void do_sksum(char *spec, char **fargv);
 205 void do_benchmark(tfc_useconds useconds, double dseconds);
 206
 207 enum { NO, YES };
 208
 209 enum { TFC_ERRACT_EXIT, TFC_ERRACT_CONT, TFC_ERRACT_SYNC, TFC_ERRACT_LSYNC };
 210 enum { TFC_STOP_BEGAN = 1, TFC_STOP_FULL };
 211 enum { TFC_DO_PLAIN, TFC_DO_ENCRYPT, TFC_DO_DECRYPT };
 212 enum { TFC_MAC_DROP = -1, TFC_MAC_SIGN = 1, TFC_MAC_VRFY, TFC_MAC_JUST_VRFY };
 213 enum { TFC_MACKEY_RAWKEY = 1, TFC_MACKEY_PASSWORD, TFC_MACKEY_FILE };
 214 enum { TFC_RAWKEY_KEYFILE = 1, TFC_RAWKEY_ASKSTR, TFC_RAWKEY_ASKHEX };
 215 enum { TFC_OUTFMT_HEX = 1, TFC_OUTFMT_B64, TFC_OUTFMT_RAW };
 216 enum {
 217         TFC_MODE_SKSUM = -2, TFC_MODE_PLAIN = -1, TFC_MODE_CTR = 1,
 218         TFC_MODE_STREAM, TFC_MODE_XTS, TFC_MODE_ECB, TFC_MODE_CBC, TFC_MODE_OCB
 219 };
 220 enum { TFC_CTR_SHOW = 1, TFC_CTR_HEAD, TFC_CTR_RAND };
 221
 222 #endif