Cutlery/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2025-05-24 02:02:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

Move network utilities to MediaBrowser.Common

Browse Source
This commit is contained in:
Patrick Barron 2023-11-10 10:59:45 -05:00
parent 223b156270
commit 9595636d61
7 changed files with 37 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Emby.Dlna/Main/DlnaHost.cs
View File

@ -10,7 +10,6 @@ using System.Threading.Tasks;
using Emby.Dlna.PlayTo;
using Emby.Dlna.Ssdp;
using Jellyfin.Networking.Configuration;
using Jellyfin.Networking.Extensions;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Extensions;
using MediaBrowser.Common.Net;
@ -280,7 +279,7 @@ public sealed class DlnaHost : IHostedService, IDisposable
CacheLifetime = TimeSpan.FromSeconds(1800), // How long SSDP clients can cache this info.
Location = uri.Uri, // Must point to the URL that serves your devices UPnP description document.
Address = intf.Address,
PrefixLength = NetworkExtensions.MaskToCidr(intf.Subnet.Prefix),
PrefixLength = NetworkUtils.MaskToCidr(intf.Subnet.Prefix),
FriendlyName = "Jellyfin",
Manufacturer = "Jellyfin",
ModelName = "Jellyfin Server",

3
Emby.Server.Implementations/EntryPoints/UdpServerEntryPoint.cs
View File

@ -7,7 +7,6 @@ using System.Threading;
using System.Threading.Tasks;
using Emby.Server.Implementations.Udp;
using Jellyfin.Networking.Configuration;
using Jellyfin.Networking.Extensions;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Net;
using MediaBrowser.Controller;
@ -92,7 +91,7 @@ namespace Emby.Server.Implementations.EntryPoints
var validInterfaces = _networkManager.GetInternalBindAddresses().Where(i => i.AddressFamily == AddressFamily.InterNetwork);
foreach (var intf in validInterfaces)
{
var broadcastAddress = NetworkExtensions.GetBroadcastAddress(intf.Subnet);
var broadcastAddress = NetworkUtils.GetBroadcastAddress(intf.Subnet);
_logger.LogDebug("Binding UDP server to {Address} on port {PortNumber}", broadcastAddress, PortNumber);
server = new UdpServer(_logger, _appHost, _config, broadcastAddress, PortNumber);

33
Jellyfin.Networking/Manager/NetworkManager.cs
View File

@ -8,7 +8,6 @@ using System.Net.NetworkInformation;
using System.Net.Sockets;
using System.Threading;
using Jellyfin.Networking.Configuration;
using Jellyfin.Networking.Extensions;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Net;
using MediaBrowser.Model.Net;
@ -318,7 +317,7 @@ namespace Jellyfin.Networking.Manager
var subnets = config.LocalNetworkSubnets;
// If no LAN addresses are specified, all private subnets and Loopback are deemed to be the LAN
if (!NetworkExtensions.TryParseToSubnets(subnets, out var lanSubnets, false) || lanSubnets.Count == 0)
if (!NetworkUtils.TryParseToSubnets(subnets, out var lanSubnets, false) || lanSubnets.Count == 0)
{
_logger.LogDebug("Using LAN interface addresses as user provided no LAN details.");
@ -345,7 +344,7 @@ namespace Jellyfin.Networking.Manager
_lanSubnets = lanSubnets;
}
_excludedSubnets = NetworkExtensions.TryParseToSubnets(subnets, out var excludedSubnets, true)
_excludedSubnets = NetworkUtils.TryParseToSubnets(subnets, out var excludedSubnets, true)
? excludedSubnets
: new List<IPNetwork>();
}
@ -363,7 +362,7 @@ namespace Jellyfin.Networking.Manager
var localNetworkAddresses = config.LocalNetworkAddresses;
if (localNetworkAddresses.Length > 0 && !string.IsNullOrWhiteSpace(localNetworkAddresses[0]))
{
var bindAddresses = localNetworkAddresses.Select(p => NetworkExtensions.TryParseToSubnet(p, out var network)
var bindAddresses = localNetworkAddresses.Select(p => NetworkUtils.TryParseToSubnet(p, out var network)
? network.Prefix
: (interfaces.Where(x => x.Name.Equals(p, StringComparison.OrdinalIgnoreCase))
.Select(x => x.Address)
@ -430,7 +429,7 @@ namespace Jellyfin.Networking.Manager
// Parse all IPs with netmask to a subnet
var remoteAddressFilter = new List<IPNetwork>();
var remoteFilteredSubnets = remoteIPFilter.Where(x => x.Contains('/', StringComparison.OrdinalIgnoreCase)).ToArray();
if (NetworkExtensions.TryParseToSubnets(remoteFilteredSubnets, out var remoteAddressFilterResult, false))
if (NetworkUtils.TryParseToSubnets(remoteFilteredSubnets, out var remoteAddressFilterResult, false))
{
remoteAddressFilter = remoteAddressFilterResult.ToList();
}
@ -541,7 +540,7 @@ namespace Jellyfin.Networking.Manager
false));
}
}
else if (NetworkExtensions.TryParseToSubnet(identifier, out var result) && result is not null)
else if (NetworkUtils.TryParseToSubnet(identifier, out var result) && result is not null)
{
var data = new IPData(result.Prefix, result);
publishedServerUrls.Add(
@ -607,7 +606,7 @@ namespace Jellyfin.Networking.Manager
foreach (var details in interfaceList)
{
var parts = details.Split(',');
if (NetworkExtensions.TryParseToSubnet(parts[0], out var subnet))
if (NetworkUtils.TryParseToSubnet(parts[0], out var subnet))
{
var address = subnet.Prefix;
var index = int.Parse(parts[1], CultureInfo.InvariantCulture);
@ -771,7 +770,7 @@ namespace Jellyfin.Networking.Manager
/// <inheritdoc/>
public string GetBindAddress(string source, out int? port)
{
if (!NetworkExtensions.TryParseHost(source, out var addresses, IsIPv4Enabled, IsIPv6Enabled))
if (!NetworkUtils.TryParseHost(source, out var addresses, IsIPv4Enabled, IsIPv6Enabled))
{
addresses = Array.Empty<IPAddress>();
}
@ -846,7 +845,7 @@ namespace Jellyfin.Networking.Manager
// If no source address is given, use the preferred (first) interface
if (source is null)
{
result = NetworkExtensions.FormatIPString(availableInterfaces.First().Address);
result = NetworkUtils.FormatIPString(availableInterfaces.First().Address);
_logger.LogDebug("{Source}: Using first internal interface as bind address: {Result}", source, result);
return result;
}
@ -857,14 +856,14 @@ namespace Jellyfin.Networking.Manager
{
if (intf.Subnet.Contains(source))
{
result = NetworkExtensions.FormatIPString(intf.Address);
result = NetworkUtils.FormatIPString(intf.Address);
_logger.LogDebug("{Source}: Found interface with matching subnet, using it as bind address: {Result}", source, result);
return result;
}
}
// Fallback to first available interface
result = NetworkExtensions.FormatIPString(availableInterfaces[0].Address);
result = NetworkUtils.FormatIPString(availableInterfaces[0].Address);
_logger.LogDebug("{Source}: No matching interfaces found, using preferred interface as bind address: {Result}", source, result);
return result;
}
@ -881,12 +880,12 @@ namespace Jellyfin.Networking.Manager
/// <inheritdoc/>
public bool IsInLocalNetwork(string address)
{
if (NetworkExtensions.TryParseToSubnet(address, out var subnet))
if (NetworkUtils.TryParseToSubnet(address, out var subnet))
{
return IPAddress.IsLoopback(subnet.Prefix) || (_lanSubnets.Any(x => x.Contains(subnet.Prefix)) && !_excludedSubnets.Any(x => x.Contains(subnet.Prefix)));
}
if (NetworkExtensions.TryParseHost(address, out var addresses, IsIPv4Enabled, IsIPv6Enabled))
if (NetworkUtils.TryParseHost(address, out var addresses, IsIPv4Enabled, IsIPv6Enabled))
{
foreach (var ept in addresses)
{
@ -1044,7 +1043,7 @@ namespace Jellyfin.Networking.Manager
.Select(x => x.Address)
.First();
result = NetworkExtensions.FormatIPString(bindAddress);
result = NetworkUtils.FormatIPString(bindAddress);
_logger.LogDebug("{Source}: External request received, matching external bind address found: {Result}", source, result);
return true;
}
@ -1063,7 +1062,7 @@ namespace Jellyfin.Networking.Manager
if (bindAddress is not null)
{
result = NetworkExtensions.FormatIPString(bindAddress);
result = NetworkUtils.FormatIPString(bindAddress);
_logger.LogDebug("{Source}: Internal request received, matching internal bind address found: {Result}", source, result);
return true;
}
@ -1097,14 +1096,14 @@ namespace Jellyfin.Networking.Manager
{
if (intf.Subnet.Contains(source))
{
result = NetworkExtensions.FormatIPString(intf.Address);
result = NetworkUtils.FormatIPString(intf.Address);
_logger.LogDebug("{Source}: Found external interface with matching subnet, using it as bind address: {Result}", source, result);
return true;
}
}
// Fallback to first external interface.
result = NetworkExtensions.FormatIPString(extResult[0].Address);
result = NetworkUtils.FormatIPString(extResult[0].Address);
_logger.LogDebug("{Source}: Using first external interface as bind address: {Result}", source, result);
return true;
}

5
Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs
View File

@ -21,7 +21,6 @@ using Jellyfin.Api.ModelBinders;
using Jellyfin.Data.Enums;
using Jellyfin.Extensions.Json;
using Jellyfin.Networking.Configuration;
using Jellyfin.Networking.Extensions;
using Jellyfin.Server.Configuration;
using Jellyfin.Server.Filters;
using MediaBrowser.Common.Net;
@ -277,14 +276,14 @@ namespace Jellyfin.Server.Extensions
{
AddIPAddress(config, options, addr, addr.AddressFamily == AddressFamily.InterNetwork ? NetworkConstants.MinimumIPv4PrefixSize : NetworkConstants.MinimumIPv6PrefixSize);
}
else if (NetworkExtensions.TryParseToSubnet(allowedProxies[i], out var subnet))
else if (NetworkUtils.TryParseToSubnet(allowedProxies[i], out var subnet))
{
if (subnet is not null)
{
AddIPAddress(config, options, subnet.Prefix, subnet.PrefixLength);
}
}
else if (NetworkExtensions.TryParseHost(allowedProxies[i], out var addresses, config.EnableIPv4, config.EnableIPv6))
else if (NetworkUtils.TryParseHost(allowedProxies[i], out var addresses, config.EnableIPv4, config.EnableIPv6))
{
foreach (var address in addresses)
{

9
Jellyfin.Networking/Extensions/NetworkExtensions.cs → MediaBrowser.Common/Net/NetworkUtils.cs
View File

@ -5,15 +5,14 @@ using System.Net;
using System.Net.Sockets;
using System.Text.RegularExpressions;
using Jellyfin.Extensions;
using MediaBrowser.Common.Net;
using Microsoft.AspNetCore.HttpOverrides;
namespace Jellyfin.Networking.Extensions;
namespace MediaBrowser.Common.Net;
/// <summary>
/// Defines the <see cref="NetworkExtensions" />.
/// Defines the <see cref="NetworkUtils" />.
/// </summary>
public static partial class NetworkExtensions
public static partial class NetworkUtils
{
// Use regular expression as CheckHostName isn't RFC5892 compliant.
// Modified from gSkinner's expression at https://stackoverflow.com/questions/11809631/fully-qualified-domain-name-validation
@ -224,7 +223,7 @@ public static partial class NetworkExtensions
}
else if (IPAddress.TryParse(subnetBlock, out var netmaskAddress))
{
result = new IPNetwork(address, NetworkExtensions.MaskToCidr(netmaskAddress));
result = new IPNetwork(address, NetworkUtils.MaskToCidr(netmaskAddress));
return true;
}
}

10
tests/Jellyfin.Networking.Tests/NetworkExtensionsTests.cs
View File

@ -1,6 +1,6 @@
using FsCheck;
using FsCheck.Xunit;
using Jellyfin.Networking.Extensions;
using MediaBrowser.Common.Net;
using Xunit;
namespace Jellyfin.Networking.Tests
@ -26,15 +26,15 @@ namespace Jellyfin.Networking.Tests
[InlineData("192.168.1.2/255.255.255.0")]
[InlineData("192.168.1.2/24")]
public static void TryParse_ValidHostStrings_True(string address)
=> Assert.True(NetworkExtensions.TryParseHost(address, out _, true, true));
=> Assert.True(NetworkUtils.TryParseHost(address, out _, true, true));
[Property]
public static Property TryParse_IPv4Address_True(IPv4Address address)
=> NetworkExtensions.TryParseHost(address.Item.ToString(), out _, true, true).ToProperty();
=> NetworkUtils.TryParseHost(address.Item.ToString(), out _, true, true).ToProperty();
[Property]
public static Property TryParse_IPv6Address_True(IPv6Address address)
=> NetworkExtensions.TryParseHost(address.Item.ToString(), out _, true, true).ToProperty();
=> NetworkUtils.TryParseHost(address.Item.ToString(), out _, true, true).ToProperty();
/// <summary>
/// All should be invalid address strings.
@ -47,6 +47,6 @@ namespace Jellyfin.Networking.Tests
[InlineData("fd23:184f:2029:0:3139:7386:67d7:d517:1231")]
[InlineData("[fd23:184f:2029:0:3139:7386:67d7:d517:1231]")]
public static void TryParse_InvalidAddressString_False(string address)
=> Assert.False(NetworkExtensions.TryParseHost(address, out _, true, true));
=> Assert.False(NetworkUtils.TryParseHost(address, out _, true, true));
}
}

16
tests/Jellyfin.Networking.Tests/NetworkParseTests.cs
View File

@ -3,9 +3,9 @@ using System.Collections.Generic;
using System.Linq;
using System.Net;
using Jellyfin.Networking.Configuration;
using Jellyfin.Networking.Extensions;
using Jellyfin.Networking.Manager;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Net;
using MediaBrowser.Model.Net;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging.Abstractions;
@ -80,7 +80,7 @@ namespace Jellyfin.Networking.Tests
[InlineData("[fe80::7add:12ff:febb:c67b%16]")]
[InlineData("fd23:184f:2029:0:3139:7386:67d7:d517/56")]
public static void TryParseValidIPStringsTrue(string address)
=> Assert.True(NetworkExtensions.TryParseToSubnet(address, out _));
=> Assert.True(NetworkUtils.TryParseToSubnet(address, out _));
/// <summary>
/// Checks invalid IP address formats.
@ -93,7 +93,7 @@ namespace Jellyfin.Networking.Tests
[InlineData("fd23:184f:2029:0:3139:7386:67d7:d517:1231")]
[InlineData("[fd23:184f:2029:0:3139:7386:67d7:d517:1231]")]
public static void TryParseInvalidIPStringsFalse(string address)
=> Assert.False(NetworkExtensions.TryParseToSubnet(address, out _));
=> Assert.False(NetworkUtils.TryParseToSubnet(address, out _));
/// <summary>
/// Checks if IPv4 address is within a defined subnet.
@ -113,7 +113,7 @@ namespace Jellyfin.Networking.Tests
public void IPv4SubnetMaskMatchesValidIPAddress(string netMask, string ipAddress)
{
var ipa = IPAddress.Parse(ipAddress);
Assert.True(NetworkExtensions.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
Assert.True(NetworkUtils.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
}
/// <summary>
@ -133,7 +133,7 @@ namespace Jellyfin.Networking.Tests
public void IPv4SubnetMaskDoesNotMatchInvalidIPAddress(string netMask, string ipAddress)
{
var ipa = IPAddress.Parse(ipAddress);
Assert.False(NetworkExtensions.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
Assert.False(NetworkUtils.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
}
/// <summary>
@ -149,7 +149,7 @@ namespace Jellyfin.Networking.Tests
[InlineData("2001:db8:abcd:0012::0/128", "2001:0DB8:ABCD:0012:0000:0000:0000:0000")]
public void IPv6SubnetMaskMatchesValidIPAddress(string netMask, string ipAddress)
{
Assert.True(NetworkExtensions.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
Assert.True(NetworkUtils.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
}
[Theory]
@ -160,7 +160,7 @@ namespace Jellyfin.Networking.Tests
[InlineData("2001:db8:abcd:0012::0/128", "2001:0DB8:ABCD:0012:0000:0000:0000:0001")]
public void IPv6SubnetMaskDoesNotMatchInvalidIPAddress(string netMask, string ipAddress)
{
Assert.False(NetworkExtensions.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
Assert.False(NetworkUtils.TryParseToSubnet(netMask, out var subnet) && subnet.Contains(IPAddress.Parse(ipAddress)));
}
[Theory]
@ -207,7 +207,7 @@ namespace Jellyfin.Networking.Tests
NetworkManager.MockNetworkSettings = string.Empty;
// Check to see if DNS resolution is working. If not, skip test.
if (!NetworkExtensions.TryParseHost(source, out var host))
if (!NetworkUtils.TryParseHost(source, out var host))
{
return;
}