Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(chatffi): tor configuration #5752

Merged
merged 6 commits into from
Sep 12, 2023
Merged

feat(chatffi): tor configuration #5752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ddd5f70
feat(chatffi): tor config support
brianp Sep 6, 2023
7835777
Rename exports to avoid duplicate symbol conflicts
brianp Sep 7, 2023
e7d9405
Add some tests
brianp Sep 7, 2023
0dcfd26
Rename destroy function
brianp Sep 8, 2023
af0b03b
Update naming changes in tests
brianp Sep 8, 2023
3b29409
Add test for shutdown
brianp Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions base_layer/chat_ffi/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ tari_common = { path = "../../common" }
tari_common_types = { path = "../common_types" }
tari_comms = { path = "../../comms/core" }
tari_contacts = { path = "../contacts" }
tari_p2p = { path = "../p2p" }
tari_shutdown = { path = "../../infrastructure/shutdown" }
tari_utilities = { version = "0.5" }

libc = "0.2.65"
libsqlite3-sys = { version = "0.25.1", features = ["bundled"], optional = true }
Expand Down
93 changes: 70 additions & 23 deletions base_layer/chat_ffi/chat.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@

struct ApplicationConfig;

struct ChatMessages;
struct ChatByteVector;

struct ChatClientFFI;

struct ClientFFI;
struct ChatMessages;

struct TariAddress;

struct TransportConfig;

struct ChatFFIContactsLivenessData {
const char *address;
uint64_t last_seen;
Expand Down Expand Up @@ -52,24 +56,24 @@ extern "C" {
* # Safety
* The ```destroy_client``` method must be called when finished with a ClientFFI to prevent a memory leak
*/
struct ClientFFI *create_chat_client(struct ApplicationConfig *config,
int *error_out,
CallbackContactStatusChange callback_contact_status_change,
CallbackMessageReceived callback_message_received);
struct ChatClientFFI *create_chat_client(struct ApplicationConfig *config,
int *error_out,
CallbackContactStatusChange callback_contact_status_change,
CallbackMessageReceived callback_message_received);

/**
* Frees memory for a ClientFFI
* Frees memory for a ChatClientFFI
*
* ## Arguments
* `client` - The pointer of a ClientFFI
* `client` - The pointer of a ChatClientFFI
*
* ## Returns
* `()` - Does not return a value, equivalent to void in C
*
* # Safety
* None
*/
void destroy_client_ffi(struct ClientFFI *client);
void destroy_chat_client_ffi(struct ChatClientFFI *client);

/**
* Creates a Chat Client config
Expand All @@ -89,6 +93,7 @@ struct ApplicationConfig *create_chat_config(const char *network_str,
const char *public_address,
const char *datastore_path,
const char *identity_file_path,
struct TransportConfig *tor_transport_config,
const char *log_path,
int *error_out);

Expand All @@ -104,7 +109,7 @@ struct ApplicationConfig *create_chat_config(const char *network_str,
* # Safety
* None
*/
void destroy_config(struct ApplicationConfig *config);
void destroy_chat_config(struct ApplicationConfig *config);

/**
* Sends a message over a client
Expand All @@ -121,10 +126,10 @@ void destroy_config(struct ApplicationConfig *config);
* # Safety
* The ```receiver``` should be destroyed after use
*/
void send_message(struct ClientFFI *client,
struct TariAddress *receiver,
const char *message_c_char,
int *error_out);
void send_chat_message(struct ChatClientFFI *client,
struct TariAddress *receiver,
const char *message_c_char,
int *error_out);

/**
* Add a contact
Expand All @@ -140,7 +145,7 @@ void send_message(struct ClientFFI *client,
* # Safety
* The ```address``` should be destroyed after use
*/
void add_contact(struct ClientFFI *client, struct TariAddress *receiver, int *error_out);
void add_chat_contact(struct ChatClientFFI *client, struct TariAddress *receiver, int *error_out);

/**
* Check the online status of a contact
Expand All @@ -156,7 +161,7 @@ void add_contact(struct ClientFFI *client, struct TariAddress *receiver, int *er
* # Safety
* The ```address``` should be destroyed after use
*/
int check_online_status(struct ClientFFI *client, struct TariAddress *receiver, int *error_out);
int check_online_status(struct ChatClientFFI *client, struct TariAddress *receiver, int *error_out);

/**
* Get a ptr to all messages from or to address
Expand All @@ -175,11 +180,11 @@ int check_online_status(struct ClientFFI *client, struct TariAddress *receiver,
* The ```address``` should be destroyed after use
* The returned pointer to ```*mut ChatMessages``` should be destroyed after use
*/
struct ChatMessages *get_messages(struct ClientFFI *client,
struct TariAddress *address,
int *limit,
int *page,
int *error_out);
struct ChatMessages *get_chat_messages(struct ChatClientFFI *client,
struct TariAddress *address,
int *limit,
int *page,
int *error_out);

/**
* Frees memory for messages
Expand All @@ -193,7 +198,7 @@ struct ChatMessages *get_messages(struct ClientFFI *client,
* # Safety
* None
*/
void destroy_messages(struct ChatMessages *messages_ptr);
void destroy_chat_messages(struct ChatMessages *messages_ptr);

/**
* Creates a TariAddress and returns a ptr
Expand Down Expand Up @@ -224,11 +229,53 @@ struct TariAddress *create_tari_address(const char *receiver_c_char, int *error_
*/
void destroy_tari_address(struct TariAddress *address);

/**
* Creates a tor transport config
*
* ## Arguments
* `control_server_address` - The pointer to a char array
* `tor_cookie` - The pointer to a ChatByteVector containing the contents of the tor cookie file, can be null
* `tor_port` - The tor port
* `tor_proxy_bypass_for_outbound` - Whether tor will use a direct tcp connection for a given bypass address instead of
* the tor proxy if tcp is available, if not it has no effect
* `socks_password` - The pointer to a char array containing the socks password, can be null
* `error_out` - Pointer to an int which will be modified to an error code should one occur, may not be null. Functions
* as an out parameter.
*
* ## Returns
* `*mut TransportConfig` - Returns a pointer to a tor TransportConfig, null on error.
*
* # Safety
* The ```destroy_chat_tor_transport_config``` method must be called when finished with a TransportConfig to prevent a
* memory leak
*/
struct TransportConfig *create_chat_tor_transport_config(const char *control_server_address,
const struct ChatByteVector *tor_cookie,
unsigned short tor_port,
bool tor_proxy_bypass_for_outbound,
const char *socks_username,
const char *socks_password,
int *error_out);

/**
* Frees memory for a TransportConfig
*
* ## Arguments
* `transport` - The pointer to a TransportConfig
*
* ## Returns
* `()` - Does not return a value, equivalent to void in C
*
* # Safety
* None
*/
void destroy_chat_tor_transport_config(struct TransportConfig *transport);

/**
* Frees memory for a ChatFFIMessage
*
* ## Arguments
* `address` - The pointer of a ChatFFIMessage
* `transport` - The pointer to a ChatFFIMessage
*
* ## Returns
* `()` - Does not return a value, equivalent to void in C
Expand Down
Loading