Change Reconfig Behaviour

CHANGELOG.md

@@ -1,3 +1,8 @@
+# Upcoming
+
+### Developer
+* Update: Move VpnHood.Client.WebUI to a standalone repo
+
 # v2.4.299
 ### Client
 * Fix: Windows: Installation Package

VpnHood.Client/ClientOptions.cs

@@ -3,34 +3,33 @@
 using VpnHood.Common.Net;
 using VpnHood.Tunneling.Factory;
 
-namespace VpnHood.Client
+namespace VpnHood.Client;
+
+public class ClientOptions
 {
-    public class ClientOptions
-    {
-        /// <summary>
-        ///     a never used IPv4 that must be outside the local network
-        /// </summary>
-        public IPAddress TcpProxyLoopbackAddressIpV4 { get; set; } = IPAddress.Parse("11.0.0.0");
-        /// <summary>
-        ///     a never used IPv6 ip that must be outside the machine
-        /// </summary>
-        public IPAddress TcpProxyLoopbackAddressIpV6 { get; set; } = IPAddress.Parse("2000::");
+    /// <summary>
+    ///     a never used IPv4 that must be outside the local network
+    /// </summary>
+    public IPAddress TcpProxyLoopbackAddressIpV4 { get; set; } = IPAddress.Parse("11.0.0.0");
+    /// <summary>
+    ///     a never used IPv6 ip that must be outside the machine
+    /// </summary>
+    public IPAddress TcpProxyLoopbackAddressIpV6 { get; set; } = IPAddress.Parse("2000::");
 
-        public IPAddress[] DnsServers { get; set; } = { IPAddress.Parse("8.8.8.8"), IPAddress.Parse("8.8.4.4"), 
-            IPAddress.Parse("2001:4860:4860::8888"), IPAddress.Parse("2001:4860:4860::8844") };
-        public bool AutoDisposePacketCapture { get; set; } = true;
-        public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(60);
-        public Version Version { get; set; } = typeof(ClientOptions).Assembly.GetName().Version;
-        public bool UseUdpChannel { get; set; } = false;
-        public bool ExcludeLocalNetwork { get; set; } = true;
-        public IpRange[]? IncludeIpRanges { get; set; }
-        public IpRange[]? PacketCaptureIncludeIpRanges { get; set; }
-        public SocketFactory SocketFactory { get; set; } = new();
-        public int MaxDatagramChannelCount { get; set; } = 4;
-        public string UserAgent { get; set; } = Environment.OSVersion.ToString();
+    public IPAddress[] DnsServers { get; set; } = { IPAddress.Parse("8.8.8.8"), IPAddress.Parse("8.8.4.4"), 
+        IPAddress.Parse("2001:4860:4860::8888"), IPAddress.Parse("2001:4860:4860::8844") };
+    public bool AutoDisposePacketCapture { get; set; } = true;
+    public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(60);
+    public Version Version { get; set; } = typeof(ClientOptions).Assembly.GetName().Version;
+    public bool UseUdpChannel { get; set; } = false;
+    public bool ExcludeLocalNetwork { get; set; } = true;
+    public IpRange[]? IncludeIpRanges { get; set; }
+    public IpRange[]? PacketCaptureIncludeIpRanges { get; set; }
+    public SocketFactory SocketFactory { get; set; } = new();
+    public int MaxDatagramChannelCount { get; set; } = 4;
+    public string UserAgent { get; set; } = Environment.OSVersion.ToString();
 
 #if  DEBUG
-        public int ProtocolVersion { get; set; }
+    public int ProtocolVersion { get; set; }
 #endif
-    }
 }

VpnHood.Server.Access/AccessServers/FileAccessServer.cs

@@ -53,7 +53,7 @@ public FileAccessServer(string storagePath, FileAccessServerOptions options)
     public Task<ServerCommand> Server_UpdateStatus(ServerStatus serverStatus)
     {
         ServerStatus = serverStatus;
-        return Task.FromResult(new ServerCommand());
+        return Task.FromResult(new ServerCommand(ServerConfig.ConfigCode));
     }
 
     public Task<ServerConfig> Server_Configure(ServerInfo serverInfo)

VpnHood.Server.Access/AccessServers/FileAccessServerOptions.cs

@@ -1,13 +1,15 @@
-using System.Net;
+using System;
+using System.Net;
 
 namespace VpnHood.Server.AccessServers
 {
     public class FileAccessServerOptions : ServerConfig
     {
         public FileAccessServerOptions()
-            : base(new IPEndPoint[] { new(IPAddress.Any, 443), new(IPAddress.IPv6Any, 443) } )
+            : base(new IPEndPoint[] { new(IPAddress.Any, 443), new(IPAddress.IPv6Any, 443) }, Guid.Empty.ToString())
         {
         }
+
         public string? SslCertificatesPassword { get; set; }
     }
 }

VpnHood.Server.Access/ServerCommand.cs

@@ -4,6 +4,11 @@ namespace VpnHood.Server
 {
     public class ServerCommand
     {
-        public Guid? ConfigCode { get; set; }
+        public string ConfigCode { get; set; }
+
+        public ServerCommand(string configCode)
+        {
+            ConfigCode = configCode;
+        }
     }
 }

VpnHood.Server.Access/ServerConfig.cs

@@ -10,16 +10,18 @@ public class ServerConfig
         public TrackingOptions TrackingOptions { get; set; } = new();
         public SessionOptions SessionOptions { get; set; } = new();
         public int UdpPort { get; set; }
+        public string ConfigCode { get; set; }
 
         [JsonConverter(typeof(ArrayConverter<IPEndPoint, IPEndPointConverter>))]
         public IPEndPoint[] TcpEndPoints { get; set; }
 
         [JsonConverter(typeof(TimeSpanConverter))]
         public TimeSpan UpdateStatusInterval { get; set; } = TimeSpan.FromSeconds(120);
 
-        public ServerConfig(IPEndPoint[] tcpEndPoints)
+        public ServerConfig(IPEndPoint[] tcpEndPoints, string configCode)
         {
             TcpEndPoints = tcpEndPoints;
+            ConfigCode = configCode;
         }
     }
 }

VpnHood.Server.Access/ServerInfo.cs

@@ -5,7 +5,6 @@
 
 namespace VpnHood.Server
 {
-
     public class ServerInfo
     {
         [JsonConstructor]
@@ -38,7 +37,6 @@ public ServerInfo(Version version,
         public string? OsVersion { get; set; }
         public long TotalMemory { get; set; }
         public string? MachineName { get; set; }
-        public Guid? ConfigCode { get; set; }
         public string? LastError { get; set; }
     }
 }

VpnHood.Server.Access/ServerStatus.cs

@@ -10,5 +10,6 @@ public class ServerStatus
         public int ThreadCount { get; set; }
         public long TunnelSendSpeed { get; set; }
         public long TunnelReceiveSpeed { get; set; }
+        public string ConfigCode { get; set; } = default!;
     }
 }

VpnHood.Server/VpnHoodServer.cs

@@ -24,6 +24,7 @@ public class VpnHoodServer : IDisposable
         private Timer? _updateStatusTimer;
         private bool _disposed;
         private string? _lastConfigError;
+        private string _lastConfigCode = "";
 
         public VpnHoodServer(IAccessServer accessServer, ServerOptions options)
         {
@@ -113,7 +114,7 @@ public async Task Start()
             await Configure();
         }
 
-        private async Task Configure(Guid? configurationCode = null)
+        private async Task Configure()
         {
             if (_tcpHost.IsDisposed)
                 throw new ObjectDisposedException($"Could not configure after disposing {nameof(TcpHost)}!");
@@ -139,7 +140,6 @@ private async Task Configure(Guid? configurationCode = null)
                     OsInfo = SystemInfoProvider.GetOperatingSystemInfo(),
                     OsVersion = Environment.OSVersion.ToString(),
                     TotalMemory = SystemInfoProvider.GetSystemInfo().TotalMemory,
-                    ConfigCode = configurationCode,
                     LastError = _lastConfigError
                 };
 
@@ -152,6 +152,7 @@ private async Task Configure(Guid? configurationCode = null)
                 _tcpHost.OrgStreamReadBufferSize = serverConfig.SessionOptions.TcpBufferSize;
                 _tcpHost.TunnelStreamReadBufferSize = serverConfig.SessionOptions.TcpBufferSize;
                 _tcpHost.TcpTimeout = serverConfig.SessionOptions.TcpTimeout;
+                _lastConfigCode = serverConfig.ConfigCode;
 
                 // starting the listeners
                 var verb = _tcpHost.IsStarted ? "Restarting" : "Starting";
@@ -228,32 +229,31 @@ public ServerStatus Status
                     FreeMemory = systemInfo.FreeMemory,
                     UsedMemory = Process.GetCurrentProcess().WorkingSet64,
                     TunnelSendSpeed = SessionManager.Sessions.Sum(x => x.Value.Tunnel.SendSpeed),
-                    TunnelReceiveSpeed = SessionManager.Sessions.Sum(x => x.Value.Tunnel.ReceiveSpeed)
+                    TunnelReceiveSpeed = SessionManager.Sessions.Sum(x => x.Value.Tunnel.ReceiveSpeed),
+                    ConfigCode = _lastConfigCode
                 };
                 return serverStatus;
             }
         }
 
         private async Task SendStatusToAccessServer()
         {
-            Guid? configurationCode = null;
             try
             {
                 VhLogger.Instance.LogTrace("Sending status to AccessServer...");
                 var res = await AccessServer.Server_UpdateStatus(Status);
-                configurationCode = res.ConfigCode;
+
+                // reconfigure
+                if (res.ConfigCode != _lastConfigCode)
+                {
+                    VhLogger.Instance.LogInformation("Reconfiguration was requested.");
+                    _ = Configure();
+                }
             }
             catch (Exception ex)
             {
                 VhLogger.Instance.LogError(ex, "Could not send server status.");
             }
-
-            // reconfigure
-            if (configurationCode != null)
-            {
-                VhLogger.Instance.LogInformation("Reconfiguration was requested.");
-                _ = Configure(configurationCode);
-            }
         }
     }
 }

VpnHood.ZTest/TestAccessServer.cs

@@ -21,6 +21,8 @@ public TestAccessServer(IAccessServer baseAccessServer)
         }
 
         public DateTime? LastConfigureTime { get; private set; }
+        public ServerInfo? LastServerInfo { get; private set; }
+        public ServerStatus? LastServerStatus { get; private set; }
 
         public TestEmbedIoAccessServer EmbedIoAccessServer { get; }
         public IAccessServer BaseAccessServer { get; }
@@ -32,15 +34,15 @@ public TestAccessServer(IAccessServer baseAccessServer)
         public async Task<ServerCommand> Server_UpdateStatus(ServerStatus serverStatus)
         {
             var ret = await  _restAccessServer.Server_UpdateStatus(serverStatus);
-            ret.ConfigCode = ConfigCode;
+            LastServerStatus = serverStatus;
             return ret;
         }
 
         public Task<ServerConfig> Server_Configure(ServerInfo serverInfo)
         {
             LastConfigureTime = DateTime.Now;
-            if (ConfigCode == serverInfo.ConfigCode)
-                ConfigCode = null;
+            LastServerInfo = serverInfo;
+            LastServerStatus = serverInfo.Status;
             return _restAccessServer.Server_Configure(serverInfo);
         }
 

VpnHood.ZTest/Tests/ServerTest.cs

@@ -64,7 +64,7 @@ public async Task Reconfigure()
             var fileAccessServerOptions = new FileAccessServerOptions { TcpEndPoints = new[] { serverEndPoint } };
             using var fileAccessServer = TestHelper.CreateFileAccessServer(fileAccessServerOptions);
             var serverConfig = fileAccessServer.ServerConfig;
-            serverConfig.UpdateStatusInterval = TimeSpan.FromSeconds(1);
+            serverConfig.UpdateStatusInterval = TimeSpan.FromMilliseconds(500);
             serverConfig.TrackingOptions.LogClientIp = true;
             serverConfig.TrackingOptions.LogLocalPort = true;
             serverConfig.SessionOptions.TcpTimeout = TimeSpan.FromSeconds(2070);
@@ -81,9 +81,10 @@ public async Task Reconfigure()
             Assert.IsTrue(testAccessServer.LastConfigureTime > dateTime);
 
             dateTime = DateTime.Now;
-            testAccessServer.ConfigCode = Guid.NewGuid();
-            await Task.Delay(2500);
-            Assert.IsNull(testAccessServer.ConfigCode);
+            fileAccessServer.ServerConfig.ConfigCode = Guid.NewGuid().ToString();
+            await Task.Delay(TimeSpan.FromSeconds(2));
+
+            Assert.AreEqual(fileAccessServer.ServerConfig.ConfigCode, testAccessServer.LastServerStatus!.ConfigCode);
             Assert.IsTrue(testAccessServer.LastConfigureTime > dateTime);
             Assert.IsTrue(server.SessionManager.TrackingOptions.LogClientIp);
             Assert.IsTrue(server.SessionManager.TrackingOptions.LogLocalPort);

VpnHood.sln.DotSettings

@@ -14,6 +14,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Digi/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=dow_0022_002C_0020St/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Encipherment/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=ffff/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Icmp/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=ipgroups/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=lastcheck/@EntryIndexedValue">True</s:Boolean>