netban.h

Go to the documentation of this file.

#ifndef ENGINE_SHARED_NETBAN_H
#define ENGINE_SHARED_NETBAN_H
 
#include <base/mem.h>
#include <base/net.h>
#include <base/str.h>
#include <base/time.h>
 
#include <engine/console.h>
 
inline int NetComp(const NETADDR *pAddr1, const NETADDR *pAddr2)
{
    return mem_comp(pAddr1, pAddr2, pAddr1->type == NETTYPE_IPV4 ? 8 : 20);
}
 
class CNetRange
{
public:
    NETADDR m_LB;
    NETADDR m_UB;
 
    bool IsValid() const { return m_LB.type == m_UB.type && NetComp(&m_LB, &m_UB) < 0; }
};
 
inline int NetComp(const CNetRange *pRange1, const CNetRange *pRange2)
{
    return NetComp(&pRange1->m_LB, &pRange2->m_LB) || NetComp(&pRange1->m_UB, &pRange2->m_UB);
}
 
class CNetBan
{
protected:
    bool NetMatch(const NETADDR *pAddr1, const NETADDR *pAddr2) const
    {
        return NetComp(pAddr1, pAddr2) == 0;
    }
 
    bool NetMatch(const CNetRange *pRange, const NETADDR *pAddr, int Start, int Length) const
    {
        return pRange->m_LB.type == pAddr->type && (Start == 0 || mem_comp(&pRange->m_LB.ip[0], &pAddr->ip[0], Start) == 0) &&
               mem_comp(&pRange->m_LB.ip[Start], &pAddr->ip[Start], Length - Start) <= 0 && mem_comp(&pRange->m_UB.ip[Start], &pAddr->ip[Start], Length - Start) >= 0;
    }
 
    bool NetMatch(const CNetRange *pRange, const NETADDR *pAddr) const
    {
        return NetMatch(pRange, pAddr, 0, pRange->m_LB.type == NETTYPE_IPV4 ? 4 : 16);
    }
 
    const char *NetToString(const NETADDR *pData, char *pBuffer, unsigned BufferSize) const
    {
        char aAddrStr[NETADDR_MAXSTRSIZE];
        net_addr_str(pData, aAddrStr, sizeof(aAddrStr), false);
        str_format(pBuffer, BufferSize, "<{'%s'}>", aAddrStr);
        return pBuffer;
    }
 
    const char *NetToString(const CNetRange *pData, char *pBuffer, unsigned BufferSize) const
    {
        char aAddrStr1[NETADDR_MAXSTRSIZE], aAddrStr2[NETADDR_MAXSTRSIZE];
        net_addr_str(&pData->m_LB, aAddrStr1, sizeof(aAddrStr1), false);
        net_addr_str(&pData->m_UB, aAddrStr2, sizeof(aAddrStr2), false);
        str_format(pBuffer, BufferSize, "<{'%s' - '%s'}>", aAddrStr1, aAddrStr2);
        return pBuffer;
    }
 
    class CNetHash
    {
    public:
        int m_Hash;
        int m_HashIndex; // matching parts for ranges, 0 for addr
 
        CNetHash() = default;
        CNetHash(const NETADDR *pAddr);
        CNetHash(const CNetRange *pRange);
 
        static int MakeHashArray(const NETADDR *pAddr, CNetHash aHash[17]);
    };
 
    struct CBanInfo
    {
        enum
        {
            EXPIRES_NEVER = -1,
            REASON_LENGTH = 128,
        };
        int64_t m_Expires;
        char m_aReason[REASON_LENGTH];
        bool m_VerbatimReason;
    };
 
    template<class T>
    struct CBan
    {
        T m_Data;
        CBanInfo m_Info;
        CNetHash m_NetHash;
 
        // hash list
        CBan *m_pHashNext;
        CBan *m_pHashPrev;
 
        // used or free list
        CBan *m_pNext;
        CBan *m_pPrev;
    };
 
    template<class T, int HashCount>
    class CBanPool
    {
    public:
        typedef T CDataType;
 
        CBan<CDataType> *Add(const CDataType *pData, const CBanInfo *pInfo, const CNetHash *pNetHash);
        int Remove(CBan<CDataType> *pBan);
        void Update(CBan<CDataType> *pBan, const CBanInfo *pInfo);
        void Reset();
 
        int Num() const { return m_CountUsed; }
        bool IsFull() const { return m_CountUsed == MAX_BANS; }
 
        CBan<CDataType> *First() const { return m_pFirstUsed; }
        CBan<CDataType> *First(const CNetHash *pNetHash) const { return m_aapHashList[pNetHash->m_HashIndex][pNetHash->m_Hash]; }
        CBan<CDataType> *Find(const CDataType *pData, const CNetHash *pNetHash) const
        {
            for(CBan<CDataType> *pBan = m_aapHashList[pNetHash->m_HashIndex][pNetHash->m_Hash]; pBan; pBan = pBan->m_pHashNext)
            {
                if(NetComp(&pBan->m_Data, pData) == 0)
                    return pBan;
            }
 
            return nullptr;
        }
        CBan<CDataType> *Get(int Index) const;
 
    private:
        enum
        {
            MAX_BANS = 2048,
        };
 
        CBan<CDataType> *m_aapHashList[HashCount][256];
        CBan<CDataType> m_aBans[MAX_BANS];
        CBan<CDataType> *m_pFirstFree;
        CBan<CDataType> *m_pFirstUsed;
        int m_CountUsed;
 
        void InsertUsed(CBan<CDataType> *pBan);
    };
 
    typedef CBanPool<NETADDR, 1> CBanAddrPool;
    typedef CBanPool<CNetRange, 16> CBanRangePool;
    typedef CBan<NETADDR> CBanAddr;
    typedef CBan<CNetRange> CBanRange;
 
    template<class T>
    void MakeBanInfo(const CBan<T> *pBan, char *pBuf, unsigned BuffSize, int Type) const;
    template<class T>
    int Ban(T *pBanPool, const typename T::CDataType *pData, int Seconds, const char *pReason, bool VerbatimReason);
    template<class T>
    int Unban(T *pBanPool, const typename T::CDataType *pData);
 
    class IConsole *m_pConsole;
    class IStorage *m_pStorage;
    CBanAddrPool m_BanAddrPool;
    CBanRangePool m_BanRangePool;
    NETADDR m_LocalhostIpV4, m_LocalhostIpV6;
 
public:
    enum
    {
        MSGTYPE_PLAYER = 0,
        MSGTYPE_LIST,
        MSGTYPE_BANADD,
        MSGTYPE_BANREM,
    };
 
    class IConsole *Console() const { return m_pConsole; }
    class IStorage *Storage() const { return m_pStorage; }
 
    virtual ~CNetBan() = default;
    void Init(class IConsole *pConsole, class IStorage *pStorage);
    void Update();
 
    virtual int BanAddr(const NETADDR *pAddr, int Seconds, const char *pReason, bool VerbatimReason);
    virtual int BanRange(const CNetRange *pRange, int Seconds, const char *pReason);
    int UnbanByAddr(const NETADDR *pAddr);
    int UnbanByRange(const CNetRange *pRange);
    int UnbanByIndex(int Index);
    void UnbanAll();
    bool IsBanned(const NETADDR *pOrigAddr, char *pBuf, unsigned BufferSize) const;
 
    static void ConBan(class IConsole::IResult *pResult, void *pUser);
    static void ConBanRange(class IConsole::IResult *pResult, void *pUser);
    static void ConUnban(class IConsole::IResult *pResult, void *pUser);
    static void ConUnbanRange(class IConsole::IResult *pResult, void *pUser);
    static void ConUnbanAll(class IConsole::IResult *pResult, void *pUser);
    static void ConBans(class IConsole::IResult *pResult, void *pUser);
    static void ConBansFind(class IConsole::IResult *pResult, void *pUser);
    static void ConBansSave(class IConsole::IResult *pResult, void *pUser);
};
 
template<class T>
void CNetBan::MakeBanInfo(const CBan<T> *pBan, char *pBuf, unsigned BuffSize, int Type) const
{
    if(pBan == nullptr || pBuf == nullptr)
    {
        if(BuffSize > 0)
            pBuf[0] = 0;
        return;
    }
 
    // build type based part
    char aBuf[256];
    if(Type == MSGTYPE_PLAYER)
        str_copy(aBuf, "You have been banned");
    else
    {
        char aTemp[256];
        switch(Type)
        {
        case MSGTYPE_LIST:
            str_format(aBuf, sizeof(aBuf), "%s banned", NetToString(&pBan->m_Data, aTemp, sizeof(aTemp)));
            break;
        case MSGTYPE_BANADD:
            str_format(aBuf, sizeof(aBuf), "banned %s", NetToString(&pBan->m_Data, aTemp, sizeof(aTemp)));
            break;
        case MSGTYPE_BANREM:
            str_format(aBuf, sizeof(aBuf), "unbanned %s", NetToString(&pBan->m_Data, aTemp, sizeof(aTemp)));
            break;
        default:
            aBuf[0] = 0;
        }
    }
 
    // add info part
    if(!pBan->m_Info.m_VerbatimReason && pBan->m_Info.m_Expires != CBanInfo::EXPIRES_NEVER)
    {
        int Mins = ((pBan->m_Info.m_Expires - time_timestamp()) + 59) / 60;
        if(Mins <= 1)
            str_format(pBuf, BuffSize, "%s for 1 minute (%s)", aBuf, pBan->m_Info.m_aReason);
        else
            str_format(pBuf, BuffSize, "%s for %d minutes (%s)", aBuf, Mins, pBan->m_Info.m_aReason);
    }
    else
        str_format(pBuf, BuffSize, "%s (%s)", aBuf, pBan->m_Info.m_aReason);
}
 
#endif