1/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
2/* If you are missing that file, acquire a complete release at teeworlds.com. */
3#ifndef ENGINE_SERVER_SERVER_H
4#define ENGINE_SERVER_SERVER_H
5
6#include "antibot.h"
7#include "authmanager.h"
8#include "name_ban.h"
9#include "snap_id_pool.h"
10
11#include <base/hash.h>
12
13#include <engine/console.h>
14#include <engine/server.h>
15#include <engine/shared/demo.h>
16#include <engine/shared/econ.h>
17#include <engine/shared/fifo.h>
18#include <engine/shared/http.h>
19#include <engine/shared/netban.h>
20#include <engine/shared/network.h>
21#include <engine/shared/protocol.h>
22#include <engine/shared/snapshot.h>
23#include <engine/shared/uuid_manager.h>
24
25#include <memory>
26#include <optional>
27#include <vector>
28
29#if defined(CONF_UPNP)
30#include "upnp.h"
31#endif
32
33class CConfig;
34class CHostLookup;
35class CLogMessage;
36class CMsgPacker;
37class CPacker;
38class IEngine;
39class IEngineMap;
40class ILogger;
41
42class CServerBan : public CNetBan
43{
44 class CServer *m_pServer;
45
46 template<class T>
47 int BanExt(T *pBanPool, const typename T::CDataType *pData, int Seconds, const char *pReason, bool VerbatimReason);
48
49public:
50 class CServer *Server() const { return m_pServer; }
51
52 void InitServerBan(class IConsole *pConsole, class IStorage *pStorage, class CServer *pServer);
53
54 int BanAddr(const NETADDR *pAddr, int Seconds, const char *pReason, bool VerbatimReason) override;
55 int BanRange(const CNetRange *pRange, int Seconds, const char *pReason) override;
56
57 static void ConBanExt(class IConsole::IResult *pResult, void *pUser);
58 static void ConBanRegion(class IConsole::IResult *pResult, void *pUser);
59 static void ConBanRegionRange(class IConsole::IResult *pResult, void *pUser);
60};
61
62class CServer : public IServer
63{
64 friend class CServerLogger;
65
66 class IGameServer *m_pGameServer;
67 class CConfig *m_pConfig;
68 class IConsole *m_pConsole;
69 class IStorage *m_pStorage;
70 class IEngineAntibot *m_pAntibot;
71 class IRegister *m_pRegister;
72 IEngine *m_pEngine;
73
74#if defined(CONF_UPNP)
75 CUPnP m_UPnP;
76#endif
77
78#if defined(CONF_FAMILY_UNIX)
79 UNIXSOCKETADDR m_ConnLoggingDestAddr;
80 bool m_ConnLoggingSocketCreated;
81 UNIXSOCKET m_ConnLoggingSocket;
82#endif
83
84 class CDbConnectionPool *m_pConnectionPool;
85
86 int m_PreviousDebugDummies = 0;
87 void UpdateDebugDummies(bool ForceDisconnect);
88
89public:
90 class IGameServer *GameServer() { return m_pGameServer; }
91 class CConfig *Config() { return m_pConfig; }
92 const CConfig *Config() const { return m_pConfig; }
93 class IConsole *Console() { return m_pConsole; }
94 class IStorage *Storage() { return m_pStorage; }
95 class IEngineAntibot *Antibot() { return m_pAntibot; }
96 class CDbConnectionPool *DbPool() { return m_pConnectionPool; }
97 IEngine *Engine() { return m_pEngine; }
98
99 enum
100 {
101 MAX_RCONCMD_SEND = 16,
102 };
103
104 enum class EDnsblState
105 {
106 NONE,
107 PENDING,
108 BLACKLISTED,
109 WHITELISTED,
110 };
111
112 static const char *DnsblStateStr(EDnsblState State);
113
114 class CClient
115 {
116 public:
117 enum
118 {
119 STATE_REDIRECTED = -1,
120 STATE_EMPTY,
121 STATE_PREAUTH,
122 STATE_AUTH,
123 STATE_CONNECTING,
124 STATE_READY,
125 STATE_INGAME,
126 };
127
128 enum
129 {
130 SNAPRATE_INIT = 0,
131 SNAPRATE_FULL,
132 SNAPRATE_RECOVER,
133 };
134
135 class CInput
136 {
137 public:
138 int m_aData[MAX_INPUT_SIZE];
139 int m_GameTick; // the tick that was chosen for the input
140 };
141
142 // connection state info
143 int m_State;
144 int m_Latency;
145 int m_SnapRate;
146
147 double m_Traffic;
148 int64_t m_TrafficSince;
149
150 int m_LastAckedSnapshot;
151 int m_LastInputTick;
152 CSnapshotStorage m_Snapshots;
153
154 CNetMsg_Sv_PreInput m_LastPreInput = {};
155 CInput m_LatestInput;
156 CInput m_aInputs[200]; // TODO: handle input better
157 int m_CurrentInput;
158
159 char m_aName[MAX_NAME_LENGTH];
160 char m_aClan[MAX_CLAN_LENGTH];
161 int m_Country;
162 std::optional<int> m_Score;
163 int m_AuthKey;
164 int m_AuthTries;
165 bool m_AuthHidden;
166 int m_NextMapChunk;
167 int m_Flags;
168 bool m_ShowIps;
169 bool m_DebugDummy;
170 bool m_ForceHighBandwidthOnSpectate;
171 NETADDR m_DebugDummyAddr;
172 std::array<char, NETADDR_MAXSTRSIZE> m_aDebugDummyAddrString;
173 std::array<char, NETADDR_MAXSTRSIZE> m_aDebugDummyAddrStringNoPort;
174
175 const IConsole::ICommandInfo *m_pRconCmdToSend;
176 enum
177 {
178 MAPLIST_UNINITIALIZED = -1,
179 MAPLIST_DISABLED = -2,
180 MAPLIST_DONE = -3,
181 };
182 int m_MaplistEntryToSend;
183
184 bool m_HasPersistentData;
185 void *m_pPersistentData;
186
187 void Reset();
188
189 // DDRace
190
191 bool m_GotDDNetVersionPacket;
192 bool m_DDNetVersionSettled;
193 int m_DDNetVersion;
194 char m_aDDNetVersionStr[64];
195 CUuid m_ConnectionId;
196 int64_t m_RedirectDropTime;
197
198 // DNSBL
199 EDnsblState m_DnsblState;
200 std::shared_ptr<CHostLookup> m_pDnsblLookup;
201
202 bool m_Sixup;
203
204 bool IncludedInServerInfo() const
205 {
206 return m_State != STATE_EMPTY && !m_DebugDummy;
207 }
208 };
209
210 IConsole::EAccessLevel ConsoleAccessLevel(int ClientId) const;
211
212 CClient m_aClients[MAX_CLIENTS];
213 int m_aIdMap[MAX_CLIENTS * VANILLA_MAX_CLIENTS];
214
215 CSnapshotDelta m_SnapshotDelta;
216 CSnapshotBuilder m_SnapshotBuilder;
217 CSnapIdPool m_IdPool;
218 CNetServer m_NetServer;
219 CEcon m_Econ;
220 CFifo m_Fifo;
221 CServerBan m_ServerBan;
222 CHttp m_Http;
223
224 IEngineMap *m_pMap;
225
226 int64_t m_GameStartTime;
227
228 enum
229 {
230 UNINITIALIZED = 0,
231 RUNNING = 1,
232 STOPPING = 2
233 };
234
235 int m_RunServer;
236
237 bool m_MapReload;
238 bool m_SameMapReload;
239 bool m_ReloadedWhenEmpty;
240 int m_RconClientId;
241 int m_RconAuthLevel;
242 int m_PrintCBIndex;
243 char m_aShutdownReason[128];
244 void *m_pPersistentData;
245
246 enum
247 {
248 MAP_TYPE_SIX = 0,
249 MAP_TYPE_SIXUP,
250 NUM_MAP_TYPES
251 };
252
253 enum
254 {
255 RECORDER_MANUAL = MAX_CLIENTS,
256 RECORDER_AUTO = MAX_CLIENTS + 1,
257 NUM_RECORDERS = MAX_CLIENTS + 2,
258 };
259
260 char m_aCurrentMap[IO_MAX_PATH_LENGTH];
261 const char *m_pCurrentMapName;
262 SHA256_DIGEST m_aCurrentMapSha256[NUM_MAP_TYPES];
263 unsigned m_aCurrentMapCrc[NUM_MAP_TYPES];
264 unsigned char *m_apCurrentMapData[NUM_MAP_TYPES];
265 unsigned int m_aCurrentMapSize[NUM_MAP_TYPES];
266 char m_aMapDownloadUrl[256];
267
268 CDemoRecorder m_aDemoRecorder[NUM_RECORDERS];
269 CAuthManager m_AuthManager;
270
271 int64_t m_ServerInfoFirstRequest;
272 int m_ServerInfoNumRequests;
273
274 char m_aErrorShutdownReason[128];
275
276 CNameBans m_NameBans;
277
278 size_t m_AnnouncementLastLine;
279 std::vector<std::string> m_vAnnouncements;
280
281 std::shared_ptr<ILogger> m_pFileLogger = nullptr;
282 std::shared_ptr<ILogger> m_pStdoutLogger = nullptr;
283
284 CServer();
285 ~CServer() override;
286
287 bool IsClientNameAvailable(int ClientId, const char *pNameRequest);
288 bool SetClientNameImpl(int ClientId, const char *pNameRequest, bool Set);
289 bool SetClientClanImpl(int ClientId, const char *pClanRequest, bool Set);
290
291 bool WouldClientNameChange(int ClientId, const char *pNameRequest) override;
292 bool WouldClientClanChange(int ClientId, const char *pClanRequest) override;
293 void SetClientName(int ClientId, const char *pName) override;
294 void SetClientClan(int ClientId, const char *pClan) override;
295 void SetClientCountry(int ClientId, int Country) override;
296 void SetClientScore(int ClientId, std::optional<int> Score) override;
297 void SetClientFlags(int ClientId, int Flags) override;
298
299 void Kick(int ClientId, const char *pReason) override;
300 void Ban(int ClientId, int Seconds, const char *pReason, bool VerbatimReason) override;
301 void ReconnectClient(int ClientId);
302 void RedirectClient(int ClientId, int Port) override;
303
304 void DemoRecorder_HandleAutoStart() override;
305
306 int64_t TickStartTime(int Tick);
307
308 int Init();
309
310 static bool StrHideIps(const char *pInput, char *pOutputWithIps, int OutputWithIpsSize, char *pOutputWithoutIps, int OutputWithoutIpsSize);
311 void SendLogLine(const CLogMessage *pMessage);
312 void SetRconCid(int ClientId) override;
313 int GetAuthedState(int ClientId) const override;
314 bool IsRconAuthed(int ClientId) const override;
315 bool IsRconAuthedAdmin(int ClientId) const override;
316 const char *GetAuthName(int ClientId) const override;
317 bool HasAuthHidden(int ClientId) const override;
318 void GetMapInfo(char *pMapName, int MapNameSize, int *pMapSize, SHA256_DIGEST *pMapSha256, int *pMapCrc) override;
319 bool GetClientInfo(int ClientId, CClientInfo *pInfo) const override;
320 void SetClientDDNetVersion(int ClientId, int DDNetVersion) override;
321 const NETADDR *ClientAddr(int ClientId) const override;
322 const std::array<char, NETADDR_MAXSTRSIZE> &ClientAddrStringImpl(int ClientId, bool IncludePort) const override;
323 const char *ClientName(int ClientId) const override;
324 const char *ClientClan(int ClientId) const override;
325 int ClientCountry(int ClientId) const override;
326 bool ClientSlotEmpty(int ClientId) const override;
327 bool ClientIngame(int ClientId) const override;
328 int Port() const override;
329 int MaxClients() const override;
330 int ClientCount() const override;
331 int DistinctClientCount() const override;
332
333 int GetClientVersion(int ClientId) const override;
334 int SendMsg(CMsgPacker *pMsg, int Flags, int ClientId) override;
335
336 void DoSnapshot();
337
338 static int NewClientCallback(int ClientId, void *pUser, bool Sixup);
339 static int NewClientNoAuthCallback(int ClientId, void *pUser);
340 static int DelClientCallback(int ClientId, const char *pReason, void *pUser);
341
342 static int ClientRejoinCallback(int ClientId, void *pUser);
343
344 void SendRconType(int ClientId, bool UsernameReq);
345 void SendCapabilities(int ClientId);
346 void SendMap(int ClientId);
347 void SendMapData(int ClientId, int Chunk);
348 void SendMapReload(int ClientId);
349 void SendConnectionReady(int ClientId);
350 void SendRconLine(int ClientId, const char *pLine);
351 // Accepts -1 as ClientId to mean "all clients with at least auth level admin"
352 void SendRconLogLine(int ClientId, const CLogMessage *pMessage);
353
354 void SendRconCmdAdd(const IConsole::ICommandInfo *pCommandInfo, int ClientId);
355 void SendRconCmdRem(const IConsole::ICommandInfo *pCommandInfo, int ClientId);
356 void SendRconCmdGroupStart(int ClientId);
357 void SendRconCmdGroupEnd(int ClientId);
358 int NumRconCommands(int ClientId);
359 void UpdateClientRconCommands(int ClientId);
360
361 class CMaplistEntry
362 {
363 public:
364 char m_aName[128];
365
366 CMaplistEntry() = default;
367 CMaplistEntry(const char *pName);
368 bool operator<(const CMaplistEntry &Other) const;
369 };
370 std::vector<CMaplistEntry> m_vMaplistEntries;
371 void SendMaplistGroupStart(int ClientId);
372 void SendMaplistGroupEnd(int ClientId);
373 void UpdateClientMaplistEntries(int ClientId);
374
375 bool CheckReservedSlotAuth(int ClientId, const char *pPassword);
376 void ProcessClientPacket(CNetChunk *pPacket);
377
378 class CCache
379 {
380 public:
381 class CCacheChunk
382 {
383 public:
384 CCacheChunk(const void *pData, int Size);
385 CCacheChunk(const CCacheChunk &) = delete;
386 CCacheChunk(CCacheChunk &&) = default;
387
388 std::vector<uint8_t> m_vData;
389 };
390
391 std::vector<CCacheChunk> m_vCache;
392
393 CCache();
394 ~CCache();
395
396 void AddChunk(const void *pData, int Size);
397 void Clear();
398 };
399 CCache m_aServerInfoCache[3 * 2];
400 CCache m_aSixupServerInfoCache[2];
401 bool m_ServerInfoNeedsUpdate = false;
402 bool m_ServerInfoNeedsResend = false;
403
404 void FillAntibot(CAntibotRoundData *pData) override;
405
406 void ExpireServerInfo() override;
407 void ExpireServerInfoAndQueueResend();
408 void CacheServerInfo(CCache *pCache, int Type, bool SendClients);
409 void CacheServerInfoSixup(CCache *pCache, bool SendClients, int MaxConsideredClients);
410 void SendServerInfo(const NETADDR *pAddr, int Token, int Type, bool SendClients);
411 void GetServerInfoSixup(CPacker *pPacker, bool SendClients);
412 bool RateLimitServerInfoConnless();
413 void SendServerInfoConnless(const NETADDR *pAddr, int Token, int Type);
414 void UpdateRegisterServerInfo();
415 void UpdateServerInfo(bool Resend);
416
417 void PumpNetwork(bool PacketWaiting);
418
419 void ChangeMap(const char *pMap) override;
420 const char *GetMapName() const override;
421 void ReloadMap() override;
422 int LoadMap(const char *pMapName);
423
424 void SaveDemo(int ClientId, float Time) override;
425 void StartRecord(int ClientId) override;
426 void StopRecord(int ClientId) override;
427 bool IsRecording(int ClientId) override;
428 void StopDemos() override;
429
430 int Run();
431
432 static void ConKick(IConsole::IResult *pResult, void *pUser);
433 static void ConStatus(IConsole::IResult *pResult, void *pUser);
434 static void ConShutdown(IConsole::IResult *pResult, void *pUser);
435 static void ConRecord(IConsole::IResult *pResult, void *pUser);
436 static void ConStopRecord(IConsole::IResult *pResult, void *pUser);
437 static void ConMapReload(IConsole::IResult *pResult, void *pUser);
438 static void ConLogout(IConsole::IResult *pResult, void *pUser);
439 static void ConShowIps(IConsole::IResult *pResult, void *pUser);
440 static void ConHideAuthStatus(IConsole::IResult *pResult, void *pUser);
441 static void ConForceHighBandwidthOnSpectate(IConsole::IResult *pResult, void *pUser);
442
443 static void ConAuthAdd(IConsole::IResult *pResult, void *pUser);
444 static void ConAuthAddHashed(IConsole::IResult *pResult, void *pUser);
445 static void ConAuthUpdate(IConsole::IResult *pResult, void *pUser);
446 static void ConAuthUpdateHashed(IConsole::IResult *pResult, void *pUser);
447 static void ConAuthRemove(IConsole::IResult *pResult, void *pUser);
448 static void ConAuthList(IConsole::IResult *pResult, void *pUser);
449
450 // console commands for sqlmasters
451 static void ConAddSqlServer(IConsole::IResult *pResult, void *pUserData);
452 static void ConDumpSqlServers(IConsole::IResult *pResult, void *pUserData);
453
454 static void ConReloadAnnouncement(IConsole::IResult *pResult, void *pUserData);
455 static void ConReloadMaplist(IConsole::IResult *pResult, void *pUserData);
456
457 static void ConchainSpecialInfoupdate(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
458 static void ConchainMaxclientsperipUpdate(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
459 static void ConchainCommandAccessUpdate(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
460
461 void LogoutClient(int ClientId, const char *pReason);
462 void LogoutKey(int Key, const char *pReason);
463
464 void ConchainRconPasswordChangeGeneric(const char *pRoleName, const char *pCurrent, IConsole::IResult *pResult);
465 static void ConchainRconPasswordChange(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
466 static void ConchainRconModPasswordChange(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
467 static void ConchainRconHelperPasswordChange(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
468 static void ConchainMapUpdate(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
469 static void ConchainSixupUpdate(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
470 static void ConchainRegisterCommunityTokenRedact(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
471 static void ConchainLoglevel(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
472 static void ConchainStdoutOutputLevel(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
473 static void ConchainAnnouncementFilename(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
474 static void ConchainInputFifo(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
475
476#if defined(CONF_FAMILY_UNIX)
477 static void ConchainConnLoggingServerChange(IConsole::IResult *pResult, void *pUserData, IConsole::FCommandCallback pfnCallback, void *pCallbackUserData);
478#endif
479
480 void RegisterCommands();
481
482 int SnapNewId() override;
483 void SnapFreeId(int Id) override;
484 void *SnapNewItem(int Type, int Id, int Size) override;
485 void SnapSetStaticsize(int ItemType, int Size) override;
486
487 // DDRace
488
489 int m_aPrevStates[MAX_CLIENTS];
490 const char *GetAnnouncementLine() override;
491 void ReadAnnouncementsFile();
492
493 static int MaplistEntryCallback(const char *pFilename, int IsDir, int DirType, void *pUser);
494 void InitMaplist();
495
496 int *GetIdMap(int ClientId) override;
497
498 void InitDnsbl(int ClientId);
499 bool DnsblWhite(int ClientId) override
500 {
501 return m_aClients[ClientId].m_DnsblState == EDnsblState::NONE ||
502 m_aClients[ClientId].m_DnsblState == EDnsblState::WHITELISTED;
503 }
504 bool DnsblPending(int ClientId) override
505 {
506 return m_aClients[ClientId].m_DnsblState == EDnsblState::PENDING;
507 }
508 bool DnsblBlack(int ClientId) override
509 {
510 return m_aClients[ClientId].m_DnsblState == EDnsblState::BLACKLISTED;
511 }
512
513 static bool CanClientUseCommandCallback(int ClientId, const IConsole::ICommandInfo *pCommand, void *pUser);
514 bool CanClientUseCommand(int ClientId, const IConsole::ICommandInfo *pCommand) const;
515 void AuthRemoveKey(int KeySlot);
516 bool ClientPrevIngame(int ClientId) override { return m_aPrevStates[ClientId] == CClient::STATE_INGAME; }
517 const char *GetNetErrorString(int ClientId) override { return m_NetServer.ErrorString(ClientId); }
518 void ResetNetErrorString(int ClientId) override { m_NetServer.ResetErrorString(ClientId); }
519 bool SetTimedOut(int ClientId, int OrigId) override;
520 void SetTimeoutProtected(int ClientId) override { m_NetServer.IgnoreTimeouts(ClientId); }
521
522 void SendMsgRaw(int ClientId, const void *pData, int Size, int Flags) override;
523
524 bool ErrorShutdown() const { return m_aErrorShutdownReason[0] != 0; }
525 void SetErrorShutdown(const char *pReason) override;
526
527 bool IsSixup(int ClientId) const override { return ClientId != SERVER_DEMO_CLIENT && m_aClients[ClientId].m_Sixup; }
528
529 void SetLoggers(std::shared_ptr<ILogger> &&pFileLogger, std::shared_ptr<ILogger> &&pStdoutLogger);
530
531#ifdef CONF_FAMILY_UNIX
532 enum CONN_LOGGING_CMD
533 {
534 OPEN_SESSION = 1,
535 CLOSE_SESSION = 2,
536 };
537
538 void SendConnLoggingCommand(CONN_LOGGING_CMD Cmd, const NETADDR *pAddr);
539#endif
540};
541
542bool IsInterrupted();
543
544extern CServer *CreateServer();
545#endif
546