Crates.io | multimixer-128 |
lib.rs | multimixer-128 |
version | 0.1.4 |
source | src |
created_at | 2023-11-07 10:36:47.851436 |
updated_at | 2023-11-25 15:54:58.262071 |
description | Universal Keyed Hashing Based on Integer Multiplication |
homepage | |
repository | https://github.com/itzmeanjan/multimixer-128.git |
max_upload_size | |
id | 1027938 |
size | 4,301,074 |
Multimixer-128: Universal Keyed Hashing Based on Integer Multiplication
$Multimixer_{128}$ is a universal keyed hashing algorithm, based on just integer arithmetic ( addition and multiplication ), proposed in paper https://ia.cr/2023/1357.
A keyed hash function, takes a key and a variable length message as input, compressing it to a fixed length digest. The keyed hashing scheme proposed in $Multimixer_{128}$ paper, takes equal length key and message ( meaning long keys will be required, in case message is long ) s.t. they are multiple of block size ( = 32 -bytes ) and compresses them into a 64 -bytes digest. It's proved to be an ε-∆universal hash function with ε = $2^{−127}$. It can be used during the compression phase of a message authentication code computation scheme. It can also be used in the compression phase of the Farfalle construction - which are used for building deck functions.
As $Multimixer_{128}$ is just based on integer arithmetic, which is pretty fast on most processors, it shows quite promising results during benchmarks. See below.
You can also find more details on how to start using $Multimixer_{128}$ API, below.
Rust stable toolchain; see https://rustup.rs for installation guide.
# When developing this library, I was using
$ rustc --version
rustc 1.73.0 (cc66ad468 2023-10-03)
[!TIP] I advise you to use
cargo-criterion
for running benchmark executable. Read more about it @ https://crates.io/crates/cargo-criterion. You can just issue following command for installing it system-wide.
cargo install cargo-criterion
For ensuring functional correctness and conformance to the specification of $Multimixer_{128}$ i.e. https://ia.cr/2023/1357 ( and its reference implementation https://github.com/Parisaa/Multimixer ), I use known answer tests that I've generated by following instructions described in https://gist.github.com/itzmeanjan/a32eab0244af55eba2847c6472337535.
cargo test --lib
Issue following command for benchmarking public function $f_{128}$ and $Multimixer_{128}$, with variable ( non-zero multiple of 32 -bytes ) length input key and message, on target CPU.
[!NOTE] When benchmarking on
x86
,x86_64
,aarch64
orloongarch64
targets, CPU cycles and cycles/ byte metrics are reported, while for other targets, default wallclock timer of criterion.rs is used for reporting time and throughput. I found https://github.com/pornin/crrl/blob/73b33c1efc73d637f3084d197353991a22c10366/benches/util.rs pretty useful for obtaining CPU cycles when benchmarking Rust functions. But I'm using criterion.rs as benchmark harness, hence I decided to go with https://crates.io/crates/criterion-cycles-per-byte plugin, much easier to integrate. But I had to patch it for my usecase and they live in the branchadd-memfence
of my fork ofcriterion-cycles-per-byte
( see my commits @ https://github.com/itzmeanjan/criterion-cycles-per-byte/commits/add-memfence ).
[!NOTE] In case you're running benchmarks on aarch64 target, consider reading https://github.com/itzmeanjan/criterion-cycles-per-byte/blob/d2f5bf8638640962a9b301966dbb3e65fbc6f283/src/lib.rs#L63-L70.
[!CAUTION] When benchmarking make sure you've disabled CPU frequency scaling, otherwise numbers you see can be pretty misleading. I found https://github.com/google/benchmark/blob/b40db869/docs/reducing_variance.md helpful.
# In case you didn't install `cargo-criterion`, you have to run benchmark with
# RUSTFLAGS="-C opt-level=3 -C target-cpu=native" cargo bench --features="internal"
RUSTFLAGS="-C opt-level=3 -C target-cpu=native" cargo criterion --features="internal"
f_128/f-128 (cached) time: [6.9927 cycles 7.0443 cycles 7.1069 cycles]
thrpt: [0.2221 cpb 0.2201 cpb 0.2185 cpb]
f_128/f-128 (random) time: [21.1852 cycles 21.3297 cycles 21.4551 cycles]
thrpt: [0.6705 cpb 0.6666 cpb 0.6620 cpb]
multimixer_128/32B key/ msg (cached)
time: [14.0913 cycles 14.1296 cycles 14.1664 cycles]
thrpt: [0.2214 cpb 0.2208 cpb 0.2202 cpb]
multimixer_128/32B key/ msg (random)
time: [63.4513 cycles 63.8913 cycles 64.3942 cycles]
thrpt: [1.0062 cpb 0.9983 cpb 0.9914 cpb]
multimixer_128/128B key/ msg (cached)
time: [42.2552 cycles 42.2975 cycles 42.3421 cycles]
thrpt: [0.1654 cpb 0.1652 cpb 0.1651 cpb]
multimixer_128/128B key/ msg (random)
time: [107.6240 cycles 109.1370 cycles 111.0124 cycles]
thrpt: [0.4336 cpb 0.4263 cpb 0.4204 cpb]
multimixer_128/512B key/ msg (cached)
time: [166.6061 cycles 166.8388 cycles 167.0822 cycles]
thrpt: [0.1632 cpb 0.1629 cpb 0.1627 cpb]
multimixer_128/512B key/ msg (random)
time: [239.1786 cycles 240.4487 cycles 241.9385 cycles]
thrpt: [0.2363 cpb 0.2348 cpb 0.2336 cpb]
multimixer_128/2048B key/ msg (cached)
time: [606.0156 cycles 606.3316 cycles 606.6701 cycles]
thrpt: [0.1481 cpb 0.1480 cpb 0.1480 cpb]
multimixer_128/2048B key/ msg (random)
time: [835.5582 cycles 848.0583 cycles 859.5641 cycles]
thrpt: [0.2099 cpb 0.2070 cpb 0.2040 cpb]
multimixer_128/8192B key/ msg (cached)
time: [2346.9930 cycles 2347.5554 cycles 2348.2118 cycles]
thrpt: [0.1433 cpb 0.1433 cpb 0.1432 cpb]
multimixer_128/8192B key/ msg (random)
time: [2816.3210 cycles 2838.9367 cycles 2859.1557 cycles]
thrpt: [0.1745 cpb 0.1733 cpb 0.1719 cpb]
f_128/f-128 (cached) time: [33.5869 cycles 33.6835 cycles 33.7842 cycles]
thrpt: [1.0558 cpb 1.0526 cpb 1.0496 cpb]
f_128/f-128 (random) time: [118.9137 cycles 119.6657 cycles 120.5443 cycles]
thrpt: [3.7670 cpb 3.7396 cpb 3.7161 cpb]
multimixer_128/32B key/ msg (cached)
time: [189.0723 cycles 189.1691 cycles 189.2789 cycles]
thrpt: [2.9575 cpb 2.9558 cpb 2.9543 cpb]
multimixer_128/32B key/ msg (random)
time: [433.4768 cycles 436.1863 cycles 438.5723 cycles]
thrpt: [6.8527 cpb 6.8154 cpb 6.7731 cpb]
multimixer_128/128B key/ msg (cached)
time: [699.8622 cycles 699.9601 cycles 700.0751 cycles]
thrpt: [2.7347 cpb 2.7342 cpb 2.7338 cpb]
multimixer_128/128B key/ msg (random)
time: [978.8853 cycles 979.8636 cycles 980.9012 cycles]
thrpt: [3.8316 cpb 3.8276 cpb 3.8238 cpb]
multimixer_128/512B key/ msg (cached)
time: [2742.5257 cycles 2743.5495 cycles 2744.8465 cycles]
thrpt: [2.6805 cpb 2.6792 cpb 2.6782 cpb]
multimixer_128/512B key/ msg (random)
time: [3223.0299 cycles 3228.1490 cycles 3233.4994 cycles]
thrpt: [3.1577 cpb 3.1525 cpb 3.1475 cpb]
multimixer_128/2048B key/ msg (cached)
time: [10932.5461 cycles 10935.6646 cycles 10939.9686 cycles]
thrpt: [2.6709 cpb 2.6698 cpb 2.6691 cpb]
multimixer_128/2048B key/ msg (random)
time: [12448.8476 cycles 12496.1792 cycles 12541.6384 cycles]
thrpt: [3.0619 cpb 3.0508 cpb 3.0393 cpb]
multimixer_128/8192B key/ msg (cached)
time: [44770.5750 cycles 44779.3846 cycles 44790.3585 cycles]
thrpt: [2.7338 cpb 2.7331 cpb 2.7326 cpb]
multimixer_128/8192B key/ msg (random)
time: [45914.0882 cycles 45978.0062 cycles 46044.7573 cycles]
thrpt: [2.8103 cpb 2.8063 cpb 2.8024 cpb]
Using $Multimixer_{128}$ hasher API is pretty straight-forward.
multimixer-128
to the [dependencies] section of the Cargo.toml file of your project.[dependencies]
multimixer-128 = { git = "https://github.com/itzmeanjan/multimixer-128" }
# or
multimixer-128 = "0.1.4"
# In case you're also interested in using f_128, the public function of multimixer-128,
# enable `internal` feature-gate of this crate.
#
# multimixer-128 = { version = "0.1.4", features = "internal" }
use multimixer_128;
fn main() {
const BLOCKS: usize = 1;
const MLEN: usize = multimixer_128::BLOCK_SIZE * BLOCKS;
// Beware, this is just an example key !
let key = [0x0fu8; MLEN];
let msg = [0xf0u8; MLEN];
let mut dig = [0u8; multimixer_128::DIGEST_SIZE];
// ...
}
fn main() {
// ...
multimixer_128::multimixer_128(&key, &msg, &mut dig);
assert_eq!(dig, [1, 0, 0, 0, 254, 255, 255, 255, 1, 0, 0, 0, 254, 255, 255, 255, 1, 0, 0, 0, 254, 255, 255, 255, 1, 0, 0, 0, 254, 255, 255, 255, 9, 0, 0, 0, 250, 255, 255, 255, 9, 0, 0, 0, 250, 255, 255, 255, 9, 0, 0, 0, 250, 255, 255, 255, 9, 0, 0, 0, 250, 255, 255, 255]);
}
I'm maintaining an example program, demonstrating usage of $Multimixer_{128}$ API, living inside examples directory.
cargo run --example multimixer_128
Key = e02f28d290bd51df3b103396debe7f2ffc90b837588e37b13a7cc8cccce9fa11
Message = 1511ad54daae3df6706e33d9953f5dff4eabb2da85ad1added1aba2e0b571397
Digest = d2324595d842cb028205c1f00328ba760d292a690452726d95728070ee7ff21e8e6af14b1e4c6d15404e709fd1fec952da3e3b7b3fe7d038fca793f3b4d7661a
[!NOTE] Most of the internal functions of this library crate are implemented as
const fn
i.e. compile-time evaluable functions. That's why I also maintain another example f_128.rs which demonstrates that property of this library using static assertions. Try executing the example program by issuing$ cargo run --example f_128 --features="internal"
and you'll see it.