Skip to content

Commit

Permalink
refactor: Add a bin_unpack_bin_max for max-length arrays.
Browse files Browse the repository at this point in the history
These are statically allocated (e.g. `uint8_t[1024]`) arrays with
variable length data inside them. Examples are group topics and
nicknames.
  • Loading branch information
iphydf committed Nov 11, 2023
1 parent 6be29f0 commit 1624044
Show file tree
Hide file tree
Showing 25 changed files with 95 additions and 59 deletions.
3 changes: 0 additions & 3 deletions .circleci/bazel-test
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ git submodule update --init --recursive
/src/workspace/tools/inject-repo c-toxcore
# TODO(iphydf): Re-enable fuzz-test when https://github.com/tweag/rules_nixpkgs/issues/442 is fixed.
cd /src/workspace && bazel test -k \
--config=ci \
--config=remote \
--build_tag_filters=-haskell,-fuzz-test \
--test_tag_filters=-haskell,-fuzz-test \
-- \
//c-toxcore/... \
"$@"
31 changes: 15 additions & 16 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ workflows:
jobs:
# Dynamic analysis in the Bazel build
- bazel-asan
- bazel-msan
- bazel-tsan
# Dynamic analysis with CMake
- asan
- tsan
- msan
- ubsan
# Static analysis
- clang-analyze
Expand All @@ -29,6 +29,7 @@ jobs:
steps:
- checkout
- run: .circleci/bazel-test
//c-toxcore/...

bazel-tsan:
working_directory: /tmp/cirrus-ci-build
Expand All @@ -38,11 +39,24 @@ jobs:
steps:
- checkout
- run: .circleci/bazel-test
//c-toxcore/...
-//c-toxcore/auto_tests:conference_av_test
-//c-toxcore/auto_tests:conference_test
-//c-toxcore/auto_tests:onion_test
-//c-toxcore/auto_tests:tox_many_test

bazel-msan:
working_directory: /tmp/cirrus-ci-build
docker:
- image: toxchat/toktok-stack:latest-tsan

steps:
- checkout
- run: .circleci/bazel-test
//c-toxcore/auto_tests:lossless_packet_test
//c-toxcore/toxav/...
//c-toxcore/toxcore/...

asan:
working_directory: ~/work
docker:
Expand Down Expand Up @@ -91,21 +105,6 @@ jobs:
- run: git submodule update --init --recursive
- run: CC=clang .circleci/cmake-ubsan

msan:
working_directory: ~/work
docker:
- image: toxchat/toktok-stack:latest-msan

steps:
- checkout
- run: git submodule update --init --recursive
- run: rm -rf /src/workspace/c-toxcore/* && mv * /src/workspace/c-toxcore/
- run:
cd /src/workspace && bazel test
//c-toxcore/auto_tests:lossless_packet_test
//c-toxcore/toxav/...
//c-toxcore/toxcore/...

infer:
working_directory: ~/work
docker:
Expand Down
2 changes: 1 addition & 1 deletion other/bootstrap_daemon/docker/tox-bootstrapd.sha256
Original file line number Diff line number Diff line change
@@ -1 +1 @@
036adfc1e993624ae0bf49f08c2890bb44e6d4224a07a8c7fd2e2b5a8be6bf4c /usr/local/bin/tox-bootstrapd
7920e5f954b9d7f1004488fe48ec515dad48ce8cd102d68a2181445d62bb5efd /usr/local/bin/tox-bootstrapd
4 changes: 4 additions & 0 deletions toxcore/Messenger.c
Original file line number Diff line number Diff line change
Expand Up @@ -3220,9 +3220,13 @@ static State_Load_Status groups_load(Messenger *m, const uint8_t *data, uint32_t

if (group_number < 0) {
LOGGER_WARNING(m->log, "Failed to load group %u", i);
// Can't recover trivially. We may need to skip over some data here.
break;
}
}

LOGGER_DEBUG(m->log, "Successfully loaded %u groups", gc_count_groups(m->group_handler));

bin_unpack_free(bu);

return STATE_LOAD_STATUS_CONTINUE;
Expand Down
26 changes: 23 additions & 3 deletions toxcore/bin_unpack.c
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,14 @@ bool bin_unpack_array(Bin_Unpack *bu, uint32_t *size)
return cmp_read_array(&bu->ctx, size) && *size <= bu->bytes_size;
}

bool bin_unpack_array_fixed(Bin_Unpack *bu, uint32_t required_size)
bool bin_unpack_array_fixed(Bin_Unpack *bu, uint32_t required_size, uint32_t *actual_size)
{
uint32_t size;
return cmp_read_array(&bu->ctx, &size) && size == required_size;
uint32_t size = 0;
const bool success = cmp_read_array(&bu->ctx, &size) && size == required_size;
if (actual_size != nullptr) {
*actual_size = size;
}
return success;
}

bool bin_unpack_bool(Bin_Unpack *bu, bool *val)
Expand Down Expand Up @@ -128,6 +132,22 @@ bool bin_unpack_bin(Bin_Unpack *bu, uint8_t **data_ptr, uint32_t *data_length_pt
return true;
}

bool bin_unpack_bin_max(Bin_Unpack *bu, uint8_t *data, uint16_t *data_length_ptr, uint16_t max_data_length)
{
uint32_t bin_size;
if (!bin_unpack_bin_size(bu, &bin_size) || bin_size > max_data_length) {
return false;
}

*data_length_ptr = bin_size;

if (!bin_unpack_bin_b(bu, data, bin_size)) {
return false;
}

return true;
}

bool bin_unpack_bin_fixed(Bin_Unpack *bu, uint8_t *data, uint32_t data_length)
{
uint32_t bin_size;
Expand Down
12 changes: 9 additions & 3 deletions toxcore/bin_unpack.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ non_null() bool bin_unpack_array(Bin_Unpack *bu, uint32_t *size);
*
* @retval false if the packed array size is not exactly the required size.
*/
non_null() bool bin_unpack_array_fixed(Bin_Unpack *bu, uint32_t required_size);
non_null() 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);
Expand All @@ -71,10 +71,16 @@ non_null() bool bin_unpack_nil(Bin_Unpack *bu);
* 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.
*
* Unlike the function above, this function does not allocate any memory, but requires the size to
* be known up front.
* 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);

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/conference_invite.c
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ static bool tox_event_conference_invite_unpack(
Tox_Event_Conference_Invite *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 3)) {
if (!bin_unpack_array_fixed(bu, 3, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/conference_message.c
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ static bool tox_event_conference_message_unpack(
Tox_Event_Conference_Message *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 4)) {
if (!bin_unpack_array_fixed(bu, 4, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/conference_peer_name.c
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ static bool tox_event_conference_peer_name_unpack(
Tox_Event_Conference_Peer_Name *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 3)) {
if (!bin_unpack_array_fixed(bu, 3, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/conference_title.c
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ static bool tox_event_conference_title_unpack(
Tox_Event_Conference_Title *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 3)) {
if (!bin_unpack_array_fixed(bu, 3, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/file_chunk_request.c
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ static bool tox_event_file_chunk_request_unpack(
Tox_Event_File_Chunk_Request *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 4)) {
if (!bin_unpack_array_fixed(bu, 4, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/file_recv.c
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ static bool tox_event_file_recv_unpack(
Tox_Event_File_Recv *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 5)) {
if (!bin_unpack_array_fixed(bu, 5, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/file_recv_chunk.c
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ static bool tox_event_file_recv_chunk_unpack(
Tox_Event_File_Recv_Chunk *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 4)) {
if (!bin_unpack_array_fixed(bu, 4, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/file_recv_control.c
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ static bool tox_event_file_recv_control_unpack(
Tox_Event_File_Recv_Control *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 3)) {
if (!bin_unpack_array_fixed(bu, 3, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_connection_status.c
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ static bool tox_event_friend_connection_status_unpack(
Tox_Event_Friend_Connection_Status *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_lossless_packet.c
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ static bool tox_event_friend_lossless_packet_unpack(
Tox_Event_Friend_Lossless_Packet *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_lossy_packet.c
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ static bool tox_event_friend_lossy_packet_unpack(
Tox_Event_Friend_Lossy_Packet *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_message.c
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ static bool tox_event_friend_message_unpack(
Tox_Event_Friend_Message *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 3)) {
if (!bin_unpack_array_fixed(bu, 3, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_name.c
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ static bool tox_event_friend_name_unpack(
Tox_Event_Friend_Name *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_read_receipt.c
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ static bool tox_event_friend_read_receipt_unpack(
Tox_Event_Friend_Read_Receipt *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_request.c
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ static bool tox_event_friend_request_unpack(
Tox_Event_Friend_Request *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_status.c
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ static bool tox_event_friend_status_unpack(
Tox_Event_Friend_Status *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_status_message.c
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ static bool tox_event_friend_status_message_unpack(
Tox_Event_Friend_Status_Message *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
2 changes: 1 addition & 1 deletion toxcore/events/friend_typing.c
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ static bool tox_event_friend_typing_unpack(
Tox_Event_Friend_Typing *event, Bin_Unpack *bu)
{
assert(event != nullptr);
if (!bin_unpack_array_fixed(bu, 2)) {
if (!bin_unpack_array_fixed(bu, 2, nullptr)) {
return false;
}

Expand Down
Loading

0 comments on commit 1624044

Please sign in to comment.