Add missing iv fixed part in error output

pylint complained:
crypto.py:1357:36: E1306: Not enough arguments for format string (too-few-format-args)

Fix 'pw' variable name in error handling

pylint complained:
crypto.py:840:40: E0602: Undefined variable 'password' (undefined-variable)

Documentation improvements

remove development tweak for test runner

This essentially reverts

    commit 406e0fa86d97f912b50689d6b080c2aee69eef86
    Author: Philipp Gesang <philipp.gesang@intra2net.com>
    Date:   Tue Apr 18 11:59:02 2017 +0200

        allow selecting individual tests with runtests.py

Tests and files for all imported test classes may still take some
moments but we don’t need to skip them any longer.

handle problems with incomplete gzip headers

Throw the appropriate exn to signal EOF or malformed data
conditions when tentatively parsing GZip headers.

add tests for truncated files

describe corruption mechanisms and their function in testing

skip some unittests on older python versions

test multivol index reconstruct with hole and header corruption

extend index reconstruct tests for multivol backups

lift block alignment requirement for tar archive rescue

It is unlikely that damaged archives have correctly aligned tar
headers. Thus we need to check each header-like section whether
it contains the right magic and the checksum matches. Objects
without a correct checksum (which spans the better part of the
header) are discarded similar to what file(1) does.

implement volume handling for rescue mode

When reconstructing the index, traverse backup volumes and set
the “volume” member on the objects appropriately.

implement leading garbage test

Implemented a rescue test since offsets won’t match in this
scenario.

include description of object validation with crypto.py scan mode

Example output for a second object with a corrupt byte in the
size field:

    PDT: obj 1: read payload @64
    PDT:    · version         = 1                    : 0100
    PDT:    · paramversion    = 1                    : 0100
    PDT:    · nacl                                   : 1dc1 154a 5405 ef5e df81 173f 2821 7a0c
    PDT:    · iv                                     : 7cae 452a a05b 5182 0300 0000
    PDT:    · ctsize          = 230                  : e600 0000 0000 0000
    PDT:    · tag                                    : 42c0 8774 3309 88eb 0e1a 71dc 8fd9 80c1
    PDT: 0 → ✓ valid object 64–294
    PDT: 294 → EOF inside object (358≤5312627≤1095216701872); adjusting size to 5312269
    PDT: obj 2: read payload @358
    PDT:    · version         = 1                    : 0100
    PDT:    · paramversion    = 1                    : 0100
    PDT:    · nacl                                   : 1dc1 154a 5405 ef5e df81 173f 2821 7a0c
    PDT:    · iv                                     : 7cae 452a a05b 5182 0400 0000
    PDT:    · ctsize          = 5312269              : 0d0f 5100 0000 0000
    PDT:    · tag                                    : 5946 dbcf 41b9 ac7e 4729 9e09 46c7 3388
    PDT: GCM tag mismatch for object 358–5312627
    PDT: 294 → × fishy object 358–5312627, corrupt header

add unit test for borked ciphertext size

allow for detecting overlapping objects with tarfile

detect overlapping objects

The CLI will run one additional pass to determine whether objects
overlap one another. Overlap might indicate bad headers or gaps
in the file (object offsets shifted).

adjust post-conditions for GZ[,AES]/rescue unit test

make crypto.py CLI accept hex-encoded keys again

Also handle decoding of those keys at the same level as base64
encoded ones.

use real new volume handler during rescue

With the dummy we end up with a nil object instead of a tarinfo
at the end of the volume. Reinstating the actual handler is
harmless and produces a valid info object again.

prevent tarobject iteration in disaster mode

The tarfile iterator relies on the header data to determine the
next object offset which may be wrong for corrupt files. Instead,
skip that iteration step and completely rely on the object
offsets determined during index rebuild.

implement tolerant GNU tar header parser

When skimming a file for tar objects, only consider the GNU
header magic and whether the blocks are aligned.

add restore helper handling for reconstructed indices

add iterator mode for reconstructed index

unify construction of secret values

implement tolerant gz header parser

Since they assume a stream object, we cannot rely on the original
tarfile GZ handling. Add a “tolerant” one according to the format
spec that notices malformed or unexpected (in Deltatar context)
values, but glosses over them if they do not necessarily impact
the readability of the object.

Also use the new symbolic constants in the existing GZ reader
instead of magic numbers.

ignore GCM tag mismatch in scan mode

Header info is assumed unreliable during rescue so a tag mismatch
must not result in a bad object.

convert TarInfo to index format

read tar objects at predetermined offsets for rescue index

Leverage the tarobj to read the object headers at the determined
offsets. Currently only implemented for encrypted archives whose
offsets are located with *crypto.py*.

add test skeleton for corrupt index reconstruction

Starting with an intact backup set.

draft rescue mode through all layers

The strategy is for rescue mode to reconstruct the relevant [*]
information from the index by inspecting the passed tar object,
then continue from there. On the crypto side, this boils down to
a streamlined (and silent) version of the “scan” mode. The
tarfile side is still WIP.

[*] Omitting the useless parts like inode number.

derive test skeleton for disaster rescue mode

implement dump mode for tolerant decryption

Utilize the safe dirfd based implementation from split mode to
write extracted objects to a target directory.

extend tarfile API for rescue mode

implement decryption for tolerant mode

Not possible to reuse the existing CLI decryption since we’re
operating with fds in scan mode.

attempt to process candidate objects in scan mode

print list of header candidates

implement PDTCRYPT header scanning

First phase: collect all possible header start locations.

Adds a CLI subcommand “scan” to crypto.py for analyzing files.

test corruption by tearing a hole in a volume

add test corrupting an entire volume

Zero out the first volume: None of the content can be restored.
This includes the file extending from the first into the second
volume.

use symbolic constant for errno

clarify index read failure

Instead of erroring out with an exception, make --restore emit an
error message indicating that something is wrong with the index.

do not discard valid data in buffers when in tolerant mode

Both decryption and decompression will fail on the first error
and ignore any results of earlier passes. In normal operation,
the hard failures are desirable to indicate a bad backup set.

However, in tolerant / recovery mode the error handling is closer
to the opposite extreme: we want to retrieve every last byte that
made it through the various layers and only skip over the parts
that cannot be interpreted at all.

catch bad parameter version in header

reject bad index files with a meaningful error

add brief description of disaster recovery

fail with info message if recovery is asked with source path

allow for numbers of missing and failed files to differ in recovery test

adjust the expectations about checksum mismatches with non-authenticated recover modes

use index iterator to accomodate multivol extraction

For reasons unknown, the “tar path iterator” always terminates
after the last element of the first volume. In fact, it does so
even for multi volume archives if the last object in the first
volume extends into the second volume. In this case, the object
is completely extracted but extraction terminates.

use random data in multivol tests

Brute force incompressibility to preven gzip from invalidating
our multivolume tests.

give each recovery test a multivol companion

This derives single- and multivolume versions of the tests.
Multiple volumes are generated by stretching the input file count
and size.

work around false positives in deltatar fs checks during rpmbuild

These only happen when running in rpmbuild, otherwise the tests
are fine. Of course, on RHBT the choir resoundeth “thou shalt not
run thine rpm build as root” but that’s not really an option
here.

catch incomplete trailing header in tolerant recovery

This makes decryption in recovery mode resistant against
malformed trailing data which would otherwise error out for the
entire buffered chunk on account of a decryption failure.

test recovery behavior with traling data

track successful recover of corrupted payload in tests

Gzip does CRC32, GCM has a MAC, but ordinary Tar only checksums
the header part, not the content. Thus recovery of a damaged
object will appear to succeed provided the object header is
intact. In order to detect the corruption, an external integrity
check is necessary.

add recover tests for completely damaged headers

sync tarfile stream diligently when writing new objects

Turns out all the offsets written to the index when neither
encrypting nor compressing were, well, … off. In fact they would
only be updated at tar block boundaries due to buffering. Since
“last_block_offset” record keeping blatantly violates layering
boundaries, it would only work reliably with the concat
compression and encryption modes that do the same.

Sync when adding a new object so we get the accurate offset
value. Voilà, recovery now works with uncompressed and
unencrypted archives as well

add header corruption tests

We hit them where it hurts:

    * for compressed backups, flip a bit in the magic;
    * for encrypted backups, flip a bit in the tag.

In either case, normal restore must fail, and disaster recovery
will be incomplete.

add test for corruption of encrypted files

track irrecoverable files in test_recover

prefer index iterator for recovery

properly damage gzip files for recover test

Ensure we are flipping bits in the compressed payload, not in the
mostly useless header. Requires some extra parsing to determine
the header length.

add bit flip helper for recover tests

fix misleading docstrings for index file hook

lay out skeleton for disaster recovery tests

New series of tests for corrupting backup sets and restoring them
incompletely (“tolerant” or “disaster recovery” mode).

draft disaster recovery mode for deltatar

The first stage recovery assumes the index is intact and all
objects are at their expected position. In this scenario, an
attempt is made to extract each object, keeping track of those
that weren’t readable and why.

return valid decrypted data on decryption failure

force tarfile reopen after bad read in deltatar

Closing the tarfile after an unreadable object was encountered
causes the stream to be reopened for the next read. Otherwise,
the corrupt object is already buffered and tarfile would continue
to seek inside the bad data.

distinguish invalid files from parse errors in restore

Especially with index files, the parse error is misleading.
Indicate the prevalent cause of the problem, i. e. that the
file is compressed but compression was not requested during
restore.

update help usage strings wrt. crypto in backup.py

extend crypto.py exception descriptions

actually default to i2n mode with crypto.py scrypt

And adapt the relevant unit test to explicitly request the full
parameters output.

add crypto.py option to output cnf-compatible scrypt object

support PDT encrypted archives with rescue_tar.py

adapt file_crypt.py for revised crypto

kill off old crypto implementation

The old aescrypto.py was only kept for reference but since
downstream integration is more or less complete wrt. encryption
we don’t need it any longer.

Good riddance.

allow passing salt to crypto.py on the command line

Nifty shortcut for hashing without a corresponding pdtcrypt file.

properly align usage message of crypto.py

improve bad CLI argument handling of crypto.py

include header version info in scrypt handler

accept crypto format version in deltatar ctor

add unit test for CLI scrypt hashing

allow passing keys directly to CLI crypto.py

Keys may now be passed as command line argument or environment
variable.

The only valid format is 16 bytes in hexadecimal.

grab password from envp if not supplied on CLI

In order to avoid the password showing up in full in the process
table, pass it in the environment instead. Uses the environment
variable PDTCRYPT_PASSWORD with both crypto.py and backup.py.

default to index mode of deltatar object when choosing extension

For external use.

handle bad randomness during IV creation

Since IVs must be unique we rely on /dev/urandom to yield a
different sequence of bytes when requesting a new fixed part.
In the unlikely event that a new fixed part has already been
used earlier, repeat it for number of times.

Abort if no unique IV could be generated this way since it
most likely indicates a faulty RNG.

extend crypto.py documentation

distinguish auxiliary file errors

Auxiliary files that grow larger than the maximum defined
encrypted file size cause an irrecoverable error because their
fixed IV is being reused. Add a new exception to distinguish this
specific case. Encrypted auxiliary files thus never consist of
more than one object, no on-the-fly continuation is permitted
like with ordinary files.

adapt unit tests for crypto.py subcommands

export scrypt hashing functionality

add SCRYPT hashing mode to crypto.py

Add a subcommand “scrypt” to crypto.py in CLI mode. Example:

    $ python3 ./deltatar/crypto.py scrypt foo -i - -o pwd   \
        <backup_dir/bfull-2017-05-11-0919-001.tar.pdtcrypt
    {"scrypt_params": {"p": 1, "N": 65536, "dkLen": 16, "r": 8},
     "salt": "b'fbdbaa9890ae243eb16391199c9243f6'", "hash":
     "b'1e7d7a78b9300d461779e9c80e4a15ac'"}

The output “hash” is calculated from the salt in the first
header found in the given archive and the password specified.

graciously handle GCM data length limit

unit test crypto file counter wraparound

After the file counter reaches UINT_MAX, it wraps around and a
new fixed part must be created.

The file counter is 32 bit unsigned integer so it needs to be
lowered to make bounds testing feasible.

extend strict iv tracking to encryption

This is just an extra soundness check to prevent accidental reuse
if IVs when handled incorrectly (same initial counters passed
twice to the same context). In normal usage this case cannot
happen.

expand crypto api to accept precomputed key

reduce noise in test_multivol_compression_sizes.py

improve iv diagnostics when decrypting

test that seeking backwards is disallowed by _Stream

Re-extracting an already decrypted file will fail on account of
IV reuse. Currently, tarfile._Stream is not capable of performing
backward seeks, so we’re good. Should this limitation be removed
in a future version, this unit test will fail.

remove pytest dependency from test_crypto.py