aboutsummaryrefslogtreecommitdiffstats
path: root/java-c-jni/SHA3.java
blob: 4be013eb98b6f7617d4a01da90d8b46c4896a8e5 (plain) (blame)
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
/**
 * sha3sum – SHA-3 (Keccak) checksum calculator
 * 
 * Copyright © 2013, 2014  Mattias Andrée (maandree@member.fsf.org)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
import java.io.*;
import java.util.*;


/**
 * SHA-3/Keccak hash algorithm implementation
 * 
 * @author  Mattias Andrée  <a href="mailto:maandree@member.fsf.org">maandree@member.fsf.org</a>
 */
public class SHA3
{
    /**
     * Suffix the message when calculating the Keccak hash sum
     */
    public static final String KECCAK_SUFFIX = "";
    
    /**
     * Suffix the message when calculating the SHA-3 hash sum
     */
    public static final String SHA3_SUFFIX = "01";
    
    /**
     * Suffix the message when calculating the RawSHAKE hash sum
     */
    public static final String RawSHAKE_SUFFIX = "11";
    
    /**
     * Suffix the message when calculating the SHAKE hash sum
     */
    public static final String SHAKE_SUFFIX = "1111";
    
    
    
    /**
     * Hidden constructor
     */
    private SHA3()
    {
	// Inhibit instansiation
    }
    

    
    /**
     * Class initialiser
     */
    static
    {
	try
	{
	    System.load((new File("./SHA3.so")).getCanonicalPath());
	}
	catch (IOException err)
	{
	    throw new Error("SHA3 library cannot be found");
	}
    }
    
    
    
    /**
     * Initialise Keccak sponge
     * 
     * @param  r  The bitrate
     * @param  c  The capacity
     * @param  n  The output size
     */
    public static native void initialise(int r, int c, int n);
    
    
    /**
     * Absorb the more of the message message to the Keccak sponge
     * 
     * @param  msg  The partial message
     */
    public static void update(byte[] msg)
    {
	update(msg, msg.length);
    }
    
    
    /**
     * Absorb the more of the message message to the Keccak sponge
     * 
     * @param  msg     The partial message
     * @param  msglen  The length of the partial message
     */
    public static native void update(byte[] msg, int msglen);
    
    
    /**
     * Squeeze the Keccak sponge
     * 
     * @return  The hash sum
     */
    public static byte[] digest()
    {
	return digest(null, 0, 0, SHA3.SHA3_SUFFIX, true);
    }
    
    
    /**
     * Squeeze the Keccak sponge
     * 
     * @param   suffix  The suffix concatenate to the message
     * @return          The hash sum
     */
    public static byte[] digest(String suffix)
    {
	return digest(null, 0, 0, suffix, true);
    }
    
    
    /**
     * Squeeze the Keccak sponge
     * 
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(boolean withReturn)
    {
	return digest(null, 0, 0, SHA3.SHA3_SUFFIX, withReturn);
    }
    
    
    /**
     * Squeeze the Keccak sponge
     * 
     * @param   suffix      The suffix concatenate to the message
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(String suffix, boolean withReturn)
    {
	return digest(null, 0, 0, suffix, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg  The rest of the message
     * @return       The hash sum
     */
    public static byte[] digest(byte[] msg)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, SHA3.SHA3_SUFFIX, true);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg     The rest of the message
     * @param   suffix  The suffix concatenate to the message
     * @return          The hash sum
     */
    public static byte[] digest(byte[] msg, String suffix)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, suffix, true);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(byte[] msg, boolean withReturn)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, SHA3.SHA3_SUFFIX, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   suffix      The suffix concatenate to the message
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(byte[] msg, String suffix, boolean withReturn)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, suffix, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg     The rest of the message
     * @param   msglen  The length of the partial message in while bytes
     * @return          The hash sum
     */
    public static byte[] digest(byte[] msg, int msglen)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, SHA3.SHA3_SUFFIX, true);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg     The rest of the message
     * @param   msglen  The length of the partial message in while bytes
     * @param   suffix  The suffix concatenate to the message
     * @return          The hash sum
     */
    public static byte[] digest(byte[] msg, int msglen, String suffix)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, suffix, true);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg     The rest of the message
     * @param   msglen  The length of the partial message in while bytes
     * @param   bits    The number of bits at the end of the message not covered by <tt>msglen</tt>
     * @return          The hash sum
     */
    public static byte[] digest(byte[] msg, int msglen, int bits)
    {
	return digest(msg, msg == null ? 0 : msg.length, bits, SHA3.SHA3_SUFFIX, true);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg     The rest of the message
     * @param   msglen  The length of the partial message in while bytes
     * @param   bits    The number of bits at the end of the message not covered by <tt>msglen</tt>
     * @param   suffix  The suffix concatenate to the message
     * @return          The hash sum
     */
    public static byte[] digest(byte[] msg, int msglen, int bits, String suffix)
    {
	return digest(msg, msg == null ? 0 : msg.length, bits, suffix, true);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   msglen      The length of the partial message in while bytes
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(byte[] msg, int msglen, boolean withReturn)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, SHA3.SHA3_SUFFIX, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   msglen      The length of the partial message in while bytes
     * @param   suffix      The suffix concatenate to the message
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(byte[] msg, int msglen, String suffix, boolean withReturn)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, suffix, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   msglen      The length of the partial message in while bytes
     * @param   bits        The number of bits at the end of the message not covered by <tt>msglen</tt>
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(byte[] msg, int msglen, int bits, boolean withReturn)
    {
	return digest(msg, msg == null ? 0 : msg.length, 0, SHA3.SHA3_SUFFIX, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   msglen      The length of the partial message
     * @param   bits        The number of bits at the end of the message not covered by <tt>msglen</tt>
     * @param   suffix      The suffix concatenate to the message
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static byte[] digest(byte[] msg, int msglen, int bits, String suffix, boolean withReturn)
    {
	int[] suffix_ = new int[suffix.length()];
	for (int i = 0, n = suffix_.length; i < n; i++)
	    suffix_[i] = suffix.charAt(i) == '1' ? 1 : 0;
	
	return digest(msg, msglen, bits, suffix_, withReturn);
    }
    
    
    /**
     * Absorb the last part of the message and squeeze the Keccak sponge
     * 
     * @param   msg         The rest of the message
     * @param   msglen      The length of the partial message
     * @param   bits        The number of bits at the end of the message not covered by <tt>msglen</tt>
     * @param   suffix      The suffix concatenate to the message
     * @param   withReturn  Whether to return the hash instead of just do a quick squeeze phrase and return {@code null}
     * @return              The hash sum, or {@code null} if <tt>withReturn</tt> is {@code false}
     */
    public static native byte[] digest(byte[] msg, int msglen, int bits, int[] suffix, boolean withReturn);
    
    
    /**
     * Force a round of Keccak-f
     */
    public static void simpleSqueeze()
    {
	simpleSqueeze(1);
    }
    
    
    /**
     * Force some rounds of Keccak-f
     * 
     * @param  times  The number of rounds
     */
    public static native void simpleSqueeze(int times);
    
    
    /**
     * Squeeze as much as is needed to get a digest
     */
    public static void fastSqueeze()
    {
	fastSqueeze(1);
    }
    
    
    /**
     * Squeeze as much as is needed to get a digest a number of times
     * 
     * @param  times  The number of digests
     */
    public static native void fastSqueeze(int times);
    
    
    /**
     * Squeeze out another digest
     * 
     * @return  The hash sum
     */
    public static native byte[] squeeze();
    
}