Testing differences between opening a file and using $(cmd)

[signduterre.git] / signduterre.py

#!/usr/bin/python3.0
#
# ToC
# 1. DOCUMENTATION
# 2. IMPORT & INITIALIZATION
# 3. OPTION HANDLING
# 4. ARGUMENT PROCESSING
# 5. SIGNATURE CREATION AND CHECKING

#############################################################################
#                                                                           #
#               DOCUMENTATION                                               #
#                                                                           #
#############################################################################

manual = """
[[[!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"]]][[[html]]][[[header]]][[[title]]]Signature-du-Terroir[[[/title]]][[[/header]]][[[body]]][[[h1]]]Signature-du-Terroir[[[/h1]]][[[p]]]
Construct a signature of the installed software state or check the integrity of the installation
using a previously made signature.
[[[/p]]][[[p]]]
Usage: signduterre.py [options] FILE1 FILE2 ...
[[[/p]]][[[p]]]
Options:[[[/p]]][[[pre]]]
  -h, --help            show this help message and exit
  -s HEX, --salt=HEX    Enter salt in cleartext. If not given, a hexadecimal
                        salt will be suggested. The SUGGESTED[=N] keyword will
                        cause the selection of the suggested string. N is the
                        number of salts generated (default N=1). If N>1, all
                        will be printed and a random one will be used to
                        generate the signature (selection printed to STDERR).
  -a, --all-salts-pattern
                        Use all salts in sequence, randomly replace salts with
                        incorrect ones in the output to create a pattern of
                        failing hashes indicated by a corresponding integer
                        number. Depends on '--salt SUGGESTED=N'.
                                                Implies --total-only.
  -p TEXT, --passphrase=TEXT
                        Enter passphrase in cleartext, the keyword
                        SUGGESTED[=N] will cause the suggested passphrase to
                        be used. If N>1, N passphrases will be printed to
                        STDERR and a random one will be used (selection
                        printed to STDERR). Entering the name of an existing
                        file (or '-' for STDIN) will cause it to be read and a
                        random passphrase found in the file will be used
                        (creating a signature), or they will all be used in
                        sequence (--check-file).
  -c FILE, --check-file=FILE
                        Check contents with the output of a previous run from
                        file or STDIN ('-'). Except when the --quiet option is
                        given, the previous output will contain all
                        information needed for the program, but not the
                        passphrase and the --execute option.
  -i FILE, --input-file=FILE
                        Use names from FILE or STDIN ('-'), use one
                        filename per line
  -o FILE, --output-file=FILE
                        Print to FILE instead of STDOUT
  -P FILE, --Private-file=FILE
                        Print private information (passwords etc.) to FILE
                        instead of STDERR
  -u USER, --user=USER  Execute $(cmd) as USER, default 'nobody' (root/sudo
                        only)
  -S, --Status          For each file, add a line with unvarying file status
                        information: st_mode, st_ino, st_dev, st_uid, st_gid,
                        and st_size (like the '?' prefix, default False)
  --Status-values=MODE  Status values to print for --Status, default MODE is
                        'fmidlugs' (file, mode, inode, device, uid, gid, size). 
                                                Also available (n)l(inks), a(time), (m)t(ime), and 
                                                c(time).
  -t, --total-only      Only print the total hash, unsets --detailed-view
                        (default True)
  -d, --detailed-view   Print hashes of individual files, is unset by --total-
                        only (default False)
  -e, --execute         Interpret $(cmd) (default False)
  --execute-args=ARGS   Arguments for the $(cmd) commands ($1 ....)
  -n, --no-execute      Explicitely do NOT Interpret $(cmd)
  --print-execute       Print the results of $() command execution to STDERR
                        for debugging purposes
   -m, --manual          Print the manual and exit
  --manual-html         Print the manual in HTML format and exit
  --manual-make         Print the examples in the manual as a makefile and
                        exit
  -r, --release-notes   Print the release notes and exit
  -l, --license         Print license text and exit
  -v, --verbose         Print more information on output
  -q, --quiet           Print minimal information (hide filenames). If the
                        output is used with --check-file, the command line
                        options and arguments must be repeated.
[[[/pre]]][[[p]]]
FILE1 FILE2 ...
Names and paths of one or more files to be checked. All file arguments in SdT accept '-' as the STDIN file
(ie, piped data).
[[[/p]]][[[p]]]
Any name starting with a '$', eg, $PATH, will be interpreted as an environmental variable or a command 
according to the bash conventions: '$ENV' and '${ENV}' as variables, '$(cmd;cmd...)' as system commands 
(bash --restricted -c 'cmd;cmd...' PID). Where PID the current Process ID is (available as positional 
parameter $0). Other parameters can be entered with the --execute-args option ($1 etc). Do not forget to 
enclose the arguments in single ''-quotes! The commands are scanned for unwanted characters and these 
are removed (eg, ' and \\, however, escaping $ is allowed, eg, '\\$1'). The use of '$(cmd;cmd...)' 
requires explicit use of the -e or --execute option.
[[[/p]]][[[p]]]
If executed as root or sudo, $(cmd;cmd...) will be executed as 'sudo -H -u <user>' which defaults to
--user nobody ('--user root' is at your own risk). This will obviously not work when invoked as non-root/sudo.
--user root is necessary when you need to check privileged information, eg, you want to check the MBR with 
'$(dd if=/dev/hda bs=512 count=1 status=noxfer | od -X)'
However, as you might use --check-file with files you did not create yourself, it is important to
be warned if commands are to be executed.
[[[/p]]][[[p]]]
Interpretation of $() ONLY works if the -e or --execute options are entered. signduterre.py can easily 
be adapted to automatically use the setting in the check-file. However, this is deemed insecure and 
commented out in the distribution version.
[[[/p]]][[[p]]]
The -n or --no-execute option explicitely supress the interpretation of $(cmd) arguments.
[[[/p]]][[[p]]]
Meta information from stat() on files is signed when the filename is preceded by a '?'. '?./signduterre.py' will 
extract (st_mode, st_ino, st_dev, st_nlinks, st_uid, st_gid, st_size) and hash a line of these data (visible 
with --verbose). The --Status option will automatically add such a line in front of every file. Note that '?' 
is implied for directories. Both '/' and '?/' produce a hash of, eg,: 
[[[/p]]][[[pre]]]
stat(/) = [st_mode=041775, st_ino=2, st_dev=234881026, st_uid=0, st_gid=80, st_size=1360]
[[[/pre]]][[[p]]]
The --Status-values=<mode> option selects which status values will be used: f(ile), m(ode), i(node), 
d(evice), u(id), g(id), s(ize), (n)l(inks), a(time), (m)t(ime), and c(time). Default is 
--Status-values='fmidugs'. Note that nlinks of a directory include every file in the directory, so this 
option can check whether files have been added to a directory.
[[[/p]]][[[p]]]
Arguments enclosed in []-brackets will be hidden in the output. That is, '[/proc/self/exe]' will show up as
'[1]' in the output (or '[n]' with n the number of the hidden argument), equivalent to the use of the 
--quiet option. This means the hidden arguments must be entered again when using the --check-file (-c) 
option.
[[[/p]]][[[p]]]
Signature-du-Terroir
[[[/p]]][[[p]]]
A very simple tool to generate a signature that can be used to test the integrity of files and "states" in 
a running installation. signduterre.py constructs a signature of the current system state and checks 
installation state with a previously made signature. The files are hashed with a passphrase to allow detection 
of compromised systems while running on the same system. The signature checking can be subverted, but the 
flexibillity of signduterre.py and the fact that the output of any command can be tested should hamper 
automated root-kit attacks.
[[[/p]]][[[p]]]
signduterre.py writes a total SHA-256 hash to STDOUT of all the files and commands entered as arguments. It 
can also write a hash for each individual file (insecure). The output of a signature can be send to a file and 
later used to check with --check-file. Hashes are calculated with a hashed salt + passphrase sequence 
pre-pended to create unpredictable hashes. This procedure ensures that an attacker does not know whether or 
not the correct passphrase has been entered. An attacker can only know when to supply the requested hash 
values if she knows the passphrase or has copies available of all the tested files and output of commands to 
calculate the hashes on the fly.
[[[/p]]][[[p]]]
The Problem
[[[/p]]][[[p]]]
How to test whether your system has been compromised when you can only use the potentially compromised system.
The solution is to store a password encrypted signature (or fingerprint) of your system when you are sure it 
is in a good state. Then you check whether the system can still distinguish between correct and incorrect passwords
when it regenerates the signature. The trick is to use the right data (ie, questions) to generate the signature.
[[[/p]]][[[p]]]
SECURITY
[[[/p]]][[[p]]]
When run on a compromised system, signduterre.py can be subverted if the attacker keeps a copy of all the 
files and command outputs, and reroutes the open() and stat() functions, or simply delegating signduterre.py 
to a chroot jail with the original system. In principle, signduterre.py only checks whether the computer 
responds identically to when the signature file was made. There is no theoretic barrier against a compromised 
computer perfectly simulating the original system when tested, but behaving adversely at other times. Except 
for running from clean boot media (USB?), I know of no theoretical sound solution to this problem.
[[[/p]]][[[p]]]
However, this scenario assumes the use of unlimited resources and time. Inside a limited, real computer system, 
the attacker must make compromises on what can and what cannot be simulated with the available time and 
hardware. The idea behind signduterre.py is to "ask difficult questions" that increase the cost of simulating 
the original system high enough to make detection of successful attacks likely.signduterre.py simply intends 
to raise the bar high enoug. One point is to store the times needed to create the original hashes. This timing 
can later be used to see whether the new timings are reasonable. If the same hardware takes considerably 
longer to perform the same calculations, or needs a much longer delay before it starts, the tester might want 
to see where this time is spent.
[[[/p]]][[[p]]]
Signature-du-Terroir works on the assumption that any attacker in control of a compromised system cannot
predict whether the passphrase entered is correct or not. An attacker can always intercept the in- and output 
of signduterre. When running with --check-file, this means the program can be made to print out OK 
irrespective of the tests. A safe use of signduterre.py is to start with a random number of incorrect 
passphrases and see whether they fail. Alternatively, and easier, is to add a number of unused salts
to the check-file and let the attacker guess which one is correct.
[[[/p]]][[[p]]]
THE CORRECT USE OF signduterre.py IS TO ENTER A RANDOM NUMBER OF INCORRECT PASSPHRASES OR SALTS FOR EACH 
TEST AND SEE WHETHER IT FAILS AT THE CORRECT INSTANCES!
[[[/p]]][[[p]]]
On a compromised system, signduterre.py's detailed file testing (--detailed-view) is easily subverted. With a 
matched file hash, the attacker will know that the correct passphrase has been entered and can print out the 
stored hashes or 'ok's  for the rest of the checks. So if the attacker keeps any entry in the signature file 
uncompromised, she can intercept the output, test the password on the unchanged entry and substitute the 
requested hashes for the output if the hash of that entry matches. 
[[[/p]]][[[p]]]
When checking for root-kits and other malware, it is safest to compare the signature files from a different, 
clean, system. But then you would not need signduterre.py anyway. If you have to work on the system itself, 
only use the -t or --total-only options to create signatures with a total hash and without individual file 
hashes. Such a signature can be used to check whether the system is unchanged. Another signature file WITH A 
DIFFERENT PASSPHRASE can then be used to identify the individual files that have changed. If a detailed 
signature file has the same passphrase, an attacker could use that other file to read the individual file 
hashes to check whether the correct passphrase was entered.
[[[/p]]][[[p]]]
Using the --check-file option in itself is UNsafe. An attacker simply has to print out 'OK' to defeat the 
check. This attack can be foiled by making it unpredictable when signduterre.py should return 'OK'. This can 
be done by using a list of salts or passphrases where only one of them (or none!) is correct. Any attacker 
will have to guess when to return 'OK'.
[[[/p]]][[[p]]]
As generating and entering wrong passphrases and salts is tedious, users have to be supported in correct use 
of SdT. To assist users, the '--salt SUGGESTED=<N>' option will generate a number N of salts. When 
checking, each of these salts is tried in turn. An attacker that is unable to simulate the uncompromised 
system will have to guess which one of the salts is the correct one, and whether or not the passphrase 
is correct. This increases the chances of detecting compromised systems. If this is not enough guess
work, the '-a', '--all-salts-pattern' option will use all salts in sequence to generate total hashes,
but random salts will be changed in the output. This generates a pattern of failed salt tests. This pattern
is translated into a bit pattern and printed as an integer ([Fail, Fail, OK, Fail, OK, OK, Fail, OK]
= 00101101 (least significant first) = 10110100 (unsigned bin) = 180). On creation of a signature, this 
number is printed to STDERR, on checking (--check-file) it is printed to STDOUT (note that the number
will never become 0 or all Fail). So for '--salt SUGGESTED=<N> --all-salts-pattern' the probability of 
guessing the correct output goes from 1/N to 1/(2^N - 1). Note that '--all-salts-pattern' will work, 
but is pointless, without '--salt SUGGESTED=<N>' with N>1.
[[[/p]]][[[p]]]
The '--passphrase SUGGESTED=N' option will generate and print N passphrases. One of these is chosen at 
random for the signature. The number of the chosen passphrase is printed on STDERR with the passwords. 
When checking a file, the stored passphrases can be read in again, either by entering the passphrase 
file after the --passphrase option ('--passphrase <passphrase file>'), or directly from the --check-file. 
signduterre.py will print out the result for each of the passphrases. 
[[[/p]]][[[p]]]
Note, that storing passphrases in a file and feeding it to signduterre.py is MUCH less secure than just 
typing them in. Moreover, it might completely defeat the purpose of signduterre.py. If future experiences 
cast any more doubt on the security of this option, it will be removed. 
[[[/p]]][[[p]]]
For those who want to know more about what an "ideal attacker" can do, see:[[[br]]]
Ken Thompson "Reflections on Trusting Trust"[[[br]]]
[[[a href="http://cm.bell-labs.com/who/ken/trust.html"]]]http://cm.bell-labs.com/who/ken/trust.html[[[/a]]][[[br]]]
[[[a href="http://www.ece.cmu.edu/~ganger/712.fall02/papers/p761-thompson.pdf"]]]http://www.ece.cmu.edu/~ganger/712.fall02/papers/p761-thompson.pdf[[[/a]]]
[[[/p]]][[[p]]]
David A Wheeler "Countering Trusting Trust through Diverse Double-Compiling"[[[br]]]
[[[a href="http://www.acsa-admin.org/2005/abstracts/47.html"]]]http://www.acsa-admin.org/2005/abstracts/47.html[[[/a]]]
[[[/p]]][[[p]]]
and the discussion of these at Bruce Schneier's 'Countering "Trusting Trust"'[[[br]]]
[[[a href="http://www.schneier.com/blog/archives/2006/01/countering_trus.html"]]]http://www.schneier.com/blog/archives/2006/01/countering_trus.html[[[/a]]]
[[[/p]]][[[p]]]
Manual
[[[/p]]][[[p]]]
The intent of signduterre.py is to ensure that the signature cannot be subverted even if the system has been 
compromised by an attacker that has obtained root control over the computer and any existing signature files.
[[[/p]]][[[p]]]
signduterre.py asks for a passphrase which is PRE-pended to every file before the hash is constructed (unless 
the passphrase is entered with an option). As long as the passphrase is not compromised, the hashes cannot 
be reconstructed. A randomly generated, unpadded base-64 encoded 16 Byte password (ie, ~22 characters) is 
suggested in interactive use. If '--passphrase SUGGESTED' is entered on the command line or no passphrase is
enetered when asked, the suggested value will be used. This value is printed to STDERR (the screen or 2) for 
safe keeping. Please, make sure you store the printed passphrase. For instance:
[[[/p]]][[[pre make=example]]]
#
# Simple system sanity test using the 'which' command to establish the paths
$ python3.0 signduterre.py --passphrase SUGGESTED --salt SUGGESTED --detailed-view \\
`which python3.0 bash ps ls find stat` 2> test-20090630_11-14-03.pwd > test-20090630_11-14-03.sdt
$ python3.0 signduterre.py --passphrase test-20090630_11-14-03.pwd --check-file test-20090630_11-14-03.sdt
[[[/pre]]][[[p]]]
The first command will store the passphrase (and all error messages) in a file 'Signature_20090630_11-14-03.pwd'
and the check-file in 'Signature_20090630_11-14-03.sdt'. The second line will test the signature.
The signature will be made of the files used for the commands python3.0, bash, ps, ls, find, and stat.
These files are found using the 'which' command.
[[[/p]]][[[p]]]
It is not secure to store files with the passphrase on the system you want to check. However, you could
pipe STDERR or --Private-file to some safe site.
[[[/p]]][[[p]]]
Good passphrases are difficult to remember, so their plaintext form should be protected. To protect the 
passphrase against rainbow and brute force attacks, the passphrase is concatenated to a salt phrase and 
hashed before use (SHA-256). 
[[[/p]]][[[p]]]
The salt phrase is requested when constructing a signature. In interactive use, an 8 byte hexadecimal 
(= 16 character) salt from /dev/urandom is suggested. If '--salt SUGGESTED' is entered on the command line
as the salt, the suggested value will be used. The salt is printed in plaintext to the output. The salt will 
make it more difficult to determine whether the same passphrase has been used to create different signatures.
[[[/p]]][[[p]]]
At the bottom, a 'TOTAL HASH' line will be printed that hashes all the lines printed for the files. This 
includes the file names as printed on the hash lines. It is not inconceivable that existing signature files 
could have been compromised in ways that might be missed when checking the signature. The total hash will 
point out such changes.
[[[/p]]][[[p]]]
Examples:[[[/p]]][[[pre make=example]]]
# 
# Self test of root directory, python, and signduterre.py using the 'which' command to establish the paths
$ python3.0 signduterre.py --detailed-view --salt 436a73e3 --passphrase liauwefa3251EWC -o test-self.sdt \\
 / `which python3.0 signduterre.py`
$ python3.0 signduterre.py --passphrase liauwefa3251EWC -c test-self.sdt
[[[/pre]]][[[p]]]
Write a signature to the file test-self.sdt and test it with the --check-file option. The signature contains 
the SHA-256 hashes of the files, /usr/bin/python3.0, signduterre.py, and the status information on the root 
directory. The salt '436a73e3' and passphrase 'liauwefa3251EWC' are used.
[[[/p]]][[[pre make=linux]]]
# 
# Self test of root directory, python, and signduterre.py using the the /proc file system
$ python3.0 signduterre.py --detailed-view --salt SUGGESTED --passphrase liauwefa3251EWC -o test-self_proc.sdt \\
 /proc/self/root /proc/self/exe `which signduterre.py`
$ python3.0 signduterre.py --passphrase liauwefa3251EWC --check-file test-self_proc.sdt
[[[/pre]]][[[p]]]
Write a signature to the file test-self_proc.sdt and test it with the --check-file option. The signature 
contains the SHA-256 hashes of the same files as above, /usr/bin/python3.0, signduterre.py, and the status 
information on the root directory. However, the python executable and the root directory are now accessed
through the /proc file system. The suggested salt is used (written to test-self_proc.sdt) and the passphrase 
is (again) 'liauwefa3251EWC'.
[[[/p]]][[[pre make=example]]]
# 
# Test of supporting commands for chkrootkit
$ python3.0 signduterre.py --execute --total-only --salt SUGGESTED=8 --passphrase SUGGESTED --Status \\
  --output-file=test-chkrootkit.sdt --Private-file=test-chkrootkit.pwd \\
  signduterre.py `which bash awk cut egrep find head id ls netstat ps strings sed uname`
$ python3.0 signduterre.py --execute --passphrase test-chkrootkit.pwd --check-file test-chkrootkit.sdt
[[[/pre]]][[[p]]]
Writes a signature of the requested files to test-chkrootkit.sdt (signature) and private information to 
test-chkrootkit.pwd (password and selected salt) and checks it in the next line. The files are those of 
commands required by the chkrootkit program (http://www.chkrootkit.org/), with bash added. The 'which' 
command will give the paths for the commands. Eight salts are generated, of which only 1 is actually 
used. When checking, the correct salt should match. This prevents a compromised program from simply 
printing out OK tot he check. A more comprehensive evation of guessing the correct salt can be obtained
by using the '--all-salts-pattern' option.
[[[/p]]][[[pre make=linux]]]
# 
# Simply lump all "system" files, the PATH environment variable and the first 2 columns of the output of lsmod
$ python3.0 signduterre.py --execute --detail --salt SUGGESTED --passphrase liauwefa3251EWC --Status --total-only \\
  signduterre.py /sbin/* /bin/* /usr/bin/find /usr/bin/stat /usr/bin/python* '${PATH}' \\
  '$(lsmod | awk "{print \$1, \$2}")' > test-20090625_14-31-54.sdt
# 
# Failing check due to missing --execute option
$ python3.0 signduterre.py --passphrase liauwefa3251EWC -c test-20090625_14-31-54.sdt
$ python3.0 signduterre.py --passphrase liauwefa3251EWC -c test-20090625_14-31-54.sdt --no-execute
# 
# Successful check
$ python3.0 signduterre.py --execute --passphrase liauwefa3251EWC --check-file test-20090625_14-31-54.sdt
[[[/pre]]][[[p]]]
Prints a signature to the system test-20090625_14-31-54.sdt and the automatically generated password to 
test-20090625_14-31-54.pwd. The salt will be automatically determined. The signature contains the SHA-256 
hashes of the file status and file contents of signduterre.py, /sbin/*, /bin/*,  /usr/bin/find, 
/usr/bin/file, /usr/bin/python* on separate lines, and a hash of the PATH environment variable. Do not 
display the hash of every single file, which could be insecure, but only the total hash.
The first two checks will both fail if test-20090625_14-31-54.sdt contains a $(cmd) entry. 
The --no-execute option is default and prevents the execute option (if reading the execute option from the 
signature file has been activated). The last check will succeed (if the files have not been changed).
[[[/p]]][[[pre make=example]]]
# 
# Use a list of generated passphrases
$ python3.0 signduterre.py --salt SUGGESTED --passphrase SUGGESTED=20 signduterre.py \\
2> test-20090630_16-44-34.pwd > test-20090630_16-44-34.sdt
$ python3.0 signduterre.py -p test-20090630_16-44-34.pwd -c test-20090630_16-44-34.sdt
[[[/pre]]][[[p]]]
Will generate and print 20 passphrases and print a signature using one randomly chosen passphrase from these 
20. Everything is written to the files 'test-20090630_16-44-34.pwd' and 'test-20090630_16-44-34.sdt'.
Such file names can easily be generated with 'test-`date "+%Y%m%d_%H-%M-%S"`.sdt'.
The next command will check all 20 passphrases generated before from the Signature file and print the results.
[[[/p]]][[[pre make=example]]]
# 
# Use a list of generated salts with a pattern of correct salts
$ python3.0 signduterre.py --salt SUGGESTED=16 --passphrase SUGGESTED --all-salts-pattern \\
-P test-salt-pattern.pwd -o test-salt-pattern.sdt `which bash stat find ls ps id uname awk gawk perl` 
$ python3.0 signduterre.py -p test-salt-pattern.pwd -c test-salt-pattern.sdt
# Compare to salt pattern number to the one from the check-file
$ cat test-salt-pattern.pwd
[[[/pre]]][[[p]]]
[[[/p]]][[[pre make=sudo]]]
# 
# Check MBR and current root directory (sudo and root user)
$ sudo python3.0 signduterre.py -u root -s SUGGESTED -p SUGGESTED --Status-values='i' -v -e -t \\
--output-file test-boot-sector.sdt --Private-file test-boot-sector.pwd --execute-args=sda \\
'?/proc/self/root' `which dd` '$(dd if=/dev/$1 bs=512 count=1 status=noxfer | od -X)'
$ sudo python3.0 signduterre.py -u root -e -p test-boot-sector.pwd -c test-boot-sector.sdt
[[[/pre]]][[[p]]]
Will hash the inode numbers of the effective root directory (eg, chroot) and the executable (python) 
together with the contents of the MBR (Master Boot Record) on /dev/sda in Hex. It uses suggested salt and 
passphrase. Accessing /dev/sda is only possible when root, so the command is entered with sudo and 
--user root. Use the '--print-execute' option if you want to check the output of the dd command.
[[[/p]]][[[p]]]
The main problem with intrusion detection by comparing file contents is the ability of an attacker 
to redirect attempts to read a compromised file to a stored copy of the original. So, sha256 or 
python could be changed to read '/home/attacker/old/ps' when the argument was '/bin/ps'. This would 
foil any scheme that depends on entering file names in programs. An answer to this threat is to 
read the bytes in files in as many ways as possible. Therefor, forcing an attacker to change many 
files which itself would increase the probability of detection of the attack. The following command 
will read the same (test) file, and generate identical hashes, in 7 different ways.
[[[/p]]][[[pre make=example]]]
#
# Example generating identical signatures of the same file in different ways
$ dd if=signduterre.py 2>/dev/null | python3.0 signduterre.py -v -d -s 1234567890abcdef -p poiuytrewq \\
--execute --execute-args='signduterre.py' signduterre.py - '$(cat $1)' '$(grep "" $1)' \\
'$(awk "{print}" $1)' '$(perl -ane "{print \$_}" $1)' \\
'$(python3.0 -c "import sys;print(open(sys.argv[1]).read(),end=\\"\\")" $1;)'
[[[/pre]]][[[p]]]
These seven "commands" do not return the same bytes (awk), or any bytes at all (grep), from the file 
when used with a binary file. Especially the conversion of binary data read internally differs from 
that returned by the $(cmd) interface. That is, the arguments 
"python3.0 signduterre.py -e -d ... /bin/ps '$(cat /bin/ps)'" will generate different signatures for 
/bin/ps and '$(cat /bin/ps)'.
[[[/p]]][[[p]]]
The examples can be run as a makefile using make. Use one of the following commands:
[[[/p]]][[[pre]]]
# General examples
python3.0 signduterre.py --manual-make |make -f - example
# Linux specific examples
python3.0 signduterre.py --manual-make |make -f - linux
# Examples requiring sudo
python3.0 signduterre.py --manual-make | sudo make -f - sudo
[[[/pre]]][[[/body]]][[[/html]]]
"""
# 
license = """
Signature-du-Terroir
Construct a signature of the installed software state or check a previously made signature.

copyright 2009, R.J.J.H. van Son

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
""";
#
# Note that only release notes are put here
# See git repository for detailed change comments:
# git clone git://repo.or.cz/signduterre.git
releasenotes = """
20090730 - Release v0.4
20090724 - Added '--all-salts-pattern' and HTML formatting in manual
20090723 - Added URL support for all files. Does not yet work due to bug in Python 3.0
20090723 - Added '-' for STDIN
20090717 - Added --execute-args
20090716 - Release v0.3
20090713 - Added --quiet option
20090712 - moved from /dev/random to /dev/urandom
20090702 - Replaced -g with -p SUGGESTED[=N]
20090702 - Generating and testing lists of random salts
20090701 - Release v0.2
20090630 - Generating and testing random passphrases
20090630 - --execute works on $(cmd) only, nlinks in ?path and ? implied for directories
20090630 - Ported to Python 3.0

20090628 - Release v0.1b
20090628 - Added release-notes

20090626 - Release v0.1a
20090626 - Initial commit to Git
""";

#############################################################################
#                                                                           #
#               IMPORT & INITIALIZATION                                     #
#                                                                           #
#############################################################################

import sys;
import os;
import stat;
import subprocess;
# if sys.stdout.isatty(): import readline;
import binascii;
import hashlib;
import re;
import time;
from optparse import OptionParser;
import base64;
import random;
import struct;
import urllib.request;
import urllib.error;

# Limit the characters that can be used in $(cmd) commands
# Only allow the escape of '$'
not_allowed_chars = re.compile('([^\w\ \.\/\"\|\;\,\-\$\[\]\{\}\(\)\@\`\!\*\=\\\\]|([\\\\]+([^\$\"\\\\]|$)))');

programname = "Signature-du-Terroir";
version = "0.4";

def open_infile(filename, mode):
        if filename == '-':
                return sys.stdin;
        elif filename.find('://') > -1:
                print("URL:", filename, file=current_private);
                return urllib.request.urlopen(filename);
        else :
                if not os.path.isfile(filename):
                        print(filename, "does not exist", file=sys.stderr)
                        quit();
                return open(filename, mode);

def open_outfile(filename, mode):
        if filename == '-':
                return sys.stdout;
        elif filename.find('://') > -1:
                print("URL:", filename, file=current_private);
                return urllib.request.urlopen(filename);
        else :
                return open(filename, mode);

current_outfile = sys.stdout;
current_private = sys.stderr;

#############################################################################
#                                                                           #
#               OPTION HANDLING                                             #
#                                                                           #
#############################################################################

parser = OptionParser()
parser.add_option("-s", "--salt", metavar="HEX", 
                                  dest="salt", default=False,
                  help="Enter salt in cleartext. If not given, a hexadecimal salt will be suggested. The SUGGESTED[=N] keyword will cause the selection of the suggested string. N is the number of salts generated (default N=1). If N>1, all will be printed and a random one will be used to generate the signature (selection printed to STDERR).")
parser.add_option("-a", "--all-salts-pattern",
                  dest="allsalts", default=False, action="store_true", 
                  help="Use all salts in sequence, randomly replace salts with incorrect ones in the output to create a pattern of failing hashes indicated by a corresponding integer number. Depends on '--salt SUGGESTED=N'. Implies --total-only.")
parser.add_option("-p", "--passphrase", metavar="TEXT",
                  dest="passphrase", default=False,
                  help="Enter passphrase in cleartext, the keyword SUGGESTED[=N] will cause the suggested passphrase to be used. If N>1, N passphrases will be printed to STDERR and a random one will be used (selection printed to STDERR). Entering the name of an existing file (or '-' for STDIN) will cause it to be read and a random passphrase found in the file will be used (creating a signature), or they will all be used in sequence (--check-file).")
parser.add_option("-c", "--check-file",
                  dest="check", default=False, metavar="FILE", 
                  help="Check contents with the output of a previous run from file or STDIN ('-'). Except when the --quiet option is given, the previous output will contain all information needed for the program, but not the passphrase and the --execute option.")
parser.add_option("-i", "--input-file",
                  dest="input", default=False, metavar="FILE", 
                  help="Use names from FILE or STDIN ('-'), use one filename per line")
parser.add_option("-o", "--output-file",
                  dest="output", default=False, metavar="FILE", 
                  help="Print to FILE instead of STDOUT")
parser.add_option("-P", "--Private-file",
                  dest="private", default=False, metavar="FILE", 
                  help="Print private information (passwords etc.) to FILE instead of STDERR")
parser.add_option("-u", "--user",
                  dest="user", default="nobody", metavar="USER", 
                  help="Execute $(cmd) as USER, default 'nobody' (root/sudo only)")
parser.add_option("-S", "--Status",
                  dest="status", default=False, action="store_true", 
                  help="For each file, add a line with unvarying file status information: st_mode, st_ino, st_dev, st_uid, st_gid, and st_size (like the '?' prefix, default False)")
parser.add_option("--Status-values",
                  dest="statusvalues", default="fmidugs", metavar="MODE", 
                  help="Status values to print for --Status, default MODE is 'fmidugs' (file, mode, inode, device, uid, gid, size). Also available (n)l(inks) a(time), (m)t(ime), and c(time).")
parser.add_option("-t", "--total-only",
                  dest="total", default=False, action="store_true", 
                  help="Only print the total hash, unsets --detailed-view (default True)")
parser.add_option("-d", "--detailed-view",
                  dest="detail", default=False, action="store_true", 
                  help="Print hashes of individual files, is unset by --total-only (default False)")
parser.add_option("-e", "--execute",
                  dest="execute", default=False, action="store_true", 
                  help="Interpret $(cmd) (default False)")
parser.add_option("--execute-args",
                  dest="executeargs", default='', metavar="ARGS", 
                  help="Arguments for the $(cmd) commands ($1 ....)")
parser.add_option("-n", "--no-execute",
                  dest="noexecute", default=False, action="store_true", 
                  help="Explicitely do NOT Interpret $(cmd)")
parser.add_option("--print-execute",
                  dest="printexecute", default=False, action="store_true", 
                  help="Print the results of $() command execution to STDERR for debugging purposes")
parser.add_option("-m", "--manual",
                  dest="manual", default=False, action="store_true", 
                  help="Print the manual and exit")
parser.add_option("--manual-html",
                  dest="manualhtml", default=False, action="store_true", 
                  help="Print the manual in HTML format and exit")
parser.add_option("--manual-make",
                  dest="manualmake", default=False, action="store_true", 
                  help="Print the examples in the manual as a makefile and exit")
parser.add_option("-r", "--release-notes",
                  dest="releasenotes", default=False, action="store_true", 
                  help="Print the release notes and exit")
parser.add_option("-l", "--license",
                  dest="license", default=False, action="store_true", 
                  help="Print license text and exit")
parser.add_option("-v", "--verbose",
                  dest="verbose", default=False, action="store_true", 
                  help="Print more information on output")
parser.add_option("-q", "--quiet",
                  dest="quiet", default=False, action="store_true", 
                  help="Print minimal information (hide filenames). If the output is used with --check-file, the command line options and arguments must be repeated.")

(options, check_filenames) = parser.parse_args();


# Start with opening any non-default output files
my_output = False;
if options.output:
        current_outfile = open_outfile(options.output, 'w');
        my_output = options.output;
        
my_private = False;
if options.private:
        current_private = open_outfile(options.private, 'w');
        my_private = options.private;
        
print("# Program: "+programname + " version " + version, file=current_outfile);
print("#", time.strftime("%Y/%m/%d %H:%M:%S", time.localtime()), "("+time.tzname[0]+")\n", file=current_outfile);

# Print license
if options.license:
        print (license, file=sys.stderr);
        exit(0);
# Print manual
if options.manual:
        htmltags = re.compile('\[\[\[[^\]]*\]\]\]');
        cleartext_manual = htmltags.sub('', manual);
        print (cleartext_manual, file=sys.stdout);
        exit(0);
# Print HTML manual
if options.manualhtml:
        protleftanglesbracks = re.compile('\<');
        protrightanglesbracks = re.compile('\>');
        leftanglesbracks = re.compile('\[\[\[');
        rightanglesbracks = re.compile('\]\]\]');
        html_manual = protleftanglesbracks.sub('&lt;', manual);
        html_manual = protrightanglesbracks.sub('&gt;', html_manual);
        html_manual = leftanglesbracks.sub('<', html_manual);
        html_manual = rightanglesbracks.sub('>', html_manual);
        print (html_manual, file=sys.stdout);
        exit(0);
# Print manual examples
if options.manualmake:
        make_manual = re.sub("\$ ", "\t", manual);
        make_manual = re.sub("\#", "\t#", make_manual);
        make_manual = re.sub(r"\\\s*\n", '', make_manual);
        make_manual = re.sub(r"\$", r'$$', make_manual);
        # Protect "single" [ brackets
        make_manual = re.sub(r"(^|[^\[])\[([^\[]|$)", r"\1&#91;\2", make_manual);
        extrexamples = re.compile(r"\[\[\[pre\s+make\=?(\w*)\s*\]\]\]\n([^\[]*)\n\[\[\[/pre\s*\]\]\]", re.IGNORECASE|re.MULTILINE|re.DOTALL);
        exampleiter = extrexamples.finditer(make_manual);
        makefile_list = [];
        for match in exampleiter:
                # We had to convert any '[' in the command. Now convert them back.
                command_text = re.sub(r"\&\#91\;", '[', match.group(2));
                makefile_list.append(match.group(1)+":\n"+command_text);
        
        previous_cat = 'NOT A VALUE';
        makefile_list.sort()
        for line in makefile_list:
                (category, commands) = line.split(':\n');
                if category != previous_cat:
                        previous_cat = category;
                        print("\n"+previous_cat+":", file=sys.stdout);
                print(commands, file=sys.stdout);
        # Clean option
        print("\nclean:\n\trm test-*.sdt test-*.pwd", file=sys.stdout);
        exit(0);
# Print release notes
if options.releasenotes:
        print ("Version: "+version, file=sys.stderr);
        print (releasenotes, file=sys.stderr);
        exit(0);

my_salt = options.salt;
my_allsalts = options.allsalts;
my_passphrase = options.passphrase;
my_check = options.check;
my_status = options.status;
my_statusvalues = options.statusvalues;
my_verbose = options.verbose and not options.quiet;
my_quiet = options.quiet;
execute = options.execute;
execute_args = options.executeargs;
if options.noexecute: execute = False;
input_file = options.input;

# Set total-only with the correct default
total_only = True;
total_only = not options.detail;
if options.total: total_only = options.total;
if my_allsalts: total_only = my_allsalts; # All alts pattern only sensible with total-only
if my_check: total_only = False;

my_user = options.user;
# Things might be executed as another user
user_change = '';
if os.getuid() == 0:
        user_change = 'sudo -H -u '+my_user+' ';
        if not my_quiet: print("User: "+my_user, file=current_outfile);

# Execute option
if execute:
        text_execute = "True";
else:
        text_execute = "False";

if execute and not my_quiet: 
        print("Execute system commands: "+text_execute+"\n", file=current_outfile);
        if execute_args != '': print("Execute arguments: '"+execute_args+"'\n", file=current_outfile);

# --quiet option
if my_quiet: print("Quiet: True\n", file=current_outfile);

# --quiet option
if my_statusvalues != 'fmidlugs': print("Status-values: '"+my_statusvalues+"'\n", file=current_outfile);

#############################################################################
#                                                                           #
#               ARGUMENT PROCESSING                                         #
#                                                                           #
#############################################################################

# Measure time intervals
start_time = time.time();

dev_random = open("/dev/urandom", 'rb');

# Read the check file
passphrase_list = [];
salt_list = [];
check_hashes = {};
total_hash_list = [];
if my_check:
        highest_arg_used = 0;
        print("# Checking: "+my_check+"\n", file=current_outfile);
        arg_list = check_filenames;
        check_filenames = [];
        with open_infile(my_check, 'r') as c:
                for line in c:
                        match = re.search("Execute system commands:\s+(True|False)", line);
                        if match != None:
                                # Uncomment the next line if you want automatic --execute from the check-file (DANGEROUS)
                                # execute = match.group(1).upper() == 'TRUE';
                                continue;
                                
                        match = re.search("Execute arguments:\s+\'([\w\$\s\-\+\/]*)\'", line);
                        if match != None:
                                execute_args = match.group(1);
                                continue;
                                
                        match = re.search("Quiet:\s+(True|False)", line);
                        if match != None:
                                my_quiet = match.group(1).upper() == 'TRUE';
                                if my_quiet: my_verbose = False;
                                continue;
                                
                        match = re.search("Salt\s*\+\s*TOTAL HASH\s*\:\s+\'([\w]*)\'\s+\'([\w]*)\'", line);
                        if match != None:
                                salt_list.append(match.group(1));
                                total_hash_list.append(match.group(2));
                                my_allsalts = True; # Salt+TOTAL HASH imples all-salts-pattern
                                continue;
                                
                        match = re.search("Salt\:\s+\'([\w]*)\'", line);
                        if match != None:
                                salt_list.append(match.group(1));
                                continue;
                                
                        match = re.search("Salt\s*\+\s*TOTAL HASH\s*\:\s+\'([\w]+)\'\s+\'([a-f0-9]+)\'", line);
                        if match != None:
                                salt_list.append(match.group(1));
                                total_hash_list.append(match.group(2));
                                continue;
                                
                        match = re.search("User\:\s+\'([\w]*)\'", line);
                        if match != None:
                                # Uncomment the next line if you want automatic --user from the check-file (DANGEROUS)
                                # my_user = match.group(1);
                                continue;
                                
                        match = re.search("Passphrase\:\s+\'([^\']*)\'", line);
                        if match != None:
                                passphrase_list.append(match.group(1));
                                continue;
                                
                        match = re.search("Status-values\:\s+\'([\w]*)\'", line);
                        if match != None:
                                my_statusvalues = match.group(1);
                                continue;
                                
                        match = re.search("^\s*([a-f0-9]+)\s+\*(TOTAL HASH)\s*$", line)
                        if match != None:
                                total_hash_list.append(match.group(1));
                                continue;
                                
                        match = re.search("^\s*([a-f0-9\-]+)\s+\*\[([0-9]+)\]\s*$", line)
                        if match != None:
                                filenumber = int(match.group(2));
                                if filenumber > highest_arg_used: highest_arg_used = filenumber;
                                # Watch out, arguments count from 0
                                check_filenames.append(arg_list[filenumber - 1]);
                                check_hashes['['+match.group(2)+']'] = match.group(1);
                                continue;

                        match = re.search("^\s*([a-f0-9\-]+)\s+\*(.*)\s*$", line)
                        if match != None:
                                check_filenames.append(match.group(2));
                                # Catch --execute error as early as possible
                                if match.group(2).startswith('$(') and not execute: 
                                        error_message = "Executable argument \'"+match.group(2)+"\' only allowed with the --execute flag";
                                        print (error_message, file=sys.stderr);
                                        if not sys.stdout.isatty(): print(error_message, file=current_outfile);
                                        exit(0);
                                check_hashes[match.group(2)] = match.group(1);
                                continue;
        for i in range(highest_arg_used, len(arg_list)):
            check_filenames.append(arg_list[i]);
            check_hashes['['+str(i+1)+']'] = (64*'-');

# Read input-file
if input_file:
        with open_infile(input_file, 'r') as i:
                for line in i:
                        # Clean up filename
                        current_filename = re.sub('[^\w\-\.\/\$\{\(\)\}\?\[\]]', '', line);
                        check_filenames.append(current_filename);
                        if my_check: check_hashes['['+str(i+1)+']'] = (64*'-');

stat_list = [];
for x in check_filenames:
        if os.path.isdir(x):
                x = '?'+x;
        if my_status and not x.startswith(('?', '$')):
                stat_list.append('?'+x);
        stat_list.append(x);
check_filenames = stat_list;

# Seed Pseudo Random Number Generator
seed = dev_random.read(16);
random.seed(seed);

# Read suggested salts from /dev/(u)random if needed
if my_salt:
        if my_salt.startswith('SUGGESTED'):
                N=1;
                match = re.search("([0-9][0-9]*)$", my_salt);
                if match != None:
                        N = int(match.group(1));
                for i in range(0,N):
                        salt = dev_random.read(8);
                        salt_list.append(str(binascii.hexlify(salt), 'ascii'));
        else:
                salt_list.append(my_salt);
elif len(salt_list) == 0:
        salt = dev_random.read(8);
        sys.stderr.write("Enter salt (suggest \'"+str(binascii.hexlify(salt), 'ascii')+"\'): ");
        new_salt = input();
        if not new_salt: new_salt = str(binascii.hexlify(salt), 'ascii');
        salt_list.append(new_salt);

# If not combining salts with TOTAL HASH, print salts now
if not my_allsalts:
        for my_salt in salt_list:
                print("Salt: \'"+my_salt+"\'", file=current_outfile);

# Get passphrase
if my_passphrase and(my_passphrase == '-' or os.path.isfile(my_passphrase)):
    with open_infile(my_passphrase, 'r') as file:
        for line in file:
                match = re.search("Passphrase\:\s+\'([^\']*)\'", line);
                if match != None:
                        passphrase_list.append(match.group(1));
elif not my_passphrase and len(passphrase_list) == 0:
        suggest_passphrase = dev_random.read(16);
        sys.stderr.write("Enter passphrase (suggest \'"+str(base64.b64encode(suggest_passphrase), 'ascii').rstrip('=')+"\'): ");
        # How kan we make this unreadable on input?
        current_passphrase = input();
        if not current_passphrase:
            current_passphrase = str(base64.b64encode(suggest_passphrase), 'ascii').rstrip('=');
            print("Passphrase: \'"+current_passphrase+"\'", file=current_private);
        passphrase_list.append(current_passphrase);
elif my_passphrase.startswith('SUGGESTED'):
    N = 1;
    match = re.search("([0-9][0-9]*)$", my_passphrase);
    if match != None:
        N = int(match.group(1));
    j = int(random.random()*N);
    for i in range(0, N):
            suggest_passphrase = dev_random.read(16);
            current_passphrase = str(base64.b64encode(suggest_passphrase), 'ascii').rstrip('=');
            print("Passphrase: \'"+current_passphrase+"\'", file=current_private);
            passphrase_list.append(current_passphrase);
else:
    passphrase_list.append(my_passphrase);

selected_salt = 1;
fail_fraction = 0.5;
if not my_check:
        if len(passphrase_list) > 1:
                j = int(random.random()*len(passphrase_list));
                passphrase_list = [passphrase_list[j]];
                print("# Selected passphrase:", j+1, file=current_private);
        if len(salt_list) > 1:
                j = int(random.random()*len(salt_list));
                # Make sure at least 1 salt will match and print the selection if only one is used
                selected_salt = j+1;
                if not my_allsalts:
                        salt_list = [salt_list[selected_salt-1]];
                        print("# Selected salt:", selected_salt, file=current_private);
                else:
                        salt_N = len(salt_list);
                        fail_fraction = (salt_N/2.0)/(salt_N - 1);
        else:
                fail_fraction = 0;

# Close /dev/(u)random
dev_random.close;

#############################################################################
#                                                                           #
#               SIGNATURE CREATION AND CHECKING                             #
#                                                                           #
#############################################################################

end_time = time.time();
print("# Preparation time:", end_time - start_time, "seconds\n", file=current_outfile);

pnum = 1;
snum = 1;
corrpnum = 0;
corrsnum = 0;
matched_salt_pattern = -1;
salt_pattern_number = -1;

for my_passphrase in passphrase_list:
        snum = 1;
        # Initialize salt pattern
        if my_allsalts: 
                salt_pattern_number = 0;
                current_salt_power = 1;

        for my_salt in salt_list:
                print("# Start signature: ", end='', file=current_outfile);
                if len(passphrase_list) > 1: print("passphrase -", pnum, end='', file=current_outfile);
                if len(salt_list) > 1: print(" salt -", snum, end='', file=current_outfile);
                print("", file=current_outfile);
                
                # Should everything be printed?
                print_verbose = my_verbose and not (my_allsalts and snum > 1);
                
                file_argnum = 0;
                start_time = time.time();
                # Construct the passphrase hash
                passphrase = hashlib.sha256();
                
                passphrase.update(bytes(my_salt, encoding='ascii'));
                passphrase.update(bytes(my_passphrase, encoding='ascii'));
                
                # Create prefix which is a hash of the salt+passphrase
                prefix = passphrase.hexdigest();
                
                # Create signature and write output
                totalhash = hashlib.sha256();
                totalhash.update(bytes(prefix, encoding='ascii'));
                for org_filename in check_filenames:
                        # Create file hash object
                        filehash = hashlib.sha256();
                        filehash.update(bytes(prefix, encoding='ascii'));
                        # Remove []
                        filename = org_filename.strip('[').rstrip(']');
                        # Use system variables and commands
                        if filename.startswith('$'):
                                # Commands $(command)
                                match = re.search('^\$\((.+)\)$', filename);
                                if match != None:
                                        if not execute : 
                                                error_message = "Executable argument \'"+filename+"\' only allowed with the --execute flag";
                                                print (error_message, file=sys.stderr);
                                                if not sys.stdout.isatty(): print(error_message, file=current_outfile);
                                                exit(0);
                                        current_command = not_allowed_chars.sub(" ", match.group(1));
                                        current_command_line = user_change+"bash --restricted -c \'"+current_command+"\' "+str(os.getpid())+" "+execute_args;
                                        if print_verbose :
                                                print("#", current_command_line, file=current_outfile);
                                        (status, b) = subprocess.getstatusoutput(current_command_line);
                                        if status != 0: 
                                                print('$('+current_command+')'+"\n"+b, file=sys.stderr);
                                                exit(status);
                                        elif options.printexecute: # For debugging commands
                                                print(b, file=sys.stderr);
                                        # subprocess.getstatusoutput() strips trailing \n, add it before encoding
                                        filehash.update(bytes(b+"\n", encoding='utf8'));
                                # ${ENV} environment variables
                                match = re.search('^\$[\{]?([^\}\(\)]+)[\}]?$', filename);
                                if match != None:
                                        current_var = not_allowed_chars.sub(" ", match.group(1));
                                        if print_verbose:
                                                print("# echo $"+ current_var, file=current_outfile);
                                        b = os.environ[current_var];
                                        filehash.update(bytes(b, encoding='utf8'));
                        # lstat() meta information
                        elif filename.startswith('?'):
                                if not os.path.exists(filename.lstrip('?')): 
                                        print(filename, "does not exist", file=sys.stderr)
                                        quit();
                                filestat = os.stat(filename.lstrip('?'));
                                if my_statusvalues == "": my_statusvalues = 'fmidlugs'
                                b = "";
                                if 'f' in my_statusvalues:
                                        b += 'stat('+filename.lstrip('?')+') = '
                                b += '[';
                                if 'm' in my_statusvalues:
                                        b += 'st_mode='+str(oct(filestat.st_mode))+', ';
                                if 'i' in my_statusvalues:
                                        b += 'st_ino='+str(filestat.st_ino)+', ';
                                if 'd' in my_statusvalues:
                                        b += 'st_dev='+str(filestat.st_dev)+', '
                                if 'l' in my_statusvalues:
                                        b += 'st_nlink='+str(filestat.st_nlink)+', '
                                if 'u' in my_statusvalues:
                                        b += 'st_uid='+str(filestat.st_uid)+', '
                                if 'g' in my_statusvalues:
                                        b += 'st_gid='+str(filestat.st_gid)+', '
                                if 's' in my_statusvalues:
                                        b += 'st_size='+str(filestat.st_size)+', '
                                if 'a' in my_statusvalues:
                                        b += 'st_atime='+str(filestat.st_atime)+', '
                                if 't' in my_statusvalues:
                                        b += 'st_mtime='+str(filestat.st_mtime)+', '
                                if 'c' in my_statusvalues:
                                        b += 'st_ctime='+str(filestat.st_ctime);
                                        
                                b = b.rstrip(', ') + ']';
                                filehash.update(bytes(b, encoding='utf8'));
                                if print_verbose:
                                        print ("# "+ b, file=current_outfile);
                        # Use file
                        else:
                                # open and read the file
                                if filename != '-' and filename.find('://') == -1 and not os.path.exists(filename): 
                                        print(filename, "does not exist", file=sys.stderr)
                                        quit();
                                with open_infile(filename, 'rb') as file:
                                        for b in file:
                                                if type(b).__name__ == 'str': 
                                                        b = bytes(b, encoding='utf8');
                                                filehash.update(b);
                                                
                        current_digest = filehash.hexdigest();
                        print_name = filename;
                        if my_quiet or org_filename.startswith('['):
                            file_argnum += 1;
                            print_name = '['+str(file_argnum)+']';
                        current_hash_line = current_digest+" *"+print_name
                        totalhash.update(bytes(current_hash_line, encoding='ascii'));
                        
                        # Be careful to use this ONLY after totalhash has been updated!
                        if total_only: 
                            current_hash_line = (len(current_digest)*'-')+" *"+print_name;
                        
                        # Write output
                        if not my_check:
                                if not (my_quiet and total_only) and not (my_allsalts and snum > 1):
                                    print(current_hash_line, file=current_outfile);
                        elif not (my_quiet or my_allsalts):
                                if check_hashes[print_name] ==  (len(current_digest)*'-'):
                                        # Suppress redundant output of empty, ----, lines
                                        if snum <= 1 and pnum <= 1: 
                                                print(check_hashes[print_name]+" *"+print_name, file=current_outfile);
                                elif current_digest != check_hashes[print_name]:
                                        print("DIFFERENT: "+current_hash_line, file=current_outfile);
                                else:
                                        print("ok"+" *"+print_name, file=current_outfile);
                
                # Handle total hash
                current_total_digest = totalhash.hexdigest();
                # Write (in)correct salts with the TOTAL HASH
                if my_allsalts:
                        output_salt = my_salt;
                        j = random.random();
                        # Randomly create an incorrect salt for failed output
                        if not my_check:
                                if j < fail_fraction and snum != selected_salt:
                                        salt = dev_random.read(8);
                                        output_salt = str(binascii.hexlify(salt), 'ascii');
                                else:
                                        salt_pattern_number += current_salt_power;
                        current_total_digest_line = "Salt+TOTAL HASH: '"+output_salt+"' '"+current_total_digest+"'";
                else: # Standard TOTAL HASH line
                        current_total_digest_line = current_total_digest+" *"+"TOTAL HASH";
                end_time = time.time();
                print("# \n# Total hash - Time to completion:", end_time - start_time, "seconds", file=current_outfile);
                total_hash_num = 0;
                if my_allsalts: total_hash_num = snum-1; # Current TOTAL HASH number of more are used
                if not my_check:
                        print(current_total_digest_line+"\n", file=current_outfile);
                elif current_total_digest != total_hash_list[total_hash_num]:
                        if not my_allsalts: print("DIFFERENT: "+current_total_digest_line+"\n", file=current_outfile);
                else:
                        if my_allsalts: salt_pattern_number += current_salt_power;  # Update salt bit pattern
                        match_number = "";
                        if len(passphrase_list) > 1 or len(salt_list): match_number = " #"
                        if len(passphrase_list) > 1: match_number += " passphrase no: "+str(pnum);
                        if len(salt_list) > 1: match_number += " salt no: "+str(snum);
                        if not my_allsalts: print("OK"+" *"+"TOTAL HASH"+match_number+"\n", file=current_outfile);
                        corrsnum = snum;
                        corrpnum = pnum;
                snum += 1;
                if my_allsalts: current_salt_power *= 2;  # Update current bit position in salt pattern
        if my_check and corrpnum == pnum: matched_salt_pattern = salt_pattern_number;
        pnum += 1;
        
if my_check and len(passphrase_list) > 1:
        if corrpnum > 0:
                print("Passphrase entry:",corrpnum,"matched", file=current_outfile);
        else:
                print("No passphrase entry matched!", file=current_outfile);
if my_check and (not my_allsalts) and len(salt_list) > 1:
        if corrpnum > 0:
                if corrsnum > 0:
                        print("Salt entry:",corrsnum,"matched", file=current_outfile);
                else:
                        print("No salt entry matched!", file=current_outfile);
        else:
                print("No entry matched", file=current_outfile);
# Print salt bit patterns
elif my_check and my_allsalts:
        print("Salt pattern number:", matched_salt_pattern, file=current_outfile);
elif not my_check and my_allsalts:
        print("# Salt pattern number:", salt_pattern_number, file=current_private);

# Close output files if necessary
if my_output and my_output != '-':
        current_outfile.close();
if my_private and my_private != '-':
        current_private.close();