network.h

Go to the documentation of this file.

/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
/* If you are missing that file, acquire a complete release at teeworlds.com.                */
#ifndef ENGINE_SHARED_NETWORK_H
#define ENGINE_SHARED_NETWORK_H
 
#include "ringbuffer.h"
#include "stun.h"
 
#include <base/types.h>
 
#include <array>
#include <optional>
 
class CHuffman;
class CNetBan;
class CPacker;
 
/*
 
CURRENT:
    packet header: 3 bytes
        unsigned char flags_ack; // 6bit flags, 2bit ack
            0.6:   ORNCaaAA
            0.6.5: ORNCT-AA
            0.7:   --NORCAA
 
        O = flag compression
        R = flag resend
        N = flag connless
        C = flag control
        T = flag token (0.6.5 only not supported by ddnet)
        - = unused, should be zero
        a = should be zero otherwise it messes up the ack number
        A = bit of ack number
 
 
        unsigned char ack; // 8 bit ack
        unsigned char num_chunks; // 8 bit chunks
 
        (unsigned char padding[3])  // 24 bit extra in case it's a connection less packet
                                    // this is to make sure that it's compatible with the
                                    // old protocol
 
    chunk header: 2-3 bytes
        unsigned char flags_size; // 2bit flags, 6 bit size
        unsigned char size_seq; // 4bit size, 4bit seq
        (unsigned char seq;) // 8bit seq, if vital flag is set
*/
 
enum
{
    NETSENDFLAG_VITAL = 1,
    NETSENDFLAG_CONNLESS = 2,
    NETSENDFLAG_FLUSH = 4,
    NETSENDFLAG_EXTENDED = 8,
 
    NETSTATE_OFFLINE = 0,
    NETSTATE_CONNECTING,
    NETSTATE_ONLINE,
};
 
enum
{
    NET_MAX_PACKETSIZE = 1400,
    NET_MAX_PAYLOAD = NET_MAX_PACKETSIZE - 6,
    NET_MAX_CHUNKHEADERSIZE = 3,
    NET_PACKETHEADERSIZE = 3,
    NET_CONNLESS_EXTRA_SIZE = 4,
    NET_MAX_CLIENTS = 64,
    NET_MAX_CONSOLE_CLIENTS = 4,
    NET_MAX_SEQUENCE = 1 << 10,
    NET_MAX_PACKET_CHUNKS = 0xFF,
 
    NET_PACKETFLAG_UNUSED = 1 << 0,
    NET_PACKETFLAG_TOKEN = 1 << 1,
    NET_PACKETFLAG_CONTROL = 1 << 2,
    NET_PACKETFLAG_CONNLESS = 1 << 3,
    NET_PACKETFLAG_RESEND = 1 << 4,
    NET_PACKETFLAG_COMPRESSION = 1 << 5,
    // NOT SENT VIA THE NETWORK DIRECTLY:
    NET_PACKETFLAG_EXTENDED = 1 << 6,
 
    NET_CHUNKFLAG_VITAL = 1,
    NET_CHUNKFLAG_RESEND = 2,
 
    NET_CTRLMSG_KEEPALIVE = 0,
    NET_CTRLMSG_CONNECT = 1,
    NET_CTRLMSG_CONNECTACCEPT = 2,
    NET_CTRLMSG_ACCEPT = 3,
    NET_CTRLMSG_CLOSE = 4,
 
    NET_CONN_BUFFERSIZE = 1024 * 32,
 
    NET_CONNLIMIT_IPS = 16,
 
    NET_TOKENCACHE_ADDRESSEXPIRY = 64,
    NET_TOKENCACHE_PACKETEXPIRY = 5,
};
enum
{
    NET_TOKEN_MAX = 0xffffffff,
    NET_TOKEN_NONE = NET_TOKEN_MAX,
    NET_TOKEN_MASK = NET_TOKEN_MAX,
 
    NET_TOKENREQUEST_DATASIZE = 512,
};
 
typedef int SECURITY_TOKEN;
typedef unsigned int TOKEN;
 
SECURITY_TOKEN ToSecurityToken(const unsigned char *pData);
void WriteSecurityToken(unsigned char *pData, SECURITY_TOKEN Token);
 
extern const unsigned char SECURITY_TOKEN_MAGIC[4];
 
enum
{
    NET_SECURITY_TOKEN_UNKNOWN = -1,
    NET_SECURITY_TOKEN_UNSUPPORTED = 0,
};
 
typedef int (*NETFUNC_DELCLIENT)(int ClientId, const char *pReason, void *pUser);
typedef int (*NETFUNC_NEWCLIENT_CON)(int ClientId, void *pUser);
typedef int (*NETFUNC_NEWCLIENT)(int ClientId, void *pUser, bool Sixup);
typedef int (*NETFUNC_NEWCLIENT_NOAUTH)(int ClientId, void *pUser);
typedef int (*NETFUNC_CLIENTREJOIN)(int ClientId, void *pUser);
 
struct CNetChunk
{
    // -1 means that it's a stateless packet
    // 0 on the client means the server
    int m_ClientId;
    NETADDR m_Address; // only used when client_id == -1
    int m_Flags;
    int m_DataSize;
    const void *m_pData;
    // only used if the flags contain NETSENDFLAG_EXTENDED and NETSENDFLAG_CONNLESS
    unsigned char m_aExtraData[NET_CONNLESS_EXTRA_SIZE];
};
 
class CNetChunkHeader
{
public:
    int m_Flags;
    int m_Size;
    int m_Sequence;
 
    unsigned char *Pack(unsigned char *pData, int Split = 4) const;
    unsigned char *Unpack(unsigned char *pData, int Split = 4);
};
 
class CNetChunkResend
{
public:
    int m_Flags;
    int m_DataSize;
    unsigned char *m_pData;
 
    int m_Sequence;
    int64_t m_LastSendTime;
    int64_t m_FirstSendTime;
};
 
class CNetPacketConstruct
{
public:
    int m_Flags;
    int m_Ack;
    int m_NumChunks;
    int m_DataSize;
    unsigned char m_aChunkData[NET_MAX_PAYLOAD];
    unsigned char m_aExtraData[NET_CONNLESS_EXTRA_SIZE];
};
 
enum class CONNECTIVITY
{
    UNKNOWN,
    CHECKING,
    UNREACHABLE,
    REACHABLE,
    ADDRESS_KNOWN,
};
 
class CStun
{
    class CProtocol
    {
        int m_Index;
        NETSOCKET m_Socket;
        CStunData m_Stun;
        bool m_HaveStunServer = false;
        NETADDR m_StunServer;
        bool m_HaveAddr = false;
        NETADDR m_Addr;
        int64_t m_LastResponse = -1;
        int64_t m_NextTry = -1;
        int m_NumUnsuccessfulTries = -1;
 
    public:
        CProtocol(int Index, NETSOCKET Socket);
        void FeedStunServer(NETADDR StunServer);
        void Refresh();
        void Update();
        bool OnPacket(NETADDR Addr, unsigned char *pData, int DataSize);
        CONNECTIVITY GetConnectivity(NETADDR *pGlobalAddr);
    };
    CProtocol m_aProtocols[2];
 
public:
    CStun(NETSOCKET Socket);
    void FeedStunServer(NETADDR StunServer);
    void Refresh();
    void Update();
    bool OnPacket(NETADDR Addr, unsigned char *pData, int DataSize);
    CONNECTIVITY GetConnectivity(int NetType, NETADDR *pGlobalAddr);
};
 
class CNetConnection
{
    // TODO: is this needed because this needs to be aware of
    // the ack sequencing number and is also responible for updating
    // that. this should be fixed.
    friend class CNetRecvUnpacker;
 
public:
    enum class EState
    {
        OFFLINE,
        WANT_TOKEN,
        CONNECT,
        PENDING,
        ONLINE,
        ERROR,
    };
 
    SECURITY_TOKEN m_SecurityToken;
 
private:
    unsigned short m_Sequence;
    unsigned short m_Ack;
    unsigned short m_PeerAck;
    EState m_State;
    int m_RemoteClosed;
    bool m_BlockCloseMsg;
    bool m_UnknownSeq;
 
    CStaticRingBuffer<CNetChunkResend, NET_CONN_BUFFERSIZE> m_Buffer;
 
    int64_t m_LastUpdateTime;
    int64_t m_LastRecvTime;
    int64_t m_LastSendTime;
 
    char m_aErrorString[256];
 
    CNetPacketConstruct m_Construct;
 
    NETADDR m_aConnectAddrs[16];
    int m_NumConnectAddrs;
    NETADDR m_PeerAddr;
    NETSOCKET m_Socket;
    NETSTATS m_Stats;
 
    std::array<char, NETADDR_MAXSTRSIZE> m_aPeerAddrStr;
    std::array<char, NETADDR_MAXSTRSIZE> m_aPeerAddrStrNoPort;
    // client 0.7
    static TOKEN GenerateToken7(const NETADDR *pPeerAddr);
    class CNetBase *m_pNetBase;
    bool IsSixup() const { return m_Sixup; }
 
    //
    void SetPeerAddr(const NETADDR *pAddr);
    void ClearPeerAddr();
    void ResetStats();
    void SetError(const char *pString);
    void AckChunks(int Ack);
 
    int QueueChunkEx(int Flags, int DataSize, const void *pData, int Sequence);
    void SendConnect();
    void SendControl(int ControlMsg, const void *pExtra, int ExtraSize);
    void SendControlWithToken7(int ControlMsg, SECURITY_TOKEN ResponseToken);
    void ResendChunk(CNetChunkResend *pResend);
    void Resend();
 
public:
    bool m_TimeoutProtected;
    bool m_TimeoutSituation;
 
    void SetToken7(TOKEN Token);
 
    void Reset(bool Rejoin = false);
    void Init(NETSOCKET Socket, bool BlockCloseMsg);
    int Connect(const NETADDR *pAddr, int NumAddrs);
    int Connect7(const NETADDR *pAddr, int NumAddrs);
    void Disconnect(const char *pReason);
 
    int Update();
    int Flush();
 
    int Feed(CNetPacketConstruct *pPacket, NETADDR *pAddr, SECURITY_TOKEN SecurityToken = NET_SECURITY_TOKEN_UNSUPPORTED, SECURITY_TOKEN ResponseToken = NET_SECURITY_TOKEN_UNSUPPORTED);
    int QueueChunk(int Flags, int DataSize, const void *pData);
 
    const char *ErrorString();
    void SignalResend();
    EState State() const { return m_State; }
    const NETADDR *PeerAddress() const { return &m_PeerAddr; }
    const std::array<char, NETADDR_MAXSTRSIZE> &PeerAddressString(bool IncludePort) const
    {
        return IncludePort ? m_aPeerAddrStr : m_aPeerAddrStrNoPort;
    }
    void ConnectAddresses(const NETADDR **ppAddrs, int *pNumAddrs) const
    {
        *ppAddrs = m_aConnectAddrs;
        *pNumAddrs = m_NumConnectAddrs;
    }
 
    void ResetErrorString() { m_aErrorString[0] = 0; }
    const char *ErrorString() const { return m_aErrorString; }
 
    // Needed for GotProblems in NetClient
    int64_t LastRecvTime() const { return m_LastRecvTime; }
    int64_t ConnectTime() const { return m_LastUpdateTime; }
 
    int AckSequence() const { return m_Ack; }
    int SeqSequence() const { return m_Sequence; }
    int SecurityToken() const { return m_SecurityToken; }
    CStaticRingBuffer<CNetChunkResend, NET_CONN_BUFFERSIZE> *ResendBuffer() { return &m_Buffer; }
 
    void SetTimedOut(const NETADDR *pAddr, int Sequence, int Ack, SECURITY_TOKEN SecurityToken, CStaticRingBuffer<CNetChunkResend, NET_CONN_BUFFERSIZE> *pResendBuffer, bool Sixup);
 
    // anti spoof
    void DirectInit(const NETADDR &Addr, SECURITY_TOKEN SecurityToken, SECURITY_TOKEN Token, bool Sixup);
    void SetUnknownSeq() { m_UnknownSeq = true; }
    void SetSequence(int Sequence) { m_Sequence = Sequence; }
 
    bool m_Sixup;
    SECURITY_TOKEN m_Token;
};
 
class CConsoleNetConnection
{
public:
    enum class EState
    {
        OFFLINE,
        ONLINE,
        ERROR,
    };
 
private:
    EState m_State;
 
    NETADDR m_PeerAddr;
    NETSOCKET m_Socket;
 
    char m_aBuffer[NET_MAX_PACKETSIZE];
    int m_BufferOffset;
 
    char m_aErrorString[256];
 
    bool m_LineEndingDetected;
    char m_aLineEnding[3];
 
public:
    int Init(NETSOCKET Socket, const NETADDR *pAddr);
    void Disconnect(const char *pReason);
 
    EState State() const { return m_State; }
    const NETADDR *PeerAddress() const { return &m_PeerAddr; }
    const char *ErrorString() const { return m_aErrorString; }
 
    void Reset();
    int Update();
    int Send(const char *pLine);
    int Recv(char *pLine, int MaxLength);
};
 
class CNetRecvUnpacker
{
public:
    bool m_Valid;
 
    NETADDR m_Addr;
    CNetConnection *m_pConnection;
    int m_CurrentChunk;
    int m_ClientId;
    CNetPacketConstruct m_Data;
    unsigned char m_aBuffer[NET_MAX_PACKETSIZE];
 
    CNetRecvUnpacker() { Clear(); }
    void Clear();
    void Start(const NETADDR *pAddr, CNetConnection *pConnection, int ClientId);
    int FetchChunk(CNetChunk *pChunk);
};
 
// server side
class CNetServer
{
    struct CSlot
    {
    public:
        CNetConnection m_Connection;
    };
 
    struct CSpamConn
    {
        NETADDR m_Addr;
        int64_t m_Time;
        int m_Conns;
    };
 
    NETADDR m_Address;
    NETSOCKET m_Socket;
    CNetBan *m_pNetBan;
    CSlot m_aSlots[NET_MAX_CLIENTS];
    int m_MaxClients;
    int m_MaxClientsPerIp;
 
    NETFUNC_NEWCLIENT m_pfnNewClient;
    NETFUNC_NEWCLIENT_NOAUTH m_pfnNewClientNoAuth;
    NETFUNC_DELCLIENT m_pfnDelClient;
    NETFUNC_CLIENTREJOIN m_pfnClientRejoin;
    void *m_pUser;
 
    unsigned char m_aSecurityTokenSeed[16];
 
    // vanilla connect flood detection
    int64_t m_VConnFirst;
    int m_VConnNum;
 
    CSpamConn m_aSpamConns[NET_CONNLIMIT_IPS];
 
    CNetRecvUnpacker m_RecvUnpacker;
 
    void OnTokenCtrlMsg(NETADDR &Addr, int ControlMsg, const CNetPacketConstruct &Packet);
    int OnSixupCtrlMsg(NETADDR &Addr, CNetChunk *pChunk, int ControlMsg, const CNetPacketConstruct &Packet, SECURITY_TOKEN &ResponseToken, SECURITY_TOKEN Token);
    void OnPreConnMsg(NETADDR &Addr, CNetPacketConstruct &Packet);
    void OnConnCtrlMsg(NETADDR &Addr, int ClientId, int ControlMsg, const CNetPacketConstruct &Packet);
    bool ClientExists(const NETADDR &Addr) { return GetClientSlot(Addr) != -1; }
    int GetClientSlot(const NETADDR &Addr);
    void SendControl(NETADDR &Addr, int ControlMsg, const void *pExtra, int ExtraSize, SECURITY_TOKEN SecurityToken);
 
    int TryAcceptClient(NETADDR &Addr, SECURITY_TOKEN SecurityToken, bool VanillaAuth = false, bool Sixup = false, SECURITY_TOKEN Token = 0);
    int NumClientsWithAddr(NETADDR Addr);
    bool Connlimit(NETADDR Addr);
    void SendMsgs(NETADDR &Addr, const CPacker **ppMsgs, int Num);
 
public:
    int SetCallbacks(NETFUNC_NEWCLIENT pfnNewClient, NETFUNC_DELCLIENT pfnDelClient, void *pUser);
    int SetCallbacks(NETFUNC_NEWCLIENT pfnNewClient, NETFUNC_NEWCLIENT_NOAUTH pfnNewClientNoAuth, NETFUNC_CLIENTREJOIN pfnClientRejoin, NETFUNC_DELCLIENT pfnDelClient, void *pUser);
 
    //
    bool Open(NETADDR BindAddr, CNetBan *pNetBan, int MaxClients, int MaxClientsPerIp);
    void Close();
 
    //
    int Recv(CNetChunk *pChunk, SECURITY_TOKEN *pResponseToken);
    int Send(CNetChunk *pChunk);
    void Update();
 
    //
    void Drop(int ClientId, const char *pReason);
 
    // status requests
    const NETADDR *ClientAddr(int ClientId) const { return m_aSlots[ClientId].m_Connection.PeerAddress(); }
    const std::array<char, NETADDR_MAXSTRSIZE> &ClientAddrString(int ClientId, bool IncludePort) const { return m_aSlots[ClientId].m_Connection.PeerAddressString(IncludePort); }
    bool HasSecurityToken(int ClientId) const { return m_aSlots[ClientId].m_Connection.SecurityToken() != NET_SECURITY_TOKEN_UNSUPPORTED; }
    NETADDR Address() const { return m_Address; }
    NETSOCKET Socket() const { return m_Socket; }
    CNetBan *NetBan() const { return m_pNetBan; }
    int NetType() const { return net_socket_type(m_Socket); }
    int MaxClients() const { return m_MaxClients; }
 
    void SendTokenSixup(NETADDR &Addr, SECURITY_TOKEN Token);
 
    //
    void SetMaxClientsPerIp(int Max);
    bool SetTimedOut(int ClientId, int OrigId);
    void SetTimeoutProtected(int ClientId);
 
    void ResetErrorString(int ClientId);
    const char *ErrorString(int ClientId);
 
    // anti spoof
    SECURITY_TOKEN GetGlobalToken();
    SECURITY_TOKEN GetToken(const NETADDR &Addr);
    SECURITY_TOKEN GetVanillaToken(const NETADDR &Addr);
};
 
class CNetConsole
{
    struct CSlot
    {
        CConsoleNetConnection m_Connection;
    };
 
    NETSOCKET m_Socket;
    CNetBan *m_pNetBan;
    CSlot m_aSlots[NET_MAX_CONSOLE_CLIENTS];
 
    NETFUNC_NEWCLIENT_CON m_pfnNewClient;
    NETFUNC_DELCLIENT m_pfnDelClient;
    void *m_pUser;
 
    CNetRecvUnpacker m_RecvUnpacker;
 
public:
    void SetCallbacks(NETFUNC_NEWCLIENT_CON pfnNewClient, NETFUNC_DELCLIENT pfnDelClient, void *pUser);
 
    //
    bool Open(NETADDR BindAddr, CNetBan *pNetBan);
    void Close();
 
    //
    int Recv(char *pLine, int MaxLength, int *pClientId = nullptr);
    int Send(int ClientId, const char *pLine);
    void Update();
 
    //
    int AcceptClient(NETSOCKET Socket, const NETADDR *pAddr);
    void Drop(int ClientId, const char *pReason);
 
    // status requests
    const NETADDR *ClientAddr(int ClientId) const { return m_aSlots[ClientId].m_Connection.PeerAddress(); }
    CNetBan *NetBan() const { return m_pNetBan; }
};
 
class CNetTokenCache
{
public:
    void Init(NETSOCKET Socket);
    void SendPacketConnless(CNetChunk *pChunk);
    void FetchToken(NETADDR *pAddr);
    void AddToken(const NETADDR *pAddr, TOKEN Token);
    TOKEN GetToken(const NETADDR *pAddr);
    TOKEN GenerateToken();
    void Update();
 
private:
    class CConnlessPacketInfo
    {
    public:
        NETADDR m_Addr;
        int m_DataSize;
        unsigned char m_aData[NET_MAX_PAYLOAD];
        int64_t m_Expiry;
    };
 
    class CAddressInfo
    {
    public:
        NETADDR m_Addr;
        TOKEN m_Token;
        int64_t m_Expiry;
    };
 
    NETSOCKET m_Socket;
    std::vector<CAddressInfo> m_TokenCache;
    std::vector<CConnlessPacketInfo> m_ConnlessPackets;
};
 
// client side
class CNetClient
{
    CNetConnection m_Connection;
    CNetRecvUnpacker m_RecvUnpacker;
    CNetTokenCache m_TokenCache;
 
    CStun *m_pStun = nullptr;
 
public:
    NETSOCKET m_Socket;
    // openness
    bool Open(NETADDR BindAddr);
    void Close();
 
    // connection state
    void Disconnect(const char *pReason);
    void Connect(const NETADDR *pAddr, int NumAddrs);
    void Connect7(const NETADDR *pAddr, int NumAddrs);
 
    // communication
    int Recv(CNetChunk *pChunk, SECURITY_TOKEN *pResponseToken, bool Sixup);
    int Send(CNetChunk *pChunk);
 
    // pumping
    void Update();
    int Flush();
 
    void ResetErrorString();
 
    // error and state
    int NetType() const { return net_socket_type(m_Socket); }
    int State();
    const NETADDR *ServerAddress() const { return m_Connection.PeerAddress(); }
    void ConnectAddresses(const NETADDR **ppAddrs, int *pNumAddrs) const { m_Connection.ConnectAddresses(ppAddrs, pNumAddrs); }
    bool GotProblems(int64_t MaxLatency) const;
    const char *ErrorString() const;
 
    // stun
    void FeedStunServer(NETADDR StunServer);
    void RefreshStun();
    CONNECTIVITY GetConnectivity(int NetType, NETADDR *pGlobalAddr);
};
 
// TODO: both, fix these. This feels like a junk class for stuff that doesn't fit anywhere
class CNetBase
{
    static IOHANDLE ms_DataLogSent;
    static IOHANDLE ms_DataLogRecv;
    static CHuffman ms_Huffman;
 
public:
    static void OpenLog(IOHANDLE DataLogSent, IOHANDLE DataLogRecv);
    static void CloseLog();
    static void Init();
    static int Compress(const void *pData, int DataSize, void *pOutput, int OutputSize);
    static int Decompress(const void *pData, int DataSize, void *pOutput, int OutputSize);
 
    static bool IsValidConnectionOrientedPacket(const CNetPacketConstruct *pPacket);
 
    static void SendControlMsg(NETSOCKET Socket, NETADDR *pAddr, int Ack, int ControlMsg, const void *pExtra, int ExtraSize, SECURITY_TOKEN SecurityToken, bool Sixup = false);
    static void SendControlMsgWithToken7(NETSOCKET Socket, NETADDR *pAddr, TOKEN Token, int Ack, int ControlMsg, TOKEN MyToken, bool Extended);
    static void SendPacketConnless(NETSOCKET Socket, NETADDR *pAddr, const void *pData, int DataSize, bool Extended, unsigned char aExtra[NET_CONNLESS_EXTRA_SIZE]);
    static void SendPacketConnlessWithToken7(NETSOCKET Socket, NETADDR *pAddr, const void *pData, int DataSize, SECURITY_TOKEN Token, SECURITY_TOKEN ResponseToken);
    static void SendPacket(NETSOCKET Socket, NETADDR *pAddr, CNetPacketConstruct *pPacket, SECURITY_TOKEN SecurityToken, bool Sixup = false);
 
    static std::optional<int> UnpackPacketFlags(unsigned char *pBuffer, int Size);
    static int UnpackPacket(unsigned char *pBuffer, int Size, CNetPacketConstruct *pPacket, bool &Sixup, SECURITY_TOKEN *pSecurityToken = nullptr, SECURITY_TOKEN *pResponseToken = nullptr);
 
    // The backroom is ack-NET_MAX_SEQUENCE/2. Used for knowing if we acked a packet or not
    static bool IsSeqInBackroom(int Seq, int Ack);
};
 
#endif