tfc_error.c

   1 /*
   2  * tfcrypt -- high security Threefish encryption tool.
   3  *
   4  * tfcrypt is copyrighted:
   5  * Copyright (C) 2012-2019 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 #include "tfcrypt.h"
  30
  31 void xerror(tfc_yesno noexit, tfc_yesno noerrno, tfc_yesno nostats, const char *fmt, ...)
  32 {
  33         va_list ap;
  34         char *s;
  35
  36         if (quiet) goto _ex;
  37
  38         va_start(ap, fmt);
  39
  40         if (statline_was_shown == YES && do_statline_dynamic == YES) tfc_esay("\n");
  41
  42         tfc_nfsay(stderr, "%s: ", progname);
  43         tfc_vfsay(stderr, NO, fmt, ap);
  44         if (errno && noerrno == NO) {
  45                 s = strerror(errno);
  46                 tfc_esay(": %s", s);
  47         }
  48         else tfc_esay("\n");
  49
  50         va_end(ap);
  51
  52         if (nostats == NO) print_crypt_status(-1);
  53
  54 _ex:
  55         if (noexit == YES) {
  56                 errno = 0;
  57                 return;
  58         }
  59
  60         xexit(2);
  61 }
  62
  63 void xexit(int status)
  64 {
  65         memset(srcblk, 0, sizeof(srcblk));
  66         memset(dstblk, 0, sizeof(dstblk));
  67
  68         memset(key, 0, sizeof(key));
  69         memset(ctr, 0, sizeof(ctr));
  70         memset(mackey, 0, sizeof(mackey));
  71         memset(xtskey, 0, sizeof(xtskey));
  72         memset(tweak, 0, sizeof(tweak));
  73         memset(&sk, 0, sizeof(struct skein));
  74         memset(&tfe, 0, sizeof(struct tfe_stream));
  75
  76         tfc_finirandom();
  77
  78         memset(macvrfy, 0, sizeof(macvrfy));
  79         memset(macresult, 0, sizeof(macresult));
  80
  81         memset(tmpdata, 0, sizeof(tmpdata));
  82         memset(&getps, 0, sizeof(struct getpasswd_state));
  83         memset(pwdask, 0, sizeof(pwdask));
  84         memset(pwdagain, 0, sizeof(pwdagain));
  85
  86         exit(status);
  87 }
  88
  89 void usage(void)
  90 {
  91         tfc_yesno is_embedded_prog = NO;
  92
  93         if (optopt == 'V') {
  94                 char shash[64];
  95                 tfc_say("tfcrypt toolkit, version %s.", _TFCRYPT_VERSION);
  96                 hash_defaults(shash, sizeof(shash));
  97                 tfc_say("Defaults hash: %s", shash);
  98                 memset(shash, 0, sizeof(shash));
  99                 xexit(0);
 100         }
 101
 102         if ((strlen(progname) <= 9)
 103         && ((!strcmp(progname, "sksum"))
 104         || ((!memcmp(progname, "sk", 2))
 105         && (!memcmp(progname+3, "sum", 3)
 106         || !memcmp(progname+4, "sum", 3)
 107         || !memcmp(progname+5, "sum", 3)
 108         || !memcmp(progname+6, "sum", 3))))) {
 109                 is_embedded_prog = YES;
 110                 tfc_say("usage: %s [-AW] [-D BITS] [-n TURNS] [-l length] [-c <file>] [-U <file>] [source] ...", progname);
 111                 tfc_say("\n");
 112                 tfc_say("%s: calculate and print Skein hashsum of stream.", progname);
 113                 tfc_say("  -D BITS: specify bits as it was skBITSsum.");
 114                 tfc_say("  -n TURNS: number of turns to perform in Skein function.");
 115                 tfc_say("    sksum defaults to just one in all modes.");
 116                 tfc_say("  -A: format checksum in base64 rather than in binary hex.");
 117                 tfc_say("  -W: output raw binary checksum and remove filename(s) from output.");
 118                 tfc_say("  -H: output small hexdump (hex string and ASCII printable characters).");
 119                 tfc_say("  -l length: read only these first bytes of source.");
 120                 tfc_say("  -c <file>: read hashes list from file and check them.");
 121                 tfc_say("  -U <file>: read Skein MAC key from file.");
 122                 tfc_say("multiple sources can be given in cmdline, and if one of");
 123                 tfc_say("them is specified as \"-\", then reads are performed from stdin.");
 124                 tfc_say("\n");
 125         }
 126         else if (!strcmp(progname, "base64")) {
 127                 is_embedded_prog = YES;
 128                 tfc_say("usage: %s [-ed] [source] [output]", progname);
 129                 tfc_say("\n");
 130                 tfc_say("tfcrypt embedded base64 encoder/decoder.");
 131                 tfc_say("  -e: encode stream into base64.");
 132                 tfc_say("  -d: decode base64 stream.");
 133                 tfc_say("no error checking is performed.");
 134                 tfc_say("\n");
 135         }
 136         else if (!strcmp(progname, "tfbench")) {
 137                 is_embedded_prog = YES;
 138                 tfc_say("usage: %s seconds", progname);
 139                 tfc_say("do an in-memory random data benchmark of Threefish.");
 140                 tfc_say("\n");
 141         }
 142
 143         if (is_embedded_prog) {
 144                 tfc_say("This program is physical part of tfcrypt toolkit.");
 145                 tfc_say("(see it's version with %s -V)", progname);
 146                 tfc_say("Please note that other tfcrypt options are either ignored there,");
 147                 tfc_say("or result of using them is undefined and it's not a bug.");
 148
 149                 xexit(1);
 150         }
 151
 152         tfc_say("usage: %s [opts] [--] [key] [source] [output]", progname);
 153         tfc_say("\n");
 154         tfc_say("tfcrypt toolkit: encrypt streams with Threefish in CTR mode,");
 155         tfc_say("calculate and check Skein hashsums, generate CSPRNG quality random data,");
 156         tfc_say("convert encrypted data into ASCII format to ease transmission.");
 157         tfc_say("\n");
 158         tfc_say("  -e, -d: encrypt, decrypt (it maybe required).");
 159         tfc_say("  -L <file>: load tfcrypt defaults from file.");
 160         tfc_say("    defaults is text file which defines salt, nr_turns and default mode.");
 161         tfc_say("  -s <file>: load tfcrypt salt from file.");
 162         tfc_say("  -s disable: disable key salting at all.");
 163         tfc_say("  -p: instead of using key, ask for password.");
 164         tfc_say("  -k: use raw (%u byte) key instead of deriving it from arbitrary data.", TFC_U(TF_KEY_SIZE));
 165         tfc_say("  -z: ask for key in plain C string form through password asker.");
 166         tfc_say("  -x: ask for key in hex string form through password asker.");
 167         tfc_say("  -K <file>: generate key from keyfile or password and write it to file.");
 168         tfc_say("  -t <file>: use (raw) tweak from file.");
 169         tfc_say("  -w: overwrite source file. If not file, ignored.");
 170         tfc_say("  -n TURNS: number of turns to perform in Skein function.");
 171         tfc_say("    Default is always defined when building tfcrypt.");
 172         tfc_say("  -C mode: mode of operation: CTR, STREAM, XTS, ECB, CBC, OCB.");
 173         tfc_say("    Default encryption mode can be changed when building tfcrypt.");
 174         tfc_say("  -c opt: initial CTR value initialisation mode:");
 175         tfc_say("    show: do default action, then dump CTR value to stderr,");
 176         tfc_say("    head: when decrypting, read CTR from beginning of stream,");
 177         tfc_say("    rand: generate random CTR and write it to beginning of stream,");
 178         tfc_say("    zero: assume zero CTR is used, do not read from and write it to stream,");
 179         tfc_say("    hexc:nr[,hexc:nr,...]: construct counter from given pattern.");
 180         tfc_say("      Example: \"ff:124,08:2,80:2\" will fill counter first with 124 0xff bytes,");
 181         tfc_say("      then with 2 0x08 bytes, then 2 0x80 bytes. To fill with zeroes, it is");
 182         tfc_say("      simple to specify just a \"0:128\" as a pattern. Note that bytes that");
 183         tfc_say("      exceed CTR space will be just dropped, and any unused bytes are set to zeroes.");
 184         tfc_say("    <file>: read CTR from given file (both when encrypting/decrypting).");
 185         tfc_say("      default is to derive CTR from user provided password or keyfile with");
 186         tfc_say("      a single Skein function turn over derived, %u byte raw key", TFC_U(TF_KEY_SIZE));
 187         tfc_say("  -q: always be quiet, never tell anything (except when signaled).");
 188         tfc_say("  -v: print number of read and written encrypted bytes, and explain stages.");
 189         tfc_say("  -V seconds: activate timer that will repeatedly print statistics to stderr.");
 190         tfc_say("  -a: shortcut of -O xtime.");
 191         tfc_say("  -r <file>: specify random source instead of /dev/urandom.");
 192         tfc_say("  -R nr_bytes: generate nr_bytes of random bytes suitable for use as key data.");
 193         tfc_say("    -R also supports these aliases specified instead of nr_bytes:");
 194         tfc_say("    cbs: output fixed maximum crypt block size (%u bytes),", TFC_U(TF_BLOCK_SIZE));
 195         tfc_say("    ks: output fixed maximum crypt key size (%u bytes)", TFC_U(TF_KEY_SIZE));
 196         tfc_say("    xks: output fixed maximum crypt XTS key size (%u bytes)", TFC_U(TF_KEY_SIZE*2));
 197         tfc_say("    iobs: output %s builtin block size TFC_BLKSIZE (%u bytes),", progname, TFC_U(TFC_BLKSIZE));
 198         tfc_say("    if nr_bytes is not a valid number or alias, this string will be");
 199         tfc_say("    used to attempt to open it as file, and examine it's size.");
 200         tfc_say("    Then this examined size will be set as nr_bytes to output.");
 201         tfc_say("  -Z nr_bytes: like -R, but emit zero stream instead of random.");
 202         tfc_say("  -D MACBITS: specify bit width of a MAC signature.");
 203         tfc_say("  -U key/pwd/<file>: read Skein MAC key from file.");
 204         tfc_say("    key: use primary encryption rawkey as a MAC key.");
 205         tfc_say("    pwd: ask for password string that will be used as MAC key.");
 206         tfc_say("  -S MAC: append MAC signature to end of file:");
 207         tfc_say("    MAC: embed MAC signature into file itself at the end,");
 208         tfc_say("    <file>: write a detached MAC signature into separate <file>,");
 209         tfc_say("    -: write a detached MAC signature to stdout.");
 210         tfc_say("    useful only with variable length files! For block devices,");
 211         tfc_say("    specify a separate file name to save signature to: -S file.");
 212         tfc_say("  -A: format raw binary data, like MAC signature or Skein hash, in base64.");
 213         tfc_say("  -W: output pure binary data, and disable any strings addition in Skein.");
 214         tfc_say("  -H: output small hexdump (hex string and ASCII printable characters).");
 215         tfc_say("  -M MAC: verify attached MAC signature when decrypting a file:");
 216         tfc_say("    MAC: embed MAC signature into file itself at the end,");
 217         tfc_say("    <file>: write a detached MAC signature into separate <file>,");
 218         tfc_say("    -: read a detached MAC signature from stdin,");
 219         tfc_say("    drop: do not verify attached MAC, if any, and drop it from output.");
 220         tfc_say("  -m: just verify MAC provided with -M. Do not write output file.");
 221         tfc_say("    This option must be specified after -M.");
 222         tfc_say("  -E how: how to behave on I/O errors (both src or dst):");
 223         tfc_say("    exit: print error if not quiet, then exit,");
 224         tfc_say("    cont: print error if not quiet, then continue,");
 225         tfc_say("      no action to pad missing data is attempted.");
 226         tfc_say("      may be dangerous when working with block devices.");
 227         tfc_say("    sync: print error if not quiet, then continue,");
 228         tfc_say("      pad missing data block with zeroes.");
 229         tfc_say("    lsync: same as sync, but does not use SEEK_SET logic,");
 230         tfc_say("      lsync uses only relative seek operations, and does not prequery");
 231         tfc_say("      the current file position for exact offsets, which maybe unsafe.");
 232         tfc_say("      For this reason, it is HIGHLY recommended to use sync instead!");
 233         tfc_say("      Note that both sync and lsync work only with read errors!");
 234         tfc_say("  default error action is exit with printing status if not quiet.");
 235         tfc_say("  -E xall: turn on error actions above for all errors, not just EIO errors.");
 236         tfc_say("  -E xseek: ignore positioning and other seek related errors.");
 237         tfc_say("    Multiple -E specifiers may be given in separate options.");
 238         tfc_say("  -O opts: set options (comma separated list):");
 239         tfc_say("    sync: request a synchronous I/O for a output,");
 240         tfc_say("    fsync: on each write() call a corresponding fsync(fd),");
 241         tfc_say("    trunc: open(O_WRONLY) will truncate output file to zero size.");
 242         tfc_say("    pad: pad incomplete (l.t. %u bytes) block with zeroes.", TFC_U(TF_BLOCK_SIZE));
 243         tfc_say("    xtime: copy timestamps from source to destination files.");
 244         tfc_say("    gibsize: use SI units of size: 1k = 1000. Applies only to size prefixes.");
 245         tfc_say("    Computers convention is to use 1024, whereas SI/hdd measure in 1000.");
 246         tfc_say("    plainstats: force status line to be plain: no fancy dynamic stuff.");
 247         tfc_say("    Dynamic line works well only on VT100 compatible ttys, and");
 248         tfc_say("    when the whole status line width is smaller than tty width.");
 249         tfc_say("    statless: emit less information in status line (only processed data).");
 250         tfc_say("    norepeat: do not ask for any possible password confirmations.");
 251         tfc_say("    showsecrets: show passwords in plaintext instead of masking them.");
 252         tfc_say("    prompt=str: set main password prompts to this string.");
 253         tfc_say("    macprompt=str: set MAC password prompts to this string.");
 254         tfc_say("    shorthex: with -H, do not print printable characters, dump only hex string.");
 255         tfc_say("    iobs=val: set IO block size value. Must not exceed %u bytes.", TFC_U(TFC_BLKSIZE));
 256         tfc_say("    xtsblocks=val: use these nr of TF blocks per XTS block. Default is %u.", TFC_U(TFC_XTSBLOCKS));
 257         tfc_say("    iseek=val: seek source file/device by these val bytes.");
 258         tfc_say("    Initial counter is adjusted automatically.");
 259         tfc_say("    ixseek=val: rawseek source file/device by these val bytes.");
 260         tfc_say("    Do not adjust initial counter automatically.");
 261         tfc_say("    ictr=val: Increment initial counter by this val blocks.");
 262         tfc_say("    The size of each block is %u bytes.", TFC_U(TF_BLOCK_SIZE));
 263         tfc_say("    ictr option is valid only for CTR and CTR like modes.");
 264         tfc_say("    ixctr=val: Increment initial counter by this val bytes.");
 265         tfc_say("    Internally this number is translated into number of %u byte blocks.", TFC_U(TF_BLOCK_SIZE));
 266         tfc_say("    oseek=val: seek destination file/device by these val bytes.");
 267         tfc_say("    count=val: process only these val bytes, both input and output.");
 268         tfc_say("    ftrunc=val: truncate output file to these val bytes before closing it.");
 269         tfc_say("    xkey=val: take only val bytes from user keyfile.");
 270         tfc_say("    okey=val: seek the key before reading it (usually a device).");
 271         tfc_say("    xctr=val: specify size in bytes of initial counter prepended or read.");
 272         tfc_say("    fullkey: occupy tweak space by key space, extending key size by 256 bits.");
 273         tfc_say("  -P: plain IO mode: disable encryption/decryption code at all.");
 274         tfc_say("\n");
 275         tfc_say("Default is to ask for password, then encrypt stdin into stdout.");
 276         tfc_say("Some cmdline parameters may be mutually exclusive, or they can");
 277         tfc_say("generate errors or behave abnormally. Please understand that some");
 278         tfc_say("dumb mode error checking may be not performed well, and please read");
 279         tfc_say("the README included within package and this help text carefully.");
 280         tfc_say("\n");
 281
 282         xexit(1);
 283 }