25 releases (5 stable)

1.3.1 Jan 25, 2022
1.2.0 Nov 5, 2021
1.0.0 Jul 25, 2021
0.3.8 May 25, 2021
0.0.0 Sep 17, 2019

#43 in Command line utilities

Download history 126/week @ 2022-04-27 209/week @ 2022-05-04 427/week @ 2022-05-11 161/week @ 2022-05-18 193/week @ 2022-05-25 272/week @ 2022-06-01 134/week @ 2022-06-08 57/week @ 2022-06-15 58/week @ 2022-06-22 55/week @ 2022-06-29 100/week @ 2022-07-06 104/week @ 2022-07-13 106/week @ 2022-07-20 81/week @ 2022-07-27 110/week @ 2022-08-03 66/week @ 2022-08-10

374 downloads per month

CC0-1.0 OR Apache-2.0

1.5MB
35K SLoC

GNU Style Assembly 17K SLoC Assembly 9K SLoC // 0.0% comments Rust 5K SLoC // 0.1% comments C 3.5K SLoC // 0.1% comments Python 143 SLoC // 0.1% comments

b3sum

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

b3sum 1.3.1

USAGE:
    b3sum [OPTIONS] [FILE]...

ARGS:
    <FILE>...    Files to hash, or checkfiles to check. When no file is given,
                 or when - is given, read standard input.

OPTIONS:
    -c, --check                   Reads BLAKE3 sums from the [FILE]s and checks them
        --derive-key <CONTEXT>    Uses the key derivation mode, with the given
                                  context string. Cannot be used with --keyed.
    -h, --help                    Print help information
        --keyed                   Uses the keyed mode. The secret key is read from standard
                                  input, and it must be exactly 32 raw bytes.
    -l, --length <LEN>            The number of output bytes, prior to hex
                                  encoding (default 32)
        --no-mmap                 Disables memory mapping. Currently this also disables
                                  multithreading.
        --no-names                Omits filenames in the output
        --num-threads <NUM>       The maximum number of threads to use. By
                                  default, this is the number of logical cores.
                                  If this flag is omitted, or if its value is 0,
                                  RAYON_NUM_THREADS is also respected.
        --quiet                   Skips printing OK for each successfully verified file.
                                  Must be used with --check.
        --raw                     Writes raw output bytes to stdout, rather than hex.
                                  --no-names is implied. In this case, only a single
                                  input is allowed.
    -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.

Dependencies

~3.5MB
~65K SLoC