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
402
#ifndef _BEACON_CRYPT_H_
#define _BEACON_CRYPT_H_
/* Generated with cbindgen:0.29.4 */
// Do not modify manually.
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#define beaconcrypt_ML_DSA_SIGN_RANDOM_SIZE 32
#define beaconcrypt_ML_DSA_87_ENC_PUBKEY_SIZE (beaconcrypt_ML_DSA_87_PUBKEY_SIZE + 1)
#define beaconcrypt_ML_KEM_1024_ENCAP_RAN_SIZE beaconcrypt_SHARED_SECRET_SIZE
#define beaconcrypt_KEX_KDF_OUT_LEN 32
#define beaconcrypt_KDF_STATE_SIZE 32
/**
* crypto_aead::chacha20poly1305_ietf::KEYBYTES
*/
#define beaconcrypt_AEAD_KEY_LEN 32
/**
* crypto_aead::chacha20poly1305_ietf::NPUBBYTES
*/
#define beaconcrypt_AEAD_NONCE_LEN 12
#define beaconcrypt_KDF_RATCHET_OUTPUT_LEN ((beaconcrypt_AEAD_KEY_LEN + beaconcrypt_KDF_STATE_SIZE) + beaconcrypt_AEAD_NONCE_LEN)
/**
* crypto_scalarmult::BYTES
*/
#define beaconcrypt_DH_OUT_LEN 32
#define beaconcrypt_RATCHET_MAX_GAP 50
#define beaconcrypt_ED25519_SEED_SIZE 32
#define beaconcrypt_KEM_SHARED_SECRET_SIZE 32
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*/
int32_t process_initial_message(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*/
int32_t process_initial_message_signed(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - A serialized `cryptoframe_capnp::crypto_frame`
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t decrypt_server_message(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - A serialized `cryptoframe_capnp::crypto_frame`
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t decrypt_server_message_signed(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - Whatever you want to be encrypted to the server
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t encrypt_to_server(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - Whatever you want to be encrypted to the server
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t encrypt_to_server_signed(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - Whatever you want to be encrypted to the server
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t generate_registration(uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* This function is safe to call multiple times. It is used to initialize beacons with a hardcoded server public key. You should always use this on beacons
* ## Arguments
*
* * `is_beacon` - Whether the current instance is a beacon
* * `server_seq` - The ID of the server's identity key for the campaign
*/
void init_for_server(bool is_beacon,
uint64_t server_seq,
const uint8_t *server_pk,
uint64_t server_pk_len);
/**
* Initialize a server with existing keys from seeds. This MUST only be called by a server
* # Safety
* This function is safe to call multiple times.
* ## Arguments
*
* * `server_seq` - The ID of the server's identity key for the campaign
* * `id_seed` - 32 byte Ed25519 seed for the server's identity key
*/
void init_server_from_seeds(uint64_t server_seq, const uint8_t *id_seed);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
*
* * `bytes` - A serialized `phase1_capnp::init_kex` from the network
* * `bytes_len` - The size of the `bytes` buffer
* * `data` - The contents of the initial message to send back to the agent, as bytes
* * `data_len` - The size of the `data` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
* ## Returns
*
* * i32 - Values other than 0 indicate failure
*
*/
int32_t register_beacon(const uint8_t *bytes,
uintptr_t bytes_len,
const uint8_t *data,
uintptr_t data_len,
uint8_t **_response,
uintptr_t *response_len,
uintptr_t *response_capa,
uint8_t **_pk,
uintptr_t *pk_len,
uintptr_t *pk_capa,
uint64_t *key_id);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `seq` - The sequence number for the beacon to encypt to
* * `bytes` - A serialized `cryptoframe_capnp::crypto_frame`
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t decrypt_beacon_message(uint64_t seq,
const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `seq` - The sequence number for the beacon to encypt to
* * `bytes` - A serialized `cryptoframe_capnp::crypto_frame`
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t decrypt_beacon_message_signed(uint64_t seq,
const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `seq` - The sequence number for the beacon to encypt to
* * `bytes` - Whatever you want to be encrypted to the server
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t encrypt_to_beacon(uint64_t seq,
const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `seq` - The sequence number for the beacon to encypt to
* * `bytes` - Whatever you want to be encrypted to the server
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t encrypt_to_beacon_signed(uint64_t seq,
const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t **_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* This function is safe to call multiple times
* ## Arguments
*
* * `is_beacon` - Whether the current instance is a beacon
* * `server_seq` - The ID of the server's identity key for the campaign
*/
void init(bool is_beacon, uint64_t server_seq);
/**
* # Safety
* * This function MUST only be called to clean up byte buffers returned by this library, do NOT use as a general `free`
* * `ptr` should NOT be null and should point to a byte buffer of `len` length, in bytes.
*/
void free_vec(uint8_t *ptr,
uintptr_t len,
uintptr_t capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - A serialized `protogram_capnp::proto_gram`
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t verify_signature(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t *_out,
uintptr_t *out_len,
uintptr_t *out_capa);
/**
* # Safety
* * `bytes` should NOT be null and should point to a byte buffer of `bytes_len` length, in bytes.
* * The library will overwrite all the `out` parameters
* * It is not safe to read the `out` parameters if the function doesn't return `0`
*
* ## Arguments
* * `bytes` - Buffer to sign, probably should be a `cryptoframe_capnp::crypto_frame`
* * `bytes_len` - The size of the `bytes` buffer
* * `out` - A caller-managed pointer that will contain the results in case of success. Call `free_vec` to free it once you're done
* * `out_len` - The actual size of the `out` buffer
* * `out_capa` - The size of the underlying allocation for the `out` buffer
*
* ## Returns
* `0` on success, negative values on error
*/
int32_t sign_message(const uint8_t *bytes,
uintptr_t bytes_len,
uint8_t *_out,
uintptr_t *out_len,
uintptr_t *out_capa);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* _BEACON_CRYPT_H_ */