3b6bb15e86
d9b8fa6098d fix: Fake broadcast address for 127.x.x.x aa649165a57 chore: Add code for future netprof TCP testing 9e5693de5ac chore: add to_string functions for netprof enums 52d915e6a90 cleanup: Heap allocate network profile objects 80fabd4a729 feat: Implement Tox network profiler 05abe083cb6 cleanup: Some random cleanups, mostly related to mem. 5cca24513b8 cleanup: Check that onion IP/Port packing worked. e092ecd1244 cleanup: Use tox memory allocator in some more places. 3cfe41c7587 fix: Avoid `memcpy`-ing structs into onion ping id data. e32ac001938 fix: Add more information on why the frame was not sent. ab887003687 fix: Allow TCP connections to fail `connect` calls. 7603170e663 refactor: Use tox memory in group connection allocations. 5bd8a85eb89 cleanup: Align internal logger with external on type of source line. e9bf524d9e1 cleanup: Add missing `#include` to sort_test.cc. d10c966b998 feat: Add `to_string` functions for toxencryptsave errors. 7bfd0dc8003 docs: Update the docs for group join functions 380dde9f2ae test: Add more logging to TCP connection constructor. 0f12f384c8c cleanup: Reduce stack frame sizes to below 4096 bytes. bc43cec0626 chore: Happy new year! fbe78f1702e cleanup: Add a `TOX_HIDE_DEPRECATED` check to hide deprecated symbols. 44d9da07e77 refactor: Use tox memory for group moderation/pack allocations. 7f26d520168 refactor: Use tox memory in group chats allocations. 2f62f3d0e77 refactor: Use tox Memory for group allocations. 8a968162041 chore: Add dispatch/events headers to bazel export. 2bbfb35abf6 docs: Output the error code string instead of int. in toxav logging d55d0e4eaef cleanup: Remove redundant code for checking if group exists 2a6dc643338 chore: Upgrade dependencies for websockify. fc0650601c1 fix: Allow peers to reconnect to group chats using a password git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: d9b8fa6098de6c074038b6664d2572627540b148
182 lines
6.1 KiB
C
182 lines
6.1 KiB
C
/* SPDX-License-Identifier: GPL-3.0-or-later
|
|
* Copyright © 2016-2025 The TokTok team.
|
|
* Copyright © 2014 Tox project.
|
|
*/
|
|
|
|
/**
|
|
* Connection to friends.
|
|
*/
|
|
#ifndef C_TOXCORE_TOXCORE_FRIEND_CONNECTION_H
|
|
#define C_TOXCORE_TOXCORE_FRIEND_CONNECTION_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "DHT.h"
|
|
#include "attributes.h"
|
|
#include "logger.h"
|
|
#include "mem.h"
|
|
#include "mono_time.h"
|
|
#include "net_crypto.h"
|
|
#include "network.h"
|
|
#include "onion_client.h"
|
|
|
|
#define MAX_FRIEND_CONNECTION_CALLBACKS 2
|
|
#define MESSENGER_CALLBACK_INDEX 0
|
|
#define GROUPCHAT_CALLBACK_INDEX 1
|
|
|
|
#define PACKET_ID_ALIVE 16
|
|
#define PACKET_ID_SHARE_RELAYS 17
|
|
#define PACKET_ID_FRIEND_REQUESTS 18
|
|
|
|
/** Interval between the sending of ping packets. */
|
|
#define FRIEND_PING_INTERVAL 8
|
|
|
|
/** If no packets are received from friend in this time interval, kill the connection. */
|
|
#define FRIEND_CONNECTION_TIMEOUT (FRIEND_PING_INTERVAL * 4)
|
|
|
|
/** Time before friend is removed from the DHT after last hearing about him. */
|
|
#define FRIEND_DHT_TIMEOUT BAD_NODE_TIMEOUT
|
|
|
|
#define FRIEND_MAX_STORED_TCP_RELAYS (MAX_FRIEND_TCP_CONNECTIONS * 4)
|
|
|
|
/** Max number of tcp relays sent to friends */
|
|
#define MAX_SHARED_RELAYS RECOMMENDED_FRIEND_TCP_CONNECTIONS
|
|
|
|
/** How often we share our TCP relays with each friend connection */
|
|
#define SHARE_RELAYS_INTERVAL (60 * 2)
|
|
|
|
typedef enum Friendconn_Status {
|
|
FRIENDCONN_STATUS_NONE,
|
|
FRIENDCONN_STATUS_CONNECTING,
|
|
FRIENDCONN_STATUS_CONNECTED,
|
|
} Friendconn_Status;
|
|
|
|
typedef struct Friend_Connections Friend_Connections;
|
|
|
|
non_null() Net_Crypto *friendconn_net_crypto(const Friend_Connections *fr_c);
|
|
|
|
/** @return friendcon_id corresponding to the real public key on success.
|
|
* @retval -1 on failure.
|
|
*/
|
|
non_null()
|
|
int getfriend_conn_id_pk(const Friend_Connections *fr_c, const uint8_t *real_pk);
|
|
|
|
/** @brief Increases lock_count for the connection with friendcon_id by 1.
|
|
*
|
|
* @retval 0 on success.
|
|
* @retval -1 on failure.
|
|
*/
|
|
non_null()
|
|
int friend_connection_lock(const Friend_Connections *fr_c, int friendcon_id);
|
|
|
|
/**
|
|
* @retval FRIENDCONN_STATUS_CONNECTED if the friend is connected.
|
|
* @retval FRIENDCONN_STATUS_CONNECTING if the friend isn't connected.
|
|
* @retval FRIENDCONN_STATUS_NONE on failure.
|
|
*/
|
|
non_null()
|
|
unsigned int friend_con_connected(const Friend_Connections *fr_c, int friendcon_id);
|
|
|
|
/** @brief Copy public keys associated to friendcon_id.
|
|
*
|
|
* @retval 0 on success.
|
|
* @retval -1 on failure.
|
|
*/
|
|
non_null(3) nullable(1, 2)
|
|
int get_friendcon_public_keys(uint8_t *real_pk, uint8_t *dht_temp_pk, const Friend_Connections *fr_c, int friendcon_id);
|
|
|
|
/** Set temp dht key for connection. */
|
|
non_null()
|
|
void set_dht_temp_pk(Friend_Connections *fr_c, int friendcon_id, const uint8_t *dht_temp_pk, void *userdata);
|
|
|
|
typedef int global_status_cb(void *object, int friendcon_id, bool status, void *userdata);
|
|
|
|
typedef int fc_status_cb(void *object, int friendcon_id, bool status, void *userdata);
|
|
typedef int fc_data_cb(void *object, int friendcon_id, const uint8_t *data, uint16_t length, void *userdata);
|
|
typedef int fc_lossy_data_cb(void *object, int friendcon_id, const uint8_t *data, uint16_t length, void *userdata);
|
|
|
|
/** Set global status callback for friend connections. */
|
|
non_null(1) nullable(2, 3)
|
|
void set_global_status_callback(Friend_Connections *fr_c, global_status_cb *global_status_callback, void *object);
|
|
|
|
/** @brief Set the callbacks for the friend connection.
|
|
* @param index is the index (0 to (MAX_FRIEND_CONNECTION_CALLBACKS - 1)) we
|
|
* want the callback to set in the array.
|
|
*
|
|
* @retval 0 on success.
|
|
* @retval -1 on failure
|
|
*/
|
|
non_null(1) nullable(4, 5, 6, 7)
|
|
int friend_connection_callbacks(const Friend_Connections *fr_c, int friendcon_id, unsigned int index,
|
|
fc_status_cb *status_callback,
|
|
fc_data_cb *data_callback,
|
|
fc_lossy_data_cb *lossy_data_callback,
|
|
void *object, int number);
|
|
|
|
/** @brief return the crypt_connection_id for the connection.
|
|
*
|
|
* @return crypt_connection_id on success.
|
|
* @retval -1 on failure.
|
|
*/
|
|
non_null()
|
|
int friend_connection_crypt_connection_id(const Friend_Connections *fr_c, int friendcon_id);
|
|
|
|
/** @brief Create a new friend connection.
|
|
* If one to that real public key already exists, increase lock count and return it.
|
|
*
|
|
* @retval -1 on failure.
|
|
* @return connection id on success.
|
|
*/
|
|
non_null()
|
|
int new_friend_connection(Friend_Connections *fr_c, const uint8_t *real_public_key);
|
|
|
|
/** @brief Kill a friend connection.
|
|
*
|
|
* @retval -1 on failure.
|
|
* @retval 0 on success.
|
|
*/
|
|
non_null()
|
|
int kill_friend_connection(Friend_Connections *fr_c, int friendcon_id);
|
|
|
|
/** @brief Send a Friend request packet.
|
|
*
|
|
* @retval -1 if failure.
|
|
* @retval 0 if it sent the friend request directly to the friend.
|
|
* @return the number of peers it was routed through if it did not send it directly.
|
|
*/
|
|
non_null()
|
|
int send_friend_request_packet(
|
|
Friend_Connections *fr_c, int friendcon_id, uint32_t nospam_num, const uint8_t *data, uint16_t length);
|
|
|
|
typedef int fr_request_cb(
|
|
void *object, const uint8_t *source_pubkey, const uint8_t *data, uint16_t length, void *userdata);
|
|
|
|
/** @brief Set friend request callback.
|
|
*
|
|
* This function will be called every time a friend request packet is received.
|
|
*/
|
|
non_null()
|
|
void set_friend_request_callback(Friend_Connections *fr_c, fr_request_cb *fr_request_callback, void *object);
|
|
|
|
/** Create new friend_connections instance. */
|
|
non_null()
|
|
Friend_Connections *new_friend_connections(
|
|
const Logger *logger, const Memory *mem, const Mono_Time *mono_time, const Network *ns,
|
|
Onion_Client *onion_c, bool local_discovery_enabled);
|
|
|
|
/** main friend_connections loop. */
|
|
non_null()
|
|
void do_friend_connections(Friend_Connections *fr_c, void *userdata);
|
|
|
|
/** Free everything related with friend_connections. */
|
|
nullable(1)
|
|
void kill_friend_connections(Friend_Connections *fr_c);
|
|
|
|
typedef struct Friend_Conn Friend_Conn;
|
|
|
|
non_null() Friend_Conn *get_conn(const Friend_Connections *fr_c, int friendcon_id);
|
|
non_null() int friend_conn_get_onion_friendnum(const Friend_Conn *fc);
|
|
non_null() const IP_Port *friend_conn_get_dht_ip_port(const Friend_Conn *fc);
|
|
|
|
#endif /* C_TOXCORE_TOXCORE_FRIEND_CONNECTION_H */
|