Security is our #1 priority

.gitea/workflows/build-docker-image.yml

@@ -0,0 +1,50 @@
+name: Build and Push Server Docker Image
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-server:
+    runs-on: ubuntu-24.04
+    container:
+      image: docker:dind
+      privileged: true
+      
+    steps:
+
+      - name: Install required tools
+        run: apk add --no-cache git nodejs npm
+      # 1. Check out the repo
+      - uses: actions/checkout@v4
+
+      # 2. Set up Docker Buildx (recommended for advanced caching)
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # 3. Log in to your container registry
+      - name: Log in to registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ secrets.REGISTRY_URL }}
+          username: ${{ secrets.REGISTRY_USERNAME }}
+          password: ${{ secrets.REGISTRY_PASSWORD }}
+
+      # 4. Lowercase the repository name
+      - name: Set lowercase repo name
+        run: echo "REPO_NAME_LOWER=$(echo '${{ github.event.repository.name }}' | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
+
+      # 5. Build & push the server image, using remote cache
+      - name: Build and push server image
+        uses: docker/build-push-action@v4
+        with:
+          context:    VirtualDDNSRouter.Server
+          file:       VirtualDDNSRouter.Server/Dockerfile
+          push:       true
+          tags:       ${{ secrets.REGISTRY_URL }}/${{ github.repository_owner }}/${{ env.REPO_NAME_LOWER }}:latest-server
+          cache-from: type=registry,ref=${{ secrets.REGISTRY_URL }}/${{ github.repository_owner }}/${{ env.REPO_NAME_LOWER }}:buildcache
+          cache-to:   type=registry,ref=${{ secrets.REGISTRY_URL }}/${{ github.repository_owner }}/${{ env.REPO_NAME_LOWER }}:buildcache,mode=max
+
+
+          

.gitignore

@@ -4,4 +4,6 @@ obj/
 riderModule.iml
 /_ReSharper.Caches/
 .idea
-rules.yaml
+rules.yaml
+/VirtualDDNSRouter.Client/settings.yaml
+settings.yaml

README.md

@@ -0,0 +1,87 @@
+# VirtualDDNSRouter (VDR)
+
+VirtualDDNSRouter (VDR) is a lightweight dynamic DNS router solution that consists of two components:
+- **Client**: Updates the server with the current IP address of a service
+- **Server**: Acts as a reverse proxy that redirects requests to the correct IP address
+
+This solution is particularly useful for accessing services running on dynamic IP addresses through consistent URLs.
+
+## Quick Start (Recommended Method)
+
+The easiest way to use VDR is by downloading the pre-built binaries:
+
+1. Download the latest release for your platform from [https://git.mahdium.ir/mahdium/VDR/releases/latest](https://git.mahdium.ir/mahdium/VDR/releases/latest)
+2. Extract the archives for both client and server
+3. Configure each component using the provided examples
+4. Run the server and client applications
+
+## Components
+
+- [Client Documentation](VirtualDDNSRouter.Client/README.md) - For updating IP addresses
+- [Server Documentation](VirtualDDNSRouter.Server/README.md) - For routing requests
+
+## Architecture
+
+```
+┌─────────────────┐        ┌─────────────────┐        ┌─────────────────┐
+│   VDR Client    │        │   VDR Server    │        │     Service     │
+│                 │        │                 │        │                 │
+│ • Periodically  │◄──────►│ • Maintains IP  │◄──────►│ • Running on    │
+│   updates IP    │        │   mappings      │        │   dynamic IP    │
+│   with server   │        │ • Redirects to  │        │ • Exposes port  │
+│                 │        │   correct IP    │        │                 │
+└─────────────────┘        └─────────────────┘        └─────────────────┘
+
+┌─────────────────┐
+│     User        │
+│                 │
+│ • Accesses      │
+│   service via   │
+│   consistent    │
+│   URL           │
+└─────────────────┘
+         │
+         ▼
+┌─────────────────┐
+│   VDR Server    │
+│                 │
+│ • Redirects to  │
+│   current IP    │
+└─────────────────┘
+```
+
+## Alternative Deployment Methods
+
+### Using Docker
+
+You can also run VDR using Docker:
+
+```bash
+# Build the images
+docker-compose build
+
+# Run the services
+docker-compose up
+```
+
+See the [compose.yaml](compose.yaml) file for details.
+
+### Building from Source
+
+If you prefer to build from source:
+
+```bash
+# For the server
+cd VirtualDDNSRouter.Server
+dotnet build
+dotnet run
+
+# For the client
+cd VirtualDDNSRouter.Client
+dotnet build
+dotnet run
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

VirtualDDNSRouter.Client/Context/YamlStaticContextClient.cs

@@ -0,0 +1,9 @@
+using YamlDotNet.Serialization;
+
+namespace VirtualDDNSRouter.Client.Context;
+
+[YamlStaticContext]
+[YamlSerializable(typeof(Settings))]
+public partial class YamlStaticContextClient : StaticContext
+{
+}

VirtualDDNSRouter.Client/Dockerfile

@@ -0,0 +1,21 @@
+FROM mcr.microsoft.com/dotnet/runtime:10.0 AS base
+USER $APP_UID
+WORKDIR /app
+
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build
+ARG BUILD_CONFIGURATION=Release
+WORKDIR /src
+COPY ["VirtualDDNSRouter.Client/VirtualDDNSRouter.Client.csproj", "VirtualDDNSRouter.Client/"]
+RUN dotnet restore "VirtualDDNSRouter.Client/VirtualDDNSRouter.Client.csproj"
+COPY . .
+WORKDIR "/src/VirtualDDNSRouter.Client"
+RUN dotnet build "./VirtualDDNSRouter.Client.csproj" -c $BUILD_CONFIGURATION -o /app/build
+
+FROM build AS publish
+ARG BUILD_CONFIGURATION=Release
+RUN dotnet publish "./VirtualDDNSRouter.Client.csproj" -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=false
+
+FROM base AS final
+WORKDIR /app
+COPY --from=publish /app/publish .
+ENTRYPOINT ["dotnet", "VirtualDDNSRouter.Client.dll"]

VirtualDDNSRouter.Client/Helpers/YamlParser.cs

@@ -0,0 +1,34 @@
+using VirtualDDNSRouter.Client.Context;
+using YamlDotNet.Serialization;
+using YamlDotNet.Serialization.NamingConventions;
+using Settings = VirtualDDNSRouter.Client.Models.Settings;
+
+namespace VirtualDDNSRouter.Client.Helpers;
+
+public class Helpers
+{
+    private static readonly string YamlFilePath = "settings.yaml";
+
+    public static async Task<Settings> GetSettings()
+    {
+        if (!File.Exists(YamlFilePath))
+            throw new FileNotFoundException($"Settings file not found: {YamlFilePath}");
+
+        var yamlContent = await File.ReadAllTextAsync(YamlFilePath).ConfigureAwait(false);
+
+        // Build the deserializer with explicit naming convention
+        var deserializer = new StaticDeserializerBuilder(new YamlStaticContextClient())
+            .WithNamingConvention(UnderscoredNamingConvention.Instance)
+            .IgnoreUnmatchedProperties()
+            .Build();
+
+        // Deserialize into Settings
+        var settings = deserializer.Deserialize<Settings>(yamlContent);
+
+        if (settings is null || string.IsNullOrWhiteSpace(settings.host) || string.IsNullOrWhiteSpace(settings.path) ||
+            string.IsNullOrWhiteSpace(settings.apiKey))
+            throw new Exception("Invalid settings file");
+
+        return settings;
+    }
+}

VirtualDDNSRouter.Client/Models/Settings.cs

@@ -0,0 +1,17 @@
+using YamlDotNet.Serialization;
+
+namespace VirtualDDNSRouter.Client.Models;
+
+[YamlSerializable]
+public record Settings
+{
+    public string host { get; set; } = string.Empty;
+    public string path { get; set; } = string.Empty;
+    public ushort destinationPort { get; set; } = 80;
+    public string apiKey { get; set; } = string.Empty;
+    public ushort refreshIntervalMinutes { get; set; } = 5;
+
+    public Settings()
+    {
+    }
+}

VirtualDDNSRouter.Client/Program.cs

@@ -0,0 +1,43 @@
+using VirtualDDNSRouter.Client.Helpers;
+
+var settings = await Helpers.GetSettings();
+
+using var cts = new CancellationTokenSource();
+Console.CancelKeyPress += (s, e) =>
+{
+    Console.WriteLine("Shutdown requested…");
+    e.Cancel = true;
+    cts.Cancel();
+};
+
+var timer = new PeriodicTimer(TimeSpan.FromMinutes(settings.refreshIntervalMinutes));
+
+var client = new HttpClient { Timeout = TimeSpan.FromSeconds(10) };
+var builder = new UriBuilder
+{
+    Scheme = "http",
+    Host = settings.host,
+    Path = $"setip/{settings.path}/{settings.destinationPort}/{settings.apiKey}"
+};
+
+var request = new HttpRequestMessage(HttpMethod.Get, builder.Uri);
+
+Console.WriteLine("[INFO] App started. Scheduling IP address update every " + settings.refreshIntervalMinutes +
+                  " minutes.");
+
+try
+{
+    while (await timer.WaitForNextTickAsync(cts.Token))
+    {
+        if (cts.IsCancellationRequested) break;
+        var response = await client.SendAsync(request, cts.Token);
+        if (response.IsSuccessStatusCode)
+            Console.WriteLine("[INFO] IP address updated at " + DateTime.Now.ToString("HH:mm:ss"));
+        else
+            Console.WriteLine("[ERROR] IP address update failed at " + DateTime.Now.ToString("HH:mm:ss"));
+    }
+}
+catch (OperationCanceledException)
+{
+    Console.WriteLine("[INFO] Shutdown complete.");
+}

VirtualDDNSRouter.Client/README.md

@@ -0,0 +1,56 @@
+# VirtualDDNSRouter Client
+
+The VirtualDDNSRouter Client is a lightweight application that periodically updates the IP address of a service with the VirtualDDNSRouter Server.
+
+## Configuration
+
+The client uses a YAML configuration file named `settings.yaml`. You can create this file by copying and modifying the provided example:
+
+```bash
+cp settings.example.yaml settings.yaml
+```
+
+The configuration file has the following structure:
+
+```yaml
+host: example.com           # The hostname of the VDR server
+path: odoo                  # The path identifier for your service
+destination_port: 8081      # The port of your service
+api_key: abc123XYZ          # The API key for authentication
+refresh_interval_minutes: 3 # How often to update the IP address (in minutes)
+```
+
+## Running the Client
+
+### Method 1: Downloading Pre-built Binaries (Recommended)
+
+1. Download the latest client binary from [https://git.mahdium.ir/mahdium/VDR/releases/latest](https://git.mahdium.ir/mahdium/VDR/releases/latest)
+2. Extract the archive
+3. Create your `settings.yaml` file based on `settings.example.yaml`
+4. Run the client:
+
+```bash
+./VirtualDDNSRouter.Client
+```
+
+### Method 2: Using Docker
+
+```bash
+docker run -v ./settings.yaml:/app/settings.yaml virtualddnsrouter.client
+```
+
+### Method 3: Building from Source
+
+```bash
+dotnet build
+dotnet run
+```
+
+## Usage
+
+After starting the client, it will:
+1. Read the configuration from `settings.yaml`
+2. Send an update to the server every `refresh_interval_minutes`
+3. Continue running until stopped with Ctrl+C
+
+The client will output logs showing when updates are sent and whether they were successful.

VirtualDDNSRouter.Client/VirtualDDNSRouter.Client.csproj

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net10.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <PublishAot>true</PublishAot>
+        <InvariantGlobalization>true</InvariantGlobalization>
+        <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <Content Include="..\.dockerignore">
+            <Link>.dockerignore</Link>
+        </Content>
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="YamlDotNet" Version="16.3.0"/>
+        <PackageReference Include="Vecc.YamlDotNet.Analyzers.StaticGenerator" Version="16.3.0"/>
+    </ItemGroup>
+
+</Project>

VirtualDDNSRouter.Client/settings.example.yaml

@@ -0,0 +1,5 @@
+host: example.com
+path: odoo
+destination_port: 8081
+api_key: abc123XYZ
+refresh_interval_minutes: 3

VirtualDDNSRouter.Server/Context/YamlStaticContext.cs

@@ -5,6 +5,6 @@ namespace VirtualDDNSRouter.Server.Context;
 
 [YamlStaticContext]
 [YamlSerializable(typeof(Rule))]
-public partial class YamlStaticContext : StaticContext
+public partial class YamlStaticContextServer : StaticContext
 {
 }

VirtualDDNSRouter.Server/Dockerfile

@@ -1,23 +1,17 @@
-FROM mcr.microsoft.com/dotnet/aspnet:10.0 AS base
-USER $APP_UID
-WORKDIR /app
-EXPOSE 8080
-EXPOSE 8081
+FROM mcr.microsoft.com/dotnet/sdk:10.0.100-preview.7-alpine3.22-aot AS build
+
+# Install NativeAOT build prerequisites
+RUN apk update \
+    && apk add --no-cache \
+       clang zlib-dev 
+
+WORKDIR /source
 
-FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build
-ARG BUILD_CONFIGURATION=Release
-WORKDIR /src
-COPY ["VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.csproj", "VirtualDDNSRouter.Server/"]
-RUN dotnet restore "VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.csproj"
 COPY . .
-WORKDIR "/src/VirtualDDNSRouter.Server"
-RUN dotnet build "./VirtualDDNSRouter.Server.csproj" -c $BUILD_CONFIGURATION -o /app/build
+RUN dotnet publish -r linux-musl-x64 -o /app 'VirtualDDNSRouter.Server.csproj'
 
-FROM build AS publish
-ARG BUILD_CONFIGURATION=Release
-RUN dotnet publish "./VirtualDDNSRouter.Server.csproj" -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=false
+FROM mcr.microsoft.com/dotnet/runtime-deps:10.0.0-preview.7-alpine3.22
 
-FROM base AS final
 WORKDIR /app
-COPY --from=publish /app/publish .
-ENTRYPOINT ["dotnet", "VirtualDDNSRouter.Server.dll"]
+COPY --from=build /app .
+ENTRYPOINT ["/app/VirtualDDNSRouter.Server"]

VirtualDDNSRouter.Server/Models/Rule.cs

@@ -10,7 +10,7 @@ public record Rule
 
     public Rule()
     {
-    } // Needed for AOT static deserializer
+    } // Needed for AOT static deserializer - AI
 }
 
 public record Route

VirtualDDNSRouter.Server/README.md

@@ -0,0 +1,89 @@
+# VirtualDDNSRouter Server
+
+The VirtualDDNSRouter Server is a lightweight reverse proxy that maintains dynamic mappings between paths and IP
+addresses. Clients can update their IP addresses, and users can access services through consistent URLs.
+
+## Configuration
+
+The server uses a YAML rules file named `rules.yaml`. You can create this file by copying and modifying the provided
+example:
+
+```bash
+cp rules.example.yaml rules.yaml
+```
+
+The rules file has the following structure:
+
+```yaml
+- name: Odoo Server      # A descriptive name for the service
+  api_key: abc123XYZ     # The API key for authentication
+  path: odoo             # The path identifier for the service
+
+- name: Backup server
+  api_key: def456ABC
+  path: bk
+```
+
+Each entry defines a service with:
+
+- `name`: A descriptive label (for documentation purposes)
+- `api_key`: A secret key used by clients to authenticate updates
+- `path`: The URL path that users will use to access the service
+
+## Running the Server
+
+### Method 1: Downloading Pre-built Binaries (Recommended)
+
+1. Download the latest server binary
+   from [https://git.mahdium.ir/mahdium/VDR/releases/latest](https://git.mahdium.ir/mahdium/VDR/releases/latest)
+2. Extract the archive
+3. Create your `rules.yaml` file based on `rules.example.yaml`
+4. Run the server:
+
+```bash
+./VirtualDDNSRouter.Server
+```
+
+By default, the server listens on port 8080. You can change this by setting the `ASPNETCORE_HTTP_PORTS` environment
+variable:
+
+```bash
+ASPNETCORE_HTTP_PORTS=8081 ./VirtualDDNSRouter.Server
+```
+
+### Method 2: Using Docker
+
+```bash
+docker run -p 8080:8080 -v ./rules.yaml:/app/rules.yaml virtualddnsrouter.server
+```
+
+### Method 3: Building from Source
+
+```bash
+dotnet build
+dotnet run
+```
+
+## Usage
+
+The server provides two main endpoints:
+
+1. **IP Update Endpoint** (used by clients):
+   ```
+   GET /setip/{path}/{port}/{api_key}
+   ```
+   Clients call this endpoint to update their IP address.
+
+2. **Service Access Endpoint** (used by users):
+   ```
+   GET /goto/{path}
+   ```
+   Users access this endpoint to reach the service associated with the path.
+
+For example, if a client has configured a service with path "odoo", users can access it at:
+
+```
+http://your-server:8080/goto/odoo
+```
+
+The server will redirect users to the IP address and port that the client last reported.

VirtualDDNSRouter.Server/Services/YamlParser.cs

@@ -1,4 +1,3 @@
-using System.Diagnostics.CodeAnalysis;
 using VirtualDDNSRouter.Server.Context;
 using VirtualDDNSRouter.Server.Interfaces;
 using VirtualDDNSRouter.Server.Models;
@@ -19,7 +18,7 @@ public class YamlParser : IYamlParser
         var yamlContent = await File.ReadAllTextAsync(_yamlFilePath).ConfigureAwait(false);
 
         // Build the deserializer with explicit naming convention
-        var deserializer = new StaticDeserializerBuilder(new YamlStaticContext())
+        var deserializer = new StaticDeserializerBuilder(new YamlStaticContextServer())
             .WithNamingConvention(UnderscoredNamingConvention.Instance) // maps api_key -> apiKey
             .IgnoreUnmatchedProperties()
             .Build();
@@ -27,6 +26,6 @@ public class YamlParser : IYamlParser
         // Deserialize into a list of Rule
         var rules = deserializer.Deserialize<List<Rule>>(yamlContent);
 
-        return rules ?? new List<Rule>();
+        return rules;
     }
 }

VirtualDDNSRouter.Server/VirtualDDNSRouter.Server.http

@@ -1,11 +1,18 @@
 @VirtualDDNSRouter.Server_HostAddress = http://localhost:5277
 
-GET {{VirtualDDNSRouter.Server_HostAddress}}/todos/
-Accept: application/json
+### Set IP for a path
+# This endpoint is used by clients to register/update their IP address for a specific path
+# Parameters:
+# - path: The path identifier (must match a rule in rules.yaml)
+# - port: The port number the client wants to expose
+# - apiKey: The API key for authentication (must match the rule for the path)
+POST {{VirtualDDNSRouter.Server_HostAddress}}/setip/{path}/{port}/{apiKey}
+Content-Type: application/json
 
 ###
 
-GET {{VirtualDDNSRouter.Server_HostAddress}}/todos/1
-Accept: application/json
+### Redirect to registered service
+# This endpoint redirects to the IP and port registered for a specific path
+GET {{VirtualDDNSRouter.Server_HostAddress}}/goto/{path}
 
 ###

VirtualDDNSRouter.sln

@@ -7,6 +7,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		compose.yaml = compose.yaml
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VirtualDDNSRouter.Client", "VirtualDDNSRouter.Client\VirtualDDNSRouter.Client.csproj", "{68BC4818-F3A1-4862-BAE6-6F43D3237E63}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -17,5 +19,9 @@ Global
 		{6101BFD3-C31C-41CB-9402-A8B9F3EBEE22}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6101BFD3-C31C-41CB-9402-A8B9F3EBEE22}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6101BFD3-C31C-41CB-9402-A8B9F3EBEE22}.Release|Any CPU.Build.0 = Release|Any CPU
+		{68BC4818-F3A1-4862-BAE6-6F43D3237E63}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{68BC4818-F3A1-4862-BAE6-6F43D3237E63}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{68BC4818-F3A1-4862-BAE6-6F43D3237E63}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{68BC4818-F3A1-4862-BAE6-6F43D3237E63}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 EndGlobal

compose.yaml

@@ -5,3 +5,9 @@
       context: .
       dockerfile: VirtualDDNSRouter.Server/Dockerfile
 
+  virtualddnsrouter.client:
+    image: virtualddnsrouter.client
+    build:
+      context: .
+      dockerfile: VirtualDDNSRouter.Client/Dockerfile
+