miden-crypto/src/hash/rescue/mod.rs
src/hash/rescue/mod.rsRaw
1use core::ops::Range;
2
3use super::{
4 CubeExtension, Digest, ElementHasher, Felt, FieldElement, Hasher, StarkField, ONE, ZERO,
5};
6
7mod arch;
8pub use arch::optimized::{add_constants_and_apply_inv_sbox, add_constants_and_apply_sbox};
9
10mod mds;
11use mds::{apply_mds, MDS};
12
13mod rpo;
14pub use rpo::{Rpo256, RpoDigest, RpoDigestError};
15
16mod rpx;
17pub use rpx::{Rpx256, RpxDigest, RpxDigestError};
18
19#[cfg(test)]
20mod tests;
21
22// CONSTANTS
23// ================================================================================================
24
25/// The number of rounds is set to 7. For the RPO hash functions all rounds are uniform. For the
26/// RPX hash function, there are 3 different types of rounds.
27const NUM_ROUNDS: usize = 7;
28
29/// Sponge state is set to 12 field elements or 96 bytes; 8 elements are reserved for rate and
30/// the remaining 4 elements are reserved for capacity.
31const STATE_WIDTH: usize = 12;
32
33/// The rate portion of the state is located in elements 4 through 11.
34const RATE_RANGE: Range<usize> = 4..12;
35const RATE_WIDTH: usize = RATE_RANGE.end - RATE_RANGE.start;
36
37const INPUT1_RANGE: Range<usize> = 4..8;
38const INPUT2_RANGE: Range<usize> = 8..12;
39
40/// The capacity portion of the state is located in elements 0, 1, 2, and 3.
41const CAPACITY_RANGE: Range<usize> = 0..4;
42
43/// The output of the hash function is a digest which consists of 4 field elements or 32 bytes.
44///
45/// The digest is returned from state elements 4, 5, 6, and 7 (the first four elements of the
46/// rate portion).
47const DIGEST_RANGE: Range<usize> = 4..8;
48const DIGEST_SIZE: usize = DIGEST_RANGE.end - DIGEST_RANGE.start;
49
50/// The number of bytes needed to encoded a digest
51const DIGEST_BYTES: usize = 32;
52
53/// The number of byte chunks defining a field element when hashing a sequence of bytes
54const BINARY_CHUNK_SIZE: usize = 7;
55
56/// S-Box and Inverse S-Box powers;
57///
58/// The constants are defined for tests only because the exponentiations in the code are unrolled
59/// for efficiency reasons.
60#[cfg(test)]
61const ALPHA: u64 = 7;
62#[cfg(test)]
63const INV_ALPHA: u64 = 10540996611094048183;
64
65// SBOX FUNCTION
66// ================================================================================================
67
68#[inline(always)]
69fn apply_sbox(state: &mut [Felt; STATE_WIDTH]) {
70 state[0] = state[0].exp7();
71 state[1] = state[1].exp7();
72 state[2] = state[2].exp7();
73 state[3] = state[3].exp7();
74 state[4] = state[4].exp7();
75 state[5] = state[5].exp7();
76 state[6] = state[6].exp7();
77 state[7] = state[7].exp7();
78 state[8] = state[8].exp7();
79 state[9] = state[9].exp7();
80 state[10] = state[10].exp7();
81 state[11] = state[11].exp7();
82}
83
84// INVERSE SBOX FUNCTION
85// ================================================================================================
86
87#[inline(always)]
88fn apply_inv_sbox(state: &mut [Felt; STATE_WIDTH]) {
89 // compute base^10540996611094048183 using 72 multiplications per array element
90 // 10540996611094048183 = b1001001001001001001001001001000110110110110110110110110110110111
91
92 // compute base^10
93 let mut t1 = *state;
94 t1.iter_mut().for_each(|t| *t = t.square());
95
96 // compute base^100
97 let mut t2 = t1;
98 t2.iter_mut().for_each(|t| *t = t.square());
99
100 // compute base^100100
101 let t3 = exp_acc::<Felt, STATE_WIDTH, 3>(t2, t2);
102
103 // compute base^100100100100
104 let t4 = exp_acc::<Felt, STATE_WIDTH, 6>(t3, t3);
105
106 // compute base^100100100100100100100100
107 let t5 = exp_acc::<Felt, STATE_WIDTH, 12>(t4, t4);
108
109 // compute base^100100100100100100100100100100
110 let t6 = exp_acc::<Felt, STATE_WIDTH, 6>(t5, t3);
111
112 // compute base^1001001001001001001001001001000100100100100100100100100100100
113 let t7 = exp_acc::<Felt, STATE_WIDTH, 31>(t6, t6);
114
115 // compute base^1001001001001001001001001001000110110110110110110110110110110111
116 for (i, s) in state.iter_mut().enumerate() {
117 let a = (t7[i].square() * t6[i]).square().square();
118 let b = t1[i] * t2[i] * *s;
119 *s = a * b;
120 }
121
122 #[inline(always)]
123 fn exp_acc<B: StarkField, const N: usize, const M: usize>(
124 base: [B; N],
125 tail: [B; N],
126 ) -> [B; N] {
127 let mut result = base;
128 for _ in 0..M {
129 result.iter_mut().for_each(|r| *r = r.square());
130 }
131 result.iter_mut().zip(tail).for_each(|(r, t)| *r *= t);
132 result
133 }
134}
135
136#[inline(always)]
137fn add_constants(state: &mut [Felt; STATE_WIDTH], ark: &[Felt; STATE_WIDTH]) {
138 state.iter_mut().zip(ark).for_each(|(s, &k)| *s += k);
139}
140
141// ROUND CONSTANTS
142// ================================================================================================
143
144/// Rescue round constants;
145/// computed as in [specifications](https://github.com/ASDiscreteMathematics/rpo)
146///
147/// The constants are broken up into two arrays ARK1 and ARK2; ARK1 contains the constants for the
148/// first half of RPO round, and ARK2 contains constants for the second half of RPO round.
149const ARK1: [[Felt; STATE_WIDTH]; NUM_ROUNDS] = [
150 [
151 Felt::new(5789762306288267392),
152 Felt::new(6522564764413701783),
153 Felt::new(17809893479458208203),
154 Felt::new(107145243989736508),
155 Felt::new(6388978042437517382),
156 Felt::new(15844067734406016715),
157 Felt::new(9975000513555218239),
158 Felt::new(3344984123768313364),
159 Felt::new(9959189626657347191),
160 Felt::new(12960773468763563665),
161 Felt::new(9602914297752488475),
162 Felt::new(16657542370200465908),
163 ],
164 [
165 Felt::new(12987190162843096997),
166 Felt::new(653957632802705281),
167 Felt::new(4441654670647621225),
168 Felt::new(4038207883745915761),
169 Felt::new(5613464648874830118),
170 Felt::new(13222989726778338773),
171 Felt::new(3037761201230264149),
172 Felt::new(16683759727265180203),
173 Felt::new(8337364536491240715),
174 Felt::new(3227397518293416448),
175 Felt::new(8110510111539674682),
176 Felt::new(2872078294163232137),
177 ],
178 [
179 Felt::new(18072785500942327487),
180 Felt::new(6200974112677013481),
181 Felt::new(17682092219085884187),
182 Felt::new(10599526828986756440),
183 Felt::new(975003873302957338),
184 Felt::new(8264241093196931281),
185 Felt::new(10065763900435475170),
186 Felt::new(2181131744534710197),
187 Felt::new(6317303992309418647),
188 Felt::new(1401440938888741532),
189 Felt::new(8884468225181997494),
190 Felt::new(13066900325715521532),
191 ],
192 [
193 Felt::new(5674685213610121970),
194 Felt::new(5759084860419474071),
195 Felt::new(13943282657648897737),
196 Felt::new(1352748651966375394),
197 Felt::new(17110913224029905221),
198 Felt::new(1003883795902368422),
199 Felt::new(4141870621881018291),
200 Felt::new(8121410972417424656),
201 Felt::new(14300518605864919529),
202 Felt::new(13712227150607670181),
203 Felt::new(17021852944633065291),
204 Felt::new(6252096473787587650),
205 ],
206 [
207 Felt::new(4887609836208846458),
208 Felt::new(3027115137917284492),
209 Felt::new(9595098600469470675),
210 Felt::new(10528569829048484079),
211 Felt::new(7864689113198939815),
212 Felt::new(17533723827845969040),
213 Felt::new(5781638039037710951),
214 Felt::new(17024078752430719006),
215 Felt::new(109659393484013511),
216 Felt::new(7158933660534805869),
217 Felt::new(2955076958026921730),
218 Felt::new(7433723648458773977),
219 ],
220 [
221 Felt::new(16308865189192447297),
222 Felt::new(11977192855656444890),
223 Felt::new(12532242556065780287),
224 Felt::new(14594890931430968898),
225 Felt::new(7291784239689209784),
226 Felt::new(5514718540551361949),
227 Felt::new(10025733853830934803),
228 Felt::new(7293794580341021693),
229 Felt::new(6728552937464861756),
230 Felt::new(6332385040983343262),
231 Felt::new(13277683694236792804),
232 Felt::new(2600778905124452676),
233 ],
234 [
235 Felt::new(7123075680859040534),
236 Felt::new(1034205548717903090),
237 Felt::new(7717824418247931797),
238 Felt::new(3019070937878604058),
239 Felt::new(11403792746066867460),
240 Felt::new(10280580802233112374),
241 Felt::new(337153209462421218),
242 Felt::new(13333398568519923717),
243 Felt::new(3596153696935337464),
244 Felt::new(8104208463525993784),
245 Felt::new(14345062289456085693),
246 Felt::new(17036731477169661256),
247 ],
248];
249
250const ARK2: [[Felt; STATE_WIDTH]; NUM_ROUNDS] = [
251 [
252 Felt::new(6077062762357204287),
253 Felt::new(15277620170502011191),
254 Felt::new(5358738125714196705),
255 Felt::new(14233283787297595718),
256 Felt::new(13792579614346651365),
257 Felt::new(11614812331536767105),
258 Felt::new(14871063686742261166),
259 Felt::new(10148237148793043499),
260 Felt::new(4457428952329675767),
261 Felt::new(15590786458219172475),
262 Felt::new(10063319113072092615),
263 Felt::new(14200078843431360086),
264 ],
265 [
266 Felt::new(6202948458916099932),
267 Felt::new(17690140365333231091),
268 Felt::new(3595001575307484651),
269 Felt::new(373995945117666487),
270 Felt::new(1235734395091296013),
271 Felt::new(14172757457833931602),
272 Felt::new(707573103686350224),
273 Felt::new(15453217512188187135),
274 Felt::new(219777875004506018),
275 Felt::new(17876696346199469008),
276 Felt::new(17731621626449383378),
277 Felt::new(2897136237748376248),
278 ],
279 [
280 Felt::new(8023374565629191455),
281 Felt::new(15013690343205953430),
282 Felt::new(4485500052507912973),
283 Felt::new(12489737547229155153),
284 Felt::new(9500452585969030576),
285 Felt::new(2054001340201038870),
286 Felt::new(12420704059284934186),
287 Felt::new(355990932618543755),
288 Felt::new(9071225051243523860),
289 Felt::new(12766199826003448536),
290 Felt::new(9045979173463556963),
291 Felt::new(12934431667190679898),
292 ],
293 [
294 Felt::new(18389244934624494276),
295 Felt::new(16731736864863925227),
296 Felt::new(4440209734760478192),
297 Felt::new(17208448209698888938),
298 Felt::new(8739495587021565984),
299 Felt::new(17000774922218161967),
300 Felt::new(13533282547195532087),
301 Felt::new(525402848358706231),
302 Felt::new(16987541523062161972),
303 Felt::new(5466806524462797102),
304 Felt::new(14512769585918244983),
305 Felt::new(10973956031244051118),
306 ],
307 [
308 Felt::new(6982293561042362913),
309 Felt::new(14065426295947720331),
310 Felt::new(16451845770444974180),
311 Felt::new(7139138592091306727),
312 Felt::new(9012006439959783127),
313 Felt::new(14619614108529063361),
314 Felt::new(1394813199588124371),
315 Felt::new(4635111139507788575),
316 Felt::new(16217473952264203365),
317 Felt::new(10782018226466330683),
318 Felt::new(6844229992533662050),
319 Felt::new(7446486531695178711),
320 ],
321 [
322 Felt::new(3736792340494631448),
323 Felt::new(577852220195055341),
324 Felt::new(6689998335515779805),
325 Felt::new(13886063479078013492),
326 Felt::new(14358505101923202168),
327 Felt::new(7744142531772274164),
328 Felt::new(16135070735728404443),
329 Felt::new(12290902521256031137),
330 Felt::new(12059913662657709804),
331 Felt::new(16456018495793751911),
332 Felt::new(4571485474751953524),
333 Felt::new(17200392109565783176),
334 ],
335 [
336 Felt::new(17130398059294018733),
337 Felt::new(519782857322261988),
338 Felt::new(9625384390925085478),
339 Felt::new(1664893052631119222),
340 Felt::new(7629576092524553570),
341 Felt::new(3485239601103661425),
342 Felt::new(9755891797164033838),
343 Felt::new(15218148195153269027),
344 Felt::new(16460604813734957368),
345 Felt::new(9643968136937729763),
346 Felt::new(3611348709641382851),
347 Felt::new(18256379591337759196),
348 ],
349];