forked from Green-Sky/tomato
Green Sky
a3126d581b
82460b212 feat: add ngc events 24b54722a fix: Ensure we have allocators available for the error paths. 48dbcfebc cleanup: Remove redundant `-DSODIUM_EXPORT` from definitions. 0cef46ee9 cleanup: Fix a few more clang-tidy warnings. 0c5b918e9 cleanup: Fix a few more clang-tidy warnings. 4d3c97f49 cleanup: Enforce stricter identifier naming using clang-tidy. a549807df refactor: Add `mem` module to allow tests to override allocators. 6133fb153 chore: Add devcontainer setup for codespaces. 620e07ecd chore: Set a timeout for tests started using Conan c0ec33b16 chore: Migrate Windows CI from Appveyor to Azure DevOps 8ed47f3ef fix incorrect documentation a1e245841 docs: Fix doxygen config and remove some redundant comments. b0f633185 chore: Fix the Android CI job 7469a529b fix: Add missing `#include <array>`. 2b1a6b0d2 add missing ngc constants getter declarations and definitions 2e02d5637 chore: Add missing module dependencies. REVERT: 67badf694 feat: add ngc events git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: 82460b2124216af1ac9d63060de310a682a2fd15
155 lines
5.3 KiB
C
155 lines
5.3 KiB
C
/* SPDX-License-Identifier: GPL-3.0-or-later
|
|
* Copyright © 2016-2018 The TokTok team.
|
|
* Copyright © 2014 Tox project.
|
|
*/
|
|
|
|
/**
|
|
* Implementation of the TCP relay client part of Tox.
|
|
*/
|
|
#ifndef C_TOXCORE_TOXCORE_TCP_CLIENT_H
|
|
#define C_TOXCORE_TOXCORE_TCP_CLIENT_H
|
|
|
|
#include "crypto_core.h"
|
|
#include "forwarding.h"
|
|
#include "mono_time.h"
|
|
#include "network.h"
|
|
|
|
#define TCP_CONNECTION_TIMEOUT 10
|
|
|
|
typedef enum TCP_Proxy_Type {
|
|
TCP_PROXY_NONE,
|
|
TCP_PROXY_HTTP,
|
|
TCP_PROXY_SOCKS5,
|
|
} TCP_Proxy_Type;
|
|
|
|
typedef struct TCP_Proxy_Info {
|
|
IP_Port ip_port;
|
|
uint8_t proxy_type; // a value from TCP_PROXY_TYPE
|
|
} TCP_Proxy_Info;
|
|
|
|
typedef enum TCP_Client_Status {
|
|
TCP_CLIENT_NO_STATUS,
|
|
TCP_CLIENT_PROXY_HTTP_CONNECTING,
|
|
TCP_CLIENT_PROXY_SOCKS5_CONNECTING,
|
|
TCP_CLIENT_PROXY_SOCKS5_UNCONFIRMED,
|
|
TCP_CLIENT_CONNECTING,
|
|
TCP_CLIENT_UNCONFIRMED,
|
|
TCP_CLIENT_CONFIRMED,
|
|
TCP_CLIENT_DISCONNECTED,
|
|
} TCP_Client_Status;
|
|
|
|
typedef struct TCP_Client_Connection TCP_Client_Connection;
|
|
|
|
non_null()
|
|
const uint8_t *tcp_con_public_key(const TCP_Client_Connection *con);
|
|
non_null()
|
|
IP_Port tcp_con_ip_port(const TCP_Client_Connection *con);
|
|
non_null()
|
|
TCP_Client_Status tcp_con_status(const TCP_Client_Connection *con);
|
|
|
|
non_null()
|
|
void *tcp_con_custom_object(const TCP_Client_Connection *con);
|
|
non_null()
|
|
uint32_t tcp_con_custom_uint(const TCP_Client_Connection *con);
|
|
non_null()
|
|
void tcp_con_set_custom_object(TCP_Client_Connection *con, void *object);
|
|
non_null()
|
|
void tcp_con_set_custom_uint(TCP_Client_Connection *con, uint32_t value);
|
|
|
|
/** Create new TCP connection to ip_port/public_key */
|
|
non_null(1, 2, 3, 4, 5, 6, 7, 8, 9) nullable(10)
|
|
TCP_Client_Connection *new_tcp_connection(
|
|
const Logger *logger, const Memory *mem, const Mono_Time *mono_time, const Random *rng, const Network *ns,
|
|
const IP_Port *ip_port, const uint8_t *public_key, const uint8_t *self_public_key, const uint8_t *self_secret_key,
|
|
const TCP_Proxy_Info *proxy_info);
|
|
|
|
/** Run the TCP connection */
|
|
non_null(1, 2, 3) nullable(4)
|
|
void do_tcp_connection(const Logger *logger, const Mono_Time *mono_time,
|
|
TCP_Client_Connection *tcp_connection, void *userdata);
|
|
|
|
/** Kill the TCP connection */
|
|
nullable(1)
|
|
void kill_tcp_connection(TCP_Client_Connection *tcp_connection);
|
|
|
|
typedef int tcp_onion_response_cb(void *object, const uint8_t *data, uint16_t length, void *userdata);
|
|
|
|
/**
|
|
* @retval 1 on success.
|
|
* @retval 0 if could not send packet.
|
|
* @retval -1 on failure (connection must be killed).
|
|
*/
|
|
non_null()
|
|
int send_onion_request(const Logger *logger, TCP_Client_Connection *con, const uint8_t *data, uint16_t length);
|
|
non_null()
|
|
void onion_response_handler(TCP_Client_Connection *con, tcp_onion_response_cb *onion_callback, void *object);
|
|
|
|
non_null()
|
|
int send_forward_request_tcp(const Logger *logger, TCP_Client_Connection *con, const IP_Port *dest, const uint8_t *data,
|
|
uint16_t length);
|
|
non_null()
|
|
void forwarding_handler(TCP_Client_Connection *con, forwarded_response_cb *forwarded_response_callback, void *object);
|
|
|
|
typedef int tcp_routing_response_cb(void *object, uint8_t connection_id, const uint8_t *public_key);
|
|
typedef int tcp_routing_status_cb(void *object, uint32_t number, uint8_t connection_id, uint8_t status);
|
|
|
|
/**
|
|
* @retval 1 on success.
|
|
* @retval 0 if could not send packet.
|
|
* @retval -1 on failure (connection must be killed).
|
|
*/
|
|
non_null()
|
|
int send_routing_request(const Logger *logger, TCP_Client_Connection *con, const uint8_t *public_key);
|
|
non_null()
|
|
void routing_response_handler(TCP_Client_Connection *con, tcp_routing_response_cb *response_callback, void *object);
|
|
non_null()
|
|
void routing_status_handler(TCP_Client_Connection *con, tcp_routing_status_cb *status_callback, void *object);
|
|
|
|
/**
|
|
* @retval 1 on success.
|
|
* @retval 0 if could not send packet.
|
|
* @retval -1 on failure (connection must be killed).
|
|
*/
|
|
non_null()
|
|
int send_disconnect_request(const Logger *logger, TCP_Client_Connection *con, uint8_t con_id);
|
|
|
|
/** @brief Set the number that will be used as an argument in the callbacks related to con_id.
|
|
*
|
|
* When not set by this function, the number is -1.
|
|
*
|
|
* return 0 on success.
|
|
* return -1 on failure.
|
|
*/
|
|
non_null()
|
|
int set_tcp_connection_number(TCP_Client_Connection *con, uint8_t con_id, uint32_t number);
|
|
|
|
typedef int tcp_routing_data_cb(void *object, uint32_t number, uint8_t connection_id, const uint8_t *data,
|
|
uint16_t length, void *userdata);
|
|
|
|
/**
|
|
* @retval 1 on success.
|
|
* @retval 0 if could not send packet.
|
|
* @retval -1 on failure.
|
|
*/
|
|
non_null()
|
|
int send_data(const Logger *logger, TCP_Client_Connection *con, uint8_t con_id, const uint8_t *data, uint16_t length);
|
|
non_null()
|
|
void routing_data_handler(TCP_Client_Connection *con, tcp_routing_data_cb *data_callback, void *object);
|
|
|
|
typedef int tcp_oob_data_cb(void *object, const uint8_t *public_key, const uint8_t *data, uint16_t length,
|
|
void *userdata);
|
|
|
|
/**
|
|
* @retval 1 on success.
|
|
* @retval 0 if could not send packet.
|
|
* @retval -1 on failure.
|
|
*/
|
|
non_null()
|
|
int send_oob_packet(const Logger *logger, TCP_Client_Connection *con, const uint8_t *public_key, const uint8_t *data,
|
|
uint16_t length);
|
|
non_null()
|
|
void oob_data_handler(TCP_Client_Connection *con, tcp_oob_data_cb *oob_data_callback, void *object);
|
|
|
|
|
|
#endif
|