Crate blake2b_simd

Repo — Docs — Crate

An implementation of the BLAKE2b hash with:

• 100% stable Rust.
• An AVX2 implementation ported from libsodium. This implementation is faster than libsodium's, and faster than any hash function provided by OpenSSL. See the Performance section below.
• A portable, safe implementation for other platforms.
• Dynamic CPU feature detection. Binaries for x86 include the AVX2 implementation by default and call it if the processor supports it at runtime.
• All the features from the the BLAKE2 spec, like adjustable length, keying, and associated data for tree hashing.
• A clone of the Coreutils b2sum command line utility, provided as a sub-crate.
• no_std support. The std Cargo feature is on by default, for CPU feature detection and for implementing std::io::Write.
• An implementation of the multithreaded blake2bp variant, provided as an optional Cargo feature.

Example

use blake2b_simd::{blake2b, Params};

let expected = "ca002330e69d3e6b84a46a56a6533fd79d51d97a3bb7cad6c2ff43b354185d6d\
                c1e723fb3db4ae0737e120378424c714bb982d9dc5bbd7a0ab318240ddd18f8d";
let hash = blake2b(b"foo");
assert_eq!(expected, &hash.to_hex());

let hash = Params::new()
    .hash_length(16)
    .key(b"The Magic Words are Squeamish Ossifrage")
    .personal(b"L. P. Waterhouse")
    .to_state()
    .update(b"foo")
    .update(b"bar")
    .update(b"baz")
    .finalize();
assert_eq!("ee8ff4e9be887297cf79348dc35dab56", &hash.to_hex());

An example using the included b2sum command line utility:

$ cd b2sum
$ cargo build --release
    Finished release [optimized] target(s) in 0.04s
$ echo hi | ./target/release/b2sum --length 256
de9543b2ae1b2b87434a730727db17f5ac8b8c020b84a5cb8c5fbcc1423443ba  -

Performance

The AVX2 implementation in this crate is ported from the C implementation in libsodium. That implementation was originally written by Samuel Neves and integrated into libsodium by Frank Denis. All credit for performance goes to those authors.

To run small benchmarks yourself, first install OpenSSL and libsodium on your machine, then:

cd benches/cargo_bench
# Use --no-default-features if you're missing OpenSSL or libsodium.
cargo +nightly bench

The benches/benchmark_gig sub-crate allocates a gigabyte (10⁹) array and repeatedly hashes it to measure throughput. A similar C program, benches/bench_libsodium.c, does the same thing using libsodium's implementation of BLAKE2b. Here are the results from my laptop:

• Intel Core i5-8250U, Arch Linux, kernel version 4.17.13
• libsodium version 1.0.16, gcc 8.2.0, gcc -O3 -lsodium benches/bench_libsodium.c (via the helper script benches/bench_libsodium.sh)
• rustc 1.30.0-nightly (73c78734b 2018-08-05), cargo +nightly run --release

               ╭────────────┬────────────╮
               │ portable   │ AVX2       │
╭──────────────┼────────────┼────────────┤
│ blake2b_simd │ 0.771 GB/s │ 1.005 GB/s │
│ libsodium    │ 0.743 GB/s │ 0.939 GB/s │
╰──────────────┴────────────┴────────────╯

The benches/bench_b2sum.py script benchmarks b2sum against several Coreutils hashes, on a 10 MB file of random data. Here are the results from my laptop:

╭───────────────────────────┬────────────╮
│ blake2b_simd b2sum --mmap │ 0.676 GB/s │
│ blake2b_simd b2sum        │ 0.649 GB/s │
│ coreutils sha1sum         │ 0.628 GB/s │
│ coreutils b2sum           │ 0.536 GB/s │
│ coreutils md5sum          │ 0.476 GB/s │
│ coreutils sha512sum       │ 0.464 GB/s │
╰───────────────────────────┴────────────╯

The benches/count_cycles sub-crate (cargo +nightly run --release) measures a peak throughput of 1.8 cycles per byte.

Structs

Hash	A finalized BLAKE2 hash, with constant-time equality.
Params	A parameter builder for State that exposes all the various BLAKE2 features.
State	An incremental hasher for BLAKE2b.

Constants

BLOCKBYTES	The number input bytes passed to each call to the compression function. Small benchmarks need to use an even multiple of BLOCKBYTES, or else their apparent throughput will be low.
KEYBYTES	The max key length.
OUTBYTES	The max hash length.
PERSONALBYTES	The max personalization length.
SALTBYTES	The max salt length.

Functions

blake2b

Compute the BLAKE2b hash of a slice of bytes, using default parameters.