bab_rs 0.6.0

An implementation of the Bab family of hash functions, and its WILLIAM3 instantiation.
Documentation 
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use anyhash::{Hasher, HasherWrite};

use crate::{
    CHUNK_SIZE, HashChunkContext, HashInnerContext, WIDTH, William3Digest,
    generic::{BabHasher as GenericHasher, BabInstantiation},
    hash_chunk, hash_inner,
};

/// A stateful hasher for incrementally computing WILLIAM3 digests.
///
/// Use the [`anyhash::Hasher`] and [`anyhash::HasherWrite`] traits to compute digests. This crate reexports them at the root for convenience.
///
/// ```
/// # #[cfg(feature = "william3")] {
/// use bab_rs::{William3Hasher, William3Digest, batch_hash, WIDTH, Hasher, HasherWrite};
/// let mut hasher = William3Hasher::new();
/// hasher.write(&[0, 1, 2]);
/// hasher.write(&[3, 4]);
/// let digest1 = hasher.finish();
///
/// let mut batch_digest1 = William3Digest::default();
/// batch_hash(&[0, 1, 2, 3, 4], &mut batch_digest1);
///
/// assert_eq!(digest1, batch_digest1);
///
/// // You can continue using the hasher after calling `finish`.
/// hasher.write(&[5, 6]);
///
/// let mut batch_digest2 = William3Digest::default();
/// batch_hash(&[0, 1, 2, 3, 4, 5, 6], &mut batch_digest2);
///
/// assert_eq!(
///     hasher.finish(),
///     batch_digest2,
/// );
/// # }
/// ```
pub struct William3Hasher {
    hasher: GenericHasher<WIDTH, CHUNK_SIZE, HashChunkContext, HashInnerContext>,
}

impl William3Hasher {
    /// Creates a new WILLIAM3 hasher.
    pub fn new() -> Self {
        let bab_instantiation = BabInstantiation {
            hash_chunk,
            hash_inner,
            hash_chunk_context: HashChunkContext::new(),
            hash_inner_context: HashInnerContext::new(),
        };

        Self {
            hasher: GenericHasher::new(bab_instantiation),
        }
    }

    /// Creates a new WILLIAM3 hasher for keyed hashing.
    pub fn new_keyed(key: [u32; 8]) -> Self {
        let bab_instantiation = BabInstantiation {
            hash_chunk,
            hash_inner,
            hash_chunk_context: HashChunkContext::new_keyed(key),
            hash_inner_context: HashInnerContext::new_keyed(key),
        };

        Self {
            hasher: GenericHasher::new(bab_instantiation),
        }
    }
}

impl HasherWrite for William3Hasher {
    fn write(&mut self, bytes: &[u8]) {
        self.hasher.write(bytes)
    }
}

impl Hasher<William3Digest> for William3Hasher {
    fn finish(&self) -> William3Digest {
        self.hasher.finish().into()
    }
}

impl Default for William3Hasher {
    fn default() -> Self {
        Self::new()
    }
}

#[test]
fn test_hasher() {
    let data = [17u8; CHUNK_SIZE * 16];

    for len in 0..data.len() {
        let mut digest_batch = [0; WIDTH].into();
        crate::batch_hash(&data[..len], &mut digest_batch);

        let mut hasher = William3Hasher::new();
        hasher.write(&data[..len]);
        let digest_hasher = hasher.finish();

        assert_eq!(digest_hasher, digest_batch);
    }
}

#[cfg(all(feature = "william3", feature = "std"))]
#[test]
fn generate_test_data() {
    let mut data = vec![];
    data.push(vec![]);
    data.push(vec![0]);
    data.push(vec![1; 1024]);
    data.push(vec![2; 1025]);
    data.push(vec![3; 4097]);

    for bytes in data {
        let mut digest_batch = [0; WIDTH].into();
        crate::batch_hash(&bytes[..], &mut digest_batch);

        println!(
            "input ({:?} repeated bytes):\n{:?}\n\ndigest:\n{:?}\n\n======\n\n",
            bytes.len(),
            &bytes[..],
            digest_batch.as_bytes()
        );
    }
}