kangarootwelve_xkcp.rs
A Rust wrapper around the eXtended Keccak Code Package
implementation of the
KangarooTwelve cryptographic
hash function. That implementation includes SSSE3, AVX2, and AVX-512
optimizations, and it detects processor support at runtime. The k12sum
sub-crate provides a command line interface.
This package wraps C code via FFI, so you have to have a C compiler installed to build it.
Usage
The k12sum
command line utility
k12sum
hashes files or data from standard input using KangarooTwelve.
Prebuilt binaries are available for Linux, Windows, and macOS (requiring
the unidentified developer
workaround)
on the releases page.
To build k12sum
yourself:
- Make sure you have a working C compiler. On Linux and macOS, you can
run
gcc --version
to check that GCC is installed. On Windows, if you don't already have Visual Studio installed, you can install the C++ Build Tools for Visual Studio 2019. - Install Rust and Cargo.
- Run
cargo install k12sum
.
If rustup
didn't configure your PATH
for you, you might need to go
looking for the installed binary in e.g. ~/.cargo/bin
. You can test
out how fast KangarooTwelve is on your machine (however see the
Performance section below) by creating a big file and
hashing it, for example as follows:
# Create a 1 GB file.
# Hash it with SHA-256.
# Hash it with KangarooTwelve.
The kangarootwelve_xkcp
Rust crate
To use KangarooTwelve from Rust code, add a dependency on the
kangarootwelve_xkcp
crate to your Cargo.toml
. Here's an example of
hashing some bytes:
// Hash an input all at once.
let hash1 = hash;
// Hash an input incrementally.
let mut hasher = new;
hasher.update;
hasher.update;
hasher.update;
let hash2 = hasher.finalize;
assert_eq!;
// Extended output. OutputReader also implements Read.
let mut hasher = new;
hasher.update;
let mut output_reader = hasher.finalize_xof;
let mut output = ;
output_reader.squeeze;
assert_eq!;
License
The Rust wrapping code in this project is released into the public domain via CC0. Vendored XKCP code is covered by a mixture of licenses.