ipban.qh File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
float	Ban_Delete (float i)
float	Ban_Insert (string ip, float bantime, string reason, float dosync)
void	Ban_KickBanClient (entity client, float bantime, float masksize, string reason)
void	Ban_LoadBans ()
float	Ban_MaybeEnforceBan (entity client)
float	Ban_MaybeEnforceBanOnce (entity client)
void	Ban_SaveBans ()
void	Ban_View ()
float	BanCommand (string command)
void	OnlineBanList_URI_Get_Callback (float id, float status, string data)

Function Documentation

Ban_Delete()

float Ban_Delete

(

float

i

)

Definition at line 286 of file ipban.qc.

References ban_count, ban_expire, ban_ip, Ban_SaveBans(), OnlineBanList_SendUnban(), and strunzone().

Referenced by Ban_Insert(), Ban_LoadBans(), and BanCommand_unban().

{
    if(i < 0)
        return false;
    if(i >= ban_count)
        return false;
    if(ban_expire[i] == 0)
        return false;
    if(ban_expire[i] > 0)
    {
        OnlineBanList_SendUnban(ban_ip[i]);
        strunzone(ban_ip[i]);
    }
    ban_expire[i] = 0;
    ban_ip[i] = "";
    Ban_SaveBans();
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_Insert()

float Ban_Insert	(	string	ip,
		float	bantime,
		string	reason,
		float	dosync
	)

Definition at line 505 of file ipban.qc.

References ban_count, Ban_Delete(), Ban_Enforce(), ban_expire, ban_ip, BAN_MAX, Ban_SaveBans(), ftos(), LOG_INFO, LOG_TRACE, max(), OnlineBanList_SendBan(), strzone(), substring(), and time.

Referenced by Ban_KickBanClient(), BanCommand_ban(), and OnlineBanList_URI_Get_Callback().

{
    float i;
    float j;
    float bestscore;

    // already banned?
    for(i = 0; i < ban_count; ++i)
        if(ban_ip[i] == ip)
        {
            // prolong the ban
            if(time + bantime > ban_expire[i])
            {
                ban_expire[i] = time + bantime;
                LOG_TRACE(ip, "'s ban has been prolonged to ", ftos(bantime), " seconds from now");
            }
            else
                LOG_TRACE(ip, "'s ban is still active until ", ftos(ban_expire[i] - time), " seconds from now");

            // and enforce
            reason = Ban_Enforce(i, reason);

            // and abort
            if(dosync)
                if(reason != "")
                    if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
                        OnlineBanList_SendBan(ip, bantime, reason);

            return false;
        }

    // do we have a free slot?
    for(i = 0; i < ban_count; ++i)
        if(time > ban_expire[i])
            break;
    // no free slot? Then look for the one who would get unbanned next
    if(i >= BAN_MAX)
    {
        i = 0;
        bestscore = ban_expire[i];
        for(j = 1; j < ban_count; ++j)
        {
            if(ban_expire[j] < bestscore)
            {
                i = j;
                bestscore = ban_expire[i];
            }
        }
    }
    // if we replace someone, will we be banned longer than him (so long-term
    // bans never get overridden by short-term bans)
    if(i < ban_count)
    if(ban_expire[i] > time + bantime)
    {
        LOG_INFO(ip, " could not get banned due to no free ban slot");
        return false;
    }
    // okay, insert our new victim as i
    Ban_Delete(i);
    LOG_TRACE(ip, " has been banned for ", ftos(bantime), " seconds");
    ban_expire[i] = time + bantime;
    ban_ip[i] = strzone(ip);
    ban_count = max(ban_count, i + 1);

    Ban_SaveBans();

    reason = Ban_Enforce(i, reason);

    // and abort
    if(dosync)
        if(reason != "")
            if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
                OnlineBanList_SendBan(ip, bantime, reason);

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_KickBanClient()

void Ban_KickBanClient	(	entity	client,
		float	bantime,
		float	masksize,
		string	reason
	)

Definition at line 582 of file ipban.qc.

References Ban_GetClientIP(), ban_idfp, Ban_Insert(), ban_ip1, ban_ip2, ban_ip3, ban_ip4, sprint(), strcat(), and string_null.

Referenced by BanCommand_kickban().

{
    string ip, id;
    if(!Ban_GetClientIP(client))
    {
        sprint(client, strcat("Kickbanned: ", reason, "\n"));
        dropclient(client);
        return;
    }

    // who to ban?
    switch(masksize)
    {
        case 1:
            ip = strcat1(ban_ip1);
            break;
        case 2:
            ip = strcat1(ban_ip2);
            break;
        case 3:
            ip = strcat1(ban_ip3);
            break;
        case 4:
        default:
            ip = strcat1(ban_ip4);
            break;
    }
    if(ban_idfp)
        id = strcat1(ban_idfp);
    else
        id = string_null;

    Ban_Insert(ip, bantime, reason, 1);
    if(id)
        Ban_Insert(id, bantime, reason, 1);
    /*
     * not needed, as we enforce the ban in Ban_Insert anyway
    // and kick him
    sprint(client, strcat("Kickbanned: ", reason, "\n"));
    dropclient(client);
     */
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_LoadBans()

void Ban_LoadBans

(

)

Definition at line 305 of file ipban.qc.

References argv(), autocvar_g_banned_list, ban_count, Ban_Delete(), ban_expire, ban_ip, ban_loaded, entity(), OnlineBanList_Think(), setthink, stof(), strzone(), time, and tokenize_console.

Referenced by Ban_IsClientBanned(), and spawnfunc().

{
    float i, n;
    for(i = 0; i < ban_count; ++i)
        Ban_Delete(i);
    ban_count = 0;
    ban_loaded = true;
    n = tokenize_console(autocvar_g_banned_list);
    if(stof(argv(0)) == 1)
    {
        ban_count = (n - 1) / 2;
        for(i = 0; i < ban_count; ++i)
        {
            ban_ip[i] = strzone(argv(2*i+1));
            ban_expire[i] = time + stof(argv(2*i+2));
        }
    }

    entity e = new(bansyncer);
    setthink(e, OnlineBanList_Think);
    e.nextthink = time + 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_MaybeEnforceBan()

float Ban_MaybeEnforceBan

(

entity

client

)

Definition at line 451 of file ipban.qc.

References autocvar_g_ban_telluser, Ban_IsClientBanned(), LOG_INFOF, and sprint().

Referenced by Ban_MaybeEnforceBanOnce().

{
    if (Ban_IsClientBanned(client, -1))
    {
        if (!client.crypto_idfp)
            LOG_INFOF("^1NOTE:^7 banned client %s just tried to enter\n",
                client.netaddress);
        else
            LOG_INFOF("^1NOTE:^7 banned client %s (%s) just tried to enter\n",
                client.netaddress, client.crypto_idfp);

        if(autocvar_g_ban_telluser)
            sprint(client, "You are banned from this server.\n");
        dropclient(client);
        return true;
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_MaybeEnforceBanOnce()

float Ban_MaybeEnforceBanOnce

(

entity

client

)

Definition at line 471 of file ipban.qc.

References Ban_MaybeEnforceBan().

Referenced by ClientConnect(), and SV_ParseClientCommand().

{
    if (client.ban_checked) return false;
    client.ban_checked = true;
    return Ban_MaybeEnforceBan(client);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_SaveBans()

void Ban_SaveBans

(

)

Definition at line 263 of file ipban.qc.

References ban_count, ban_expire, ban_ip, ban_loaded, cvar_set(), ftos(), strcat(), strlen(), and time.

Referenced by Ban_Delete(), Ban_Insert(), and Shutdown().

{
    string out;
    float i;

    if(!ban_loaded)
        return;

    // version of list
    out = "1";
    for(i = 0; i < ban_count; ++i)
    {
        if(time > ban_expire[i])
            continue;
        out = strcat(out, " ", ban_ip[i]);
        out = strcat(out, " ", ftos(ban_expire[i] - time));
    }
    if(strlen(out) <= 1) // no real entries
        cvar_set("g_banned_list", "");
    else
        cvar_set("g_banned_list", out);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Ban_View()

void Ban_View

(

)

Definition at line 328 of file ipban.qc.

References ban_count, ban_expire, ban_ip, ftos(), LOG_INFO, strcat(), and time.

Referenced by BanCommand_banlist().

{
    float i, n;
    string msg;

    LOG_INFO("^2Listing all existing active bans:");

    n = 0;
    for(i = 0; i < ban_count; ++i)
    {
        if(time > ban_expire[i])
            continue;

        ++n; // total number of existing bans

        msg = strcat("#", ftos(i), ": ");
        msg = strcat(msg, ban_ip[i], " is still banned for ");
        msg = strcat(msg, ftos(ban_expire[i] - time), " seconds");

        LOG_INFO("  ", msg);
    }

    LOG_INFO("^2Done listing all active (", ftos(n), ") bans.");
}

Here is the call graph for this function:

Here is the caller graph for this function:

BanCommand()

float BanCommand

(

string

command

)

Definition at line 316 of file banning.qc.

References BanCommand_macro_command(), and tokenize_console.

Referenced by GameCommand().

{
    int argc = tokenize_console(command);

    // Guide for working with argc arguments by example:
    // argc:   1    - 2      - 3     - 4
    // argv:   0    - 1      - 2     - 3
    // cmd     vote - master - login - password

    if (BanCommand_macro_command(argc, command)) // continue as usual and scan for normal commands
        return true;                             // handled by one of the above GenericCommand_* functions

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

OnlineBanList_URI_Get_Callback()

void OnlineBanList_URI_Get_Callback	(	float	id,
		float	status,
		string	data
	)

Definition at line 79 of file ipban.qc.

References argv(), autocvar_g_ban_sync_interval, autocvar_g_ban_sync_timeout, autocvar_g_ban_sync_trusted_servers_verify, autocvar_g_ban_sync_uri, Ban_Insert(), ftos(), LABEL, LOG_INFO, LOG_TRACE, MAX_IPBAN_URIS, min(), OnlineBanList_RequestWaiting, OnlineBanList_Servers, OnlineBanList_Timeout, stof(), strcat(), strlen(), strstrofs, substring(), time, tokenize_console, tokenizebyseparator, and URI_GET_IPBAN.

Referenced by URI_Get_Callback().

{
    float n, i, j, l;
    string ip;
    float timeleft;
    string reason;
    string serverip;
    float syncinterval;
    string uri;

    id -= URI_GET_IPBAN;

    if(id >= MAX_IPBAN_URIS)
    {
        LOG_INFO("Received ban list for invalid ID");
        return;
    }

    tokenize_console(autocvar_g_ban_sync_uri);
    uri = argv(id);

    string prelude = strcat("Received ban list from ", uri, ": ");

    if(OnlineBanList_RequestWaiting[id] == 0)
    {
        LOG_INFO(prelude, "rejected (unexpected)");
        return;
    }

    OnlineBanList_RequestWaiting[id] = 0;

    if(time > OnlineBanList_Timeout)
    {
        LOG_INFO(prelude, "rejected (too late)");
        return;
    }

    syncinterval = autocvar_g_ban_sync_interval;
    if(syncinterval == 0)
    {
        LOG_INFO(prelude, "rejected (syncing disabled)");
        return;
    }
    if(syncinterval > 0)
        syncinterval *= 60;

    if(status != 0)
    {
        LOG_INFO(prelude, "error: status is ", ftos(status));
        return;
    }

    if(substring(data, 0, 1) == "<")
    {
        LOG_INFO(prelude, "error: received HTML instead of a ban list");
        return;
    }

    if(strstrofs(data, "\r", 0) != -1)
    {
        LOG_INFO(prelude, "error: received carriage returns");
        return;
    }

    if(data == "")
        n = 0;
    else
        n = tokenizebyseparator(data, "\n");

    if((n % 4) != 0)
    {
        LOG_INFO(prelude, "error: received invalid item count: ", ftos(n));
        return;
    }

    LOG_INFO(prelude, "OK, ", ftos(n / 4), " items");

    for(i = 0; i < n; i += 4)
    {
        ip = argv(i);
        timeleft = stof(argv(i + 1));
        reason = argv(i + 2);
        serverip = argv(i + 3);

        LOG_TRACE("received ban list item ", ftos(i / 4), ": ip=", ip);
        LOG_TRACE(" timeleft=", ftos(timeleft), " reason=", reason);
        LOG_TRACE(" serverip=", serverip);

        timeleft -= 1.5 * autocvar_g_ban_sync_timeout;
        if(timeleft < 0)
            continue;

        l = strlen(ip);
        if(l != 44) // length 44 is a cryptographic ID
        {
            for(j = 0; j < l; ++j)
                if(strstrofs("0123456789.", substring(ip, j, 1), 0) == -1)
                {
                    LOG_INFO("Invalid character ", substring(ip, j, 1), " in IP address ", ip, ". Skipping this ban.");
                    goto skip;
                }
        }

        if(autocvar_g_ban_sync_trusted_servers_verify)
            if((strstrofs(strcat(";", OnlineBanList_Servers, ";"), strcat(";", serverip, ";"), 0) == -1))
                continue;

        if(syncinterval > 0)
            timeleft = min(syncinterval + (OnlineBanList_Timeout - time) + 5, timeleft);
            // the ban will be prolonged on the next sync
            // or expire 5 seconds after the next timeout
        Ban_Insert(ip, timeleft, strcat("ban synced from ", serverip, " at ", uri), 0);
        LOG_INFO("Ban list syncing: accepted ban of ", ip, " by ", serverip, " at ", uri, ": ", reason);

LABEL(skip)
    }
}

Here is the call graph for this function:

Here is the caller graph for this function: