pissnet/pissircd
1
0
Fork 0
mirror of https://github.com/pissnet/pissircd.git synced 2025-08-11 12:41:37 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

JSON-RPC over Websocket: don't close websocket connections after ~30s,

Browse source 
keep them open, but do a websocket ping/pong to check if the
connection is alive.
This is usually handled by browsers themselves, but if you are using
websockets from a non-browser then you may have to PONG back on
a PING, see https://www.rfc-editor.org/rfc/rfc6455#section-5.5.2
(note that PING-PONG is a requirement there)
This commit is contained in:
Bram Matthys 2023-01-04 13:50:57 +01:00
parent b33628b765
commit ccbd320338
No known key found for this signature in database
GPG key ID: BF8116B163EAAE98
2 changed files with 44 additions and 1 deletions

35
src/modules/rpc/rpc.c
View file

@ -22,6 +22,7 @@ int rpc_config_run_ex_listen(ConfigFile *cf, ConfigEntry *ce, int type, void *pt
int rpc_config_test_rpc_user(ConfigFile *cf, ConfigEntry *ce, int type, int *errs);
int rpc_config_run_rpc_user(ConfigFile *cf, ConfigEntry *ce, int type);
int rpc_client_accept(Client *client);
int rpc_pre_local_handshake_timeout(Client *client, const char **comment);
void rpc_client_handshake_unix_socket(Client *client);
void rpc_client_handshake_web(Client *client);
int rpc_handle_webrequest(Client *client, WebRequest *web);
@ -90,6 +91,7 @@ MOD_INIT()
HookAdd(modinfo->handle, HOOKTYPE_CONFIGRUN_EX, 0, rpc_config_run_ex_listen);
HookAdd(modinfo->handle, HOOKTYPE_CONFIGRUN, 0, rpc_config_run_rpc_user);
HookAdd(modinfo->handle, HOOKTYPE_HANDSHAKE, -5000, rpc_client_accept);
HookAdd(modinfo->handle, HOOKTYPE_PRE_LOCAL_HANDSHAKE_TIMEOUT, 0, rpc_pre_local_handshake_timeout);
HookAdd(modinfo->handle, HOOKTYPE_RAWPACKET_IN, INT_MIN, rpc_packet_in_unix_socket);
memset(&r, 0, sizeof(r));
@ -638,6 +640,39 @@ void rpc_client_handshake_web(Client *client)
fd_setselect(client->local->fd, FD_SELECT_READ, read_packet, client);
}
#define RPC_WEBSOCKET_PING_TIME 120
int rpc_pre_local_handshake_timeout(Client *client, const char **comment)
{
/* Don't hang up websocket connections */
if (IsRPC(client) && WSU(client) && WSU(client)->handshake_completed)
{
long t = TStime() - client->local->last_msg_received;
if ((t > RPC_WEBSOCKET_PING_TIME*2) && IsPingSent(client))
{
*comment = "No websocket PONG received in time.";
return HOOK_CONTINUE;
} else
if ((t > RPC_WEBSOCKET_PING_TIME) && !IsPingSent(client) && !IsDead(client))
{
char pingbuf[4];
const char *pkt = pingbuf;
int pktlen = sizeof(pingbuf);
pingbuf[0] = 0x11;
pingbuf[1] = 0x22;
pingbuf[2] = 0x33;
pingbuf[3] = 0x44;
websocket_create_packet_simple(WSOP_PING, &pkt, &pktlen);
dbuf_put(&client->local->sendQ, pkt, pktlen);
send_queued(client);
SetPingSent(client);
}
return HOOK_ALLOW; /* prevent closing the connection due to timeout */
}
return HOOK_CONTINUE;
}
RPCUser *find_rpc_user(const char *username)
{
RPCUser *r;

10
src/modules/websocket_common.c
View file

@ -287,7 +287,15 @@ int websocket_handle_packet_ping(Client *client, const char *buf, int len)
int websocket_handle_packet_pong(Client *client, const char *buf, int len)
{
/* We don't care */
/* We only care about pongs for RPC websocket connections.
* Also, we don't verify the content, actually,
* so don't use this for security like a pingpong cookie.
*/
if (IsRPC(client))
{
client->local->last_msg_received = TStime();
ClearPingSent(client);
}
return 0;
}