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