20 custom domain support

AddNewTunnelWindow.xaml

@@ -4,7 +4,7 @@
         xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
         xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
         mc:Ignorable="d"
-        Title="Add New Tunnel" Height="190" Width="300" Icon="icons8-tunnel-256.png">
+        Title="Add New Tunnel" Height="210" Width="300" Icon="icons8-tunnel-256.png">
     <Grid Margin="10">
         <Grid.ColumnDefinitions>
             <ColumnDefinition Width="Auto" />
@@ -15,6 +15,7 @@
             <RowDefinition Height="Auto" />
             <RowDefinition Height="Auto" />
             <RowDefinition Height="Auto" Name="wdSubdomain" />
+            <RowDefinition Height="Auto" Name="wdCustomdomain" />
             <RowDefinition Height="*" />
         </Grid.RowDefinitions>
 
@@ -32,7 +33,10 @@
         <Label Grid.Row="3" Name="llsubdomain" >Subdomain:</Label>
         <TextBox Name="tbSubdomain" Grid.Column="1" Grid.Row="3" />
 
-        <Button Name="btnAddNewTunnel" Content="Add new tunnel" Grid.Column="1" Grid.Row="4"
+        <Label Grid.Row="4" Name="llCustomDomain" >Custom Domain:</Label>
+        <TextBox Name="tbCustomDomain" Grid.Column="1" Grid.Row="4" />
+
+        <Button Name="btnAddNewTunnel" Content="Add new tunnel" Grid.Column="1" Grid.Row="5"
                 Click="BtnAddNewTunnel_OnClick" />
     </Grid>
 </Window>

AddNewTunnelWindow.xaml.cs

@@ -25,8 +25,14 @@ public AddNewTunnelWindow(List<TunnelDescription> currentTunnelDescriptions ,boo
             if (!paidAccount)
             {
                 tbSubdomain.Visibility = Visibility.Hidden;
+                tbCustomDomain.Visibility = Visibility.Hidden;
+
                 llsubdomain.Visibility = Visibility.Hidden;
+                llCustomDomain.Visibility = Visibility.Hidden;
+
                 wdSubdomain.MaxHeight = 0;
+                wdCustomdomain.MaxHeight = 0;
+
                 Height = 170;
             }
 

DataTemplates/TunnelDescription.cs

@@ -33,6 +33,7 @@ public bool Active
         }
 
         public string SubDomain { get; set; }
+        public string CustomDomain { get; set; }
 
         public event PropertyChangedEventHandler PropertyChanged;
 

FirstTimeWizard.xaml.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Controls;
 using NgrokSharp;
@@ -35,19 +36,9 @@ public FirstTimeWizard(INgrokManager ngrokManager)
             cmbTunnelExit.SelectedIndex = 0;
 
             _ngrokManager = ngrokManager;
-            _ngrokManager.DownloadAndUnZipDone += _ngrokManager_DownloadAndUnZipDone;
         }
 
-        private void _ngrokManager_DownloadAndUnZipDone(object sender, EventArgs e)
-        {
-            btnDownload.Content = "Next";
-            txtbkDownloadInstruction.Text = "Download completed successfully! Please click next.";
-            btnDownload.IsEnabled = true;
-            pbprogress.IsIndeterminate = false;
-            pbprogress.Value = 100;
-        }
-
-        private void BtnDownload_OnClick(object sender, RoutedEventArgs e)
+        private async void BtnDownload_OnClick(object sender, RoutedEventArgs e)
         {
             if ((string)btnDownload.Content == "Next")
             {
@@ -58,15 +49,25 @@ private void BtnDownload_OnClick(object sender, RoutedEventArgs e)
             txtbkDownloadInstruction.Text = "Please wait while ngrok is downloading";
             pbprogress.IsIndeterminate = true;
             btnDownload.IsEnabled = false;
-            _ngrokManager.DownloadNgrok();
+            await _ngrokManager.DownloadAndUnzipNgrokAsync();
+            DownloadAndUnZipDone();
+        }
+
+        private void DownloadAndUnZipDone()
+        {
+            btnDownload.Content = "Next";
+            txtbkDownloadInstruction.Text = "Download completed successfully! Please click next.";
+            btnDownload.IsEnabled = true;
+            pbprogress.IsIndeterminate = false;
+            pbprogress.Value = 100;
         }
 
         private void BtnSelectDataCenter_OnClick(object sender, RoutedEventArgs e)
         {
             tabcl.SelectedIndex = 2;
         }
 
-        private void BtnAuth_OnClick(object sender, RoutedEventArgs e)
+        private async void BtnAuth_OnClick(object sender, RoutedEventArgs e)
         {
             if (string.IsNullOrWhiteSpace(txtbxAuthToken.Text))
             {
@@ -88,7 +89,7 @@ private void BtnAuth_OnClick(object sender, RoutedEventArgs e)
                 }
             }
 
-            _ngrokManager.RegisterAuthToken(txtbxAuthToken.Text);
+            await _ngrokManager.RegisterAuthTokenAsync(txtbxAuthToken.Text);
 
             DialogResult = true;
 

MainWindow.xaml.cs

@@ -3,9 +3,11 @@
 using System.Collections.ObjectModel;
 using System.IO;
 using System.Linq;
+using System.Net;
+using System.Text.Json;
 using System.Windows;
-using Newtonsoft.Json;
 using NgrokSharp;
+using NgrokSharp.DTO;
 
 namespace ngrokGUI
 {
@@ -40,7 +42,7 @@ public MainWindow()
             try
             {
                 //Load settings
-                settings = JsonConvert.DeserializeObject<Settings>(File.ReadAllText($"{_downloadFolder}Settings.json"));
+                settings = JsonSerializer.Deserialize<Settings>(File.ReadAllText($"{_downloadFolder}Settings.json"));
 
                 if (settings.FirstTimeSetupDone == false)
                 {
@@ -53,7 +55,7 @@ public MainWindow()
                         settings.DataCenterRegion = firstTimeWizard.cmbTunnelExit.SelectedIndex;
                         settings.PaidAccount = (bool) firstTimeWizard.cbxPaidAccount.IsChecked;
 
-                        File.WriteAllText($"{_downloadFolder}Settings.json", JsonConvert.SerializeObject(settings));
+                        File.WriteAllText($"{_downloadFolder}Settings.json", JsonSerializer.Serialize(settings));
                     }
                 }
 
@@ -63,7 +65,7 @@ public MainWindow()
 
                 if (File.Exists($"{_downloadFolder}SavedTunnels.json"))
                 {
-                    JsonConvert.DeserializeObject<List<TunnelDescription>>(File.ReadAllText(
+                    JsonSerializer.Deserialize<List<TunnelDescription>>(File.ReadAllText(
                         $"{_downloadFolder}SavedTunnels.json"))?.ForEach( x => _tunnelDescriptions.Add(x));
                 }
 
@@ -96,7 +98,8 @@ private async void btnMenuItemAddNew_OnClick(object sender, RoutedEventArgs e)
                     proto = addNewTunnelWindow.cobProtocol.SelectionBoxItem.ToString(),
                     addr = addNewTunnelWindow.tbLocalPort.Text,
                     bind_tls = "false",
-                    subdomain = addNewTunnelWindow.tbSubdomain.Text
+                    subdomain = addNewTunnelWindow.tbSubdomain.Text,
+                    hostname = addNewTunnelWindow.tbCustomDomain.Text
                 };
 
                 // bind_tls http bind an HTTPS or HTTP endpoint or both true, false, or both
@@ -106,12 +109,12 @@ private async void btnMenuItemAddNew_OnClick(object sender, RoutedEventArgs e)
                     startTunnelDto.bind_tls = "true";
                 }
 
-                var httpResponseMessage = await _ngrokManager.StartTunnel(startTunnelDto);
+                var httpResponseMessage = await _ngrokManager.StartTunnelAsync(startTunnelDto);
 
                 if ((int) httpResponseMessage.StatusCode == 201)
                 {
                     var tunnelDetail =
-                        JsonConvert.DeserializeObject<TunnelDetailDTO>(
+                        JsonSerializer.Deserialize<TunnelDetailDTO>(
                             await httpResponseMessage.Content.ReadAsStringAsync());
 
                     var tunnel = new TunnelDescription
@@ -121,14 +124,15 @@ private async void btnMenuItemAddNew_OnClick(object sender, RoutedEventArgs e)
                         Port = Convert.ToInt32(addNewTunnelWindow.tbLocalPort.Text),
                         Url = tunnelDetail.PublicUrl,
                         Active = true,
-                        SubDomain = addNewTunnelWindow.tbSubdomain.Text
+                        SubDomain = addNewTunnelWindow.tbSubdomain.Text,
+                        CustomDomain = addNewTunnelWindow.tbCustomDomain.Text
                     };
                     _tunnelDescriptions.Add(tunnel);
                 }
                 else
                 {
                     var tunnelError =
-                        JsonConvert.DeserializeObject<TunnelErrorDTO>(
+                        JsonSerializer.Deserialize<TunnelErrorDTO>(
                             await httpResponseMessage.Content.ReadAsStringAsync());
                     MessageBox.Show(tunnelError.Details.Err);
                 }
@@ -149,7 +153,7 @@ private void Window_Closed(object sender, EventArgs e)
                 }
             }
 
-            File.WriteAllText($"{_downloadFolder}SavedTunnels.json", JsonConvert.SerializeObject(_tunnelDescriptions));
+            File.WriteAllText($"{_downloadFolder}SavedTunnels.json", JsonSerializer.Serialize(_tunnelDescriptions));
 
         }
 
@@ -167,9 +171,9 @@ private async void btnMenuItemStopTunnel_OnClick(object sender, RoutedEventArgs
         {
             if (lwTunnels.SelectedIndex == -1) return;
 
-            var result = await _ngrokManager.StopTunnel(_tunnelDescriptions[lwTunnels.SelectedIndex].Name);
+            var result = await _ngrokManager.StopTunnelAsync(_tunnelDescriptions[lwTunnels.SelectedIndex].Name);
 
-            if (result == 204)
+            if (result.StatusCode == HttpStatusCode.NoContent)
             {
                 _tunnelDescriptions[lwTunnels.SelectedIndex].Active = false;
 
@@ -187,7 +191,7 @@ private void BtnMenuItemRunFirstTimeWizard_OnClick(object sender, RoutedEventArg
             if (result == MessageBoxResult.Yes)
             {
                 Settings settings = new Settings {FirstTimeSetupDone = false};
-                File.WriteAllText($"{_downloadFolder}Settings.json", JsonConvert.SerializeObject(settings));
+                File.WriteAllText($"{_downloadFolder}Settings.json", JsonSerializer.Serialize(settings));
                 Close();
             }
         }
@@ -205,7 +209,8 @@ private async void btnMenuItemStartTunnel_OnClick(object sender, RoutedEventArgs
                 proto = _tunnelDescriptions[lwTunnels.SelectedIndex].Protocol,
                 addr = _tunnelDescriptions[lwTunnels.SelectedIndex].Port.ToString(),
                 bind_tls = "false",
-                subdomain = _tunnelDescriptions[lwTunnels.SelectedIndex].SubDomain
+                subdomain = _tunnelDescriptions[lwTunnels.SelectedIndex].SubDomain,
+                hostname = _tunnelDescriptions[lwTunnels.SelectedIndex].CustomDomain
             };
 
             // bind_tls http bind an HTTPS or HTTP endpoint or both true, false, or both
@@ -215,12 +220,12 @@ private async void btnMenuItemStartTunnel_OnClick(object sender, RoutedEventArgs
                 startTunnelDto.bind_tls = "true";
             }
 
-            var httpResponseMessage = await _ngrokManager.StartTunnel(startTunnelDto);
+            var httpResponseMessage = await _ngrokManager.StartTunnelAsync(startTunnelDto);
 
             if ((int)httpResponseMessage.StatusCode == 201)
             {
                 var tunnelDetail =
-                    JsonConvert.DeserializeObject<TunnelDetailDTO>(
+                    JsonSerializer.Deserialize<TunnelDetailDTO>(
                         await httpResponseMessage.Content.ReadAsStringAsync());
 
                 _tunnelDescriptions[lwTunnels.SelectedIndex].Active = true;
@@ -229,7 +234,7 @@ private async void btnMenuItemStartTunnel_OnClick(object sender, RoutedEventArgs
             else
             {
                 var tunnelError =
-                    JsonConvert.DeserializeObject<TunnelErrorDTO>(
+                    JsonSerializer.Deserialize<TunnelErrorDTO>(
                         await httpResponseMessage.Content.ReadAsStringAsync());
                 MessageBox.Show(tunnelError.Details.Err);
             }
@@ -242,7 +247,7 @@ private async void btnMenuItemDeleteTunnel_OnClick(object sender, RoutedEventArg
 
             if (_tunnelDescriptions[lwTunnels.SelectedIndex].Active)
             {
-                var result = await _ngrokManager.StopTunnel(_tunnelDescriptions[lwTunnels.SelectedIndex].Name);
+                var result = await _ngrokManager.StopTunnelAsync(_tunnelDescriptions[lwTunnels.SelectedIndex].Name);
             }
 
             var tunnel = _tunnelDescriptions.SingleOrDefault(x => x.Name == _tunnelDescriptions[lwTunnels.SelectedIndex].Name);

README.md

@@ -31,6 +31,9 @@
     <li>
       <a href="#about-the-project">About The Project</a>
     </li>
+    <li>
+      <a href="#Features">Features</a>
+    </li>
     <li>
       <a href="#getting-started">Getting Started</a>
       <ul>
@@ -53,10 +56,24 @@
 NgrokGUI is a windows GUI for ngrok. It helps download ngrok, getting it ready for first time use and managing tunnels. The idea for the project arose due to friends wanting a gui to ngrok that was more user friendly.
 I later found a Dungeons & Dragons community that uses [Foundryvtt](https://foundryvtt.com/) to run their games. NgrokGUI allows an easy way for the dungeon master to host the game without spending additional money on hosting or messing with port forwarding.
 
+<!--
+
 #### 🔨 New version underway! 🔨
 I have gotten requests for this application to be ported to Linux and Mac as well. Therefore, I am in the process of rewriting the application in avaloniaui.
 Look at the v2 branch if you wanna follow the progress
 
+-->
+
+## Features
+
+* Create tunnels for http https and tcp protocols.
+* Downloads Ngrok automatically.
+* Start and stop tunnels.
+* Remembers previous created tunnels.
+* Support for paid Ngrok account features
+  * Create tunnel with subdomain
+  * Create tunnels on custom branded domains
+
 ### Built With
 
 * [NgrokSharp](https://github.com/entvex/NgrokSharp)
@@ -69,7 +86,7 @@ To get a local copy up and running follow these simple steps.
 ### Prerequisites
 
 * Windows 7 or Later
-* [.NET 5.0 x64](https://dotnet.microsoft.com/download/dotnet/5.0/runtime/) or later
+* [.NET 6.0 x64](https://dotnet.microsoft.com/download/dotnet/6.0/runtime) or later
 * [Ngrok authtoken](https://dashboard.ngrok.com/get-started/setup)
 ### Installation
 

ngrokGUI.csproj

@@ -1,8 +1,8 @@
-<Project Sdk="Microsoft.NET.Sdk.WindowsDesktop">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>WinExe</OutputType>
-    <TargetFramework>net5.0-windows</TargetFramework>
+    <TargetFramework>net6.0-windows</TargetFramework>
     <UseWPF>true</UseWPF>
     <ApplicationIcon>icons8-tunnel-256.ico</ApplicationIcon>
     <AssemblyName>ngrokGUI</AssemblyName>
@@ -21,7 +21,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="NgrokSharp" Version="1.0.7" />
+    <PackageReference Include="NgrokSharp" Version="1.0.12" />
   </ItemGroup>
 
   <ItemGroup>

ngrokGUI.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.31019.35
+# Visual Studio Version 17
+VisualStudioVersion = 17.1.32228.430
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ngrokGUI", "ngrokGUI.csproj", "{F0DA3BFF-57BE-4E5E-8C67-2C4692E144E4}"
 EndProject