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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
use crate::PI;
use core::fmt;
use digest::{
Digest, HashMarker, Output,
block_api::{
AlgorithmName, Block, BlockSizeUser, Buffer, BufferKindUser, Eager, FixedOutputCore,
OutputSizeUser, Reset, UpdateCore,
},
common::hazmat::{DeserializeStateError, SerializableState, SerializedState},
typenum::{Sum, U8, Unsigned},
};
macro_rules! fsb_impl {
(
$state:ident, $block_size:ident, $output_size:ident, $state_size:ident,
$n:expr, $w:expr, $r:expr, $p:expr, $s:expr, $doc:expr,
) => {
use digest::consts::{$block_size, $output_size, $state_size};
#[derive(Clone)]
#[doc=$doc]
pub struct $state {
blocks_len: u64,
state: [u8; $r / 8],
}
impl HashMarker for $state {}
impl BlockSizeUser for $state {
type BlockSize = $block_size;
}
impl OutputSizeUser for $state {
type OutputSize = $output_size;
}
impl BufferKindUser for $state {
type BufferKind = Eager;
}
impl UpdateCore for $state {
#[inline]
fn update_blocks(&mut self, blocks: &[Block<Self>]) {
self.blocks_len += blocks.len() as u64;
for block in blocks {
Self::compress(&mut self.state, block);
}
}
}
impl FixedOutputCore for $state {
#[inline]
fn finalize_fixed_core(&mut self, buffer: &mut Buffer<Self>, out: &mut Output<Self>) {
let block_bytes = self.blocks_len * Self::BlockSize::U64;
let bit_len = 8 * (block_bytes + buffer.get_pos() as u64);
let mut h = self.state;
buffer.len64_padding_be(bit_len, |b| Self::compress(&mut h, b));
let res = whirlpool::Whirlpool::digest(&h[..]);
let n = out.len();
out.copy_from_slice(&res[..n]);
}
}
impl Default for $state {
#[inline]
fn default() -> Self {
Self {
blocks_len: 0u64,
state: [0u8; $r / 8],
}
}
}
impl Reset for $state {
#[inline]
fn reset(&mut self) {
*self = Default::default();
}
}
impl AlgorithmName for $state {
fn write_alg_name(f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(stringify!($full_state))
}
}
impl fmt::Debug for $state {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(concat!(stringify!($state), " { ... }"))
}
}
impl Drop for $state {
fn drop(&mut self) {
#[cfg(feature = "zeroize")]
{
use digest::zeroize::Zeroize;
self.state.zeroize();
self.blocks_len.zeroize();
}
}
}
#[cfg(feature = "zeroize")]
impl digest::zeroize::ZeroizeOnDrop for $state {}
impl SerializableState for $state {
type SerializedStateSize = Sum<$state_size, U8>;
fn serialize(&self) -> SerializedState<Self> {
let mut serialized_state = SerializedState::<Self>::default();
serialized_state[..self.state.len()].copy_from_slice(&self.state[..]);
serialized_state[self.state.len()..]
.copy_from_slice(&self.blocks_len.to_le_bytes());
serialized_state
}
fn deserialize(
serialized_state: &SerializedState<Self>,
) -> Result<Self, DeserializeStateError> {
let (serialized_state, serialized_block_len) =
serialized_state.split::<$state_size>();
let mut state = [0; $r / 8];
state.copy_from_slice(serialized_state.as_ref());
let blocks_len = u64::from_le_bytes(*serialized_block_len.as_ref());
Ok(Self { state, blocks_len })
}
}
impl $state {
const SIZE_OUTPUT_COMPRESS: usize = $r / 8;
const SIZE_INPUT_COMPRESS: usize = $s / 8;
const SIZE_MSG_CHUNKS: usize = Self::SIZE_INPUT_COMPRESS - Self::SIZE_OUTPUT_COMPRESS;
const SIZE_VECTORS: usize = $p / 8 + 1;
const SHIFT: u8 = 8 - ($p % 8) as u8;
fn define_iv(index: usize) -> [u8; Self::SIZE_VECTORS] {
let mut subset_pi: [u8; Self::SIZE_VECTORS] = [0u8; Self::SIZE_VECTORS];
subset_pi.copy_from_slice(
&PI[index * Self::SIZE_VECTORS..(index + 1) * Self::SIZE_VECTORS],
);
// Now we change the last byte of the vector. We shift right and left, basically to
// replace the last `shift` bits by zero.
if let Some(last) = subset_pi.last_mut() {
*last >>= Self::SHIFT;
*last <<= Self::SHIFT;
}
subset_pi
}
/// Vector XORing. Given the s input bits of the function, we derive a set of w indexes
/// $(W_i)_{i\in[0;w-1]}$ between $0$ and $n - 1$. The value of each $W_i$ is computed
/// from the inputs bits like this:
/// $W_i = i \times (n / w) + IV_i + M_i \times 2^{r / w}.
fn computing_w_indices(
input_vector: &[u8; Self::SIZE_OUTPUT_COMPRESS],
message: &Block<Self>,
) -> [u32; $w] {
let mut wind: [u32; $w] = [0; $w];
let divided_message: [u8; $w] = Self::dividing_bits(message, ($s - $r) / $w);
for i in 0..($w) {
let message_i = divided_message[i] as u32;
wind[i] = (i * $n / $w) as u32
+ input_vector[i] as u32
+ (message_i << ($r / $w) as u8);
}
wind
}
/// This function servers the purpose presented in table 3, of breaking a bit array into
/// batches of size not multiple of 8. Note that the IV will be broken always in size 8, which
/// is quite convenient. Also, the only numbers we'll have to worry for are 5 and 6.
fn dividing_bits(input_bits: &Block<Self>, size_batches: usize) -> [u8; $w] {
if size_batches != 5usize && size_batches != 6usize {
panic!(
"Expecting batches of size 5 or 6. Other values do not follow \
the standard specification"
)
}
let mut new_bits = [0u8; $w];
let shifting_factor = (8 - size_batches) as u8;
for (i, new_bit) in new_bits.iter_mut().enumerate().take($w - 1) {
let position = i * size_batches;
let initial_byte = position / 8;
let initial_bit = position % 8;
let switch = (initial_bit + size_batches - 1) / 8; // check if we use the next byte
if switch == 1 {
*new_bit = (input_bits[initial_byte] << initial_bit as u8
| input_bits[initial_byte + 1] >> (8 - initial_bit as u8))
>> shifting_factor;
} else {
*new_bit =
(input_bits[initial_byte] << initial_bit as u8) >> shifting_factor;
}
}
new_bits[$w - 1] =
(input_bits[Self::SIZE_MSG_CHUNKS - 1] << shifting_factor) >> shifting_factor;
new_bits
}
/// This function outputs r bits, which are used to chain to the next iteration.
fn compress(hash: &mut [u8; Self::SIZE_OUTPUT_COMPRESS], message_block: &Block<Self>) {
let mut initial_vector = [0u8; Self::SIZE_OUTPUT_COMPRESS];
let w_indices = Self::computing_w_indices(hash, message_block);
for w_index in w_indices.iter() {
let chosen_vec = w_index / $r as u32;
let shift_value = w_index % $r as u32;
let mut vector = Self::define_iv(chosen_vec as usize);
let truncated = Self::shift_and_truncate(&mut vector, shift_value);
initial_vector
.iter_mut()
.zip(truncated.iter())
.for_each(|(x1, x2)| *x1 ^= *x2);
}
*hash = initial_vector;
}
fn shift_and_truncate(
array: &mut [u8; Self::SIZE_VECTORS],
shift_value: u32,
) -> [u8; Self::SIZE_OUTPUT_COMPRESS] {
let array_len = array.len();
let bits_in_cue = ($p % 8) as u8;
let mut truncated = [0u8; Self::SIZE_OUTPUT_COMPRESS];
if shift_value == 0 {
truncated.copy_from_slice(&array[..Self::SIZE_OUTPUT_COMPRESS]);
} else if shift_value <= (bits_in_cue as u32) {
let bytes_to_shift = 1;
let starting_byte = (array_len - bytes_to_shift) as usize;
truncated[0] = array[starting_byte] << (bits_in_cue - shift_value as u8);
truncated[0] ^= array[0] >> shift_value;
for position in 1..Self::SIZE_OUTPUT_COMPRESS {
truncated[position] ^= array[position - 1] << (8 - shift_value);
truncated[position] ^= array[position] >> shift_value;
}
} else {
// First we need to decide which is the last byte and bit that will go to the first position.
// Then, we build our truncated array from there. Recall that the last byte is not complete,
// and we have a total of P % 8 hanging bits (this will always happen).
let bytes_to_shift =
(((shift_value - bits_in_cue as u32 - 1) / 8) + 2) as usize;
// So then, the starting byte will be:
let starting_byte = (array_len - bytes_to_shift) as usize;
// And the starting bit:
let remaining_bits = ((shift_value - bits_in_cue as u32) % 8) as u8;
if remaining_bits != 0 {
for position in 0..(bytes_to_shift - 1) {
truncated[position] = array[starting_byte + position]
<< (8 - remaining_bits)
| array[starting_byte + position + 1] >> remaining_bits;
}
// The last case is different, as we don't know if there are sufficient bits in the cue to fill
// up a full byte. We have three cases: 1. where P % 8 (bits_in_cue) is larger than
// starting_bit, 2. where it is equal, and 3. where it is smaller. But we can fill the bits, and
// then decide how to proceed depending on the difference.
let difference = bits_in_cue.checked_sub(8 - remaining_bits);
match difference {
Some(x) => {
if x > 0 {
// the next position takes starting_bits from the byte with the remaining zeros, and
// `difference` from the first byte. Then we iterate by shifting 8 - difference bits.
truncated[bytes_to_shift - 1] ^= array
[starting_byte + bytes_to_shift - 1]
<< (bits_in_cue - x);
truncated[bytes_to_shift - 1] ^= array[0] >> x;
for (index, position) in
(bytes_to_shift..Self::SIZE_OUTPUT_COMPRESS).enumerate()
{
truncated[position] ^= array[index] << (8 - x);
truncated[position] ^= array[index + 1] >> x;
}
} else {
for (index, position) in ((bytes_to_shift - 1)
..Self::SIZE_OUTPUT_COMPRESS)
.enumerate()
{
truncated[position] = array[index];
}
}
}
None => {
let positive_diff = (8 - remaining_bits) - bits_in_cue;
// we need to fill the remainder with bits of the next byte.
truncated[bytes_to_shift - 2] ^= array[0] >> (8 - positive_diff);
for (index, position) in
((bytes_to_shift - 1)..Self::SIZE_OUTPUT_COMPRESS).enumerate()
{
truncated[position] ^= array[index] << positive_diff;
truncated[position] ^= array[index + 1] >> (8 - positive_diff);
}
}
}
} else {
truncated[..bytes_to_shift].clone_from_slice(
&array[starting_byte..(starting_byte + bytes_to_shift)],
);
// we need to fill the remainder with bits of the next byte.
truncated[bytes_to_shift - 1] ^= array[0] >> bits_in_cue;
for (index, position) in
(bytes_to_shift..Self::SIZE_OUTPUT_COMPRESS).enumerate()
{
truncated[position] ^= array[index] << (8 - bits_in_cue);
truncated[position] ^= array[index + 1] >> bits_in_cue;
}
}
}
truncated
}
}
};
}
fsb_impl!(
Fsb160Core,
U60,
U20,
U80,
5 << 18,
80,
640,
653,
1120,
"Core FSB-160 hasher state",
);
fsb_impl!(
Fsb224Core,
U84,
U28,
U112,
7 << 18,
112,
896,
907,
1568,
"Core FSB-224 hasher state",
);
fsb_impl!(
Fsb256Core,
U96,
U32,
U128,
1 << 21,
128,
1024,
1061,
1792,
"Core FSB-256 hasher state",
);
fsb_impl!(
Fsb384Core,
U115,
U48,
U184,
23 << 16,
184,
1472,
1483,
2392,
"Core FSB-384 hasher state",
);
fsb_impl!(
Fsb512Core,
U155,
U64,
U248,
31 << 16,
248,
1984,
1987,
3224,
"Core FSB-512 hasher state",
);