finished a(nother) rewrite of how players authenticate. name-based authentication has been added and passwords work fully now.
3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is not open source and may not be copied without explicit
8 * written permission of AlliedModders LLC. This file may not be redistributed
9 * in whole or significant part.
10 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
15 #include "PlayerManager.h"
16 #include "ForwardSys.h"
18 #include "AdminCache.h"
19 #include "ConCmdManager.h"
20 #include "MenuStyle_Valve.h"
21 #include "MenuStyle_Radio.h"
22 #include "sm_stringutil.h"
23 #include "CoreConfig.h"
24 #include <inetchannel.h>
28 PlayerManager g_Players;
29 bool g_OnMapStarted = false;
31 SH_DECL_HOOK5(IServerGameClients, ClientConnect, SH_NOATTRIB, 0, bool, edict_t *, const char *, const char *, char *, int);
32 SH_DECL_HOOK2_void(IServerGameClients, ClientPutInServer, SH_NOATTRIB, 0, edict_t *, const char *);
33 SH_DECL_HOOK1_void(IServerGameClients, ClientDisconnect, SH_NOATTRIB, 0, edict_t *);
34 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
35 SH_DECL_HOOK1_void(IServerGameClients, ClientSettingsChanged, SH_NOATTRIB, 0, edict_t *);
36 SH_DECL_HOOK3_void(IServerGameDLL, ServerActivate, SH_NOATTRIB, 0, edict_t *, int, int);
38 class KickPlayerTimer : public ITimedEvent
41 ResultType OnTimer(ITimer *pTimer, void *pData)
43 int userid = (int)pData;
44 int client = g_Players.GetClientOfUserId(userid);
47 CPlayer *player = g_Players.GetPlayerByIndex(client);
48 player->Kick("Your name is reserved by SourceMod; set your password to use it.");
52 void OnTimerEnd(ITimer *pTimer, void *pData)
57 PlayerManager::PlayerManager()
62 m_UserIdLookUp = new int[USHRT_MAX];
63 memset(m_UserIdLookUp, 0, sizeof(int) * USHRT_MAX);
66 PlayerManager::~PlayerManager()
68 delete [] m_AuthQueue;
69 delete [] m_UserIdLookUp;
72 void PlayerManager::OnSourceModAllInitialized()
74 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
75 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect_Post, true);
76 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
77 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
78 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
79 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
80 SH_ADD_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
81 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
83 g_ShareSys.AddInterface(NULL, this);
85 ParamType p1[] = {Param_Cell, Param_String, Param_Cell};
86 ParamType p2[] = {Param_Cell};
88 m_clconnect = g_Forwards.CreateForward("OnClientConnect", ET_Event, 3, p1);
89 m_clputinserver = g_Forwards.CreateForward("OnClientPutInServer", ET_Ignore, 1, p2);
90 m_cldisconnect = g_Forwards.CreateForward("OnClientDisconnect", ET_Ignore, 1, p2);
91 m_cldisconnect_post = g_Forwards.CreateForward("OnClientDisconnect_Post", ET_Ignore, 1, p2);
92 m_clcommand = g_Forwards.CreateForward("OnClientCommand", ET_Hook, 2, NULL, Param_Cell, Param_Cell);
93 m_clinfochanged = g_Forwards.CreateForward("OnClientSettingsChanged", ET_Ignore, 1, p2);
94 m_clauth = g_Forwards.CreateForward("OnClientAuthorized", ET_Ignore, 2, NULL, Param_Cell, Param_String);
95 m_onActivate = g_Forwards.CreateForward("OnServerLoad", ET_Ignore, 0, NULL);
96 m_onActivate2 = g_Forwards.CreateForward("OnMapStart", ET_Ignore, 0, NULL);
99 void PlayerManager::OnSourceModShutdown()
101 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientConnect, serverClients, this, &PlayerManager::OnClientConnect, false);
102 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientPutInServer, serverClients, this, &PlayerManager::OnClientPutInServer, true);
103 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect, false);
104 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientDisconnect, serverClients, this, &PlayerManager::OnClientDisconnect_Post, true);
105 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientCommand, serverClients, this, &PlayerManager::OnClientCommand, false);
106 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, ClientSettingsChanged, serverClients, this, &PlayerManager::OnClientSettingsChanged, true);
107 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, ServerActivate, gamedll, this, &PlayerManager::OnServerActivate, true);
109 /* Release forwards */
110 g_Forwards.ReleaseForward(m_clconnect);
111 g_Forwards.ReleaseForward(m_clputinserver);
112 g_Forwards.ReleaseForward(m_cldisconnect);
113 g_Forwards.ReleaseForward(m_cldisconnect_post);
114 g_Forwards.ReleaseForward(m_clcommand);
115 g_Forwards.ReleaseForward(m_clinfochanged);
116 g_Forwards.ReleaseForward(m_clauth);
117 g_Forwards.ReleaseForward(m_onActivate);
118 g_Forwards.ReleaseForward(m_onActivate2);
123 ConfigResult PlayerManager::OnSourceModConfigChanged(const char *key,
129 if (strcmp(key, "PassInfoVar") == 0)
131 if (strcmp(value, "_password") != 0)
133 m_PassInfoVar.assign(value);
135 return ConfigResult_Accept;
137 return ConfigResult_Ignore;
140 void PlayerManager::OnServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
144 /* Initialize all players */
145 m_maxClients = clientMax;
147 m_Players = new CPlayer[m_maxClients + 1];
148 m_AuthQueue = new unsigned int[m_maxClients + 1];
151 memset(m_AuthQueue, 0, sizeof(unsigned int) * (m_maxClients + 1));
153 m_onActivate->Execute(NULL);
154 m_onActivate2->Execute(NULL);
156 g_OnMapStarted = true;
158 SM_ExecuteAllConfigs();
161 bool PlayerManager::CheckSetAdmin(int index, CPlayer *pPlayer, AdminId id)
163 const char *password = g_Admins.GetAdminPassword(id);
164 if (password != NULL)
166 if (m_PassInfoVar.size() < 1)
171 /* Whoa... the user needs a password! */
172 const char *given = engine->GetClientConVarValue(index, m_PassInfoVar.c_str());
173 if (!given || strcmp(given, password) != 0)
179 pPlayer->SetAdminId(id, false);
184 bool PlayerManager::CheckSetAdminName(int index, CPlayer *pPlayer, AdminId id)
186 const char *password = g_Admins.GetAdminPassword(id);
187 if (password == NULL)
192 if (m_PassInfoVar.size() < 1)
197 /* Whoa... the user needs a password! */
198 const char *given = engine->GetClientConVarValue(index, m_PassInfoVar.c_str());
199 if (!given || strcmp(given, password) != 0)
204 pPlayer->SetAdminId(id, false);
209 void PlayerManager::RunAuthChecks()
213 unsigned int removed = 0;
214 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
216 pPlayer = GetPlayerByIndex(m_AuthQueue[i]);
217 authstr = engine->GetPlayerNetworkIDString(pPlayer->m_pEdict);
218 if (authstr && authstr[0] != '\0'
219 && (strcmp(authstr, "STEAM_ID_PENDING") != 0))
221 /* Set authorization */
222 pPlayer->Authorize(authstr);
224 /* Mark as removed from queue */
225 unsigned int client = m_AuthQueue[i];
229 /* Send to extensions */
230 List<IClientListener *>::iterator iter;
231 IClientListener *pListener;
232 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
235 pListener->OnClientAuthorized(client, authstr);
236 if (!pPlayer->IsConnected())
242 /* Send to plugins if player is still connected */
243 if (pPlayer->IsConnected() && m_clauth->GetFunctionCount())
245 /* :TODO: handle the case of a player disconnecting in the middle */
246 m_clauth->PushCell(client);
247 m_clauth->PushString(authstr);
248 m_clauth->Execute(NULL);
251 if (pPlayer->IsConnected())
253 pPlayer->Authorize_Post();
258 /* Clean up the queue */
261 /* We don't have to compact the list if it's empty */
262 if (removed != m_AuthQueue[0])
264 unsigned int diff = 0;
265 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
267 /* If this member is removed... */
268 if (m_AuthQueue[i] == 0)
270 /* Increase the differential */
273 /* diff cannot increase faster than i+1 */
275 assert(i - diff >= 1);
276 /* move this index down */
277 m_AuthQueue[i - diff] = m_AuthQueue[i];
280 m_AuthQueue[0] -= removed;
283 g_SourceMod.SetAuthChecking(false);
288 bool PlayerManager::OnClientConnect(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
290 int client = engine->IndexOfEdict(pEntity);
292 List<IClientListener *>::iterator iter;
293 IClientListener *pListener = NULL;
294 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
297 if (!pListener->InterceptClientConnect(client, reject, maxrejectlen))
305 m_Players[client].Initialize(pszName, pszAddress, pEntity);
306 m_clconnect->PushCell(client);
307 m_clconnect->PushStringEx(reject, maxrejectlen, SM_PARAM_STRING_UTF8, SM_PARAM_COPYBACK);
308 m_clconnect->PushCell(maxrejectlen);
309 m_clconnect->Execute(&res, NULL);
313 if (!m_Players[client].IsAuthorized())
315 m_AuthQueue[++m_AuthQueue[0]] = client;
316 g_SourceMod.SetAuthChecking(true);
319 RETURN_META_VALUE(MRES_SUPERCEDE, false);
322 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = client;
327 bool PlayerManager::OnClientConnect_Post(edict_t *pEntity, const char *pszName, const char *pszAddress, char *reject, int maxrejectlen)
329 int client = engine->IndexOfEdict(pEntity);
330 bool orig_value = META_RESULT_ORIG_RET(bool);
331 CPlayer *pPlayer = GetPlayerByIndex(client);
334 List<IClientListener *>::iterator iter;
335 IClientListener *pListener = NULL;
336 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
339 pListener->OnClientConnected(client);
340 if (!pPlayer->IsConnected())
350 void PlayerManager::OnClientPutInServer(edict_t *pEntity, const char *playername)
353 int client = engine->IndexOfEdict(pEntity);
355 CPlayer *pPlayer = GetPlayerByIndex(client);
356 /* If they're not connected, they're a bot */
357 if (!pPlayer->IsConnected())
359 /* Run manual connection routines */
361 const char *authid = engine->GetPlayerNetworkIDString(pEntity);
362 pPlayer->Authorize(authid);
363 if (!OnClientConnect(pEntity, playername, "127.0.0.1", error, sizeof(error)))
365 /* :TODO: kick the bot if it's rejected */
368 List<IClientListener *>::iterator iter;
369 IClientListener *pListener = NULL;
370 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
373 pListener->OnClientConnected(client);
374 /* See if bot was kicked */
375 if (!pPlayer->IsConnected())
380 /* Now do authorization */
381 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
384 pListener->OnClientAuthorized(client, authid);
385 /* See if bot was kicked */
386 if (!pPlayer->IsConnected())
391 /* Finally, tell plugins */
392 if (m_clauth->GetFunctionCount())
394 m_clauth->PushCell(client);
395 m_clauth->PushString(authid);
396 m_clauth->Execute(NULL);
397 if (!pPlayer->IsConnected())
402 pPlayer->Authorize_Post();
403 if (!pPlayer->IsConnected())
411 pPlayer->m_Info = playerinfo->GetPlayerInfo(pEntity);
414 List<IClientListener *>::iterator iter;
415 IClientListener *pListener = NULL;
416 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
419 pListener->OnClientPutInServer(client);
420 /* See if player was kicked */
421 if (!pPlayer->IsConnected())
427 m_Players[client].Connect();
429 m_clputinserver->PushCell(client);
430 m_clputinserver->Execute(&res, NULL);
433 void PlayerManager::OnSourceModLevelEnd()
435 /* Disconnect all bots still in game */
436 for (int i=1; i<=m_maxClients; i++)
438 if (m_Players[i].IsConnected() && m_Players[i].IsFakeClient())
440 OnClientDisconnect(m_Players[i].GetEdict());
445 void PlayerManager::OnClientDisconnect(edict_t *pEntity)
448 int client = engine->IndexOfEdict(pEntity);
450 if (m_Players[client].IsConnected())
452 m_cldisconnect->PushCell(client);
453 m_cldisconnect->Execute(&res, NULL);
456 if (m_Players[client].IsInGame())
461 List<IClientListener *>::iterator iter;
462 IClientListener *pListener = NULL;
463 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
466 pListener->OnClientDisconnecting(client);
470 * Remove client from auth queue if necessary
472 if (!m_Players[client].IsAuthorized())
474 for (unsigned int i=1; i<=m_AuthQueue[0]; i++)
476 if (m_AuthQueue[i] == (unsigned)client)
478 /* Move everything ahead of us back by one */
479 for (unsigned int j=i+1; j<=m_AuthQueue[0]; j++)
481 m_AuthQueue[j-1] = m_AuthQueue[j];
483 /* Remove us and break */
490 m_Players[client].Disconnect();
491 m_UserIdLookUp[engine->GetPlayerUserId(pEntity)] = 0;
494 void PlayerManager::OnClientDisconnect_Post(edict_t *pEntity)
497 int client = engine->IndexOfEdict(pEntity);
499 m_cldisconnect_post->PushCell(client);
500 m_cldisconnect_post->Execute(&res, NULL);
502 List<IClientListener *>::iterator iter;
503 IClientListener *pListener = NULL;
504 for (iter=m_hooks.begin(); iter!=m_hooks.end(); iter++)
507 pListener->OnClientDisconnected(client);
511 void PlayerManager::OnClientCommand(edict_t *pEntity)
513 int client = engine->IndexOfEdict(pEntity);
514 cell_t res = Pl_Continue;
516 bool result = g_ValveMenuStyle.OnClientCommand(client);
521 result = g_RadioMenuStyle.OnClientCommand(client);
528 int args = engine->Cmd_Argc() - 1;
530 cell_t res2 = Pl_Continue;
531 m_clcommand->PushCell(client);
532 m_clcommand->PushCell(args);
533 m_clcommand->Execute(&res2, NULL);
542 RETURN_META(MRES_SUPERCEDE);
545 res = g_ConCmds.DispatchClientCommand(client, (ResultType)res);
547 if (res >= Pl_Handled)
549 RETURN_META(MRES_SUPERCEDE);
553 void PlayerManager::OnClientSettingsChanged(edict_t *pEntity)
556 int client = engine->IndexOfEdict(pEntity);
558 m_clinfochanged->PushCell(engine->IndexOfEdict(pEntity));
559 m_clinfochanged->Execute(&res, NULL);
561 IPlayerInfo *info = m_Players[client].GetPlayerInfo();
562 const char *new_name = info ? info->GetName() : engine->GetClientConVarValue(client, "name");
563 const char *old_name = m_Players[client].m_Name.c_str();
565 if (strcmp(old_name, new_name) != 0)
567 AdminId id = g_Admins.FindAdminByIdentity("name", new_name);
568 if (id != INVALID_ADMIN_ID && m_Players[client].GetAdminId() != id)
570 if (!CheckSetAdminName(client, &m_Players[client], id))
572 m_Players[client].Kick("Your name is reserved by SourceMod; set your password to use it.");
573 RETURN_META(MRES_IGNORED);
575 } else if ((id = g_Admins.FindAdminByIdentity("name", old_name)) != INVALID_ADMIN_ID) {
576 if (id == m_Players[client].GetAdminId())
578 /* This player is changing their name; force them to drop admin privileges! */
579 m_Players[client].SetAdminId(INVALID_ADMIN_ID, false);
582 m_Players[client].SetName(new_name);
585 if (m_PassInfoVar.size() > 0)
587 /* Try for a password change */
588 const char *old_pass = m_Players[client].m_LastPassword.c_str();
589 const char *new_pass = engine->GetClientConVarValue(client, m_PassInfoVar.c_str());
590 if (strcmp(old_pass, new_pass) != 0)
592 m_Players[client].m_LastPassword.assign(new_pass);
593 if (m_Players[client].IsInGame() && m_Players[client].IsAuthorized())
595 /* If there is already an admin id assigned, this will just bail out. */
596 m_Players[client].DoBasicAdminChecks();
602 int PlayerManager::GetMaxClients()
607 CPlayer *PlayerManager::GetPlayerByIndex(int client) const
609 if (client > m_maxClients || client < 1)
613 return &m_Players[client];
616 int PlayerManager::GetNumPlayers()
618 return m_PlayerCount;
621 int PlayerManager::GetClientOfUserId(int userid)
623 if (userid < 0 || userid > USHRT_MAX)
628 int client = m_UserIdLookUp[userid];
630 /* Verify the userid. The cache can get messed up with older
631 * Valve engines. :TODO: If this gets fixed, do an old engine
632 * check before invoking this backwards compat code.
636 CPlayer *player = GetPlayerByIndex(client);
637 if (player && player->IsConnected())
639 int realUserId = engine->GetPlayerUserId(player->GetEdict());
640 if (realUserId == userid)
647 /* If we can't verify the userid, we have to do a manual loop */
649 for (int i = 1; i <= m_maxClients; i++)
651 player = GetPlayerByIndex(i);
652 if (!player || !player->IsConnected())
656 if (engine->GetPlayerUserId(player->GetEdict()) == userid)
658 m_UserIdLookUp[userid] = i;
666 void PlayerManager::AddClientListener(IClientListener *listener)
668 m_hooks.push_back(listener);
671 void PlayerManager::RemoveClientListener(IClientListener *listener)
673 m_hooks.remove(listener);
676 IGamePlayer *PlayerManager::GetGamePlayer(edict_t *pEdict)
678 int index = engine->IndexOfEdict(pEdict);
679 return GetGamePlayer(index);
682 IGamePlayer *PlayerManager::GetGamePlayer(int client)
684 return GetPlayerByIndex(client);
687 void PlayerManager::ClearAdminId(AdminId id)
689 for (int i=1; i<=m_maxClients; i++)
691 if (m_Players[i].m_Admin == id)
693 m_Players[i].DumpAdmin(true);
698 void PlayerManager::ClearAllAdmins()
700 for (int i=1; i<=m_maxClients; i++)
702 m_Players[i].DumpAdmin(true);
706 const char *PlayerManager::GetPassInfoVar()
708 return m_PassInfoVar.c_str();
717 m_IsConnected = false;
719 m_IsAuthorized = false;
721 m_Admin = INVALID_ADMIN_ID;
724 m_LastPassword.clear();
727 void CPlayer::Initialize(const char *name, const char *ip, edict_t *pEntity)
729 m_IsConnected = true;
735 strncopy(ip2, ip, sizeof(ip2));
736 if ((ptr = strchr(ip2, ':')) != NULL)
740 m_IpNoPort.assign(ip2);
743 void CPlayer::Connect()
752 const char *var = g_Players.GetPassInfoVar();
753 int client = engine->IndexOfEdict(m_pEdict);
756 const char *pass = engine->GetClientConVarValue(client, var);
757 m_LastPassword.assign(pass ? pass : "");
759 m_LastPassword.assign("");
764 DoBasicAdminChecks();
768 void CPlayer::Authorize(const char *steamid)
775 m_IsAuthorized = true;
776 m_AuthID.assign(steamid);
779 void CPlayer::Disconnect()
782 m_IsConnected = false;
784 m_IsAuthorized = false;
792 void CPlayer::SetName(const char *name)
797 const char *CPlayer::GetName()
799 return (m_Info) ? m_Info->GetName(): m_Name.c_str();
802 const char *CPlayer::GetIPAddress()
807 const char *CPlayer::GetAuthString()
809 return m_AuthID.c_str();
812 edict_t *CPlayer::GetEdict()
817 bool CPlayer::IsInGame()
822 bool CPlayer::IsConnected()
824 return m_IsConnected;
827 bool CPlayer::IsAuthorized()
829 return m_IsAuthorized;
832 IPlayerInfo *CPlayer::GetPlayerInfo()
837 bool CPlayer::IsFakeClient()
839 return (strcmp(m_AuthID.c_str(), "BOT") == 0);
842 void CPlayer::SetAdminId(AdminId id, bool temporary)
852 m_TempAdmin = temporary;
855 AdminId CPlayer::GetAdminId()
860 void CPlayer::DumpAdmin(bool deleting)
862 if (m_Admin != INVALID_ADMIN_ID)
864 if (m_TempAdmin && !deleting)
866 g_Admins.InvalidateAdmin(m_Admin);
868 m_Admin = INVALID_ADMIN_ID;
873 void CPlayer::Kick(const char *str)
875 int client = engine->IndexOfEdict(m_pEdict);
876 INetChannel *pNetChan = static_cast<INetChannel *>(engine->GetPlayerNetInfo(client));
877 IClient *pClient = static_cast<IClient *>(pNetChan->GetMsgHandler());
878 pClient->Disconnect("%s", str);
881 void CPlayer::Authorize_Post()
885 DoBasicAdminChecks();
889 void CPlayer::DoBasicAdminChecks()
891 if (GetAdminId() != INVALID_ADMIN_ID)
896 /* First check the name */
898 int client = engine->IndexOfEdict(m_pEdict);
900 if ((id = g_Admins.FindAdminByIdentity("name", GetName())) != INVALID_ADMIN_ID)
902 if (!g_Players.CheckSetAdminName(client, this, id))
904 int userid = engine->GetPlayerUserId(m_pEdict);
905 g_Timers.CreateTimer(&s_KickPlayerTimer, 0.1f, (void *)userid, 0);
911 if ((id = g_Admins.FindAdminByIdentity("ip", m_IpNoPort.c_str())) != INVALID_ADMIN_ID)
913 if (g_Players.CheckSetAdmin(client, this, id))
919 /* Check IP address */
920 if ((id = g_Admins.FindAdminByIdentity("steam", m_AuthID.c_str())) != INVALID_ADMIN_ID)
922 if (g_Players.CheckSetAdmin(client, this, id))