diff --git a/src/Middleware/HttpOverrides/src/ForwardedHeadersOptions.cs b/src/Middleware/HttpOverrides/src/ForwardedHeadersOptions.cs index ceb8ab32b997..cd49867fec1e 100644 --- a/src/Middleware/HttpOverrides/src/ForwardedHeadersOptions.cs +++ b/src/Middleware/HttpOverrides/src/ForwardedHeadersOptions.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.HttpOverrides; using IPAddress = System.Net.IPAddress; +using IPNetwork = System.Net.IPNetwork; namespace Microsoft.AspNetCore.Builder; diff --git a/src/Middleware/HttpOverrides/src/IPNetwork.cs b/src/Middleware/HttpOverrides/src/IPNetwork.cs index 9888de2d1535..7e0da19c040c 100644 --- a/src/Middleware/HttpOverrides/src/IPNetwork.cs +++ b/src/Middleware/HttpOverrides/src/IPNetwork.cs @@ -3,204 +3,60 @@ using System.Diagnostics.CodeAnalysis; using System.Net; -using System.Net.Sockets; namespace Microsoft.AspNetCore.HttpOverrides; /// /// A representation of an IP network based on CIDR notation. /// +[System.Obsolete("Please use System.Net.IPNetwork instead")] public class IPNetwork { + private readonly System.Net.IPNetwork _network; + /// /// Create a new with the specified and prefix length. /// /// The . /// The prefix length. /// is out of range. - public IPNetwork(IPAddress prefix, int prefixLength) : this(prefix, prefixLength, true) + public IPNetwork(IPAddress prefix, int prefixLength) { + _network = new(prefix, prefixLength); } - private IPNetwork(IPAddress prefix, int prefixLength, bool checkPrefixLengthRange) - { - if (checkPrefixLengthRange && - !IsValidPrefixLengthRange(prefix, prefixLength)) - { - throw new ArgumentOutOfRangeException(nameof(prefixLength), "The prefix length was out of range."); - } - - Prefix = prefix; - PrefixLength = prefixLength; - PrefixBytes = Prefix.GetAddressBytes(); - Mask = CreateMask(); - } + private IPNetwork(System.Net.IPNetwork network) => _network = network; /// /// Get the that represents the prefix for the network. /// - public IPAddress Prefix { get; } - - private byte[] PrefixBytes { get; } + public IPAddress Prefix => _network.BaseAddress; /// /// The CIDR notation of the subnet mask /// - public int PrefixLength { get; } - - private byte[] Mask { get; } + public int PrefixLength => _network.PrefixLength; /// /// Determine whether a given The is part of the IP network. /// /// The . /// if the is part of the IP network. Otherwise, . - public bool Contains(IPAddress address) - { - if (Prefix.AddressFamily != address.AddressFamily) - { - return false; - } - - var addressBytes = address.GetAddressBytes(); - for (int i = 0; i < PrefixBytes.Length && Mask[i] != 0; i++) - { - if ((PrefixBytes[i] & Mask[i]) != (addressBytes[i] & Mask[i])) - { - return false; - } - } - - return true; - } - - private byte[] CreateMask() - { - var mask = new byte[PrefixBytes.Length]; - int remainingBits = PrefixLength; - int i = 0; - while (remainingBits >= 8) - { - mask[i] = 0xFF; - i++; - remainingBits -= 8; - } - if (remainingBits > 0) - { - mask[i] = (byte)(0xFF << (8 - remainingBits)); - } - - return mask; - } - - private static bool IsValidPrefixLengthRange(IPAddress prefix, int prefixLength) - { - if (prefixLength < 0) - { - return false; - } - - return prefix.AddressFamily switch - { - AddressFamily.InterNetwork => prefixLength <= 32, - AddressFamily.InterNetworkV6 => prefixLength <= 128, - _ => true - }; - } + public bool Contains(IPAddress address) => _network.Contains(address); - /// - /// Converts the specified of representation of - /// an IP address and a prefix length to its equivalent. - /// - /// The of to convert, in CIDR notation. - /// - ///The equivalent to the IP address and prefix length contained in . - /// - /// is not in the correct format. - /// The prefix length contained in is out of range. - /// - public static IPNetwork Parse(ReadOnlySpan networkSpan) - { - if (!TryParseComponents(networkSpan, out var prefix, out var prefixLength)) - { - throw new FormatException("An invalid IP address or prefix length was specified."); - } - - if (!IsValidPrefixLengthRange(prefix, prefixLength)) - { - throw new ArgumentOutOfRangeException(nameof(networkSpan), "The prefix length was out of range."); - } + /// + public static IPNetwork Parse(ReadOnlySpan networkSpan) => new(System.Net.IPNetwork.Parse(networkSpan)); - return new IPNetwork(prefix, prefixLength, false); - } - - /// - /// Converts the specified of representation of - /// an IP address and a prefix length to its equivalent, and returns a value - /// that indicates whether the conversion succeeded. - /// - /// The of to validate. - /// - /// When this method returns, contains the equivalent to the IP Address - /// and prefix length contained in , if the conversion succeeded, - /// or if the conversion failed. This parameter is passed uninitialized. - /// - /// - /// if the parameter was - /// converted successfully; otherwise . - /// - /// + /// public static bool TryParse(ReadOnlySpan networkSpan, [NotNullWhen(true)] out IPNetwork? network) { - network = null; - - if (!TryParseComponents(networkSpan, out var prefix, out var prefixLength)) + if (System.Net.IPNetwork.TryParse(networkSpan, out var ipNetwork)) { - return false; + network = new(ipNetwork); + return true; } - if (!IsValidPrefixLengthRange(prefix, prefixLength)) - { - return false; - } - - network = new IPNetwork(prefix, prefixLength, false); - return true; - } - - /// - /// - /// The specified representation must be expressed using CIDR (Classless Inter-Domain Routing) notation, or 'slash notation', - /// which contains an IPv4 or IPv6 address and the subnet mask prefix length, separated by a forward slash. - /// - /// - /// e.g. "192.168.0.1/31" for IPv4, "2001:db8:3c4d::1/127" for IPv6 - /// - /// - private static bool TryParseComponents( - ReadOnlySpan networkSpan, - [NotNullWhen(true)] out IPAddress? prefix, - out int prefixLength) - { - prefix = null; - prefixLength = default; - - var forwardSlashIndex = networkSpan.IndexOf('/'); - if (forwardSlashIndex < 0) - { - return false; - } - - if (!IPAddress.TryParse(networkSpan.Slice(0, forwardSlashIndex), out prefix)) - { - return false; - } - - if (!int.TryParse(networkSpan.Slice(forwardSlashIndex + 1), out prefixLength)) - { - return false; - } - - return true; + network = null; + return false; } } diff --git a/src/Middleware/HttpOverrides/src/PublicAPI.Unshipped.txt b/src/Middleware/HttpOverrides/src/PublicAPI.Unshipped.txt index 7dc5c58110bf..a8a1a579461f 100644 --- a/src/Middleware/HttpOverrides/src/PublicAPI.Unshipped.txt +++ b/src/Middleware/HttpOverrides/src/PublicAPI.Unshipped.txt @@ -1 +1,3 @@ #nullable enable +*REMOVED*Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.KnownNetworks.get -> System.Collections.Generic.IList! +Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.KnownNetworks.get -> System.Collections.Generic.IList! diff --git a/src/Middleware/HttpOverrides/test/ForwardedHeadersMiddlewareTest.cs b/src/Middleware/HttpOverrides/test/ForwardedHeadersMiddlewareTest.cs index 4fd1341acc45..69dc2e6dd9aa 100644 --- a/src/Middleware/HttpOverrides/test/ForwardedHeadersMiddlewareTest.cs +++ b/src/Middleware/HttpOverrides/test/ForwardedHeadersMiddlewareTest.cs @@ -1092,7 +1092,7 @@ public async Task XForwardForIPv4ToIPv6Mapping(string forHeader, string knownPro var knownNetworkParts = knownNetwork.Split('/'); var networkIp = IPAddress.Parse(knownNetworkParts[0]); var prefixLength = int.Parse(knownNetworkParts[1], CultureInfo.InvariantCulture); - options.KnownNetworks.Add(new IPNetwork(networkIp, prefixLength)); + options.KnownNetworks.Add(new System.Net.IPNetwork(networkIp, prefixLength)); } using var host = new HostBuilder() diff --git a/src/Middleware/HttpOverrides/test/IPNetworkTest.cs b/src/Middleware/HttpOverrides/test/IPNetworkTest.cs index c8f33f7a333b..9538f121c550 100644 --- a/src/Middleware/HttpOverrides/test/IPNetworkTest.cs +++ b/src/Middleware/HttpOverrides/test/IPNetworkTest.cs @@ -4,6 +4,7 @@ namespace Microsoft.AspNetCore.HttpOverrides; +[System.Obsolete] public class IPNetworkTest { [Theory]