Skip to content

Latest commit

 

History

History
192 lines (138 loc) · 5.56 KB

README.md

File metadata and controls

192 lines (138 loc) · 5.56 KB
Raw

hasher

hasher is a program that can do multithreaded simultaneous hashing of files with up to 48 hashing algorithms while only reading the file once. This means that in almost all cases the limiting factor in performance will be IO, and you won't have to waste time reading the same data multiple times if you need multiple hashing algorithms.

Building

hasher requires a fairly modern version of stable Rust. All development is done on the latest stable release, and older versions are likely to cause issues.

Install Rust using the instructions located here.

To build, run the following at the root of the repository:

cargo build -r

After this is complete your binary will be located at target/release/hasher and can be moved wherever you desire, or leave it in place and use cargo run -r.

musl libc Builds

On Linux systems you may run into some glibc version issues if you, for example, build on an Arch Linux system and then run on a Debian Stable system. The easiest way to alleviate this issue is to build the application on the target you are running, however that's not always possible or desirable, so there is another option: static compilation with libc built into the binary. This can be done by following the following steps:

sudo apt install musl-tools  # Or equivalent package for musl-gcc on your system

rustup target add x86_64-unknown-linux-musl
cargo build -r --target=x86_64-unknown-linux-musl

This will create a release build in the same location as normal builds but now it will not use glibc. Note that this will slightly impact performance, as the program is being compiled for a generic x86_64 system, and can't include instructions from extensions that only exist on modern CPUs.

Usage

The basic structure for usage is:

hasher {command} {options} {directories}

With all commands supporting the following basic options (though some may do nothing):

  • -v/--verbose, -q/--quiet
    • Control logging verbosity. Use -vvv for maximum output
  • -e/--continue-on-error
    • Don't stop after encountering an error
  • -s/--sql-only
    • Only output to SQLite database
  • -j/--json-only
    • Only output to JSON
  • -p/--pretty-json
    • Pretty print JSON output
  • -c/--config-file
    • Path to config file (default: ./config.toml)
  • --dry-run
    • Run without actually saving anything
  • --retry-count
    • Number of retries for operations (default: 3)
  • --retry-delay
    • Delay in seconds between retries (default: 5)
  • --skip-failures
    • Skip failures instead of erroring out

hash: Hash Files/Directories

hasher hash [OPTIONS] [SOURCE]

Hash files in a directory. If no source is provided, the current directory is used.

Special options:

  • --decompress
    • Decompress gzipped files before hashing
  • --hash-both
    • Hash both compressed and decompressed content for gzipped files
  • -n/--stdin
    • Hash data from stdin instead of files

verify: Verify Hashes

hasher verify [OPTIONS]

Verify files against stored hashes in the database.

Special options:

  • -m/--mismatches-only: Only output when files fail to verify
  • --decompress: Decompress gzipped files before verifying
  • --hash-both: Verify both compressed and decompressed content

copy: Copy Files

hasher copy [OPTIONS] <SOURCE> <DESTINATION>

Copy files while hashing them.

Special options:

  • --store-source-path: Store source path instead of destination path in database
  • -z/--compress: Compress files with gzip while copying
  • --compression-level: Gzip compression level (1-9, default: 6)

download: Download Files

hasher download [OPTIONS] <SOURCE> <DESTINATION>

Download and hash files. SOURCE can be either a URL or a file containing URLs (one per line).

Special options:

  • --no-clobber: Do not replace already downloaded files
  • -z/--compress: Compress downloaded files with gzip
  • --compression-level: Gzip compression level (1-9, default: 6)

Config File

The config file (default config.toml) controls which hashes are calculated and database settings. See the example config.toml in the repository root for all options.

Supported Hashes

The following hashes are supported:

  • CRC32
  • MD2, MD4, MD5
  • SHA-1
  • SHA-2 (SHA-224 through SHA-512)
  • SHA-3 (SHA3-224 through SHA3-512)
  • BLAKE2 (Blake2s256, Blake2b512)
  • BelT
  • Whirlpool
  • Tiger/Tiger2
  • Streebog (GOST R 34.11-2012)
  • RIPEMD (128/160/256/320)
  • FSB
  • SM3
  • GOST R 34.11-94
  • Grøstl
  • SHABAL

Testing

There are some unit tests for the crucial bits of the which can be tested with:

cargo test

However the test.py script has been created to test that the major user-facing functions are working:

python3 test.py

The only requirements for this script are a reasonably modern version of Python 3.

Code Style

hasher follows rustfmt code style, and it can be applied in a single command with:

rustfmt --edition 2021 src/*.rs src/commands/*.rs

Notes

Memory Integrity

While hasher being written in Rust makes it immune to memory safety bugs, hasher does not have any protections against issues that may compromise memory integrity like cosmic bitflips. This is not a concern for most activities on servers that have ECC memory, however this is important to keep in mind if you are doing very large amounts of hashing on conventional computers with non-ECC memory. Trust, but verify.

Changelog

See docs/CHANGELOG.md for version history.

Other

Sponsored by 📼 🚙