2 * Protocol of online ban list:
5 * GET g_ban_sync_uri?action=ban&hostname=...&ip=xxx.xxx.xxx&duration=nnnn&reason=...................
6 * (IP 1, 2, 3, or 4 octets, 3 octets for example is a /24 mask)
8 * GET g_ban_sync_uri?action=unban&hostname=...&ip=xxx.xxx.xxx
9 * - Querying the ban list
10 * GET g_ban_sync_uri?action=list&hostname=...&servers=xxx.xxx.xxx.xxx;xxx.xxx.xxx.xxx;...
12 * shows the bans from the listed servers, and possibly others.
13 * Format of a ban is ASCII plain text, four lines per ban, delimited by
14 * newline ONLY (no carriage return):
16 * IP address (also 1, 2, 3, or 4 octets, delimited by dot)
17 * time left in seconds
19 * server IP that registered the ban
22 float Ban_Insert(string ip, float bantime, string reason, float dosync);
24 void OnlineBanList_SendBan(string ip, float bantime, string reason)
29 uri = strcat( "?action=ban&hostname=", uri_escape(cvar_string("hostname")));
30 uri = strcat(uri, "&ip=", uri_escape(ip));
31 uri = strcat(uri, "&duration=", ftos(bantime));
32 uri = strcat(uri, "&reason=", uri_escape(reason));
34 n = tokenize_console(cvar_string("g_ban_sync_uri"));
35 if(n >= MAX_IPBAN_URIS)
37 for(i = 0; i < n; ++i)
38 uri_get(strcat(argv(i), uri), URI_GET_DISCARD); // 0 = "discard" callback target
41 void OnlineBanList_SendUnban(string ip)
46 uri = strcat( "?action=unban&hostname=", uri_escape(cvar_string("hostname")));
47 uri = strcat(uri, "&ip=", uri_escape(ip));
49 n = tokenize_console(cvar_string("g_ban_sync_uri"));
50 if(n >= MAX_IPBAN_URIS)
52 for(i = 0; i < n; ++i)
53 uri_get(strcat(argv(i), uri), URI_GET_DISCARD); // 0 = "discard" callback target
56 string OnlineBanList_Servers;
57 float OnlineBanList_Timeout;
58 float OnlineBanList_RequestWaiting[MAX_IPBAN_URIS];
60 void OnlineBanList_URI_Get_Callback(float id, float status, string data)
72 if(id >= MAX_IPBAN_URIS)
74 print("Received ban list for invalid ID\n");
78 tokenize_console(cvar_string("g_ban_sync_uri"));
81 print("Received ban list from ", uri, ": ");
83 if(OnlineBanList_RequestWaiting[id] == 0)
85 print("rejected (unexpected)\n");
89 OnlineBanList_RequestWaiting[id] = 0;
91 if(time > OnlineBanList_Timeout)
93 print("rejected (too late)\n");
97 syncinterval = cvar("g_ban_sync_interval");
100 print("rejected (syncing disabled)\n");
108 print("error: status is ", ftos(status), "\n");
112 if(substring(data, 0, 1) == "<")
114 print("error: received HTML instead of a ban list: ");
118 if(strstrofs(data, "\r", 0) != -1)
120 print("error: received carriage returns: ");
127 n = tokenizebyseparator(data, "\n");
131 print("error: received invalid item count: ", ftos(n), "\n");
135 print("OK, ", ftos(n / 4), " items\n");
137 for(i = 0; i < n; i += 4)
140 timeleft = stof(argv(i + 1));
141 reason = argv(i + 2);
142 serverip = argv(i + 3);
144 dprint("received ban list item ", ftos(i / 4), ": ip=", ip);
145 dprint(" timeleft=", ftos(timeleft), " reason=", reason);
146 dprint(" serverip=", serverip, "\n");
148 timeleft -= 1.5 * cvar("g_ban_sync_timeout");
153 for(j = 0; j < l; ++j)
154 if(strstrofs("0123456789.", substring(ip, j, 1), 0) == -1)
156 print("Invalid character ", substring(ip, j, 1), " in IP address ", ip, ". Skipping this ban.\n");
160 if(cvar("g_ban_sync_trusted_servers_verify"))
161 if((strstrofs(strcat(";", OnlineBanList_Servers, ";"), strcat(";", serverip, ";"), 0) == -1))
165 timeleft = min(syncinterval + (OnlineBanList_Timeout - time) + 5, timeleft);
166 // the ban will be prolonged on the next sync
167 // or expire 5 seconds after the next timeout
168 Ban_Insert(ip, timeleft, strcat("ban synced from ", serverip, " at ", uri), 0);
169 print("Ban list syncing: accepted ban of ", ip, " by ", serverip, " at ", uri, ": ");
176 void OnlineBanList_Think()
182 if(cvar_string("g_ban_sync_uri") == "")
184 if(cvar("g_ban_sync_interval") == 0) // < 0 is okay, it means "sync on level start only"
186 argc = tokenize_console(cvar_string("g_ban_sync_trusted_servers"));
190 if(OnlineBanList_Servers)
191 strunzone(OnlineBanList_Servers);
192 OnlineBanList_Servers = argv(0);
193 for(i = 1; i < argc; ++i)
194 OnlineBanList_Servers = strcat(OnlineBanList_Servers, ";", argv(i));
195 OnlineBanList_Servers = strzone(OnlineBanList_Servers);
197 uri = strcat( "?action=list&hostname=", uri_escape(cvar_string("hostname")));
198 uri = strcat(uri, "&servers=", uri_escape(OnlineBanList_Servers));
200 OnlineBanList_Timeout = time + cvar("g_ban_sync_timeout");
202 n = tokenize_console(cvar_string("g_ban_sync_uri"));
203 if(n >= MAX_IPBAN_URIS)
205 for(i = 0; i < n; ++i)
207 if(OnlineBanList_RequestWaiting[i])
209 OnlineBanList_RequestWaiting[i] = 1;
210 uri_get(strcat(argv(i), uri), URI_GET_IPBAN + i); // 1000 = "banlist" callback target
213 if(cvar("g_ban_sync_interval") > 0)
214 self.nextthink = time + max(60, cvar("g_ban_sync_interval") * 60);
225 string ban_ip[BAN_MAX];
226 float ban_expire[BAN_MAX];
244 for(i = 0; i < ban_count; ++i)
246 if(time > ban_expire[i])
248 out = strcat(out, " ", ban_ip[i]);
249 out = strcat(out, " ", ftos(ban_expire[i] - time));
251 if(strlen(out) <= 1) // no real entries
252 cvar_set("g_banned_list", "");
254 cvar_set("g_banned_list", out);
257 float Ban_Delete(float i)
263 if(ban_expire[i] == 0)
265 if(ban_expire[i] > 0)
267 OnlineBanList_SendUnban(ban_ip[i]);
268 strunzone(ban_ip[i]);
279 for(i = 0; i < ban_count; ++i)
283 n = tokenize_console(cvar_string("g_banned_list"));
284 if(stof(argv(0)) == 1)
286 ban_count = (n - 1) / 2;
287 for(i = 0; i < ban_count; ++i)
289 ban_ip[i] = strzone(argv(2*i+1));
290 ban_expire[i] = time + stof(argv(2*i+2));
296 e.classname = "bansyncer";
297 e.think = OnlineBanList_Think;
298 e.nextthink = time + 1;
305 for(i = 0; i < ban_count; ++i)
307 if(time > ban_expire[i])
309 msg = strcat("#", ftos(i), ": ");
310 msg = strcat(msg, ban_ip[i], " is still banned for ");
311 msg = strcat(msg, ftos(ban_expire[i] - time), " seconds");
316 float Ban_GetClientIP(entity client)
318 // we can't use tokenizing here, as this is called during ban list parsing
319 float i1, i2, i3, i4;
322 s = client.netaddress;
324 i1 = strstrofs(s, ".", 0);
327 i2 = strstrofs(s, ".", i1 + 1);
330 i3 = strstrofs(s, ".", i2 + 1);
333 i4 = strstrofs(s, ".", i3 + 1);
337 ban_ip1 = substring(s, 0, i1);
338 ban_ip2 = substring(s, 0, i2);
339 ban_ip3 = substring(s, 0, i3);
340 ban_ip4 = strcat1(s);
345 float Ban_IsClientBanned(entity client, float idx)
350 if(!Ban_GetClientIP(client))
362 for(i = b; i < e; ++i)
365 if(time > ban_expire[i])
368 if(ban_ip1 == s) return TRUE;
369 if(ban_ip2 == s) return TRUE;
370 if(ban_ip3 == s) return TRUE;
371 if(ban_ip4 == s) return TRUE;
376 float Ban_MaybeEnforceBan(entity client)
378 if(Ban_IsClientBanned(client, -1))
381 s = strcat("^1NOTE:^7 banned client ", client.netaddress, " just tried to enter\n");
389 string Ban_Enforce(float i, string reason)
394 // Enforce our new ban
396 FOR_EACH_REALCLIENT(e)
397 if(Ban_IsClientBanned(e, i))
402 reason = strcat(reason, ": affects ");
404 reason = strcat(reason, ", ");
405 reason = strcat(reason, e.netname);
407 s = strcat(s, "^1NOTE:^7 banned client ", e.netname, "^7 has to go\n");
415 float Ban_Insert(string ip, float bantime, string reason, float dosync)
422 for(i = 0; i < ban_count; ++i)
426 if(time + bantime > ban_expire[i])
428 ban_expire[i] = time + bantime;
429 dprint(ip, "'s ban has been prolonged to ", ftos(bantime), " seconds from now\n");
432 dprint(ip, "'s ban is still active until ", ftos(ban_expire[i] - time), " seconds from now\n");
435 reason = Ban_Enforce(i, reason);
440 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
441 OnlineBanList_SendBan(ip, bantime, reason);
446 // do we have a free slot?
447 for(i = 0; i < ban_count; ++i)
448 if(time > ban_expire[i])
450 // no free slot? Then look for the one who would get unbanned next
454 bestscore = ban_expire[i];
455 for(j = 1; j < ban_count; ++j)
457 if(ban_expire[j] < bestscore)
460 bestscore = ban_expire[i];
464 // if we replace someone, will we be banned longer than him (so long-term
465 // bans never get overridden by short-term bans)
467 if(ban_expire[i] > time + bantime)
469 print(ip, " could not get banned due to no free ban slot\n");
472 // okay, insert our new victim as i
474 dprint(ip, " has been banned for ", ftos(bantime), " seconds\n");
475 ban_expire[i] = time + bantime;
476 ban_ip[i] = strzone(ip);
477 ban_count = max(ban_count, i + 1);
481 reason = Ban_Enforce(i, reason);
486 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
487 OnlineBanList_SendBan(ip, bantime, reason);
492 void Ban_KickBanClient(entity client, float bantime, float masksize, string reason)
494 if(!Ban_GetClientIP(client))
496 sprint(client, strcat("Kickbanned: ", reason, "\n"));
504 Ban_Insert(ban_ip1, bantime, reason, 1);
507 Ban_Insert(ban_ip2, bantime, reason, 1);
510 Ban_Insert(ban_ip3, bantime, reason, 1);
513 Ban_Insert(ban_ip4, bantime, reason, 1);
517 * not needed, as we enforce the ban in Ban_Insert anyway
519 sprint(client, strcat("Kickbanned: ", reason, "\n"));
524 float GameCommand_Ban(string command)
534 argc = tokenize_console(command);
535 if(argv(0) == "help")
537 print(" kickban # n m p reason - kickban player n for m seconds, using mask size p (1 to 4)\n");
538 print(" ban ip m reason - ban an IP or range (incomplete IP, like 1.2.3) for m seconds\n");
539 print(" bans - list all existing bans\n");
540 print(" unban n - delete the entry #n from the bans list\n");
543 if(argv(0) == "kickban")
545 #define INITARG(c) reasonarg = c
546 #define GETARG(v,d) if((argc > reasonarg) && ((v = stof(argv(reasonarg))) != 0)) ++reasonarg; else v = d
547 #define RESTARG(v) if(argc > reasonarg) v = substring(command, argv_start_index(reasonarg), strlen(command) - argv_start_index(reasonarg)); else v = ""
550 entno = stof(argv(2));
551 if(entno > maxclients || entno < 1)
553 client = edict_num(entno);
556 GETARG(bantime, cvar("g_ban_default_bantime"));
557 GETARG(masksize, cvar("g_ban_default_masksize"));
560 Ban_KickBanClient(client, bantime, masksize, reason);
564 else if(argv(0) == "ban")
572 GETARG(bantime, cvar("g_ban_default_bantime"));
575 Ban_Insert(ip, bantime, reason, 1);
582 else if(argv(0) == "bans")
587 else if(argv(0) == "unban")