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");
100 tokenize_console(autocvar_g_ban_sync_uri);
103 string prelude = strcat("Received ban list from ", uri, ": ");
105 if(OnlineBanList_RequestWaiting[id] == 0)
107 LOG_INFO(prelude, "rejected (unexpected)");
111 OnlineBanList_RequestWaiting[id] = 0;
113 if(time > OnlineBanList_Timeout)
115 LOG_INFO(prelude, "rejected (too late)");
119 syncinterval = autocvar_g_ban_sync_interval;
120 if(syncinterval == 0)
122 LOG_INFO(prelude, "rejected (syncing disabled)");
130 LOG_INFO(prelude, "error: status is ", ftos(status));
134 if(substring(data, 0, 1) == "<")
136 LOG_INFO(prelude, "error: received HTML instead of a ban list");
140 if(strstrofs(data, "\r", 0) != -1)
142 LOG_INFO(prelude, "error: received carriage returns");
149 n = tokenizebyseparator(data, "\n");
153 LOG_INFO(prelude, "error: received invalid item count: ", ftos(n));
157 LOG_INFO(prelude, "OK, ", ftos(n / 4), " items");
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.");
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, ": ", reason);
200 void OnlineBanList_Think(entity this)
206 if(autocvar_g_ban_sync_uri == "")
208 if(autocvar_g_ban_sync_interval == 0) // < 0 is okay, it means "sync on level start only"
210 argc = tokenize_console(autocvar_g_ban_sync_trusted_servers);
214 if(OnlineBanList_Servers)
215 strunzone(OnlineBanList_Servers);
216 OnlineBanList_Servers = argv(0);
217 for(i = 1; i < argc; ++i)
218 OnlineBanList_Servers = strcat(OnlineBanList_Servers, ";", argv(i));
219 OnlineBanList_Servers = strzone(OnlineBanList_Servers);
221 uri = strcat( "action=list&hostname=", uri_escape(autocvar_hostname));
222 uri = strcat(uri, "&servers=", uri_escape(OnlineBanList_Servers));
224 OnlineBanList_Timeout = time + autocvar_g_ban_sync_timeout;
226 n = tokenize_console(autocvar_g_ban_sync_uri);
227 if(n >= MAX_IPBAN_URIS)
229 for(i = 0; i < n; ++i)
231 if(OnlineBanList_RequestWaiting[i])
233 OnlineBanList_RequestWaiting[i] = 1;
234 if(strstrofs(argv(i), "?", 0) >= 0)
235 uri_get(strcat(argv(i), "&", uri), URI_GET_IPBAN + i); // 1000 = "banlist" callback target
237 uri_get(strcat(argv(i), "?", uri), URI_GET_IPBAN + i); // 1000 = "banlist" callback target
240 if(autocvar_g_ban_sync_interval > 0)
241 this.nextthink = time + max(60, autocvar_g_ban_sync_interval * 60);
250 const float BAN_MAX = 256;
252 string ban_ip[BAN_MAX];
253 float ban_expire[BAN_MAX];
272 for(i = 0; i < ban_count; ++i)
274 if(time > ban_expire[i])
276 out = strcat(out, " ", ban_ip[i]);
277 out = strcat(out, " ", ftos(ban_expire[i] - time));
279 if(strlen(out) <= 1) // no real entries
280 cvar_set("g_banned_list", "");
282 cvar_set("g_banned_list", out);
285 float Ban_Delete(float i)
291 if(ban_expire[i] == 0)
293 if(ban_expire[i] > 0)
295 OnlineBanList_SendUnban(ban_ip[i]);
296 strunzone(ban_ip[i]);
307 for(i = 0; i < ban_count; ++i)
311 n = tokenize_console(autocvar_g_banned_list);
312 if(stof(argv(0)) == 1)
314 ban_count = (n - 1) / 2;
315 for(i = 0; i < ban_count; ++i)
317 ban_ip[i] = strzone(argv(2*i+1));
318 ban_expire[i] = time + stof(argv(2*i+2));
322 entity e = new(bansyncer);
323 setthink(e, OnlineBanList_Think);
324 e.nextthink = time + 1;
332 LOG_INFO("^2Listing all existing active bans:");
335 for(i = 0; i < ban_count; ++i)
337 if(time > ban_expire[i])
340 ++n; // total number of existing bans
342 msg = strcat("#", ftos(i), ": ");
343 msg = strcat(msg, ban_ip[i], " is still banned for ");
344 msg = strcat(msg, ftos(ban_expire[i] - time), " seconds");
349 LOG_INFO("^2Done listing all active (", ftos(n), ") bans.");
352 float Ban_GetClientIP(entity client)
354 // we can't use tokenizing here, as this is called during ban list parsing
355 float i1, i2, i3, i4;
358 if(client.crypto_idfp_signed)
359 ban_idfp = client.crypto_idfp;
361 ban_idfp = string_null;
363 s = client.netaddress;
365 i1 = strstrofs(s, ".", 0);
368 i2 = strstrofs(s, ".", i1 + 1);
371 i3 = strstrofs(s, ".", i2 + 1);
374 i4 = strstrofs(s, ".", i3 + 1);
376 s = substring(s, 0, i4);
378 ban_ip1 = substring(s, 0, i1); // 8
379 ban_ip2 = substring(s, 0, i2); // 16
380 ban_ip3 = substring(s, 0, i3); // 24
381 ban_ip4 = strcat1(s); // 32
385 i1 = strstrofs(s, ":", 0);
388 i1 = strstrofs(s, ":", i1 + 1);
391 i2 = strstrofs(s, ":", i1 + 1);
394 i3 = strstrofs(s, ":", i2 + 1);
398 ban_ip1 = strcat(substring(s, 0, i1), "::/32"); // 32
399 ban_ip2 = strcat(substring(s, 0, i2), "::/48"); // 48
400 ban_ip4 = strcat(substring(s, 0, i3), "::/64"); // 64
402 if(i3 - i2 > 3) // means there is more than 2 digits and a : in the range
403 ban_ip3 = strcat(substring(s, 0, i2), ":", substring(s, i2 + 1, i3 - i2 - 3), "00::/56");
405 ban_ip3 = strcat(substring(s, 0, i2), ":0::/56");
410 float Ban_IsClientBanned(entity client, float idx)
412 float i, b, e, ipbanned;
415 if(!Ban_GetClientIP(client))
428 for(i = b; i < e; ++i)
431 if(time > ban_expire[i])
434 if(ban_ip1 == s) ipbanned = true;
435 if(ban_ip2 == s) ipbanned = true;
436 if(ban_ip3 == s) ipbanned = true;
437 if(ban_ip4 == s) ipbanned = true;
438 if(ban_idfp == s) return true;
442 if(!autocvar_g_banned_list_idmode)
450 bool Ban_MaybeEnforceBan(entity client)
452 if (Ban_IsClientBanned(client, -1))
454 string s = sprintf("^1NOTE:^7 banned client %s just tried to enter\n", client.netaddress);
463 bool Ban_MaybeEnforceBanOnce(entity client)
465 if (client.ban_checked) return false;
466 client.ban_checked = true;
467 return Ban_MaybeEnforceBan(client);
470 string Ban_Enforce(float j, string reason)
474 // Enforce our new ban
476 FOREACH_CLIENTSLOT(IS_REAL_CLIENT(it),
478 if(Ban_IsClientBanned(it, j))
483 reason = strcat(reason, ": affects ");
485 reason = strcat(reason, ", ");
486 reason = strcat(reason, it.netname);
488 s = strcat(s, "^1NOTE:^7 banned client ", it.netaddress, "^7 has to go\n");
497 float Ban_Insert(string ip, float bantime, string reason, float dosync)
504 for(i = 0; i < ban_count; ++i)
508 if(time + bantime > ban_expire[i])
510 ban_expire[i] = time + bantime;
511 LOG_TRACE(ip, "'s ban has been prolonged to ", ftos(bantime), " seconds from now");
514 LOG_TRACE(ip, "'s ban is still active until ", ftos(ban_expire[i] - time), " seconds from now");
517 reason = Ban_Enforce(i, reason);
522 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
523 OnlineBanList_SendBan(ip, bantime, reason);
528 // do we have a free slot?
529 for(i = 0; i < ban_count; ++i)
530 if(time > ban_expire[i])
532 // no free slot? Then look for the one who would get unbanned next
536 bestscore = ban_expire[i];
537 for(j = 1; j < ban_count; ++j)
539 if(ban_expire[j] < bestscore)
542 bestscore = ban_expire[i];
546 // if we replace someone, will we be banned longer than him (so long-term
547 // bans never get overridden by short-term bans)
549 if(ban_expire[i] > time + bantime)
551 LOG_INFO(ip, " could not get banned due to no free ban slot");
554 // okay, insert our new victim as i
556 LOG_TRACE(ip, " has been banned for ", ftos(bantime), " seconds");
557 ban_expire[i] = time + bantime;
558 ban_ip[i] = strzone(ip);
559 ban_count = max(ban_count, i + 1);
563 reason = Ban_Enforce(i, reason);
568 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
569 OnlineBanList_SendBan(ip, bantime, reason);
574 void Ban_KickBanClient(entity client, float bantime, float masksize, string reason)
577 if(!Ban_GetClientIP(client))
579 sprint(client, strcat("Kickbanned: ", reason, "\n"));
588 ip = strcat1(ban_ip1);
591 ip = strcat1(ban_ip2);
594 ip = strcat1(ban_ip3);
598 ip = strcat1(ban_ip4);
602 id = strcat1(ban_idfp);
606 Ban_Insert(ip, bantime, reason, 1);
608 Ban_Insert(id, bantime, reason, 1);
610 * not needed, as we enforce the ban in Ban_Insert anyway
612 sprint(client, strcat("Kickbanned: ", reason, "\n"));