1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
SipHash implementation for Rust
===============================
This crates implements SipHash-2-4 and SipHash-1-3 in Rust.
It is based on the original implementation from rust-core and exposes the
same API.
It also implements SipHash variants returning 128-bit tags.
The `sip` module implements the standard 64-bit mode, whereas the `sip128`
module implements the 128-bit mode.
Usage
-----
In `Cargo.toml`:
```toml
[dependencies]
siphasher = "0.3"
```
If you want [serde](https://github.com/serde-rs/serde) support, include the feature like this:
```toml
[dependencies]
siphasher = { version = "0.3", features = ["serde"] }
```
64-bit mode:
```rust
use siphasher::sip::{SipHasher, SipHasher13, SipHasher24};
// one-shot:
let array: &[u8] = &[1, 2, 3];
let key: &[u8; 16] = &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
let hasher = SipHasher13::new_with_key(key);
let h = hasher.hash(array);
// incremental:
use core::hash::Hasher;
let array1: &[u8] = &[1, 2, 3];
let array2: &[u8] = &[4, 5, 6];
let key: &[u8; 16] = &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
let mut hasher = SipHasher13::new_with_key(key);
hasher.write(array1);
hasher.write(array2);
let h = hasher.finish();
```
128-bit mode:
```rust
use siphasher::sip128::{Hasher128, Siphasher, SipHasher13, SipHasher24};
// one-shot:
let array: &[u8] = &[1, 2, 3];
let key: &[u8; 16] = &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
let hasher = SipHasher13::new_with_key(key);
let h = hasher.hash(array).as_bytes();
// incremental:
use core::hash::Hasher;
let array1: &[u8] = &[1, 2, 3];
let array2: &[u8] = &[4, 5, 6];
let key: &[u8; 16] = &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
let mut hasher = SipHasher13::new_with_key(key);
hasher.write(array1);
hasher.write(array2);
let h = hasher.finish128().as_bytes();
```
[API documentation](https://docs.rs/siphasher/)
-----------------------------------------------
Note
----
Due to a confusing and not well documented API, methods from the `Hasher` trait of the standard library (`std::hash::Hasher`, `core::hash::Hasher`) produce non-portable results.
This is not specific to SipHash, and affects all hash functions.
The only safe methods in that trait are `write()` and `finish()`.
It is thus recommended to use SipHash (and all other hash functions, actually) as documented above.
|
