/* SPDX-License-Identifier: GPL-3.0-or-later

 * Copyright © 2016-2025 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 "DHT.h"

#include "attributes.h"

#include "crypto_core.h"

#include "logger.h"

#include "mem.h"

#include "mono_time.h"

#include "network.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! */

uint8_t *_Nullable onion_announce_entry_public_key(Onion_Announce *_Nonnull onion_a, uint32_t entry);

void onion_announce_entry_set_time(Onion_Announce *_Nonnull 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.

 */

int create_announce_request(const Memory *_Nonnull mem, const Random *_Nonnull rng, uint8_t *_Nonnull packet, uint16_t max_packet_length, const uint8_t *_Nonnull dest_client_id,

                            const uint8_t *_Nonnull public_key, const uint8_t *_Nonnull secret_key, const uint8_t *_Nonnull ping_id, const uint8_t *_Nonnull client_id, const uint8_t *_Nonnull 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.

 */

int create_data_request(const Memory *_Nonnull mem, const Random *_Nonnull rng, uint8_t *_Nonnull packet, uint16_t max_packet_length, const uint8_t *_Nonnull public_key,

                        const uint8_t *_Nonnull encrypt_public_key, const uint8_t *_Nonnull nonce, const uint8_t *_Nonnull 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.

 */

int send_announce_request(const Logger *_Nonnull log, const Memory *_Nonnull mem, const Networking_Core *_Nonnull net, const Random *_Nonnull rng, const Onion_Path *_Nonnull path,

                          const Node_format *_Nonnull dest, const uint8_t *_Nonnull public_key, const uint8_t *_Nonnull secret_key, const uint8_t *_Nonnull ping_id, const uint8_t *_Nonnull client_id,

                          const uint8_t *_Nonnull 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.

 */

int send_data_request(const Logger *_Nonnull log, const Memory *_Nonnull mem, const Networking_Core *_Nonnull net, const Random *_Nonnull rng, const Onion_Path *_Nonnull path,

                      const IP_Port *_Nonnull dest, const uint8_t *_Nonnull public_key, const uint8_t *_Nonnull encrypt_public_key, const uint8_t *_Nonnull nonce, const uint8_t *_Nonnull data, uint16_t length);

typedef int pack_extra_data_cb(void *_Nonnull object, const Logger *_Nonnull logger, const Memory *_Nonnull mem, const Mono_Time *_Nonnull mono_time,

                               uint8_t num_nodes, uint8_t *_Nonnull plain, uint16_t plain_size,

                               uint8_t *_Nonnull response, uint16_t response_size, uint16_t offset);

void onion_announce_extra_data_callback(Onion_Announce *_Nonnull onion_a, uint16_t extra_data_max_size, pack_extra_data_cb *_Nonnull extra_data_callback, void *_Nonnull extra_data_object);

Onion_Announce *_Nullable new_onion_announce(const Logger *_Nonnull log, const Memory *_Nonnull mem, const Random *_Nonnull rng, const Mono_Time *_Nonnull mono_time, DHT *_Nonnull dht);

void kill_onion_announce(Onion_Announce *_Nullable onion_a);

#endif /* C_TOXCORE_TOXCORE_ONION_ANNOUNCE_H */