ascii-chat
Binary v0.16.50-198-g78f51665f
Library lib/v0.3.2-2240-g78f51665f
Video chat in your terminal
Loading...
Searching...
No Matches
transport.h File Reference

Go to the source code of this file.

Typedefs

typedef enum browser_transport_state browser_transport_state_t

Enumerations

enum  browser_transport_state {
  BROWSER_TRANSPORT_DISCONNECTED = 0 , BROWSER_TRANSPORT_CONNECTING = 1 , BROWSER_TRANSPORT_HANDSHAKE = 2 , BROWSER_TRANSPORT_CONNECTED = 3 ,
  BROWSER_TRANSPORT_ERROR = 4
}

Functions

browser_transport_t * browser_transport_create (void)
void browser_transport_destroy (browser_transport_t *browser)
void browser_transport_set_state (browser_transport_t *browser, browser_transport_state_t state)
void browser_transport_set_capabilities (browser_transport_t *browser, bool datagrams, size_t max_datagram_payload)
browser_transport_state_t browser_transport_state (const browser_transport_t *browser)
void browser_transport_set_connected (browser_transport_t *browser, bool connected)
bool browser_transport_is_connected (browser_transport_t *browser)
size_t browser_transport_queued_bytes (const browser_transport_t *browser)
uint64_t browser_transport_accepted_packets (const browser_transport_t *browser)
uint64_t browser_transport_dropped_packets (const browser_transport_t *browser)
uint64_t browser_transport_dropped_bytes (const browser_transport_t *browser)
bool browser_transport_writable (const browser_transport_t *browser, size_t additional_bytes)
acip_transport_t * browser_transport_base (browser_transport_t *browser)
void * browser_transport_client_state (browser_transport_t *browser)
void browser_transport_set_client_state (browser_transport_t *browser, void *state)
const void * browser_transport_output_data (browser_transport_t *browser)
size_t browser_transport_output_size (browser_transport_t *browser)
acip_traffic_class_t browser_transport_output_traffic (const browser_transport_t *browser)
acip_delivery_t browser_transport_output_delivery (const browser_transport_t *browser)
void browser_transport_output_pop (browser_transport_t *browser)
asciichat_error_t browser_transport_security_init (browser_transport_t *browser)
asciichat_error_t browser_transport_security_packet (browser_transport_t *browser, bool seal, uint32_t channel, uint32_t delivery, const uint8_t *packet, size_t length, uint8_t *output, size_t capacity, size_t *out_length, uint64_t *sequence)
asciichat_error_t browser_transport_security_tick (browser_transport_t *browser)
asciichat_error_t browser_transport_security_output (browser_transport_t *browser, uint8_t *output, size_t capacity, size_t *length, uint32_t *channel)
double browser_transport_security_epoch (browser_transport_t *browser)

Typedef Documentation

◆ browser_transport_state_t

Enumeration Type Documentation

◆ browser_transport_state

Enumerator
BROWSER_TRANSPORT_DISCONNECTED 
BROWSER_TRANSPORT_CONNECTING 
BROWSER_TRANSPORT_HANDSHAKE 
BROWSER_TRANSPORT_CONNECTED 
BROWSER_TRANSPORT_ERROR 

Definition at line 11 of file include/ascii-chat/network/browser/transport.h.

Function Documentation

◆ browser_transport_accepted_packets()

uint64_t browser_transport_accepted_packets ( const browser_transport_t * browser)

Definition at line 276 of file browser/transport.c.

276 {
277 return browser ? browser->accepted_packets : 0;
278}

References browser_transport::accepted_packets.

Referenced by ClientSessionBinding::drainOutputs(), and ClientSessionBinding::snapshot().

◆ browser_transport_base()

◆ browser_transport_client_state()

void * browser_transport_client_state ( browser_transport_t * browser)

Definition at line 259 of file browser/transport.c.

259 {
260 return browser ? browser->client_state : NULL;
261}

References browser_transport::client_state.

◆ browser_transport_create()

browser_transport_t * browser_transport_create ( void )

Definition at line 100 of file browser/transport.c.

100 {
101 browser_transport_t *browser = SAFE_CALLOC(1, sizeof(*browser), browser_transport_t *);
102 if (!browser)
103 return NULL;
104 browser->transport.methods = &browser_methods;
105 browser->transport.impl_data = browser;
106 return browser;
107}
#define SAFE_CALLOC(count, size, cast)
struct browser_transport browser_transport_t
void * impl_data
Transport-specific state.
const acip_transport_methods_t * methods
Method table (virtual functions).

References acip_transport::impl_data, acip_transport::methods, SAFE_CALLOC, and browser_transport::transport.

Referenced by browser_session_create(), and ClientSessionBinding::ClientSessionBinding().

◆ browser_transport_destroy()

void browser_transport_destroy ( browser_transport_t * browser)

Definition at line 235 of file browser/transport.c.

235 {
236 if (!browser)
237 return;
238 while (browser->output)
240 SAFE_FREE(browser);
241}
void browser_transport_output_pop(browser_transport_t *browser)
#define SAFE_FREE(ptr)
browser_output_t * output

References browser_transport_output_pop(), browser_transport::output, and SAFE_FREE.

Referenced by acip_transport_destroy(), and browser_session_destroy().

◆ browser_transport_dropped_bytes()

uint64_t browser_transport_dropped_bytes ( const browser_transport_t * browser)

Definition at line 284 of file browser/transport.c.

284 {
285 return browser ? browser->dropped_bytes : 0;
286}

References browser_transport::dropped_bytes.

Referenced by ClientSessionBinding::drainOutputs(), and ClientSessionBinding::snapshot().

◆ browser_transport_dropped_packets()

uint64_t browser_transport_dropped_packets ( const browser_transport_t * browser)

Definition at line 280 of file browser/transport.c.

280 {
281 return browser ? browser->dropped_packets : 0;
282}

References browser_transport::dropped_packets.

Referenced by ClientSessionBinding::drainOutputs(), and ClientSessionBinding::snapshot().

◆ browser_transport_is_connected()

bool browser_transport_is_connected ( browser_transport_t * browser)

Definition at line 137 of file browser/transport.c.

137 {
138 return browser && (browser->state == BROWSER_TRANSPORT_HANDSHAKE || browser->state == BROWSER_TRANSPORT_CONNECTED);
139}
browser_transport_state_t state

References BROWSER_TRANSPORT_CONNECTED, BROWSER_TRANSPORT_HANDSHAKE, and browser_transport::state.

◆ browser_transport_output_data()

const void * browser_transport_output_data ( browser_transport_t * browser)

Definition at line 268 of file browser/transport.c.

268 {
269 return browser && browser->output ? browser->output->data : NULL;
270}

References browser_output::data, and browser_transport::output.

Referenced by browser_client_send_packet(), and browser_session_output_data().

◆ browser_transport_output_delivery()

acip_delivery_t browser_transport_output_delivery ( const browser_transport_t * browser)

Definition at line 292 of file browser/transport.c.

292 {
293 return browser && browser->output ? browser->output->delivery : ACIP_DELIVERY_RELIABLE;
294}
acip_delivery_t delivery
@ ACIP_DELIVERY_RELIABLE
Definition traffic.h:16

References ACIP_DELIVERY_RELIABLE, browser_output::delivery, and browser_transport::output.

◆ browser_transport_output_pop()

void browser_transport_output_pop ( browser_transport_t * browser)

Definition at line 141 of file browser/transport.c.

141 {
142 browser_transport_output_pop_internal(browser);
143}

Referenced by browser_client_send_packet(), browser_session_output_pop(), and browser_transport_destroy().

◆ browser_transport_output_size()

size_t browser_transport_output_size ( browser_transport_t * browser)

Definition at line 272 of file browser/transport.c.

272 {
273 return browser && browser->output ? browser->output->length : 0;
274}

References browser_output::length, and browser_transport::output.

Referenced by browser_client_send_packet(), and browser_session_output_size().

◆ browser_transport_output_traffic()

acip_traffic_class_t browser_transport_output_traffic ( const browser_transport_t * browser)

Definition at line 288 of file browser/transport.c.

288 {
289 return browser && browser->output ? browser->output->traffic_class : ACIP_TRAFFIC_CONTROL;
290}
acip_traffic_class_t traffic_class
@ ACIP_TRAFFIC_CONTROL
Definition traffic.h:10

References ACIP_TRAFFIC_CONTROL, browser_transport::output, and browser_output::traffic_class.

◆ browser_transport_queued_bytes()

size_t browser_transport_queued_bytes ( const browser_transport_t * browser)

Definition at line 125 of file browser/transport.c.

125 {
126 return browser ? browser->queued_bytes : 0;
127}

References browser_transport::queued_bytes.

Referenced by browser_session_queued_bytes(), ClientSessionBinding::drainOutputs(), and ClientSessionBinding::snapshot().

◆ browser_transport_security_epoch()

double browser_transport_security_epoch ( browser_transport_t * browser)

Definition at line 212 of file browser/transport.c.

212 {
213 if (!browser || !browser->transport.crypto_ctx)
214 return -1;
215 crypto_session_t *session = NULL;
216 if (crypto_session_lock(browser->transport.crypto_ctx, &session) != ASCIICHAT_OK)
217 return -1;
218 const double epoch = (double)session->records.key_epoch;
219 crypto_session_unlock(session);
220 return epoch;
221}
@ ASCIICHAT_OK
Definition error_codes.h:50
struct crypto_session crypto_session_t
For crypto session, this is the live record that ties owner, mutex, records, rotation together....
void crypto_session_unlock(crypto_session_t *session)
asciichat_error_t crypto_session_lock(crypto_context_t *crypto, crypto_session_t **output)
crypto_context_t * crypto_ctx
Optional encryption context.
uint64_t key_epoch
Definition record.h:25

References ASCIICHAT_OK, acip_transport::crypto_ctx, crypto_session_lock(), crypto_session_unlock(), crypto_record::key_epoch, crypto_session::records, and browser_transport::transport.

Referenced by browser_session_security_epoch(), ClientSessionBinding::drainOutputs(), and ClientSessionBinding::process().

◆ browser_transport_security_init()

asciichat_error_t browser_transport_security_init ( browser_transport_t * browser)

Definition at line 145 of file browser/transport.c.

145 {
146 if (!browser || !browser->transport.crypto_ctx)
147 return SET_ERRNO(ERROR_INVALID_STATE, "Browser transport security is unavailable");
148 crypto_session_t *session = NULL;
149 const asciichat_error_t result = crypto_session_lock(browser->transport.crypto_ctx, &session);
150 if (result == ASCIICHAT_OK)
151 crypto_session_unlock(session);
152 return result;
153}
#define SET_ERRNO(code,...)
asciichat_error_t
Error and exit codes - unified status values (0-255).
Definition error_codes.h:48
@ ERROR_INVALID_STATE

References ASCIICHAT_OK, acip_transport::crypto_ctx, crypto_session_lock(), crypto_session_unlock(), ERROR_INVALID_STATE, SET_ERRNO, and browser_transport::transport.

Referenced by browser_session_security_init(), and ClientSessionBinding::process().

◆ browser_transport_security_output()

asciichat_error_t browser_transport_security_output ( browser_transport_t * browser,
uint8_t * output,
size_t capacity,
size_t * length,
uint32_t * channel )

Definition at line 195 of file browser/transport.c.

195 {
196 if (!browser || !browser->transport.crypto_ctx)
197 return SET_ERRNO(ERROR_INVALID_STATE, "Browser transport security is unavailable");
198 if (!output || !length || !channel || capacity < 256)
199 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid browser security control buffer");
200 uint8_t *packet = NULL;
202 *length = 0;
203 const asciichat_error_t result = acip_security_next_control(browser->transport.crypto_ctx, &flow, &packet, length);
204 if (result == ASCIICHAT_OK && *length) {
205 memcpy(output, packet, *length);
206 *channel = flow;
207 }
208 buffer_release(packet);
209 return result;
210}
#define buffer_release(data)
Definition buffer.h:99
unsigned char uint8_t
@ ERROR_INVALID_PARAM
asciichat_error_t acip_security_next_control(crypto_context_t *crypto, acip_traffic_class_t *flow, uint8_t **wire, size_t *length)
acip_traffic_class_t
Definition traffic.h:9

References acip_security_next_control(), ASCIICHAT_OK, buffer_release, acip_transport::crypto_ctx, ERROR_INVALID_PARAM, ERROR_INVALID_STATE, SET_ERRNO, and browser_transport::transport.

Referenced by browser_session_security_output().

◆ browser_transport_security_packet()

asciichat_error_t browser_transport_security_packet ( browser_transport_t * browser,
bool seal,
uint32_t channel,
uint32_t delivery,
const uint8_t * packet,
size_t length,
uint8_t * output,
size_t capacity,
size_t * out_length,
uint64_t * sequence )

Definition at line 155 of file browser/transport.c.

156 {
157 if (!browser || !browser->transport.crypto_ctx)
158 return SET_ERRNO(ERROR_INVALID_STATE, "Browser transport security is unavailable");
159 const size_t overhead = sizeof(packet_header_t) + 32 + CRYPTO_NONCE_SIZE + CRYPTO_MAC_SIZE;
160 if (!packet || !output || !out_length || !sequence || length > SIZE_MAX - overhead || capacity < length + (seal ? overhead : 0))
161 return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid browser security packet buffer");
162 *out_length = 0;
163 *sequence = 0;
164 uint8_t *result_packet = NULL;
165 size_t result_length = 0;
166 bool consumed = false;
167 const bool quiet = !seal && delivery == ACIP_DELIVERY_DATAGRAM;
169 if (quiet)
170 scope = errno_scope_begin();
171 const asciichat_error_t result = seal ? acip_security_seal(browser->transport.crypto_ctx, channel, delivery, packet, length, &result_packet, &result_length)
172 : acip_security_open(browser->transport.crypto_ctx, channel, delivery, packet, length, &result_packet, &result_length, sequence, &consumed);
173 if (quiet)
175 if (result == ASCIICHAT_OK && !consumed) {
176 memcpy(output, result_packet, result_length);
177 *out_length = result_length;
178 }
179 buffer_release(result_packet);
180 return result;
181}
void errno_scope_end(asciichat_errno_scope_t scope, asciichat_errno_outcome_t outcome)
asciichat_errno_scope_t errno_scope_begin(void)
@ ASCIICHAT_ERRNO_DISMISSED
asciichat_error_t acip_security_seal(crypto_context_t *crypto, acip_traffic_class_t flow, acip_delivery_t delivery, const void *packet, size_t length, uint8_t **output, size_t *written)
asciichat_error_t acip_security_open(crypto_context_t *crypto, acip_traffic_class_t flow, acip_delivery_t delivery, const void *packet, size_t length, uint8_t **output, size_t *written, uint64_t *sequence, bool *consumed)
#define CRYPTO_NONCE_SIZE
Nonce size (XSalsa20).
Definition sizes.h:83
#define CRYPTO_MAC_SIZE
MAC size (Poly1305).
Definition sizes.h:89
When code needs to work with asciichat errno snapshot, it keeps total, copied here instead of scatter...
Fixed prefix shared by every ACIP packet on the wire.
Definition packet.h:641
@ ACIP_DELIVERY_DATAGRAM
Definition traffic.h:17

References ACIP_DELIVERY_DATAGRAM, acip_security_open(), acip_security_seal(), ASCIICHAT_ERRNO_DISMISSED, ASCIICHAT_OK, buffer_release, acip_transport::crypto_ctx, CRYPTO_MAC_SIZE, CRYPTO_NONCE_SIZE, errno_scope_begin(), errno_scope_end(), ERROR_INVALID_PARAM, ERROR_INVALID_STATE, SET_ERRNO, and browser_transport::transport.

Referenced by browser_session_security_packet(), and ClientSessionBinding::process().

◆ browser_transport_security_tick()

asciichat_error_t browser_transport_security_tick ( browser_transport_t * browser)

Definition at line 183 of file browser/transport.c.

183 {
184 if (!browser || !browser->transport.crypto_ctx)
185 return SET_ERRNO(ERROR_INVALID_STATE, "Browser transport security is unavailable");
186 crypto_session_t *session = NULL;
187 asciichat_error_t result = crypto_session_lock(browser->transport.crypto_ctx, &session);
188 if (result == ASCIICHAT_OK) {
189 result = crypto_session_tick(session, time_get_ns());
190 crypto_session_unlock(session);
191 }
192 return result;
193}
asciichat_error_t crypto_session_tick(crypto_session_t *session, uint64_t now)

References ASCIICHAT_OK, acip_transport::crypto_ctx, crypto_session_lock(), crypto_session_tick(), crypto_session_unlock(), ERROR_INVALID_STATE, SET_ERRNO, and browser_transport::transport.

Referenced by browser_session_security_tick(), and ClientSessionBinding::process().

◆ browser_transport_set_capabilities()

void browser_transport_set_capabilities ( browser_transport_t * browser,
bool datagrams,
size_t max_datagram_payload )

Apply browser-negotiated delivery capabilities to the shared ACIP transport.

Definition at line 118 of file browser/transport.c.

118 {
119 if (!browser)
120 return;
121 browser->datagrams = datagrams && max_datagram_payload != 0;
122 browser->max_datagram_payload = browser->datagrams ? max_datagram_payload : 0;
123}

References browser_transport::datagrams, and browser_transport::max_datagram_payload.

Referenced by ClientSessionBinding::process().

◆ browser_transport_set_client_state()

void browser_transport_set_client_state ( browser_transport_t * browser,
void * state )

Definition at line 263 of file browser/transport.c.

263 {
264 if (browser)
265 browser->client_state = state;
266}

References browser_transport::client_state.

Referenced by browser_client_cleanup(), and browser_client_init().

◆ browser_transport_set_connected()

void browser_transport_set_connected ( browser_transport_t * browser,
bool connected )

Convenience for browser event bridges that only have an open/closed signal.

Definition at line 109 of file browser/transport.c.

109 {
111}
void browser_transport_set_state(browser_transport_t *browser, browser_transport_state_t state)

References BROWSER_TRANSPORT_CONNECTED, BROWSER_TRANSPORT_DISCONNECTED, and browser_transport_set_state().

Referenced by browser_session_set_connected().

◆ browser_transport_set_state()

void browser_transport_set_state ( browser_transport_t * browser,
browser_transport_state_t state )

◆ browser_transport_state()

◆ browser_transport_writable()

bool browser_transport_writable ( const browser_transport_t * browser,
size_t additional_bytes )