3 #include <server/defs.qh>
4 #include <server/miscfunctions.qh>
5 #include "autocvars.qh"
6 #include "command/banning.qh"
8 #include "../common/constants.qh"
9 #include "../common/util.qh"
12 * Protocol of online ban list:
15 * GET g_ban_sync_uri?action=ban&hostname=...&ip=xxx.xxx.xxx&duration=nnnn&reason=...................
16 * (IP 1, 2, 3, or 4 octets, 3 octets for example is a /24 mask)
18 * GET g_ban_sync_uri?action=unban&hostname=...&ip=xxx.xxx.xxx
19 * - Querying the ban list
20 * GET g_ban_sync_uri?action=list&hostname=...&servers=xxx.xxx.xxx.xxx;xxx.xxx.xxx.xxx;...
22 * shows the bans from the listed servers, and possibly others.
23 * Format of a ban is ASCII plain text, four lines per ban, delimited by
24 * newline ONLY (no carriage return):
26 * IP address (also 1, 2, 3, or 4 octets, delimited by dot)
27 * time left in seconds
29 * server IP that registered the ban
32 #define MAX_IPBAN_URIS (URI_GET_IPBAN_END - URI_GET_IPBAN + 1)
34 float Ban_Insert(string ip, float bantime, string reason, float dosync);
36 void OnlineBanList_SendBan(string ip, float bantime, string reason)
41 uri = strcat( "action=ban&hostname=", uri_escape(autocvar_hostname));
42 uri = strcat(uri, "&ip=", uri_escape(ip));
43 uri = strcat(uri, "&duration=", ftos(bantime));
44 uri = strcat(uri, "&reason=", uri_escape(reason));
46 n = tokenize_console(autocvar_g_ban_sync_uri);
47 if(n >= MAX_IPBAN_URIS)
49 for(i = 0; i < n; ++i)
51 if(strstrofs(argv(i), "?", 0) >= 0)
52 uri_get(strcat(argv(i), "&", uri), URI_GET_DISCARD); // 0 = "discard" callback target
54 uri_get(strcat(argv(i), "?", uri), URI_GET_DISCARD); // 0 = "discard" callback target
58 void OnlineBanList_SendUnban(string ip)
63 uri = strcat( "action=unban&hostname=", uri_escape(autocvar_hostname));
64 uri = strcat(uri, "&ip=", uri_escape(ip));
66 n = tokenize_console(autocvar_g_ban_sync_uri);
67 if(n >= MAX_IPBAN_URIS)
69 for(i = 0; i < n; ++i)
71 if(strstrofs(argv(i), "?", 0) >= 0)
72 uri_get(strcat(argv(i), "&", uri), URI_GET_DISCARD); // 0 = "discard" callback target
74 uri_get(strcat(argv(i), "?", uri), URI_GET_DISCARD); // 0 = "discard" callback target
78 string OnlineBanList_Servers;
79 float OnlineBanList_Timeout;
80 float OnlineBanList_RequestWaiting[MAX_IPBAN_URIS];
82 void OnlineBanList_URI_Get_Callback(float id, float status, string data)
94 if(id >= MAX_IPBAN_URIS)
96 LOG_INFO("Received ban list for invalid ID\n");
100 tokenize_console(autocvar_g_ban_sync_uri);
103 LOG_INFO("Received ban list from ", uri, ": ");
105 if(OnlineBanList_RequestWaiting[id] == 0)
107 LOG_INFO("rejected (unexpected)\n");
111 OnlineBanList_RequestWaiting[id] = 0;
113 if(time > OnlineBanList_Timeout)
115 LOG_INFO("rejected (too late)\n");
119 syncinterval = autocvar_g_ban_sync_interval;
120 if(syncinterval == 0)
122 LOG_INFO("rejected (syncing disabled)\n");
130 LOG_INFO("error: status is ", ftos(status), "\n");
134 if(substring(data, 0, 1) == "<")
136 LOG_INFO("error: received HTML instead of a ban list\n");
140 if(strstrofs(data, "\r", 0) != -1)
142 LOG_INFO("error: received carriage returns\n");
149 n = tokenizebyseparator(data, "\n");
153 LOG_INFO("error: received invalid item count: ", ftos(n), "\n");
157 LOG_INFO("OK, ", ftos(n / 4), " items\n");
159 for(i = 0; i < n; i += 4)
162 timeleft = stof(argv(i + 1));
163 reason = argv(i + 2);
164 serverip = argv(i + 3);
166 LOG_TRACE("received ban list item ", ftos(i / 4), ": ip=", ip);
167 LOG_TRACE(" timeleft=", ftos(timeleft), " reason=", reason);
168 LOG_TRACE(" serverip=", serverip);
170 timeleft -= 1.5 * autocvar_g_ban_sync_timeout;
175 if(l != 44) // length 44 is a cryptographic ID
177 for(j = 0; j < l; ++j)
178 if(strstrofs("0123456789.", substring(ip, j, 1), 0) == -1)
180 LOG_INFO("Invalid character ", substring(ip, j, 1), " in IP address ", ip, ". Skipping this ban.\n");
185 if(autocvar_g_ban_sync_trusted_servers_verify)
186 if((strstrofs(strcat(";", OnlineBanList_Servers, ";"), strcat(";", serverip, ";"), 0) == -1))
190 timeleft = min(syncinterval + (OnlineBanList_Timeout - time) + 5, timeleft);
191 // the ban will be prolonged on the next sync
192 // or expire 5 seconds after the next timeout
193 Ban_Insert(ip, timeleft, strcat("ban synced from ", serverip, " at ", uri), 0);
194 LOG_INFO("Ban list syncing: accepted ban of ", ip, " by ", serverip, " at ", uri, ": ");
195 LOG_INFO(reason, "\n");
201 void OnlineBanList_Think(entity this)
207 if(autocvar_g_ban_sync_uri == "")
209 if(autocvar_g_ban_sync_interval == 0) // < 0 is okay, it means "sync on level start only"
211 argc = tokenize_console(autocvar_g_ban_sync_trusted_servers);
215 if(OnlineBanList_Servers)
216 strunzone(OnlineBanList_Servers);
217 OnlineBanList_Servers = argv(0);
218 for(i = 1; i < argc; ++i)
219 OnlineBanList_Servers = strcat(OnlineBanList_Servers, ";", argv(i));
220 OnlineBanList_Servers = strzone(OnlineBanList_Servers);
222 uri = strcat( "action=list&hostname=", uri_escape(autocvar_hostname));
223 uri = strcat(uri, "&servers=", uri_escape(OnlineBanList_Servers));
225 OnlineBanList_Timeout = time + autocvar_g_ban_sync_timeout;
227 n = tokenize_console(autocvar_g_ban_sync_uri);
228 if(n >= MAX_IPBAN_URIS)
230 for(i = 0; i < n; ++i)
232 if(OnlineBanList_RequestWaiting[i])
234 OnlineBanList_RequestWaiting[i] = 1;
235 if(strstrofs(argv(i), "?", 0) >= 0)
236 uri_get(strcat(argv(i), "&", uri), URI_GET_IPBAN + i); // 1000 = "banlist" callback target
238 uri_get(strcat(argv(i), "?", uri), URI_GET_IPBAN + i); // 1000 = "banlist" callback target
241 if(autocvar_g_ban_sync_interval > 0)
242 this.nextthink = time + max(60, autocvar_g_ban_sync_interval * 60);
251 const float BAN_MAX = 256;
253 string ban_ip[BAN_MAX];
254 float ban_expire[BAN_MAX];
273 for(i = 0; i < ban_count; ++i)
275 if(time > ban_expire[i])
277 out = strcat(out, " ", ban_ip[i]);
278 out = strcat(out, " ", ftos(ban_expire[i] - time));
280 if(strlen(out) <= 1) // no real entries
281 cvar_set("g_banned_list", "");
283 cvar_set("g_banned_list", out);
286 float Ban_Delete(float i)
292 if(ban_expire[i] == 0)
294 if(ban_expire[i] > 0)
296 OnlineBanList_SendUnban(ban_ip[i]);
297 strunzone(ban_ip[i]);
308 for(i = 0; i < ban_count; ++i)
312 n = tokenize_console(autocvar_g_banned_list);
313 if(stof(argv(0)) == 1)
315 ban_count = (n - 1) / 2;
316 for(i = 0; i < ban_count; ++i)
318 ban_ip[i] = strzone(argv(2*i+1));
319 ban_expire[i] = time + stof(argv(2*i+2));
323 entity e = new(bansyncer);
324 setthink(e, OnlineBanList_Think);
325 e.nextthink = time + 1;
333 LOG_INFO("^2Listing all existing active bans:\n");
336 for(i = 0; i < ban_count; ++i)
338 if(time > ban_expire[i])
341 ++n; // total number of existing bans
343 msg = strcat("#", ftos(i), ": ");
344 msg = strcat(msg, ban_ip[i], " is still banned for ");
345 msg = strcat(msg, ftos(ban_expire[i] - time), " seconds");
347 LOG_INFO(" ", msg, "\n");
350 LOG_INFO("^2Done listing all active (", ftos(n), ") bans.\n");
353 float Ban_GetClientIP(entity client)
355 // we can't use tokenizing here, as this is called during ban list parsing
356 float i1, i2, i3, i4;
359 if(client.crypto_idfp_signed)
360 ban_idfp = client.crypto_idfp;
362 ban_idfp = string_null;
364 s = client.netaddress;
366 i1 = strstrofs(s, ".", 0);
369 i2 = strstrofs(s, ".", i1 + 1);
372 i3 = strstrofs(s, ".", i2 + 1);
375 i4 = strstrofs(s, ".", i3 + 1);
377 s = substring(s, 0, i4);
379 ban_ip1 = substring(s, 0, i1); // 8
380 ban_ip2 = substring(s, 0, i2); // 16
381 ban_ip3 = substring(s, 0, i3); // 24
382 ban_ip4 = strcat1(s); // 32
386 i1 = strstrofs(s, ":", 0);
389 i1 = strstrofs(s, ":", i1 + 1);
392 i2 = strstrofs(s, ":", i1 + 1);
395 i3 = strstrofs(s, ":", i2 + 1);
399 ban_ip1 = strcat(substring(s, 0, i1), "::/32"); // 32
400 ban_ip2 = strcat(substring(s, 0, i2), "::/48"); // 48
401 ban_ip4 = strcat(substring(s, 0, i3), "::/64"); // 64
403 if(i3 - i2 > 3) // means there is more than 2 digits and a : in the range
404 ban_ip3 = strcat(substring(s, 0, i2), ":", substring(s, i2 + 1, i3 - i2 - 3), "00::/56");
406 ban_ip3 = strcat(substring(s, 0, i2), ":0::/56");
411 float Ban_IsClientBanned(entity client, float idx)
413 float i, b, e, ipbanned;
416 if(!Ban_GetClientIP(client))
429 for(i = b; i < e; ++i)
432 if(time > ban_expire[i])
435 if(ban_ip1 == s) ipbanned = true;
436 if(ban_ip2 == s) ipbanned = true;
437 if(ban_ip3 == s) ipbanned = true;
438 if(ban_ip4 == s) ipbanned = true;
439 if(ban_idfp == s) return true;
443 if(!autocvar_g_banned_list_idmode)
451 bool Ban_MaybeEnforceBan(entity client)
453 if (Ban_IsClientBanned(client, -1))
455 string s = sprintf("^1NOTE:^7 banned client %s just tried to enter\n", client.netaddress);
464 bool Ban_MaybeEnforceBanOnce(entity client)
466 if (client.ban_checked) return false;
467 client.ban_checked = true;
468 return Ban_MaybeEnforceBan(client);
471 string Ban_Enforce(float j, string reason)
475 // Enforce our new ban
477 FOREACH_CLIENTSLOT(IS_REAL_CLIENT(it),
479 if(Ban_IsClientBanned(it, j))
484 reason = strcat(reason, ": affects ");
486 reason = strcat(reason, ", ");
487 reason = strcat(reason, it.netname);
489 s = strcat(s, "^1NOTE:^7 banned client ", it.netaddress, "^7 has to go\n");
498 float Ban_Insert(string ip, float bantime, string reason, float dosync)
505 for(i = 0; i < ban_count; ++i)
509 if(time + bantime > ban_expire[i])
511 ban_expire[i] = time + bantime;
512 LOG_TRACE(ip, "'s ban has been prolonged to ", ftos(bantime), " seconds from now");
515 LOG_TRACE(ip, "'s ban is still active until ", ftos(ban_expire[i] - time), " seconds from now");
518 reason = Ban_Enforce(i, reason);
523 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
524 OnlineBanList_SendBan(ip, bantime, reason);
529 // do we have a free slot?
530 for(i = 0; i < ban_count; ++i)
531 if(time > ban_expire[i])
533 // no free slot? Then look for the one who would get unbanned next
537 bestscore = ban_expire[i];
538 for(j = 1; j < ban_count; ++j)
540 if(ban_expire[j] < bestscore)
543 bestscore = ban_expire[i];
547 // if we replace someone, will we be banned longer than him (so long-term
548 // bans never get overridden by short-term bans)
550 if(ban_expire[i] > time + bantime)
552 LOG_INFO(ip, " could not get banned due to no free ban slot\n");
555 // okay, insert our new victim as i
557 LOG_TRACE(ip, " has been banned for ", ftos(bantime), " seconds");
558 ban_expire[i] = time + bantime;
559 ban_ip[i] = strzone(ip);
560 ban_count = max(ban_count, i + 1);
564 reason = Ban_Enforce(i, reason);
569 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
570 OnlineBanList_SendBan(ip, bantime, reason);
575 void Ban_KickBanClient(entity client, float bantime, float masksize, string reason)
578 if(!Ban_GetClientIP(client))
580 sprint(client, strcat("Kickbanned: ", reason, "\n"));
589 ip = strcat1(ban_ip1);
592 ip = strcat1(ban_ip2);
595 ip = strcat1(ban_ip3);
599 ip = strcat1(ban_ip4);
603 id = strcat1(ban_idfp);
607 Ban_Insert(ip, bantime, reason, 1);
609 Ban_Insert(id, bantime, reason, 1);
611 * not needed, as we enforce the ban in Ban_Insert anyway
613 sprint(client, strcat("Kickbanned: ", reason, "\n"));