81b1e4f6348 chore: Release v0.2.21-rc.1 9303e2e49a1 chore: Update the pkgsrc versions in the update-versions tool 71ec4b3b1e9 chore: Update the version-sync script to work in a post-tox.api.h world 66da842f753 chore: Add version update script compatible with ci-tools. 199878f7660 chore: Use new bazel script for circle ci. 8278e9cda46 chore: Add release issue template and workflow. a9bb3a1c4d1 chore: Fix alpine-s390x build. 6e0a641272e chore: Add a source tarball deploy workflow. 4adebe4d8b1 chore: Don't upload ios/macos variants in deploy workflows. 18f1d858ccb chore: Move one of the 3 freebsd builds to post-submit. 432ab60c002 feat: Add a Makefile for the single file deploy build. a86c0011fd5 chore: Add deploy job for single C file library. 2e7495e8f2a docs: Update changelog format to use the new clog-compatible way. a682da99e84 chore: Export wasmExports from the wasm binary. 12f34cdff27 chore: Add wasm to the nightly binary deploys. 1451029613f chore: Add strict-abi support for macOS/iOS. c53c30e09d9 chore: Add time option to manual fuzz trigger. 2ccecdc2a1a chore: Add remaining fuzz tests to cflite. 4626c2e230e test: Add a Net_Crypto fuzz test. b4a0e617c48 refactor: Use IP string length from ip_ntoa instead of strlen. b85b91f22f6 cleanup: rename getnodes/sendnodes to nodes request/response This change alignes the naming to be closer to the spec and make it less ambiguous. This change also changes the naming of some private/experimental marked APIs. - tox_callback_dht_nodes_response() - tox_dht_nodes_request() - Tox_Event_Dht_Get_Nodes_Response f1991aaa029 perf: Use stack allocation for strerror rendering. 3984211ccbf cleanup: remove kicked peers from saved peers list 26a991ed2be fix: ip to string function not accepting tcp families 712861f2e6d cleanup: Make websockify output qtox-compatible logging. 01932ea2f73 chore: Add opus and vpx to the toxcore wasm build. d29c42ef631 refactor: don't fully discard received DHT nodes. This is mostly forward thinking, where we might introduce other ip families, in addition to ipv4, ipv6, tcp_ipv4 etc. 21e2325934f chore: Fix xcframework tarball creation. b10c8b766ba chore: Fix xcframework checksum creation. 93787a9322e chore: Add ios/macos framework build. 9f723f891d3 fix: run do_gca also in bootstrap nodes 496cc703556 chore: Support arm64 iphone simulator. aa0e2a8e928 chore: Add support for more iOS architectures. 13ad8e81cbf chore: Add binary deploy workflows. c8344726378 refactor: Move tox_log_level out into its own file. 8799bea76c3 cleanup: Mark events/dispatch headers as experimental. d4164edb548 refactor: Remove tox_types.h; use `struct` tags instead. d408c982090 refactor: Move `Tox_Options` to `tox_options.h`. 5ab42d41209 chore: Move most cirrus jobs to circleci. 463eeae1144 cleanup: Avoid clashing with global define `DEBUG`. 92cc1e91747 refactor: Make Tox_Options own the passed proxy host and savedata. f276b397226 test: Add some more asserts for I/O and alloc to succeed. edb4dfc4869 fix: Don't crash on malloc failures in bin_unpack. be457d5d0b2 cleanup: Use tox memory for bin_unpack and net_strerror. git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: 81b1e4f6348124784088591c4fe9ab41e273031d
127 lines
5.3 KiB
C
127 lines
5.3 KiB
C
/* SPDX-License-Identifier: GPL-3.0-or-later
|
|
* Copyright © 2022-2025 The TokTok team.
|
|
*/
|
|
|
|
#ifndef C_TOXCORE_TOXCORE_BIN_UNPACK_H
|
|
#define C_TOXCORE_TOXCORE_BIN_UNPACK_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include "attributes.h"
|
|
#include "mem.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Binary deserialisation object.
|
|
*
|
|
* User code never creates this object. It is created and destroyed within the below functions,
|
|
* and passed to the callback. This enforces an alloc/dealloc bracket, so user code can never
|
|
* forget to clean up an unpacker.
|
|
*/
|
|
typedef struct Bin_Unpack Bin_Unpack;
|
|
|
|
/** @brief Function used to unpack an object.
|
|
*
|
|
* This function would typically cast the `void *` to the actual object pointer type and then call
|
|
* more appropriately typed unpacking functions.
|
|
*/
|
|
typedef bool bin_unpack_cb(void *obj, Bin_Unpack *bu);
|
|
|
|
/** @brief Unpack an object from a buffer of a given size.
|
|
*
|
|
* This function creates and initialises a `Bin_Unpack` object, calls the callback with the
|
|
* unpacker object and the to-be-unpacked object, and then cleans up the unpacker object.
|
|
*
|
|
* Unlike `bin_pack_obj`, this function does not support NULL anywhere. The input array
|
|
* must be non-null, even if it is zero-length.
|
|
*
|
|
* @param callback The function called on the created unpacker and unpacked object.
|
|
* @param obj The object to be packed, passed as `obj` to the callback.
|
|
* @param buf A byte array containing the serialised representation of `obj`.
|
|
* @param buf_size The size of the byte array.
|
|
*
|
|
* @retval false if an error occurred (e.g. buffer overrun).
|
|
*/
|
|
non_null()
|
|
bool bin_unpack_obj(const Memory *mem, bin_unpack_cb *callback, void *obj, const uint8_t *buf, uint32_t buf_size);
|
|
|
|
/** @brief Start unpacking a MessagePack array.
|
|
*
|
|
* A call to this function must be followed by exactly `size` calls to other functions below.
|
|
*
|
|
* @param size Will contain the number of array elements following the array marker.
|
|
*/
|
|
non_null() bool bin_unpack_array(Bin_Unpack *bu, uint32_t *size);
|
|
|
|
/** @brief Start unpacking a fixed size MessagePack array.
|
|
*
|
|
* Fails if the array size is not the required size. If `actual_size` is passed a non-null
|
|
* pointer, the array size is written there.
|
|
*
|
|
* @retval false if the packed array size is not exactly the required size.
|
|
*/
|
|
non_null(1) nullable(3)
|
|
bool bin_unpack_array_fixed(Bin_Unpack *bu, uint32_t required_size, uint32_t *actual_size);
|
|
|
|
/** @brief Unpack a MessagePack bool. */
|
|
non_null() bool bin_unpack_bool(Bin_Unpack *bu, bool *val);
|
|
/** @brief Unpack a MessagePack positive int into a `uint8_t`. */
|
|
non_null() bool bin_unpack_u08(Bin_Unpack *bu, uint8_t *val);
|
|
/** @brief Unpack a MessagePack positive int into a `uint16_t`. */
|
|
non_null() bool bin_unpack_u16(Bin_Unpack *bu, uint16_t *val);
|
|
/** @brief Unpack a MessagePack positive int into a `uint32_t`. */
|
|
non_null() bool bin_unpack_u32(Bin_Unpack *bu, uint32_t *val);
|
|
/** @brief Unpack a MessagePack positive int into a `uint64_t`. */
|
|
non_null() bool bin_unpack_u64(Bin_Unpack *bu, uint64_t *val);
|
|
/** @brief Unpack a Messagepack nil value. */
|
|
non_null() bool bin_unpack_nil(Bin_Unpack *bu);
|
|
|
|
/** @brief Unpack a MessagePack bin into a newly allocated byte array.
|
|
*
|
|
* Allocates a new byte array and stores it into `data_ptr` with its length stored in
|
|
* `data_length_ptr`. This function requires that the unpacking buffer has at least as many bytes
|
|
* remaining to be unpacked as the bin claims to need, so it's not possible to cause an arbitrarily
|
|
* large allocation unless the input array was already that large.
|
|
*/
|
|
non_null() bool bin_unpack_bin(Bin_Unpack *bu, uint8_t **data_ptr, uint32_t *data_length_ptr);
|
|
/** @brief Unpack a variable size MessagePack bin into a fixed size byte array.
|
|
*
|
|
* Stores unpacked data into `data` with its length stored in `data_length_ptr`. This function does
|
|
* not allocate memory and requires that `max_data_length` is less than or equal to `sizeof(arr)`
|
|
* when `arr` is passed as `data` pointer.
|
|
*/
|
|
non_null() bool bin_unpack_bin_max(Bin_Unpack *bu, uint8_t *data, uint16_t *data_length_ptr, uint16_t max_data_length);
|
|
/** @brief Unpack a MessagePack bin of a fixed length into a pre-allocated byte array.
|
|
*
|
|
* Similar to the function above, but doesn't output the data length.
|
|
*/
|
|
non_null() bool bin_unpack_bin_fixed(Bin_Unpack *bu, uint8_t *data, uint32_t data_length);
|
|
|
|
/** @brief Start unpacking a custom binary representation.
|
|
*
|
|
* A call to this function must be followed by exactly `size` bytes packed by functions below.
|
|
*/
|
|
non_null() bool bin_unpack_bin_size(Bin_Unpack *bu, uint32_t *size);
|
|
|
|
/** @brief Read a `uint8_t` directly from the unpacker, consuming 1 byte. */
|
|
non_null() bool bin_unpack_u08_b(Bin_Unpack *bu, uint8_t *val);
|
|
/** @brief Read a `uint16_t` as big endian 16 bit int, consuming 2 bytes. */
|
|
non_null() bool bin_unpack_u16_b(Bin_Unpack *bu, uint16_t *val);
|
|
/** @brief Read a `uint32_t` as big endian 32 bit int, consuming 4 bytes. */
|
|
non_null() bool bin_unpack_u32_b(Bin_Unpack *bu, uint32_t *val);
|
|
/** @brief Read a `uint64_t` as big endian 64 bit int, consuming 8 bytes. */
|
|
non_null() bool bin_unpack_u64_b(Bin_Unpack *bu, uint64_t *val);
|
|
|
|
/** @brief Read a byte array directly from the packer, consuming `length` bytes. */
|
|
non_null() bool bin_unpack_bin_b(Bin_Unpack *bu, uint8_t *data, uint32_t length);
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* C_TOXCORE_TOXCORE_BIN_UNPACK_H */
|