Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |
00001 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 00080 00081 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 00092 00093 00094 00095 00096 00097 00098 00099 00100 00101 00102 00103 00104 00105 00106 00107 00108 00109 00110 00111 00112 00113 00114 00115 00116 00117 00118 00119 00120 00121 00122 00123 00124 00125 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 00136 00137 00138 00139 00140 00141 00142 00143 00144 00145 00146 00147 00148 00149 00150 00151 00152 00153 00154 00155 00156 00157 00158 00159 00160 00161 00162 00163 00164 00165 00166 00167 00168 00169 00170 00171 00172 00173 00174 00175 00176 00177 00178 00179 00180 00181 00182 00183 00184 00185 00186 00187 00188 00189 00190 00191 00192 00193 00194 00195 00196 00197 00198 00199 00200 00201 00202 00203 00204 00205 00206 00207 00208 00209 00210 00211 00212 00213 00214 00215 00216 00217 00218 00219 00220 00221 00222 00223 00224 00225 00226 00227 00228 00229 00230 00231 00232 00233 00234 00235 00236 00237 00238 00239 00240 00241 00242 00243 00244 00245 00246 00247 00248 00249 00250 00251 00252 00253 00254 00255 00256 00257 00258 00259 00260 00261 00262 00263 00264 00265 00266 00267 00268 00269 00270 00271 00272 00273 00274 00275 00276 00277 00278 00279 00280 00281 00282 00283 00284 00285 00286 00287 00288 00289 00290 00291 00292 00293 00294 00295 00296 00297 00298 00299 00300 00301 00302 00303 00304 00305 00306 00307 00308 00309 00310 00311 00312 00313 00314 00315 00316 00317 00318 00319 00320 00321 00322 00323 00324 00325 00326 00327 00328 00329 00330 00331 00332 00333 00334 00335 00336 00337 00338 00339 00340 00341 00342 00343 00344 00345 00346 00347 00348 00349 00350 00351 00352 00353 00354 00355 00356 00357 00358 00359 00360 00361 00362 00363 00364 00365 00366 00367 00368 00369 00370 00371 00372 00373 00374 00375 00376 00377 00378 00379 00380 00381 00382 00383 00384 00385 00386 00387 00388 00389 00390 00391 00392 00393 00394 00395 00396 00397 00398 00399 00400 00401 00402 00403 00404 00405 00406 00407 00408 00409 00410 00411 00412 00413 00414 00415 00416 00417 00418 00419 00420 00421 00422 00423 00424 00425 00426 00427 00428 00429 00430 00431 00432 00433 00434 00435 00436 00437 00438 00439 00440 00441 00442 00443 00444 00445 00446 00447 00448 00449 00450 00451 00452 00453 00454 00455 00456 00457 00458 00459 00460 00461 00462 00463 00464 00465 00466 00467 00468 00469 00470 00471 00472 00473 00474 00475 00476 00477 00478 00479 00480 00481 00482 00483 00484 00485 00486 00487 00488 00489 00490 00491 00492 00493 00494 00495 00496 00497 00498 00499 00500 00501 00502 00503 00504 00505 00506 00507 00508 00509 00510 00511 00512 00513 00514 00515 00516 00517 00518 00519 00520 00521 00522 00523 00524 00525 00526 00527 00528 00529 00530 00531 00532 00533 00534 00535 |
//============================================================================= // AccessControl. // // AccessControl is a helper class for GameInfo. // The AccessControl class determines whether or not the player is allowed to // login in the PreLogin() function, and also controls whether or not a player // can enter as a spectator or a game administrator. // // Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. //============================================================================= class AccessControl extends Info config(Game); var globalconfig array<string> IPPolicies; var globalconfig array<UniqueNetID> BannedIDs; struct BannedInfo { var UniqueNetID BannedID; var string PlayerName; var string TimeStamp; }; var globalconfig array<BannedInfo> BannedPlayerInfo; struct BannedHashInfo { var string PlayerName; var string BannedHash; }; var globalconfig array<BannedHashInfo> BannedHashes; var localized string IPBanned; var localized string WrongPassword; var localized string NeedPassword; var localized string SessionBanned; var localized string KickedMsg; var localized string DefaultKickReason; var localized string IdleKickReason; /** String to display when kicked for banned CD hash key */ var localized string BannedCDHashKeyString; /** String to display when kicked for a timed out CD hash key request */ var localized string TimedOutCDHashKeyString; var class<Admin> AdminClass; var private globalconfig string AdminPassword; // Password to receive bAdmin privileges. var private globalconfig string GamePassword; // Password to enter game. var localized string ACDisplayText[3]; var localized string ACDescText[3]; var bool bDontAddDefaultAdmin; struct SessionBanInfo { var UniqueNetID BanID; var string BanHash; var string BanIP; }; var array<SessionBanInfo> SessionBans; /** * @return TRUE if the specified player has admin priveleges. */ function bool IsAdmin(PlayerController P) { if ( P != None ) { if ( Admin(P) != None ) { return true; } if ( P.PlayerReplicationInfo != None && P.PlayerReplicationInfo.bAdmin ) { return true; } } return false; } function bool SetAdminPassword(string P) { AdminPassword = P; return true; } function SetGamePassword(string P) { GamePassword = P; WorldInfo.Game.UpdateGameSettings(); } function bool RequiresPassword() { return GamePassword != ""; } /** * Takes a string and tries to find the matching controller associated with it. First it searches as if the string is the * player's name. If it doesn't find a match, it attempts to resolve itself using the target as the player id. * * @Params Target The search key * * @returns the controller assoicated with the key. NONE is a valid return and means not found. */ function Controller GetControllerFromString(string Target) { local Controller C,FinalC; local int i; FinalC = none; foreach WorldInfo.AllControllers(class'Controller', C) { if (C.PlayerReplicationInfo != None && (C.PlayerReplicationInfo.PlayerName ~= Target || C.PlayerReplicationInfo.GetPlayerAlias() ~= Target)) { FinalC = C; break; } } // if we didn't find it by name, attemtp to convert the target to a player index and look him up if possible. if ( C == none && WorldInfo != none && WorldInfo.GRI != none ) { for (i=0;i<WorldInfo.GRI.PRIArray.Length;i++) { if ( String(WorldInfo.GRI.PRIArray[i].PlayerID) == Target ) { FinalC = Controller(WorldInfo.GRI.PRIArray[i].Owner); break; } } } return FinalC; } function Kick( string Target ) { local Controller C; C = GetControllerFromString(Target); if ( C != none && C.PlayerReplicationInfo != None ) { if (PlayerController(C) != None) { KickPlayer(PlayerController(C), DefaultKickReason); } else if (C.PlayerReplicationInfo.bBot) { if (C.Pawn != None) { C.Pawn.Destroy(); } if (C != None) { C.Destroy(); } } } } function KickBan( string Target ) { local PlayerController P; local BannedInfo NewBanInfo; local BannedHashInfo NewBanHashInfo; //local string IP; P = PlayerController( GetControllerFromString(Target) ); if ( NetConnection(P.Player) != None ) { // don't bother with IP ban on console - doesn't work /* if (!WorldInfo.IsConsoleBuild()) { IP = P.GetPlayerNetworkAddress(); if( CheckIPPolicy(IP) ) { IP = Left(IP, InStr(IP, ":")); `Log("Adding IP Ban for: "$IP); IPPolicies[IPPolicies.length] = "DENY," $ IP; SaveConfig(); } } */ if ( P.PlayerReplicationInfo.UniqueId != P.PlayerReplicationInfo.default.UniqueId && !IsIDBanned(P.PlayerReplicationInfo.UniqueID) ) { //Legacy struct (read from ini only), now check primarily from new BannedPlayerInfo //BannedIDs.AddItem(P.PlayerReplicationInfo.UniqueId); NewBanInfo.BannedID = P.PlayerReplicationInfo.UniqueId; NewBanInfo.PlayerName = P.PlayerReplicationInfo.PlayerName; NewBanInfo.TimeStamp = Timestamp(); BannedPlayerInfo.AddItem(NewBanInfo); SaveConfig(); } //Add this player to the list of banned hashes if (P.HashResponseCache != "" && P.HashResponseCache != "0" && !IsHashBanned(P.HashResponseCache)) { NewBanHashInfo.PlayerName = P.PlayerReplicationInfo.PlayerName; NewBanHashInfo.BannedHash = P.HashResponseCache; BannedHashes.AddItem(NewBanHashInfo); SaveConfig(); } KickPlayer(P, DefaultKickReason); return; } } function SessionBan(string Target) { local PlayerController P; P = PlayerController(GetControllerFromString(Target)); if (P != none) SessionBanPlayer(P); } function bool KickPlayer(PlayerController C, string KickReason) { local string KickString; // Do not kick logged admins if (C != None && !IsAdmin(C) && NetConnection(C.Player)!=None ) { if (C.Pawn != None) { C.Pawn.Suicide(); } /** Written to work around old clients not getting the proper string to let them know they need to update */ /** Since ClientWasKicked() is a client side function that if modified they won't have anyway */ //C.ClientWasKicked(); KickString = Localize("AccessControl", "KickedMsg", "Engine"); //Append a reason if (KickReason != "" && !(KickReason ~= DefaultKickReason)) { KickString @= KickReason; } C.ClientSetProgressMessage(PMT_ConnectionFailure, KickString); if (C != None) { C.Destroy(); } return true; } return false; } function SessionBanPlayer(PlayerController C) { local SessionBanInfo SB; if (C != none && !IsAdmin(C) && NetConnection(C.Player) != none) { if (!WorldInfo.IsConsoleBuild()) { SB.BanIP = C.GetPlayerNetworkAddress(); SB.BanIP = Left(SB.BanIP, InStr(SB.BanIP, ":")); } SB.BanID = C.PlayerReplicationInfo.UniqueId; if (C.HashResponseCache != "" && C.HashResponseCache != "0") SB.BanHash = C.HashResponseCache; SessionBans.AddItem(SB); LogInternal("Session banning '"$C.PlayerReplicationInfo.GetPlayerAlias()$"', IP:"@SB.BanIP$", Hash:"@SB.BanHash$", ID:"@ Class'OnlineSubsystem'.static.UniqueNetIDToString(SB.BanID)); KickPlayer(C, SessionBanned); } } function bool AdminLogin( PlayerController P, string Password ) { if (AdminPassword == "") return false; if (Password == AdminPassword) { P.PlayerReplicationInfo.bAdmin = true; return true; } return false; } function bool AdminLogout(PlayerController P) { if (P.PlayerReplicationInfo.bAdmin) { P.PlayerReplicationInfo.bAdmin = false; P.bGodMode = false; P.Suicide(); return true; } return false; } function AdminEntered( PlayerController P ) { local string LoginString; LoginString = P.PlayerReplicationInfo.GetPlayerAlias()@"logged in as a server administrator."; LogInternal(LoginString); WorldInfo.Game.Broadcast( P, LoginString ); } function AdminExited( PlayerController P ) { local string LogoutString; LogoutString = P.PlayerReplicationInfo.GetPlayerAlias()@"is no longer logged in as a server administrator."; LogInternal(LogoutString); WorldInfo.Game.Broadcast( P, LogoutString ); } /** * Parses the specified string for admin auto-login options * * @param Options a string containing key/pair options from the URL (?key=value,?key=value) * * @return TRUE if the options contained name and password which were valid for admin login. */ function bool ParseAdminOptions( string Options ) { local string InAdminName, InPassword; InPassword = class'GameInfo'.static.ParseOption( Options, "Password" ); InAdminName= class'GameInfo'.static.ParseOption( Options, "AdminName" ); return ValidLogin(InAdminName, InPassword); } /** * @return TRUE if the specified username + password match the admin username/password */ function bool ValidLogin(string UserName, string Password) { return (AdminPassword != "" && Password==AdminPassword); } // // Accept or reject a player on the server. // Fails login if you set the OutError to a non-empty string. // event PreLogin(string Options, string Address, out string OutError, bool bSpectator) { // Do any name or password or name validation here. local string InPassword; OutError=""; InPassword = WorldInfo.Game.ParseOption( Options, "Password" ); if( (WorldInfo.NetMode != NM_Standalone) && WorldInfo.Game.AtCapacity(bSpectator) ) { //This is passed to Localize in UnPenLev.cpp so the .int has to have this string and it doesn't //OutError = PathName(WorldInfo.Game.GameMessageClass) $ ".MaxedOutMessage"; OutError = "Engine.GameMessage.MaxedOutMessage"; } else if ( GamePassword != "" && !(InPassword == GamePassword) && (AdminPassword == "" || !(InPassword == AdminPassword)) ) { OutError = (InPassword == "") ? "Engine.AccessControl.NeedPassword" : "Engine.AccessControl.WrongPassword"; } if (!CheckIPPolicy(Address)) { OutError = "Engine.AccessControl.IPBanned"; } } function bool CheckIPPolicy(string Address) { local int i, j; local int LastMatchingPolicy; local string Policy, Mask; local bool bAcceptAddress, bAcceptPolicy; // strip port number j = InStr(Address, ":"); if(j != -1) Address = Left(Address, j); bAcceptAddress = True; for(i=0; i<IPPolicies.Length; i++) { j = InStr(IPPolicies[i], ","); if(j==-1) continue; Policy = Left(IPPolicies[i], j); Mask = Mid(IPPolicies[i], j+1); if(Policy ~= "ACCEPT") bAcceptPolicy = True; else if(Policy ~= "DENY") bAcceptPolicy = False; else continue; j = InStr(Mask, "*"); if(j != -1) { if(Left(Mask, j) == Left(Address, j)) { bAcceptAddress = bAcceptPolicy; LastMatchingPolicy = i; } } else { if(Mask == Address) { bAcceptAddress = bAcceptPolicy; LastMatchingPolicy = i; } } } if(!bAcceptAddress) { LogInternal("Denied connection for "$Address$" with IP policy "$IPPolicies[LastMatchingPolicy]); } else if (Address != "" && SessionBans.Find('BanIP', Address) != INDEX_None) { LogInternal("Denied connection for "$Address$" due to session ban"); bAcceptAddress = False; } return bAcceptAddress; } function bool IsHashBanned(const string HashToCheck) { local int i; // Check for active session bans if (HashToCheck != "" && SessionBans.Find('BanHash', HashToCheck) != INDEX_None) return true; //Check the new array for banned id's for (i = 0; i < BannedHashes.length; i++) { if (BannedHashes[i].BannedHash == HashToCheck) { return true; } } return false; } function bool IsIDBanned(const out UniqueNetID NetID) { local int i; // Check for active session bans if (SessionBans.Find('BanID', NetID) != INDEX_None) return True; //Check the new array for banned id's for (i = 0; i < BannedPlayerInfo.length; i++) { if (BannedPlayerInfo[i].BannedID == NetID) { return true; } } //Legacy struct for banning for (i = 0; i < BannedIDs.length; i++) { if (BannedIDs[i] == NetID) { return true; } } return false; } defaultproperties { IPPolicies(0)="ACCEPT;*" IPBanned="Your IP address has been banned on this server." WrongPassword="The password you entered is incorrect." NeedPassword="You need to enter a password to join this game." SessionBanned="Your IP address has been banned from the current game session." KickedMsg="You have been forcibly removed from the game." DefaultKickReason="None specified" IdleKickReason="Kicked for idling." BannedCDHashKeyString="Banned CD Key." TimedOutCDHashKeyString="Key check failed with the server. Please update with the latest patch." AdminClass=Class'Engine.Admin' ACDisplayText(0)="Game Password" ACDisplayText(1)="Access Policies" ACDisplayText(2)="Admin Password" ACDescText(0)="If this password is set, players will have to enter it to join this server." ACDescText(1)="Specifies IP addresses or address ranges which have been banned." ACDescText(2)="Password required to login with administrator privileges on this server." Begin Object Class=SpriteComponent Name=Sprite ObjName=Sprite Archetype=SpriteComponent'Engine.Default__Info:Sprite' ObjectArchetype=SpriteComponent'Engine.Default__Info:Sprite' End Object Components(0)=Sprite CollisionType=COLLIDE_CustomDefault Name="Default__AccessControl" ObjectArchetype=Info'Engine.Default__Info' } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |