-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathkeccak_8h.html
401 lines (366 loc) · 17.1 KB
/
keccak_8h.html
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
395
396
397
398
399
400
401
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libusual: usual/crypto/keccak.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libusual
 <span id="projectnumber">0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">usual/crypto/keccak.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Simple API to Keccak1600 permutation + sponge.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_keccak_context.html">KeccakContext</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keccak state structure for all modes. <a href="struct_keccak_context.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#a31673b6ce010f4bf1c812e8bde9f7abf">keccak_init</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, unsigned int capacity)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set up state with specified capacity. <a href="#a31673b6ce010f4bf1c812e8bde9f7abf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#af309311400a3d59ec46e412be345350c">keccak_absorb</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, const void *data, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hash additional data. <a href="#af309311400a3d59ec46e412be345350c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#a477c7e1a734c583fbb23cf6034350c60">keccak_squeeze</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, uint8_t *dst, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract bytes from state. <a href="#a477c7e1a734c583fbb23cf6034350c60"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#adcaa0843ce9ac8ae5bd2acdfa4f3cf19">keccak_squeeze_xor</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, uint8_t *dst, const void *src, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract bytes from state, XOR into data. <a href="#adcaa0843ce9ac8ae5bd2acdfa4f3cf19"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#a993de8525e28b8fa44d72a39ed133102">keccak_encrypt</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, uint8_t *dst, const void *src, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XOR data into state and return it. <a href="#a993de8525e28b8fa44d72a39ed133102"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#aeb2adfb3ec2425519aa6a0b3278fd834">keccak_decrypt</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, uint8_t *dst, const void *src, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">XOR state with data and return it. <a href="#aeb2adfb3ec2425519aa6a0b3278fd834"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#af60f345f9c56b107e86bced175d51529">keccak_pad</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx, const void *data, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hash pad suffix. <a href="#af60f345f9c56b107e86bced175d51529"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#a12372a5c9f7821e6d98e425f843b5caf">keccak_rewind</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move internal position to start of buffer. <a href="#a12372a5c9f7821e6d98e425f843b5caf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="keccak_8h.html#adc13cfdc7c717daf8610629d2375f5bb">keccak_forget</a> (struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear rate bits. <a href="#adc13cfdc7c717daf8610629d2375f5bb"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Simple API to Keccak1600 permutation + sponge. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a31673b6ce010f4bf1c812e8bde9f7abf"></a><!-- doxytag: member="keccak.h::keccak_init" ref="a31673b6ce010f4bf1c812e8bde9f7abf" args="(struct KeccakContext *ctx, unsigned int capacity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="keccak_8h.html#a31673b6ce010f4bf1c812e8bde9f7abf">keccak_init</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>capacity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set up state with specified capacity. </p>
<p>Returns 1 if successful, 0 if invalid capacity. </p>
</div>
</div>
<a class="anchor" id="af309311400a3d59ec46e412be345350c"></a><!-- doxytag: member="keccak.h::keccak_absorb" ref="af309311400a3d59ec46e412be345350c" args="(struct KeccakContext *ctx, const void *data, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#af309311400a3d59ec46e412be345350c">keccak_absorb</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hash additional data. </p>
</div>
</div>
<a class="anchor" id="a477c7e1a734c583fbb23cf6034350c60"></a><!-- doxytag: member="keccak.h::keccak_squeeze" ref="a477c7e1a734c583fbb23cf6034350c60" args="(struct KeccakContext *ctx, uint8_t *dst, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#a477c7e1a734c583fbb23cf6034350c60">keccak_squeeze</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract bytes from state. </p>
</div>
</div>
<a class="anchor" id="adcaa0843ce9ac8ae5bd2acdfa4f3cf19"></a><!-- doxytag: member="keccak.h::keccak_squeeze_xor" ref="adcaa0843ce9ac8ae5bd2acdfa4f3cf19" args="(struct KeccakContext *ctx, uint8_t *dst, const void *src, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#adcaa0843ce9ac8ae5bd2acdfa4f3cf19">keccak_squeeze_xor</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract bytes from state, XOR into data. </p>
</div>
</div>
<a class="anchor" id="a993de8525e28b8fa44d72a39ed133102"></a><!-- doxytag: member="keccak.h::keccak_encrypt" ref="a993de8525e28b8fa44d72a39ed133102" args="(struct KeccakContext *ctx, uint8_t *dst, const void *src, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#a993de8525e28b8fa44d72a39ed133102">keccak_encrypt</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XOR data into state and return it. </p>
</div>
</div>
<a class="anchor" id="aeb2adfb3ec2425519aa6a0b3278fd834"></a><!-- doxytag: member="keccak.h::keccak_decrypt" ref="aeb2adfb3ec2425519aa6a0b3278fd834" args="(struct KeccakContext *ctx, uint8_t *dst, const void *src, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#aeb2adfb3ec2425519aa6a0b3278fd834">keccak_decrypt</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XOR state with data and return it. </p>
</div>
</div>
<a class="anchor" id="af60f345f9c56b107e86bced175d51529"></a><!-- doxytag: member="keccak.h::keccak_pad" ref="af60f345f9c56b107e86bced175d51529" args="(struct KeccakContext *ctx, const void *data, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#af60f345f9c56b107e86bced175d51529">keccak_pad</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hash pad suffix. </p>
</div>
</div>
<a class="anchor" id="a12372a5c9f7821e6d98e425f843b5caf"></a><!-- doxytag: member="keccak.h::keccak_rewind" ref="a12372a5c9f7821e6d98e425f843b5caf" args="(struct KeccakContext *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#a12372a5c9f7821e6d98e425f843b5caf">keccak_rewind</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move internal position to start of buffer. </p>
<p>Useful for PRNG/duplex modes. </p>
</div>
</div>
<a class="anchor" id="adc13cfdc7c717daf8610629d2375f5bb"></a><!-- doxytag: member="keccak.h::keccak_forget" ref="adc13cfdc7c717daf8610629d2375f5bb" args="(struct KeccakContext *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="keccak_8h.html#adc13cfdc7c717daf8610629d2375f5bb">keccak_forget</a> </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="struct_keccak_context.html">KeccakContext</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear rate bits. </p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>