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
/**
* \file sha3_ops.h
* \brief Header defining the callback API for OQS SHA3 and SHAKE
*
* \author John Underhill, Douglas Stebila
*
* SPDX-License-Identifier: MIT
*/
#ifndef OQS_SHA3_OPS_H
#define OQS_SHA3_OPS_H
#include <stddef.h>
#include <stdint.h>
#include <oqs/common.h>
#if defined(__cplusplus)
extern "C" {
#endif
/** Data structure for the state of the incremental SHA3-256 API. */
typedef struct {
/** Internal state. */
void *ctx;
} OQS_SHA3_sha3_256_inc_ctx;
/** Data structure for the state of the incremental SHA3-384 API. */
typedef struct {
/** Internal state. */
void *ctx;
} OQS_SHA3_sha3_384_inc_ctx;
/** Data structure for the state of the incremental SHA3-512 API. */
typedef struct {
/** Internal state. */
void *ctx;
} OQS_SHA3_sha3_512_inc_ctx;
/** Data structure for the state of the incremental SHAKE-128 API. */
typedef struct {
/** Internal state. */
void *ctx;
} OQS_SHA3_shake128_inc_ctx;
/** Data structure for the state of the incremental SHAKE-256 API. */
typedef struct {
/** Internal state. */
void *ctx;
} OQS_SHA3_shake256_inc_ctx;
/** Data structure implemented by cryptographic provider for SHA-3 operations.
*/
struct OQS_SHA3_callbacks {
/**
* Implementation of function OQS_SHA3_sha3_256.
*/
void (*SHA3_sha3_256)(uint8_t *output, const uint8_t *input, size_t inplen);
/**
* Implementation of function OQS_SHA3_sha3_256_inc_init.
*/
void (*SHA3_sha3_256_inc_init)(OQS_SHA3_sha3_256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_256_inc_absorb.
*/
void (*SHA3_sha3_256_inc_absorb)(OQS_SHA3_sha3_256_inc_ctx *state, const uint8_t *input, size_t inlen);
/**
* Implementation of function OQS_SHA3_sha3_256_inc_finalize.
*/
void (*SHA3_sha3_256_inc_finalize)(uint8_t *output, OQS_SHA3_sha3_256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_256_inc_ctx_release.
*/
void (*SHA3_sha3_256_inc_ctx_release)(OQS_SHA3_sha3_256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_256_inc_ctx_reset.
*/
void (*SHA3_sha3_256_inc_ctx_reset)(OQS_SHA3_sha3_256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_256_inc_ctx_clone.
*/
void (*SHA3_sha3_256_inc_ctx_clone)(OQS_SHA3_sha3_256_inc_ctx *dest, const OQS_SHA3_sha3_256_inc_ctx *src);
/**
* Implementation of function OQS_SHA3_sha3_384.
*/
void (*SHA3_sha3_384)(uint8_t *output, const uint8_t *input, size_t inplen);
/**
* Implementation of function OQS_SHA3_sha3_384_inc_init.
*/
void (*SHA3_sha3_384_inc_init)(OQS_SHA3_sha3_384_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_384_inc_absorb.
*/
void (*SHA3_sha3_384_inc_absorb)(OQS_SHA3_sha3_384_inc_ctx *state, const uint8_t *input, size_t inlen);
/**
* Implementation of function OQS_SHA3_sha3_384_inc_finalize.
*/
void (*SHA3_sha3_384_inc_finalize)(uint8_t *output, OQS_SHA3_sha3_384_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_384_inc_ctx_release.
*/
void (*SHA3_sha3_384_inc_ctx_release)(OQS_SHA3_sha3_384_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_384_inc_ctx_reset.
*/
void (*SHA3_sha3_384_inc_ctx_reset)(OQS_SHA3_sha3_384_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_384_inc_ctx_clone.
*/
void (*SHA3_sha3_384_inc_ctx_clone)(OQS_SHA3_sha3_384_inc_ctx *dest, const OQS_SHA3_sha3_384_inc_ctx *src);
/**
* Implementation of function OQS_SHA3_sha3_512.
*/
void (*SHA3_sha3_512)(uint8_t *output, const uint8_t *input, size_t inplen);
/**
* Implementation of function OQS_SHA3_sha3_512_inc_init.
*/
void (*SHA3_sha3_512_inc_init)(OQS_SHA3_sha3_512_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_512_inc_absorb.
*/
void (*SHA3_sha3_512_inc_absorb)(OQS_SHA3_sha3_512_inc_ctx *state, const uint8_t *input, size_t inlen);
/**
* Implementation of function OQS_SHA3_sha3_512_inc_finalize.
*/
void (*SHA3_sha3_512_inc_finalize)(uint8_t *output, OQS_SHA3_sha3_512_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_512_inc_ctx_release.
*/
void (*SHA3_sha3_512_inc_ctx_release)(OQS_SHA3_sha3_512_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_512_inc_ctx_reset.
*/
void (*SHA3_sha3_512_inc_ctx_reset)(OQS_SHA3_sha3_512_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_sha3_512_inc_ctx_clone.
*/
void (*SHA3_sha3_512_inc_ctx_clone)(OQS_SHA3_sha3_512_inc_ctx *dest, const OQS_SHA3_sha3_512_inc_ctx *src);
/**
* Implementation of function OQS_SHA3_shake128.
*/
void (*SHA3_shake128)(uint8_t *output, size_t outlen, const uint8_t *input, size_t inplen);
/**
* Implementation of function OQS_SHA3_shake128_inc_init.
*/
void (*SHA3_shake128_inc_init)(OQS_SHA3_shake128_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake128_inc_absorb.
*/
void (*SHA3_shake128_inc_absorb)(OQS_SHA3_shake128_inc_ctx *state, const uint8_t *input, size_t inlen);
/**
* Implementation of function OQS_SHA3_shake128_inc_finalize.
*/
void (*SHA3_shake128_inc_finalize)(OQS_SHA3_shake128_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake128_inc_squeeze.
*/
void (*SHA3_shake128_inc_squeeze)(uint8_t *output, size_t outlen, OQS_SHA3_shake128_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake128_inc_ctx_release.
*/
void (*SHA3_shake128_inc_ctx_release)(OQS_SHA3_shake128_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake128_inc_ctx_clone.
*/
void (*SHA3_shake128_inc_ctx_clone)(OQS_SHA3_shake128_inc_ctx *dest, const OQS_SHA3_shake128_inc_ctx *src);
/**
* Implementation of function OQS_SHA3_shake128_inc_ctx_reset.
*/
void (*SHA3_shake128_inc_ctx_reset)(OQS_SHA3_shake128_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake256.
*/
void (*SHA3_shake256)(uint8_t *output, size_t outlen, const uint8_t *input, size_t inplen);
/**
* Implementation of function OQS_SHA3_shake256_inc_init.
*/
void (*SHA3_shake256_inc_init)(OQS_SHA3_shake256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake256_inc_absorb.
*/
void (*SHA3_shake256_inc_absorb)(OQS_SHA3_shake256_inc_ctx *state, const uint8_t *input, size_t inlen);
/**
* Implementation of function OQS_SHA3_shake256_inc_finalize.
*/
void (*SHA3_shake256_inc_finalize)(OQS_SHA3_shake256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake256_inc_squeeze.
*/
void (*SHA3_shake256_inc_squeeze)(uint8_t *output, size_t outlen, OQS_SHA3_shake256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake256_inc_ctx_release.
*/
void (*SHA3_shake256_inc_ctx_release)(OQS_SHA3_shake256_inc_ctx *state);
/**
* Implementation of function OQS_SHA3_shake256_inc_ctx_clone.
*/
void (*SHA3_shake256_inc_ctx_clone)(OQS_SHA3_shake256_inc_ctx *dest, const OQS_SHA3_shake256_inc_ctx *src);
/**
* Implementation of function OQS_SHA3_shake256_inc_ctx_reset.
*/
void (*SHA3_shake256_inc_ctx_reset)(OQS_SHA3_shake256_inc_ctx *state);
};
/**
* Set callback functions for SHA3 operations.
*
* This function may be called before OQS_init to switch the
* cryptographic provider for SHA3 operations. If it is not called,
* the default provider determined at build time will be used.
*
* @param new_callbacks Callback functions defined in OQS_SHA3_callbacks struct
*/
OQS_API void OQS_SHA3_set_callbacks(struct OQS_SHA3_callbacks *new_callbacks);
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // OQS_SHA3_OPS_H