1
0
Fork 0
mirror of https://github.com/BLAKE3-team/BLAKE3 synced 2024-05-08 06:36:11 +02:00
BLAKE3/b3sum
joveian 4c819d01bc Add --check summary of failures
Add a warning to stderr at the end similar to other *sum utilities when --check is used and some files failed verification.

At least the last part of the comment above check_one_checkfile seemed to be incorrect so I removed that comment.

Fixes #283
2023-02-04 10:14:52 -08:00
..
src Add --check summary of failures 2023-02-04 10:14:52 -08:00
tests Add --check summary of failures 2023-02-04 10:14:52 -08:00
.gitignore check in the Cargo.lock for b3sum 2021-12-18 15:27:57 -05:00
Cargo.lock version 1.3.3 2022-11-26 00:31:40 -05:00
Cargo.toml version 1.3.3 2022-11-26 00:31:40 -05:00
README.md grammar fix in b3sum help output 2022-11-20 17:24:58 -08:00
what_does_check_do.md fix a typo in the check doc 2021-11-13 09:24:15 -05:00

b3sum

A command line utility for calculating BLAKE3 hashes, similar to Coreutils tools like b2sum or md5sum.

Usage: b3sum [OPTIONS] [FILE]...

Arguments:
  [FILE]...  Files to hash, or checkfiles to check

Options:
  -l, --length <LEN>          The number of output bytes, before hex encoding [default: 32]
      --num-threads <NUM>     The maximum number of threads to use
      --keyed                 Use the keyed mode
      --derive-key <CONTEXT>  Use the key derivation mode, with the given context string
      --no-mmap               Disable memory mapping
      --no-names              Omit filenames in the output
      --raw                   Write raw output bytes to stdout, rather than hex
  -c, --check                 Read BLAKE3 sums from the [FILE]s and check them
      --quiet                 Skip printing OK for each successfully verified file
  -h, --help                  Print help information (use `--help` for more detail)
  -V, --version               Print version information

See also this document about how the --check flag works.

Example

Hash the file foo.txt:

b3sum foo.txt

Time hashing a gigabyte of data, to see how fast it is:

# Create a 1 GB file.
head -c 1000000000 /dev/zero > /tmp/bigfile
# Hash it with SHA-256.
time openssl sha256 /tmp/bigfile
# Hash it with BLAKE3.
time b3sum /tmp/bigfile

Installation

Prebuilt binaries are available for Linux, Windows, and macOS (requiring the unidentified developer workaround) on the releases page. If you've installed Rust and Cargo, you can also build b3sum yourself with:

cargo install b3sum

On Linux for example, Cargo will put the compiled binary in ~/.cargo/bin. You might want to add that directory to your $PATH, or rustup might have done it for you when you installed Cargo.

If you want to install directly from this directory, you can run cargo install --path .. Or you can just build with cargo build --release, which puts the binary at ./target/release/b3sum.