Green Sky
aae086cc65
b03b571272 fix: flaky tcp test This only fixes the symptoms, not the real problem. Sometimes or consistently on some platforms a socket might need a moment before it can be written to. 32e67ab4c2 cleanup: use typedef for private message ID's in callback 7b1db6adc1 feat: add message IDs to private group messages 99e0bcc27d refactor: Observers/ignored peers can now send and receive custom packets b3c3c49d26 fix: Disable IPv6 in Windows cross-compilation tests e742deddff feat: Check hashes of Windows dependencies when cross-compiling dfb9a0b02b fix: Test the current Windows Dockerfile, not an old Dockerhub image 14de93ccec chore: Use WineHQ's Wine as Debian Bookworm's crashes ed37616249 docs: Update the Windows cross-compilation section 9bb79c174f cleanup: Remove a couple of unnecessary misc_tools dependencies 19475adb70 chore: Statically link OpenMP into the cracker fun util on Windows 1be311e51f feat: Build the fun utils when cross-compiling to Windows 88133f8446 chore: Strip Windows binaries 3cc0ae7535 refactor: Copy over all of the required static dependencies c4fa8f7fb1 feat: Generate .def, .exp and .lib files when building for Windows 74bbac5363 feat: Let CMake create the dll instead of doing so ourselves 246642e9ae feat: Harden Windows cross-compilation 8d431c0d11 chore: Bump Windows build dependency versions e519f7998b fix: Remove unnecessary wsock32 dependency on Windows ed2b60c217 chore: Use a specific non-broken slimcc version. d7f21010a1 chore: Update github actions. e71a68b7f2 docs: Update the list of CMake options 77e08876ff chore: Remove mod and founder from group API naming scheme 12bc042767 docs: add the experimental api build option to INSTALL.md e1fa5cae96 refactor: Rename Queries to Query to align with other enums. be82a3ea30 fix: Correct type for conference offline peer numbers. 0627c36716 test: Add pkgsrc build. 92578afe4b test: Add FreeBSD VM action on GitHub. 52ece0f57b test: Build toxcore on NetBSD (VM). 3fe8ee2c11 chore: Only install tox_private.h on request. 9a8dfa06ab fix: save_compatibility_test failing on big-endian systems 86f5e55578 fix: Don't serve files from websockify. 710eb674a5 fix: Correctly pass extended public keys to group moderation code. 021db7031c refactor: Use `struct`s for extended public/secret keys. a1e999fd80 chore: Compile libsodium reference implementation with compcert. fbe3c19cf5 cleanup: correct a few nullable annotations 623e3ee5c3 cleanup: Don't use `memcpy` to cast arbitrary `struct`s to `uint8_t[]`. c71567dc18 fix: Pass array, not array pointer, to `memcmp`. 9b46a08144 cleanup: Never pass `void*` directly to `memcpy`. 5d7b7a7bbc refactor: Use tox rng to seed the keypair generation. 961891d568 cleanup: Small improvements found by PVS Studio. 8201019f0d chore: Disable NGC saving by default, enable through Tox_Options. 5dd9ee3f65 cleanup: Replace pointer arithmetic with explicit `&arr[i]`. ca4606d49d refactor: Use strong typedef for NGC peer id. 442213b722 cleanup: Simplify custom packet length check in NGC. 08d3393def fix: Correct a few potential null derefs in bootstrap daemon. b9877b32b0 fix: Add missing memunlock of local variable when it goes out of scope. dab5fe44b9 fix: Zero out stack-allocated secret key before return. f058103299 refactor: Make prune_gc_sanctions_list more obviously correct. 3ba7a0dec9 docs: Add static analysis tool list to README. 8d0811a0f3 docs: Run prettier-markdown on markdown files. 969e3a2bfc refactor: Fix network test not using the strong typedef 93c83fbc7c refactor: Use strong typedef instead of struct for `Socket`. 9fe18b176f fix: Fix some false positive from PVS Studio. 7c44379ccb cleanup: Check that WINXP macro exists before comparing it. 5c93231bef refactor: Make tox mutex non-recursive. aacff73939 docs: Fix up doxyfile. d55fc85ff5 docs: Add more documentation to crypto_core. 5bdaaaedb6 refactor: Remove `Tox *` from `tox_dispatch`. e202341e76 refactor: Don't rely on tox_dispatch passing tox in tests. 34df938f52 chore: Use C++ mode for clang-tidy. 8b05296a78 chore: Check that both gtest and gmock exist for tests. 42010660e1 test: Add slimcc compiler compatibility test. b473630321 chore: Add some comments to the astyle config. b7404f24f6 cleanup: Remove implicit bool conversions. 4e2dba4d9f chore: Reformat sources with astyle. 4359e3a6bc chore: Rename C++ headers to .hh suffixes. 0c05566e58 cleanup: Further `#include` cleanups. 8d29935b7a chore: Only check the bootstrap daemon checksum on release. f70e588bc6 cleanup: Add more `const` where possible. 511bfe39c8 cleanup: Use Bazel modules to enforce proper `#include` hygiene. 1710a0d091 refactor: Move pack/unpack `IP_Port` from DHT into network module. a975943564 chore: Really fix coverage docker image build. c08409390f chore: Fix post-submit coverage image. 39aadf8922 fix: Don't use `memcmp` to compare `IP_Port`s. d94246a906 fix: partially fix a bug that prevented group part messages from sending. eeaa039222 chore: Fix rpm build; add a CI check for it. 8328449c1a chore: Speed up docker builds a bit by reducing layer count. d6d67d56f3 cleanup: Add `const` where possible in auto tests. 6aa9e6850d cleanup: Minor cleanup of event unpack code. bdf460a3a9 refactor: Rename `system_{memory,...}` to `os_{memory,...}`. 203e1af81e fix: a few off by one errors in group autotests 5c093c4888 cleanup: Remove all uses of `SIZEOF_VLA`. 662c2140f3 test: Add goblint static analyser. 8f07755834 cleanup: Use `memzero(x, s)` instead of `memset(x, 0, s)`. a7258e40cf cleanup: Use explicit 0 instead of `PACKET_ID_PADDING`. 6370d0f15d cleanup: Expand the `Tox_Options` accessor macros. 14a1a0b9bd cleanup: Remove plan9 support. a05dccad13 test: Add a simple new/delete test for Tox. 1cdcf938b9 cleanup: Add comment after every `#endif`. ba99d4dc4b test: Fix comment I broke in the events test PR. e07248debb refactor: Migrate auto_tests to new events API. bdd42b5452 refactor: Add common msgpack array packer with callback. 3c659f5288 cleanup: Rename group to conference in groupav documentation. 89957be230 cleanup: Ensure handler params are named after callback params. c650d9d345 refactor: Pass `this` pointer as first param to s11n callbacks. e7fb91ddb8 refactor: Allow NULL pointers for byte arrays in events. 5e2c8cabc1 cleanup: make some improvements to group moderation test 259de4867e cleanup: Remove `bin_pack_{new,free}`. 21a8ff5895 cleanup: skip a do_gc iteration before removing peers marked for deletion 16809dc36e feat: Add dht_get_nodes_response event to the events system. git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: b03b5712720de9a9901ea12fd741f177327a7021
206 lines
7.9 KiB
Markdown
206 lines
7.9 KiB
Markdown
# ![Project Tox](https://raw.github.com/TokTok/c-toxcore/master/other/tox.png "Project Tox")
|
|
|
|
**Current Coverage:**
|
|
[![coverage](https://codecov.io/gh/TokTok/c-toxcore/branch/master/graph/badge.svg?token=BRfCKo02De)](https://codecov.io/gh/TokTok/c-toxcore)
|
|
|
|
[**Website**](https://tox.chat) **|** [**Wiki**](https://wiki.tox.chat/) **|**
|
|
[**Blog**](https://blog.tox.chat/) **|**
|
|
[**FAQ**](https://wiki.tox.chat/doku.php?id=users:faq) **|**
|
|
[**Binaries/Downloads**](https://tox.chat/download.html) **|**
|
|
[**Clients**](https://wiki.tox.chat/doku.php?id=clients) **|**
|
|
[**Compiling**](/INSTALL.md)
|
|
|
|
## What is Tox
|
|
|
|
Tox is a peer to peer (serverless) instant messenger aimed at making security
|
|
and privacy easy to obtain for regular users. It uses
|
|
[libsodium](https://doc.libsodium.org/) (based on
|
|
[NaCl](https://nacl.cr.yp.to/)) for its encryption and authentication.
|
|
|
|
## IMPORTANT!
|
|
|
|
### ![Danger: Experimental](other/tox-warning.png)
|
|
|
|
This is an **experimental** cryptographic network library. It has not been
|
|
formally audited by an independent third party that specializes in cryptography
|
|
or cryptanalysis. **Use this library at your own risk.**
|
|
|
|
The underlying crypto library [libsodium](https://doc.libsodium.org/) provides
|
|
reliable encryption, but the security model has not yet been fully specified.
|
|
See [issue 210](https://github.com/TokTok/c-toxcore/issues/210) for a discussion
|
|
on developing a threat model. See other issues for known weaknesses (e.g.
|
|
[issue 426](https://github.com/TokTok/c-toxcore/issues/426) describes what can
|
|
happen if your secret key is stolen).
|
|
|
|
## Toxcore Development Roadmap
|
|
|
|
The roadmap and changelog are generated from GitHub issues. You may view them on
|
|
the website, where they are updated at least once every 24 hours:
|
|
|
|
- Changelog: https://toktok.ltd/changelog/c-toxcore
|
|
- Roadmap: https://toktok.ltd/roadmap/c-toxcore
|
|
|
|
## Installing toxcore
|
|
|
|
Detailed installation instructions can be found in [INSTALL.md](INSTALL.md).
|
|
|
|
Be advised that due to the addition of `cmp` as a submodule, you now also need
|
|
to initialize the git submodules required by toxcore. This can be done by
|
|
cloning the repo with the following command:
|
|
`git clone --recurse-submodules https://github.com/Toktok/c-toxcore` or by
|
|
running `git submodule update --init` in the root directory of the repo.
|
|
|
|
In a nutshell, if you have [libsodium](https://github.com/jedisct1/libsodium)
|
|
installed, run:
|
|
|
|
```sh
|
|
mkdir _build && cd _build
|
|
cmake ..
|
|
make
|
|
sudo make install
|
|
```
|
|
|
|
If you have [libvpx](https://github.com/webmproject/libvpx) and
|
|
[opus](https://github.com/xiph/opus) installed, the above will also build the
|
|
A/V library for multimedia chats.
|
|
|
|
## Using toxcore
|
|
|
|
The simplest "hello world" example could be an echo bot. Here we will walk
|
|
through the implementation of a simple bot.
|
|
|
|
### Creating the tox instance
|
|
|
|
All toxcore API functions work with error parameters. They are enums with one
|
|
`OK` value and several error codes that describe the different situations in
|
|
which the function might fail.
|
|
|
|
```c
|
|
TOX_ERR_NEW err_new;
|
|
Tox *tox = tox_new(NULL, &err_new);
|
|
if (err_new != TOX_ERR_NEW_OK) {
|
|
fprintf(stderr, "tox_new failed with error code %d\n", err_new);
|
|
exit(1);
|
|
}
|
|
```
|
|
|
|
Here, we simply exit the program, but in a real client you will probably want to
|
|
do some error handling and proper error reporting to the user. The `NULL`
|
|
argument given to the first parameter of `tox_new` is the `Tox_Options`. It
|
|
contains various write-once network settings and allows you to load a previously
|
|
serialised instance. See [toxcore/tox.h](tox.h) for details.
|
|
|
|
### Setting up callbacks
|
|
|
|
Toxcore works with callbacks that you can register to listen for certain events.
|
|
Examples of such events are "friend request received" or "friend sent a
|
|
message". Search the API for `tox_callback_*` to find all of them.
|
|
|
|
Here, we will set up callbacks for receiving friend requests and receiving
|
|
messages. We will always accept any friend request (because we're a bot), and
|
|
when we receive a message, we send it back to the sender.
|
|
|
|
```c
|
|
tox_callback_friend_request(tox, handle_friend_request);
|
|
tox_callback_friend_message(tox, handle_friend_message);
|
|
```
|
|
|
|
These two function calls set up the callbacks. Now we also need to implement
|
|
these "handle" functions.
|
|
|
|
### Handle friend requests
|
|
|
|
```c
|
|
static void handle_friend_request(
|
|
Tox *tox, const uint8_t *public_key, const uint8_t *message, size_t length,
|
|
void *user_data) {
|
|
// Accept the friend request:
|
|
TOX_ERR_FRIEND_ADD err_friend_add;
|
|
tox_friend_add_norequest(tox, public_key, &err_friend_add);
|
|
if (err_friend_add != TOX_ERR_FRIEND_ADD_OK) {
|
|
fprintf(stderr, "unable to add friend: %d\n", err_friend_add);
|
|
}
|
|
}
|
|
```
|
|
|
|
The `tox_friend_add_norequest` function adds the friend without sending them a
|
|
friend request. Since we already got a friend request, this is the right thing
|
|
to do. If you wanted to send a friend request yourself, you would use
|
|
`tox_friend_add`, which has an extra parameter for the message.
|
|
|
|
### Handle messages
|
|
|
|
Now, when the friend sends us a message, we want to respond to them by sending
|
|
them the same message back. This will be our "echo".
|
|
|
|
```c
|
|
static void handle_friend_message(
|
|
Tox *tox, uint32_t friend_number, TOX_MESSAGE_TYPE type,
|
|
const uint8_t *message, size_t length,
|
|
void *user_data) {
|
|
TOX_ERR_FRIEND_SEND_MESSAGE err_send;
|
|
tox_friend_send_message(tox, friend_number, type, message, length,
|
|
&err_send);
|
|
if (err_send != TOX_ERR_FRIEND_SEND_MESSAGE_OK) {
|
|
fprintf(stderr, "unable to send message back to friend %d: %d\n",
|
|
friend_number, err_send);
|
|
}
|
|
}
|
|
```
|
|
|
|
That's it for the setup. Now we want to actually run the bot.
|
|
|
|
### Main event loop
|
|
|
|
Toxcore works with a main event loop function `tox_iterate` that you need to
|
|
call at a certain frequency dictated by `tox_iteration_interval`. This is a
|
|
polling function that receives new network messages and processes them.
|
|
|
|
```c
|
|
while (true) {
|
|
usleep(1000 * tox_iteration_interval(tox));
|
|
tox_iterate(tox, NULL);
|
|
}
|
|
```
|
|
|
|
That's it! Now you have a working echo bot. The only problem is that since Tox
|
|
works with public keys, and you can't really guess your bot's public key, you
|
|
can't add it as a friend in your client. For this, we need to call another API
|
|
function: `tox_self_get_address(tox, address)`. This will fill the 38 byte
|
|
friend address into the `address` buffer. You can then display that binary
|
|
string as hex and input it into your client. Writing a `bin2hex` function is
|
|
left as exercise for the reader.
|
|
|
|
We glossed over a lot of details, such as the user data which we passed to
|
|
`tox_iterate` (passing `NULL`), bootstrapping into an actual network (this bot
|
|
will work in the LAN, but not on an internet server) and the fact that we now
|
|
have no clean way of stopping the bot (`while (true)`). If you want to write a
|
|
real bot, you will probably want to read up on all the API functions. Consult
|
|
the API documentation in [toxcore/tox.h](toxcore/tox.h) for more information.
|
|
|
|
### Other resources
|
|
|
|
- [Another echo bot](https://wiki.tox.chat/developers/client_examples/echo_bot)
|
|
- [minitox](https://github.com/hqwrong/minitox) (A minimal tox client)
|
|
|
|
## SAST Tools
|
|
|
|
This project uses various tools supporting Static Application Security Testing:
|
|
|
|
- [clang-tidy](https://clang.llvm.org/extra/clang-tidy/): A clang-based C++
|
|
"linter" tool.
|
|
- [Coverity](https://scan.coverity.com/): A cloud-based static analyzer service
|
|
for Java, C/C++, C#, JavaScript, Ruby, or Python that is free for open source
|
|
projects.
|
|
- [cppcheck](https://cppcheck.sourceforge.io/): A static analyzer for C/C++
|
|
code.
|
|
- [cpplint](https://github.com/cpplint/cpplint): Static code checker for C++
|
|
- [goblint](https://goblint.in.tum.de/): A static analyzer for multi-threaded C
|
|
programs, specializing in finding concurrency bugs.
|
|
- [infer](https://github.com/facebook/infer): A static analyzer for Java, C,
|
|
C++, and Objective-C.
|
|
- [PVS-Studio](https://pvs-studio.com/en/pvs-studio/?utm_source=website&utm_medium=github&utm_campaign=open_source):
|
|
A static analyzer for C, C++, C#, and Java code.
|
|
- [tokstyle](https://github.com/TokTok/hs-tokstyle): A style checker for TokTok
|
|
C projects.
|