Merge pull request #8137 from Mailaender/sanitize-player-name

Added a client side player name sanitation

OpenRA.Game/Network/UnitOrders.cs

@@ -152,6 +152,9 @@ namespace OpenRA.Network
 							break;
 						}
 
+						Game.Settings.Player.Name = Settings.SanitizedPlayerName(Game.Settings.Player.Name);
+						Game.Settings.Save();
+
 						// Otherwise send the handshake with our current settings and let the server reject us
 						var info = new Session.Client()
 						{

OpenRA.Game/Server/Server.cs

@@ -130,6 +130,9 @@ namespace OpenRA.Server
 			Port = localEndpoint.Port;
 
 			Settings = settings;
+
+			Settings.Name = OpenRA.Settings.SanitizedServerName(Settings.Name);
+
 			ModData = modData;
 
 			randomSeed = (int)DateTime.Now.ToBinary();
@@ -286,7 +289,7 @@ namespace OpenRA.Server
 
 				var client = new Session.Client()
 				{
-					Name = handshake.Client.Name,
+					Name = OpenRA.Settings.SanitizedPlayerName(handshake.Client.Name),
 					IpAddress = ((IPEndPoint)newConn.Socket.RemoteEndPoint).Address.ToString(),
 					Index = newConn.PlayerIndex,
 					Slot = LobbyInfo.FirstEmptySlot(),

OpenRA.Game/Settings.cs

@@ -11,7 +11,9 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using OpenRA.Graphics;
+using OpenRA.Traits;
 
 namespace OpenRA
 {
@@ -301,6 +303,46 @@ namespace OpenRA
 			root.WriteToFile(settingsFile);
 		}
 
+		static string SanitizedName(string dirty)
+		{
+			if (string.IsNullOrEmpty(dirty))
+				return null;
+
+			var clean = dirty;
+
+			// reserved characters for MiniYAML and JSON
+			var disallowedChars = new char[] { '#', '@', ':', '\n', '\t', '[', ']', '{', '}', '"', '`' };
+			foreach (var disallowedChar in disallowedChars)
+				clean = clean.Replace(disallowedChar.ToString(), string.Empty);
+
+			// avoid UI glitches
+			if (clean.Length > 16)
+				clean = clean.Substring(0, 16);
+
+			return clean;
+		}
+
+		public static string SanitizedServerName(string dirty)
+		{
+			var clean = SanitizedName(dirty);
+			if (string.IsNullOrWhiteSpace(clean))
+				return new ServerSettings().Name;
+			else
+				return clean;
+		}
+
+		public static string SanitizedPlayerName(string dirty)
+		{
+			var forbiddenNames = new string[] { "Open", "Closed" };
+			var botNames = OpenRA.Game.ModData.DefaultRules.Actors["player"].Traits.WithInterface<IBotInfo>().Select(t => t.Name);
+
+			var clean = SanitizedName(dirty);
+			if (string.IsNullOrWhiteSpace(clean) || forbiddenNames.Contains(clean) || botNames.Contains(clean))
+				clean = new PlayerSettings().Name;
+
+			return clean;
+		}
+
 		static void LoadSectionYaml(MiniYaml yaml, object section)
 		{
 			var defaults = Activator.CreateInstance(section.GetType());