Merge pull request #1229 from voodoos/cleanup/SocketSharp

Cleaning WebSocketSharp continued

Emby.Server.Implementations/SocketSharp/WebSocketSharpRequest.cs

@@ -4,6 +4,7 @@ using System.Globalization;
 using System.IO;
 using System.Net;
 using System.Text;
+using MediaBrowser.Common.Net;
 using MediaBrowser.Model.Services;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
@@ -38,16 +39,9 @@ namespace Emby.Server.Implementations.SocketSharp
         public string RawUrl => request.GetEncodedPathAndQuery();
 
         public string AbsoluteUri => request.GetDisplayUrl().TrimEnd('/');
+        // Header[name] returns "" when undefined
 
-        public string XForwardedFor
+        private string GetHeader(string name) => request.Headers[name].ToString();
-            => StringValues.IsNullOrEmpty(request.Headers["X-Forwarded-For"]) ? null : request.Headers["X-Forwarded-For"].ToString();
-
-        public int? XForwardedPort
-            => StringValues.IsNullOrEmpty(request.Headers["X-Forwarded-Port"]) ? (int?)null : int.Parse(request.Headers["X-Forwarded-Port"], CultureInfo.InvariantCulture);
-
-        public string XForwardedProtocol => StringValues.IsNullOrEmpty(request.Headers["X-Forwarded-Proto"]) ? null : request.Headers["X-Forwarded-Proto"].ToString();
-
-        public string XRealIp => StringValues.IsNullOrEmpty(request.Headers["X-Real-IP"]) ? null : request.Headers["X-Real-IP"].ToString();
 
         private string remoteIp;
         public string RemoteIp
@@ -59,101 +53,27 @@ namespace Emby.Server.Implementations.SocketSharp
                     return remoteIp;
                 }
 
-                var temp = CheckBadChars(XForwardedFor.AsSpan());
+                IPAddress ip;
-                if (temp.Length != 0)
-                {
-                    return remoteIp = temp.ToString();
-                }
-
-                temp = CheckBadChars(XRealIp.AsSpan());
-                if (temp.Length != 0)
-                {
-                    return remoteIp = NormalizeIp(temp).ToString();
-                }
-
-                return remoteIp = NormalizeIp(request.HttpContext.Connection.RemoteIpAddress.ToString().AsSpan()).ToString();
-            }
-        }
-
-        private static readonly char[] HttpTrimCharacters = new char[] { (char)0x09, (char)0xA, (char)0xB, (char)0xC, (char)0xD, (char)0x20 };
-
-        // CheckBadChars - throws on invalid chars to be not found in header name/value
-        internal static ReadOnlySpan<char> CheckBadChars(ReadOnlySpan<char> name)
-        {
-            if (name.Length == 0)
-            {
-                return name;
-            }
-
-            // VALUE check
-            // Trim spaces from both ends
-            name = name.Trim(HttpTrimCharacters);
 
-            // First, check for correctly formed multi-line value
+                // "Real" remote ip might be in X-Forwarded-For of X-Real-Ip
-            // Second, check for absence of CTL characters
+                // (if the server is behind a reverse proxy for example)
-            int crlf = 0;
+                if (!IPAddress.TryParse(GetHeader(CustomHeaderNames.XForwardedFor), out ip))
-            for (int i = 0; i < name.Length; ++i)
-            {
-                char c = (char)(0x000000ff & (uint)name[i]);
-                switch (crlf)
                 {
-                    case 0:
+                    if (!IPAddress.TryParse(GetHeader(CustomHeaderNames.XRealIP), out ip))
-                        if (c == '\r')
                     {
-                            crlf = 1;
+                        ip = request.HttpContext.Connection.RemoteIpAddress;
                     }
-                        else if (c == '\n')
-                        {
-                            // Technically this is bad HTTP.  But it would be a breaking change to throw here.
-                            // Is there an exploit?
-                            crlf = 2;
                 }
-                        else if (c == 127 || (c < ' ' && c != '\t'))
-                        {
-                            throw new ArgumentException("net_WebHeaderInvalidControlChars", nameof(name));
-                        }
-
-                        break;
 
-                    case 1:
+                return remoteIp = NormalizeIp(ip).ToString();
-                        if (c == '\n')
-                        {
-                            crlf = 2;
-                            break;
             }
-
-                        throw new ArgumentException("net_WebHeaderInvalidCRLFChars", nameof(name));
-
-                    case 2:
-                        if (c == ' ' || c == '\t')
-                        {
-                            crlf = 0;
-                            break;
         }
 
-                        throw new ArgumentException("net_WebHeaderInvalidCRLFChars", nameof(name));
+        private static IPAddress NormalizeIp(IPAddress ip)
-                }
-            }
-
-            if (crlf != 0)
         {
-                throw new ArgumentException("net_WebHeaderInvalidCRLFChars", nameof(name));
+            if (ip.IsIPv4MappedToIPv6)
-            }
-
-            return name;
-        }
-
-        private ReadOnlySpan<char> NormalizeIp(ReadOnlySpan<char> ip)
-        {
-            if (ip.Length != 0 && !ip.IsWhiteSpace())
             {
-                // Handle ipv4 mapped to ipv6
+                return ip.MapToIPv4();
-                const string srch = "::ffff:";
-                var index = ip.IndexOf(srch.AsSpan(), StringComparison.OrdinalIgnoreCase);
-                if (index == 0)
-                {
-                    ip = ip.Slice(srch.Length);
-                }
             }
 
             return ip;

MediaBrowser.Common/Net/CustomHeaderNames.cs

@@ -0,0 +1,11 @@
+namespace MediaBrowser.Common.Net
+{
+    public static class CustomHeaderNames
+    {
+        // Other Headers
+        public const string XForwardedFor = "X-Forwarded-For";
+        public const string XForwardedPort = "X-Forwarded-Port";
+        public const string XForwardedProto = "X-Forwarded-Proto";
+        public const string XRealIP = "X-Real-IP";
+    }
+}

MediaBrowser.Model/Services/IHttpRequest.cs

@@ -7,26 +7,6 @@ namespace MediaBrowser.Model.Services
         /// </summary>
         string HttpMethod { get; }
 
-        /// <summary>
-        /// The IP Address of the X-Forwarded-For header, null if null or empty
-        /// </summary>
-        string XForwardedFor { get; }
-
-        /// <summary>
-        /// The Port number of the X-Forwarded-Port header, null if null or empty
-        /// </summary>
-        int? XForwardedPort { get; }
-
-        /// <summary>
-        /// The http or https scheme of the X-Forwarded-Proto header, null if null or empty
-        /// </summary>
-        string XForwardedProtocol { get; }
-
-        /// <summary>
-        /// The value of the X-Real-IP header, null if null or empty
-        /// </summary>
-        string XRealIp { get; }
-
         /// <summary>
         /// The value of the Accept HTTP Request Header
         /// </summary>