ExternalPortForwarding.cs 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. #nullable disable
  2. #pragma warning disable CS1591
  3. using System;
  4. using System.Collections.Concurrent;
  5. using System.Collections.Generic;
  6. using System.Net;
  7. using System.Text;
  8. using System.Threading;
  9. using System.Threading.Tasks;
  10. using Jellyfin.Networking.Configuration;
  11. using MediaBrowser.Controller;
  12. using MediaBrowser.Controller.Configuration;
  13. using MediaBrowser.Controller.Plugins;
  14. using MediaBrowser.Model.Dlna;
  15. using Microsoft.Extensions.Logging;
  16. using Mono.Nat;
  17. namespace Emby.Server.Implementations.EntryPoints
  18. {
  19. /// <summary>
  20. /// Server entrypoint handling external port forwarding.
  21. /// </summary>
  22. public class ExternalPortForwarding : IServerEntryPoint
  23. {
  24. private readonly IServerApplicationHost _appHost;
  25. private readonly ILogger<ExternalPortForwarding> _logger;
  26. private readonly IServerConfigurationManager _config;
  27. private readonly ConcurrentDictionary<IPEndPoint, byte> _createdRules = new ConcurrentDictionary<IPEndPoint, byte>();
  28. private Timer _timer;
  29. private string _configIdentifier;
  30. private bool _disposed = false;
  31. /// <summary>
  32. /// Initializes a new instance of the <see cref="ExternalPortForwarding"/> class.
  33. /// </summary>
  34. /// <param name="logger">The logger.</param>
  35. /// <param name="appHost">The application host.</param>
  36. /// <param name="config">The configuration manager.</param>
  37. public ExternalPortForwarding(
  38. ILogger<ExternalPortForwarding> logger,
  39. IServerApplicationHost appHost,
  40. IServerConfigurationManager config)
  41. {
  42. _logger = logger;
  43. _appHost = appHost;
  44. _config = config;
  45. }
  46. private string GetConfigIdentifier()
  47. {
  48. const char Separator = '|';
  49. var config = _config.GetNetworkConfiguration();
  50. return new StringBuilder(32)
  51. .Append(config.EnableUPnP).Append(Separator)
  52. .Append(config.PublicPort).Append(Separator)
  53. .Append(config.PublicHttpsPort).Append(Separator)
  54. .Append(_appHost.HttpPort).Append(Separator)
  55. .Append(_appHost.HttpsPort).Append(Separator)
  56. .Append(_appHost.ListenWithHttps).Append(Separator)
  57. .Append(config.EnableRemoteAccess).Append(Separator)
  58. .ToString();
  59. }
  60. private void OnConfigurationUpdated(object sender, EventArgs e)
  61. {
  62. var oldConfigIdentifier = _configIdentifier;
  63. _configIdentifier = GetConfigIdentifier();
  64. if (!string.Equals(_configIdentifier, oldConfigIdentifier, StringComparison.OrdinalIgnoreCase))
  65. {
  66. Stop();
  67. Start();
  68. }
  69. }
  70. /// <inheritdoc />
  71. public Task RunAsync()
  72. {
  73. Start();
  74. _config.ConfigurationUpdated += OnConfigurationUpdated;
  75. return Task.CompletedTask;
  76. }
  77. private void Start()
  78. {
  79. var config = _config.GetNetworkConfiguration();
  80. if (!config.EnableUPnP || !config.EnableRemoteAccess)
  81. {
  82. return;
  83. }
  84. _logger.LogInformation("Starting NAT discovery");
  85. NatUtility.DeviceFound += OnNatUtilityDeviceFound;
  86. NatUtility.StartDiscovery();
  87. _timer = new Timer((_) => _createdRules.Clear(), null, TimeSpan.FromMinutes(10), TimeSpan.FromMinutes(10));
  88. }
  89. private void Stop()
  90. {
  91. _logger.LogInformation("Stopping NAT discovery");
  92. NatUtility.StopDiscovery();
  93. NatUtility.DeviceFound -= OnNatUtilityDeviceFound;
  94. _timer?.Dispose();
  95. }
  96. private async void OnNatUtilityDeviceFound(object sender, DeviceEventArgs e)
  97. {
  98. try
  99. {
  100. await CreateRules(e.Device).ConfigureAwait(false);
  101. }
  102. catch (Exception ex)
  103. {
  104. _logger.LogError(ex, "Error creating port forwarding rules");
  105. }
  106. }
  107. private Task CreateRules(INatDevice device)
  108. {
  109. if (_disposed)
  110. {
  111. throw new ObjectDisposedException(GetType().Name);
  112. }
  113. // On some systems the device discovered event seems to fire repeatedly
  114. // This check will help ensure we're not trying to port map the same device over and over
  115. if (!_createdRules.TryAdd(device.DeviceEndpoint, 0))
  116. {
  117. return Task.CompletedTask;
  118. }
  119. return Task.WhenAll(CreatePortMaps(device));
  120. }
  121. private IEnumerable<Task> CreatePortMaps(INatDevice device)
  122. {
  123. var config = _config.GetNetworkConfiguration();
  124. yield return CreatePortMap(device, _appHost.HttpPort, config.PublicPort);
  125. if (_appHost.ListenWithHttps)
  126. {
  127. yield return CreatePortMap(device, _appHost.HttpsPort, config.PublicHttpsPort);
  128. }
  129. }
  130. private async Task CreatePortMap(INatDevice device, int privatePort, int publicPort)
  131. {
  132. _logger.LogDebug(
  133. "Creating port map on local port {LocalPort} to public port {PublicPort} with device {DeviceEndpoint}",
  134. privatePort,
  135. publicPort,
  136. device.DeviceEndpoint);
  137. try
  138. {
  139. var mapping = new Mapping(Protocol.Tcp, privatePort, publicPort, 0, _appHost.Name);
  140. await device.CreatePortMapAsync(mapping).ConfigureAwait(false);
  141. }
  142. catch (Exception ex)
  143. {
  144. _logger.LogError(
  145. ex,
  146. "Error creating port map on local port {LocalPort} to public port {PublicPort} with device {DeviceEndpoint}.",
  147. privatePort,
  148. publicPort,
  149. device.DeviceEndpoint);
  150. }
  151. }
  152. /// <inheritdoc />
  153. public void Dispose()
  154. {
  155. Dispose(true);
  156. GC.SuppressFinalize(this);
  157. }
  158. /// <summary>
  159. /// Releases unmanaged and - optionally - managed resources.
  160. /// </summary>
  161. /// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  162. protected virtual void Dispose(bool dispose)
  163. {
  164. if (_disposed)
  165. {
  166. return;
  167. }
  168. _config.ConfigurationUpdated -= OnConfigurationUpdated;
  169. Stop();
  170. _timer = null;
  171. _disposed = true;
  172. }
  173. }
  174. }