errors.c File Reference

Network error handling utilities implementation. More...

Go to the source code of this file.

Functions
bool	network_error_is_local_rejection (asciichat_error_t code)
network_error_action_t	network_error_action (asciichat_error_t code)
asciichat_error_t	network_error_public_code (asciichat_error_t code)
asciichat_error_t	network_error_from_acip (uint8_t code)
asciichat_error_t	network_error_decode (packet_type_t type, const void *payload, size_t size)
asciichat_error_t	send_error_packet (socket_t sockfd, asciichat_error_t error_code)
	Send an ACIP error packet using asciichat_error_t.
asciichat_error_t	send_error_packet_message (socket_t sockfd, asciichat_error_t error_code, const char *message)
	Send an ACIP error packet with a public message.
asciichat_error_t	check_and_record_rate_limit (rate_limiter_t *rate_limiter, const char *client_ip, rate_event_type_t event_type, bool *allowed)
	Check rate limit and record an allowed event.
asciichat_error_t	check_and_record_packet_rate_limit (rate_limiter_t *rate_limiter, const char *client_ip, packet_type_t packet_type, bool *allowed)
	Map packet type to rate event type and check rate limit.

Detailed Description

Network error handling utilities implementation.

Definition in file lib/network/errors.c.

Function Documentation

check_and_record_packet_rate_limit()

asciichat_error_t check_and_record_packet_rate_limit	(	rate_limiter_t *	rate_limiter,
		const char *	client_ip,
		packet_type_t	packet_type,
		bool *	allowed )

Map packet type to rate event type and check rate limit.

Maps packet_type_t to the corresponding rate_event_type_t and performs rate limiting check. The caller owns any error response and recovery scope.

Packet type to rate event mapping:

• IMAGE_FRAME -> RATE_EVENT_IMAGE_FRAME
• AUDIO, AUDIO_BATCH, AUDIO_OPUS, AUDIO_OPUS_BATCH -> RATE_EVENT_AUDIO
• PING, PONG -> RATE_EVENT_PING
• CLIENT_JOIN -> RATE_EVENT_CLIENT_JOIN
• CLIENT_CAPABILITIES, STREAM_START, STREAM_STOP, CLIENT_LEAVE -> RATE_EVENT_CONTROL
• All other packets -> No rate limiting (always allowed)

Parameters

rate_limiter	Rate limiter instance
client_ip	Client IP address
packet_type	Packet type being processed
allowed	Output quota decision; false on failure

Returns

ASCIICHAT_OK for a completed decision, typed failure otherwise

Definition at line 163 of file lib/network/errors.c.

                                                                                               {
  if (!allowed)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Missing rate-limit decision output");
  *allowed = false;
  // Map packet type to rate event type
  rate_event_type_t event_type;
 
  switch (packet_type) {
  case PACKET_TYPE_IMAGE_FRAME:
    event_type = RATE_EVENT_IMAGE_FRAME;
    break;
 
  case PACKET_TYPE_AUDIO_BATCH:
  case PACKET_TYPE_AUDIO_OPUS_BATCH:
    event_type = RATE_EVENT_AUDIO;
    break;
 
  case PACKET_TYPE_PING:
  case PACKET_TYPE_PONG:
    event_type = RATE_EVENT_PING;
    break;
 
  case PACKET_TYPE_CLIENT_JOIN:
    event_type = RATE_EVENT_CLIENT_JOIN;
    break;
 
  case PACKET_TYPE_CLIENT_CAPABILITIES:
  case PACKET_TYPE_STREAM_START:
  case PACKET_TYPE_STREAM_STOP:
  case PACKET_TYPE_CLIENT_LEAVE:
    event_type = RATE_EVENT_CONTROL;
    break;
 
  default:
    // No rate limiting for other packet types
    *allowed = true;
    return ASCIICHAT_OK;
  }
 
  // Use the existing check_and_record_rate_limit function
  return check_and_record_rate_limit(rate_limiter, client_ip, event_type, allowed);
}

References ASCIICHAT_OK, check_and_record_rate_limit(), ERROR_INVALID_PARAM, PACKET_TYPE_AUDIO_BATCH, PACKET_TYPE_AUDIO_OPUS_BATCH, PACKET_TYPE_CLIENT_CAPABILITIES, PACKET_TYPE_CLIENT_JOIN, PACKET_TYPE_CLIENT_LEAVE, PACKET_TYPE_IMAGE_FRAME, PACKET_TYPE_PING, PACKET_TYPE_PONG, PACKET_TYPE_STREAM_START, PACKET_TYPE_STREAM_STOP, RATE_EVENT_AUDIO, RATE_EVENT_CLIENT_JOIN, RATE_EVENT_CONTROL, RATE_EVENT_IMAGE_FRAME, RATE_EVENT_PING, and SET_ERRNO.

Referenced by process_decrypted_packet().

check_and_record_rate_limit()

asciichat_error_t check_and_record_rate_limit	(	rate_limiter_t *	rate_limiter,
		const char *	client_ip,
		rate_event_type_t	event_type,
		bool *	allowed )

Check rate limit and record an allowed event.

Helper function that checks rate limit and records the event if allowed. Encapsulates the common pattern:

1. Check rate limit
2. Return allowed=false if exceeded
3. Record event if allowed

Parameters

rate_limiter	Rate limiter instance
client_ip	Client IP address for logging
event_type	Type of event being rate limited
allowed	Output quota decision; false on failure

Returns

ASCIICHAT_OK for a completed decision, typed failure otherwise

Definition at line 145 of file lib/network/errors.c.

                                                                                           {
  if (!allowed)
    return SET_ERRNO(ERROR_INVALID_PARAM, "Missing rate-limit decision output");
  *allowed = false;
  asciichat_error_t result = rate_limiter_check(rate_limiter, client_ip, event_type, NULL, allowed);
  if (result != ASCIICHAT_OK) {
    *allowed = false;
    return result;
  }
  if (!*allowed)
    return ASCIICHAT_OK;
  result = rate_limiter_record(rate_limiter, client_ip, event_type);
  if (result != ASCIICHAT_OK)
    *allowed = false;
  return result;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, rate_limiter_check(), rate_limiter_record(), and SET_ERRNO.

Referenced by check_and_record_packet_rate_limit().

network_error_action()

network_error_action_t network_error_action

(

asciichat_error_t

code

)

Definition at line 15 of file lib/network/errors.c.

                                                                    {
  switch (code) {
  case ERROR_AUDIO:
    return NETWORK_ERROR_CONTINUE;
  case ERROR_SESSION_FULL:
  case ERROR_RATE_LIMITED:
  case ERROR_NETWORK:
  case ERROR_NETWORK_TIMEOUT:
  case ERROR_NETWORK_CONNECT:
    return NETWORK_ERROR_RETRY;
  default:
    return NETWORK_ERROR_STOP;
  }
}

References ERROR_AUDIO, ERROR_NETWORK, ERROR_NETWORK_CONNECT, ERROR_NETWORK_TIMEOUT, ERROR_RATE_LIMITED, ERROR_SESSION_FULL, NETWORK_ERROR_CONTINUE, NETWORK_ERROR_RETRY, and NETWORK_ERROR_STOP.

Referenced by EMSCRIPTEN_BINDINGS().

network_error_decode()

asciichat_error_t network_error_decode	(	packet_type_t	type,
		const void *	payload,
		size_t	size )

Decode either discovery or application error packets with bounded payload validation.

Definition at line 69 of file lib/network/errors.c.

                                                                                             {
  asciichat_error_t code;
  if (!payload)
    return SET_ERRNO(ERROR_NETWORK_PROTOCOL, "Missing remote error payload");
  if (type == PACKET_TYPE_ACIP_ERROR) {
    if (size != sizeof(acip_error_t))
      return SET_ERRNO(ERROR_NETWORK_PROTOCOL, "Invalid discovery error payload length");
    code = network_error_from_acip(((const acip_error_t *)payload)->error_code);
  } else if (type == PACKET_TYPE_ERROR_MESSAGE) {
    char message[MAX_ERROR_MESSAGE_LENGTH + 1];
    asciichat_error_t result = packet_parse_error_message(payload, size, &code, message, sizeof(message), NULL);
    if (result != ASCIICHAT_OK)
      return result;
    code = network_error_public_code(code);
    /* Preserve the server's sanitized diagnostic.  The previous code parsed
     * this message and then discarded it, making policy/protocol failures
     * indistinguishable from real authentication failures. */
    return SET_ERRNO(code, "Remote request rejected: %s", message[0] ? message : asciichat_error_string(code));
  } else {
    return SET_ERRNO(ERROR_NETWORK_PROTOCOL, "Unexpected rejection packet type");
  }
  return SET_ERRNO(code, "Remote request rejected: %s", asciichat_error_string(code));
}

References acip_error_t, ASCIICHAT_OK, ERROR_NETWORK_PROTOCOL, MAX_ERROR_MESSAGE_LENGTH, network_error_from_acip(), network_error_public_code(), packet_parse_error_message(), PACKET_TYPE_ACIP_ERROR, PACKET_TYPE_ERROR_MESSAGE, and SET_ERRNO.

Referenced by acds_protocol_receive().

network_error_from_acip()

asciichat_error_t network_error_from_acip

(

uint8_t

code

)

Definition at line 49 of file lib/network/errors.c.

                                                        {
  switch (code) {
  case ACIP_ERROR_SESSION_NOT_FOUND:
    return ERROR_SESSION_NOT_FOUND;
  case ACIP_ERROR_SESSION_FULL:
    return ERROR_SESSION_FULL;
  case ACIP_ERROR_INVALID_PASSWORD:
    return ERROR_INVALID_PASSWORD;
  case ACIP_ERROR_INVALID_SIGNATURE:
    return ERROR_INVALID_SIGNATURE;
  case ACIP_ERROR_RATE_LIMITED:
    return ERROR_RATE_LIMITED;
  case ACIP_ERROR_STRING_TAKEN:
    return ERROR_ACDS_STRING_TAKEN;
  case ACIP_ERROR_STRING_INVALID:
    return ERROR_ACDS_STRING_INVALID;
  default:
    return ERROR_INTERNAL;
  }
}

References ACIP_ERROR_INVALID_PASSWORD, ACIP_ERROR_INVALID_SIGNATURE, ACIP_ERROR_RATE_LIMITED, ACIP_ERROR_SESSION_FULL, ACIP_ERROR_SESSION_NOT_FOUND, ACIP_ERROR_STRING_INVALID, ACIP_ERROR_STRING_TAKEN, ERROR_ACDS_STRING_INVALID, ERROR_ACDS_STRING_TAKEN, ERROR_INTERNAL, ERROR_INVALID_PASSWORD, ERROR_INVALID_SIGNATURE, ERROR_RATE_LIMITED, ERROR_SESSION_FULL, and ERROR_SESSION_NOT_FOUND.

Referenced by acds_protocol_receive(), and network_error_decode().

network_error_is_local_rejection()

bool network_error_is_local_rejection

(

asciichat_error_t

code

)

True only for local packet construction failures that have not reached transport I/O.

Definition at line 11 of file lib/network/errors.c.

                                                              {
  return code == ERROR_INVALID_PARAM || code == ERROR_INVALID_FRAME || code == ERROR_NETWORK_SIZE ||
         code == ERROR_BUFFER_OVERFLOW || code == ERROR_BUFFER_FULL || code == ERROR_MEMORY;
}

References ERROR_BUFFER_FULL, ERROR_BUFFER_OVERFLOW, ERROR_INVALID_FRAME, ERROR_INVALID_PARAM, ERROR_MEMORY, and ERROR_NETWORK_SIZE.

Referenced by threaded_send_audio_batch_packet(), threaded_send_audio_opus(), threaded_send_audio_opus_batch(), threaded_send_image_frame(), threaded_send_image_frame_encoded(), and threaded_send_packet().

network_error_public_code()

asciichat_error_t network_error_public_code

(

asciichat_error_t

code

)

Allowlisted public application code; internal failures become ERROR_INTERNAL.

Definition at line 29 of file lib/network/errors.c.

                                                                    {
  switch (code) {
  case ERROR_AUDIO:
  case ERROR_SESSION_FULL:
  case ERROR_SESSION_NOT_FOUND:
  case ERROR_RATE_LIMITED:
  case ERROR_INVALID_PASSWORD:
  case ERROR_INVALID_SIGNATURE:
  case ERROR_CRYPTO_AUTH:
  case ERROR_CRYPTO_VERIFICATION:
  case ERROR_NETWORK_PROTOCOL:
  case ERROR_ACDS_STRING_TAKEN:
  case ERROR_ACDS_STRING_INVALID:
    return code;
  case ERROR_CRYPTO:
    return ERROR_CRYPTO_AUTH;
  default:
    return ERROR_INTERNAL;
  }
}

References ERROR_ACDS_STRING_INVALID, ERROR_ACDS_STRING_TAKEN, ERROR_AUDIO, ERROR_CRYPTO, ERROR_CRYPTO_AUTH, ERROR_CRYPTO_VERIFICATION, ERROR_INTERNAL, ERROR_INVALID_PASSWORD, ERROR_INVALID_SIGNATURE, ERROR_NETWORK_PROTOCOL, ERROR_RATE_LIMITED, ERROR_SESSION_FULL, and ERROR_SESSION_NOT_FOUND.

Referenced by acip_send_error(), network_error_decode(), packet_send_error(), and send_error_packet_message().

send_error_packet()

asciichat_error_t send_error_packet	(	socket_t	sockfd,
		asciichat_error_t	error_code )

Send an ACIP error packet using asciichat_error_t.

Converts an asciichat_error_t code to an ACIP error packet and sends it. Uses asciichat_error_string() for the error message.

Parameters

sockfd	Socket to send error on
error_code	Error code from asciichat_error_t enum

Returns

ASCIICHAT_OK on success, error code on failure

Definition at line 93 of file lib/network/errors.c.

                                                                                   {
  return send_error_packet_message(sockfd, error_code, asciichat_error_string(error_code));
}

References send_error_packet_message().

send_error_packet_message()

asciichat_error_t send_error_packet_message	(	socket_t	sockfd,
		asciichat_error_t	error_code,
		const char *	message )

Send an ACIP error packet with a public message.

Maps application codes to discovery wire codes and uses their fixed public text. The legacy message argument is ignored to avoid exposing internal diagnostics.

Parameters

sockfd	Socket to send error on
error_code	Error code from asciichat_error_t enum
message	Legacy argument, ignored

Returns

ASCIICHAT_OK on success, error code on failure

Definition at line 97 of file lib/network/errors.c.

                                                                                                                {
  if (sockfd == INVALID_SOCKET_VALUE) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid socket");
  }
 
  // Keep the legacy parameter for source compatibility; only allowlisted text goes on the wire.
  (void)message;
 
  // Construct ACIP error packet
  acip_error_t error = {0};
  switch (error_code) {
  case ERROR_SESSION_NOT_FOUND:
    error.error_code = ACIP_ERROR_SESSION_NOT_FOUND;
    break;
  case ERROR_SESSION_FULL:
    error.error_code = ACIP_ERROR_SESSION_FULL;
    break;
  case ERROR_INVALID_PASSWORD:
    error.error_code = ACIP_ERROR_INVALID_PASSWORD;
    break;
  case ERROR_INVALID_SIGNATURE:
    error.error_code = ACIP_ERROR_INVALID_SIGNATURE;
    break;
  case ERROR_RATE_LIMITED:
    error.error_code = ACIP_ERROR_RATE_LIMITED;
    break;
  case ERROR_ACDS_STRING_TAKEN:
    error.error_code = ACIP_ERROR_STRING_TAKEN;
    break;
  case ERROR_ACDS_STRING_INVALID:
    error.error_code = ACIP_ERROR_STRING_INVALID;
    break;
  default:
    error.error_code = ACIP_ERROR_INTERNAL;
    break;
  }
  SAFE_STRNCPY(error.error_message, asciichat_error_string(network_error_public_code(error_code)),
               sizeof(error.error_message));
 
  // Send error packet
  int result = send_packet(sockfd, PACKET_TYPE_ACIP_ERROR, &error, sizeof(error));
  if (result < 0) {
    return SET_ERRNO(ERROR_NETWORK, "Failed to send error packet");
  }
 
  return ASCIICHAT_OK;
}

References ACIP_ERROR_INTERNAL, ACIP_ERROR_INVALID_PASSWORD, ACIP_ERROR_INVALID_SIGNATURE, ACIP_ERROR_RATE_LIMITED, ACIP_ERROR_SESSION_FULL, ACIP_ERROR_SESSION_NOT_FOUND, ACIP_ERROR_STRING_INVALID, ACIP_ERROR_STRING_TAKEN, acip_error_t, ASCIICHAT_OK, ERROR_ACDS_STRING_INVALID, ERROR_ACDS_STRING_TAKEN, ERROR_INVALID_PARAM, ERROR_INVALID_PASSWORD, ERROR_INVALID_SIGNATURE, ERROR_NETWORK, ERROR_RATE_LIMITED, ERROR_SESSION_FULL, ERROR_SESSION_NOT_FOUND, network_error_public_code(), PACKET_TYPE_ACIP_ERROR, SAFE_STRNCPY, send_packet(), and SET_ERRNO.

Referenced by send_error_packet().