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
140 lines
6.3 KiB
C
140 lines
6.3 KiB
C
/* SPDX-License-Identifier: GPL-3.0-or-later
|
|
* Copyright © 2016-2018 The TokTok team.
|
|
* Copyright © 2013 Tox project.
|
|
*/
|
|
|
|
/**
|
|
* Implementation of the announce part of docs/Prevent_Tracking.txt
|
|
*/
|
|
#ifndef C_TOXCORE_TOXCORE_ONION_ANNOUNCE_H
|
|
#define C_TOXCORE_TOXCORE_ONION_ANNOUNCE_H
|
|
|
|
#include "logger.h"
|
|
#include "onion.h"
|
|
#include "timed_auth.h"
|
|
|
|
#define ONION_ANNOUNCE_MAX_ENTRIES 160
|
|
#define ONION_ANNOUNCE_TIMEOUT 300
|
|
#define ONION_PING_ID_SIZE TIMED_AUTH_SIZE
|
|
#define ONION_MAX_EXTRA_DATA_SIZE 136
|
|
|
|
#define ONION_ANNOUNCE_SENDBACK_DATA_LENGTH (sizeof(uint64_t))
|
|
|
|
#define MAX_SENT_GC_NODES 1
|
|
#define ONION_ANNOUNCE_REQUEST_MIN_SIZE (1 + CRYPTO_NONCE_SIZE + CRYPTO_PUBLIC_KEY_SIZE + ONION_PING_ID_SIZE + CRYPTO_PUBLIC_KEY_SIZE + CRYPTO_PUBLIC_KEY_SIZE + ONION_ANNOUNCE_SENDBACK_DATA_LENGTH + CRYPTO_MAC_SIZE)
|
|
#define ONION_ANNOUNCE_REQUEST_MAX_SIZE (ONION_ANNOUNCE_REQUEST_MIN_SIZE + ONION_MAX_EXTRA_DATA_SIZE)
|
|
|
|
#define ONION_ANNOUNCE_RESPONSE_MIN_SIZE (2 + ONION_ANNOUNCE_SENDBACK_DATA_LENGTH + CRYPTO_NONCE_SIZE + ONION_PING_ID_SIZE + CRYPTO_MAC_SIZE)
|
|
#define ONION_ANNOUNCE_RESPONSE_MAX_SIZE (ONION_ANNOUNCE_RESPONSE_MIN_SIZE + ONION_MAX_EXTRA_DATA_SIZE * MAX_SENT_NODES)
|
|
|
|
/* TODO: DEPRECATE */
|
|
#define ONION_ANNOUNCE_REQUEST_SIZE (1 + CRYPTO_NONCE_SIZE + CRYPTO_PUBLIC_KEY_SIZE + ONION_PING_ID_SIZE + CRYPTO_PUBLIC_KEY_SIZE + CRYPTO_PUBLIC_KEY_SIZE + ONION_ANNOUNCE_SENDBACK_DATA_LENGTH + CRYPTO_MAC_SIZE)
|
|
|
|
#define ONION_DATA_RESPONSE_MIN_SIZE (1 + CRYPTO_NONCE_SIZE + CRYPTO_PUBLIC_KEY_SIZE + CRYPTO_MAC_SIZE)
|
|
|
|
#define ONION_DATA_REQUEST_MIN_SIZE (1 + CRYPTO_PUBLIC_KEY_SIZE + CRYPTO_NONCE_SIZE + CRYPTO_PUBLIC_KEY_SIZE + CRYPTO_MAC_SIZE)
|
|
#define MAX_DATA_REQUEST_SIZE (ONION_MAX_DATA_SIZE - ONION_DATA_REQUEST_MIN_SIZE)
|
|
|
|
typedef struct Onion_Announce Onion_Announce;
|
|
|
|
/** These two are not public; they are for tests only! */
|
|
non_null()
|
|
uint8_t *onion_announce_entry_public_key(Onion_Announce *onion_a, uint32_t entry);
|
|
non_null()
|
|
void onion_announce_entry_set_time(Onion_Announce *onion_a, uint32_t entry, uint64_t announce_time);
|
|
|
|
/** @brief Create an onion announce request packet in packet of max_packet_length.
|
|
*
|
|
* Recommended value for max_packet_length is ONION_ANNOUNCE_REQUEST_MIN_SIZE.
|
|
*
|
|
* dest_client_id is the public key of the node the packet will be sent to.
|
|
* public_key and secret_key is the kepair which will be used to encrypt the request.
|
|
* ping_id is the ping id that will be sent in the request.
|
|
* client_id is the client id of the node we are searching for.
|
|
* data_public_key is the public key we want others to encrypt their data packets with.
|
|
* sendback_data is the data of ONION_ANNOUNCE_SENDBACK_DATA_LENGTH length that we expect to
|
|
* receive back in the response.
|
|
*
|
|
* return -1 on failure.
|
|
* return packet length on success.
|
|
*/
|
|
non_null()
|
|
int create_announce_request(const Random *rng, uint8_t *packet, uint16_t max_packet_length, const uint8_t *dest_client_id,
|
|
const uint8_t *public_key, const uint8_t *secret_key, const uint8_t *ping_id, const uint8_t *client_id,
|
|
const uint8_t *data_public_key, uint64_t sendback_data);
|
|
|
|
/** @brief Create an onion data request packet in packet of max_packet_length.
|
|
*
|
|
* Recommended value for max_packet_length is ONION_ANNOUNCE_REQUEST_SIZE.
|
|
*
|
|
* public_key is the real public key of the node which we want to send the data of length length to.
|
|
* encrypt_public_key is the public key used to encrypt the data packet.
|
|
*
|
|
* nonce is the nonce to encrypt this packet with
|
|
*
|
|
* return -1 on failure.
|
|
* return 0 on success.
|
|
*/
|
|
non_null()
|
|
int create_data_request(const Random *rng, uint8_t *packet, uint16_t max_packet_length, const uint8_t *public_key,
|
|
const uint8_t *encrypt_public_key, const uint8_t *nonce, const uint8_t *data, uint16_t length);
|
|
|
|
/** @brief Create and send an onion announce request packet.
|
|
*
|
|
* path is the path the request will take before it is sent to dest.
|
|
*
|
|
* public_key and secret_key is the kepair which will be used to encrypt the request.
|
|
* ping_id is the ping id that will be sent in the request.
|
|
* client_id is the client id of the node we are searching for.
|
|
* data_public_key is the public key we want others to encrypt their data packets with.
|
|
* sendback_data is the data of ONION_ANNOUNCE_SENDBACK_DATA_LENGTH length that we expect to
|
|
* receive back in the response.
|
|
*
|
|
* return -1 on failure.
|
|
* return 0 on success.
|
|
*/
|
|
non_null()
|
|
int send_announce_request(const Networking_Core *net, const Random *rng,
|
|
const Onion_Path *path, const Node_format *dest,
|
|
const uint8_t *public_key, const uint8_t *secret_key,
|
|
const uint8_t *ping_id, const uint8_t *client_id,
|
|
const uint8_t *data_public_key, uint64_t sendback_data);
|
|
|
|
/** @brief Create and send an onion data request packet.
|
|
*
|
|
* path is the path the request will take before it is sent to dest.
|
|
* (if dest knows the person with the public_key they should
|
|
* send the packet to that person in the form of a response)
|
|
*
|
|
* public_key is the real public key of the node which we want to send the data of length length to.
|
|
* encrypt_public_key is the public key used to encrypt the data packet.
|
|
*
|
|
* nonce is the nonce to encrypt this packet with
|
|
*
|
|
* The maximum length of data is MAX_DATA_REQUEST_SIZE.
|
|
*
|
|
* return -1 on failure.
|
|
* return 0 on success.
|
|
*/
|
|
non_null()
|
|
int send_data_request(const Networking_Core *net, const Random *rng, const Onion_Path *path, const IP_Port *dest,
|
|
const uint8_t *public_key, const uint8_t *encrypt_public_key, const uint8_t *nonce,
|
|
const uint8_t *data, uint16_t length);
|
|
|
|
|
|
typedef int pack_extra_data_cb(void *object, const Logger *logger, const Mono_Time *mono_time,
|
|
uint8_t num_nodes, uint8_t *plain, uint16_t plain_size,
|
|
uint8_t *response, uint16_t response_size, uint16_t offset);
|
|
|
|
non_null()
|
|
void onion_announce_extra_data_callback(Onion_Announce *onion_a, uint16_t extra_data_max_size,
|
|
pack_extra_data_cb *extra_data_callback, void *extra_data_object);
|
|
|
|
non_null()
|
|
Onion_Announce *new_onion_announce(const Logger *log, const Memory *mem, const Random *rng, const Mono_Time *mono_time, DHT *dht);
|
|
|
|
nullable(1)
|
|
void kill_onion_announce(Onion_Announce *onion_a);
|
|
|
|
#endif
|