Added dynamic capture example

- Added dynamic capture plugin example
- Added dynamic capture plugin doc
- Removed ztnc from plugin example

docs/plugins/docs/2. Architecture/6. Compile a Plugin.md

@@ -0,0 +1,15 @@
+# Compile a Plugin
+
+A plugin is basically a go program with a HTTP Server / Listener. The steps required to build a plugin is identical as building a ordinary go program. 
+
+```bash
+# Assuming you are currently inside the root folder of your plugin
+go mod tidy
+go build
+
+# Validate if the plugin is correctly build using -introspect flag
+./{{your_plugin_name}} -introspect
+
+# You should see your plugin information printed to STDOUT as JSON string
+```
+

docs/plugins/docs/3. Basic Examples/3. Static Capture Example.md

@@ -76,7 +76,7 @@ pathRouter.RegisterStaticCaptureHandle(STATIC_CAPTURE_INGRESS, http.DefaultServe
 
 The `SetDefaultHandler` is used to handle exceptions where a request is forwarded to your plugin but it cannot be handled by any of your registered path handlers. This is usually an implementation bug on the plugin side and you can add some help message or debug log to this function if needed.
 
-
+The `RegisterStaticCaptureHandle` is used to register the static capture ingress endpoint, so Zoraxy knows where to forward the HTTP request when it thinks your plugin shall be the one handling the request. In this example, `/s_capture` is used for static capture endpoint.
 
 ---
 
@@ -261,4 +261,5 @@ Request URI: /test_b
 
 ---
 
-Enjoy exploring static capture in Zoraxy!  
+Enjoy exploring static capture in Zoraxy!  
+

docs/plugins/docs/3. Basic Examples/4. Dynamic Capture Example.md

@@ -0,0 +1,352 @@
+# Dynamic Capture Example
+Last Update: 29/05/2025  
+
+---
+
+
+This example demonstrates how to use dynamic capture in Zoraxy plugins. Dynamic capture allows you to intercept requests based on real-time conditions, so you can program your plugin in a way that it can decided if it want to handle the request or not.
+
+**Notes: This example assumes you have already read Hello World and Stataic Capture Example.**
+
+Lets dive in!
+
+---
+
+## 1. Create the plugin folder structure
+
+Follow the same steps as the Hello World example to set up the plugin folder structure. Refer to the Hello World example sections 1 to 5 for details.
+
+---
+
+## 2. Define Introspect
+
+The introspect configuration specifies the dynamic capture sniff and ingress paths for your plugin.
+
+```go
+runtimeCfg, err := plugin.ServeAndRecvSpec(&plugin.IntroSpect{
+    ID:            "org.aroz.zoraxy.dynamic-capture-example",
+    Name:          "Dynamic Capture Example",
+    Author:        "aroz.org",
+    AuthorContact: "https://aroz.org",
+    Description:   "This is an example plugin for Zoraxy that demonstrates how to use dynamic captures.",
+    URL:           "https://zoraxy.aroz.org",
+    Type:          plugin.PluginType_Router,
+    VersionMajor:  1,
+    VersionMinor:  0,
+    VersionPatch:  0,
+
+    DynamicCaptureSniff:   "/d_sniff",
+    DynamicCaptureIngress: "/d_capture",
+
+    UIPath: UI_PATH,
+})
+if err != nil {
+    panic(err)
+}
+```
+
+Note the `DynamicCaptureSniff` and `DynamicCaptureIngress`. These paths define the sniffing and capturing behavior for dynamic requests. The sniff path is used to evaluate whether a request should be intercepted, while the ingress path handles the intercepted requests.
+
+---
+
+## 3. Register Dynamic Capture Handlers
+
+Dynamic capture handlers are used to process requests that match specific conditions.
+
+```go
+pathRouter := plugin.NewPathRouter()
+pathRouter.SetDebugPrintMode(true)
+
+pathRouter.RegisterDynamicSniffHandler("/d_sniff", http.DefaultServeMux, func(dsfr *plugin.DynamicSniffForwardRequest) plugin.SniffResult {
+    if strings.HasPrefix(dsfr.RequestURI, "/foobar") {
+        fmt.Println("Accepting request with UUID: " + dsfr.GetRequestUUID())
+        return plugin.SniffResultAccpet
+    }
+    fmt.Println("Skipping request with UUID: " + dsfr.GetRequestUUID())
+    return plugin.SniffResultSkip
+})
+
+pathRouter.RegisterDynamicCaptureHandle("/d_capture", http.DefaultServeMux, func(w http.ResponseWriter, r *http.Request) {
+    w.WriteHeader(http.StatusOK)
+    w.Write([]byte("Welcome to the dynamic capture handler!\n\nRequest Info:\n"))
+    w.Write([]byte("Request URI: " + r.RequestURI + "\n"))
+    w.Write([]byte("Request Method: " + r.Method + "\n"))
+    w.Write([]byte("Request Headers:\n"))
+    headers := make([]string, 0, len(r.Header))
+    for key := range r.Header {
+        headers = append(headers, key)
+    }
+    sort.Strings(headers)
+    for _, key := range headers {
+        for _, value := range r.Header[key] {
+            w.Write([]byte(fmt.Sprintf("%s: %s\n", key, value)))
+        }
+    }
+})
+```
+
+The `RegisterDynamicSniffHandler` evaluates incoming requests, while the `RegisterDynamicCaptureHandle` processes the intercepted requests.
+
+### Sniffing Logic
+
+If a module registered a dynamic capture path, Zoraxy will forward the request headers as `DynamicSniffForwardRequest` (`dsfr`) object to all the plugins that is assigned to this tag. And in each of the plugins, a dedicated logic will take in the object and "think" if they want to handle the request. You can get the following information from the dsfr object by directly accessing the members of it. 
+
+```go
+type DynamicSniffForwardRequest struct {
+	Method     string              `json:"method"`
+	Hostname   string              `json:"hostname"`
+	URL        string              `json:"url"`
+	Header     map[string][]string `json:"header"`
+	RemoteAddr string              `json:"remote_addr"`
+	Host       string              `json:"host"`
+	RequestURI string              `json:"request_uri"`
+	Proto      string              `json:"proto"`
+	ProtoMajor int                 `json:"proto_major"`
+	ProtoMinor int                 `json:"proto_minor"`
+}
+```
+
+You can also use the `GetRequest()` function to get the `*http.Request` object or `GetRequestUUID()` to get a `string` value that is a UUID corresponding to this request for later matching with the incoming, forwarded request.
+
+**Note that since all request will pass through the sniffing function in your plugin, do not implement any blocking logic in your sniffing function, otherwise this will slow down all traffic going through the HTTP proxy rule with the plugin enabled.**
+
+In the sniffing stage, you can choose to either return `ControlStatusCode_CAPTURED`, where Zoraxy will forward the request to your plugin `DynamicCaptureIngress` endpoint, or `ControlStatusCode_UNHANDLED`, where Zoraxy will pass on the request to the next dynamic handling plugin or if there are no more plugins to handle the routing, to the upstream server.
+
+### Capture Handling
+
+The capture handling is where Zoraxy formally forward you the HTTP request the client is requesting. In this situation,  you must response the request by properly handling the ` http.Request` by writing to the `http.ResponseWriter`.
+
+If there is a need to match the sniffing to the capture handling logic (Let say you want to design your plugin to run some kind of pre-processing before the actual request came in), you can use the `X-Zoraxy-Requestid` header in the HTTP request. This is the same UUID as the one you get from `dsfr.GetRequestUUID()` in the sniffing stage if they are the same request object on Zoraxy side. 
+
+The http request that Zoraxy forwards to the plugin capture handling endpoint contains header like these.
+
+```html
+Request URI: /foobar/test
+Request Method: GET
+Request Headers:
+Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+Accept-Encoding: gzip, deflate, br, zstd
+(more fileds)
+X-Forwarded-For: 127.0.0.1
+X-Forwarded-Proto: https
+X-Real-Ip: 127.0.0.1
+X-Zoraxy-Requestid: d00619b8-f39e-4c04-acd8-c3a6f55b1566
+```
+
+You can extract the `X-Zoraxy-Requestid` value from the request header and do your matching for implementing your function if needed.
+
+---
+
+## 4. Render Debug UI
+
+This UI is used help validate the management Web UI is correctly shown in Zoraxy webmin interface. You should implement the required management interface for your plugin here.
+
+```go
+func RenderDebugUI(w http.ResponseWriter, r *http.Request) {
+    fmt.Fprint(w, "**Plugin UI Debug Interface**\n\n[Recv Headers] \n")
+    headerKeys := make([]string, 0, len(r.Header))
+    for name := range r.Header {
+        headerKeys = append(headerKeys, name)
+    }
+    sort.Strings(headerKeys)
+    for _, name := range headerKeys {
+        values := r.Header[name]
+        for _, value := range values {
+            fmt.Fprintf(w, "%s: %s\n", name, value)
+        }
+    }
+    w.Header().Set("Content-Type", "text/html")
+}
+```
+
+
+
+---
+
+## 5. Full Code
+
+Here is the complete code for the dynamic capture example:
+
+```go
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"sort"
+	"strconv"
+	"strings"
+
+	plugin "example.com/zoraxy/dynamic-capture-example/mod/zoraxy_plugin"
+)
+
+const (
+	PLUGIN_ID              = "org.aroz.zoraxy.dynamic-capture-example"
+	UI_PATH                = "/debug"
+	STATIC_CAPTURE_INGRESS = "/s_capture"
+)
+
+func main() {
+	// Serve the plugin intro spect
+	// This will print the plugin intro spect and exit if the -introspect flag is provided
+	runtimeCfg, err := plugin.ServeAndRecvSpec(&plugin.IntroSpect{
+		ID:            "org.aroz.zoraxy.dynamic-capture-example",
+		Name:          "Dynamic Capture Example",
+		Author:        "aroz.org",
+		AuthorContact: "https://aroz.org",
+		Description:   "This is an example plugin for Zoraxy that demonstrates how to use dynamic captures.",
+		URL:           "https://zoraxy.aroz.org",
+		Type:          plugin.PluginType_Router,
+		VersionMajor:  1,
+		VersionMinor:  0,
+		VersionPatch:  0,
+
+		DynamicCaptureSniff:   "/d_sniff",
+		DynamicCaptureIngress: "/d_capture",
+
+		UIPath: UI_PATH,
+
+		/*
+			SubscriptionPath: "/subept",
+			SubscriptionsEvents: []plugin.SubscriptionEvent{
+		*/
+	})
+	if err != nil {
+		//Terminate or enter standalone mode here
+		panic(err)
+	}
+
+	// Setup the path router
+	pathRouter := plugin.NewPathRouter()
+	pathRouter.SetDebugPrintMode(true)
+
+	/*
+		Dynamic Captures
+	*/
+	pathRouter.RegisterDynamicSniffHandler("/d_sniff", http.DefaultServeMux, func(dsfr *plugin.DynamicSniffForwardRequest) plugin.SniffResult {
+		//In this example, we want to capture all URI
+		//that start with /foobar and forward it to the dynamic capture handler
+		if strings.HasPrefix(dsfr.RequestURI, "/foobar") {
+			reqUUID := dsfr.GetRequestUUID()
+			fmt.Println("Accepting request with UUID: " + reqUUID)
+
+			// Print all the values of the request
+			fmt.Println("Method:", dsfr.Method)
+			fmt.Println("Hostname:", dsfr.Hostname)
+			fmt.Println("URL:", dsfr.URL)
+			fmt.Println("Header:")
+			for key, values := range dsfr.Header {
+				for _, value := range values {
+					fmt.Printf("  %s: %s\n", key, value)
+				}
+			}
+			fmt.Println("RemoteAddr:", dsfr.RemoteAddr)
+			fmt.Println("Host:", dsfr.Host)
+			fmt.Println("RequestURI:", dsfr.RequestURI)
+			fmt.Println("Proto:", dsfr.Proto)
+			fmt.Println("ProtoMajor:", dsfr.ProtoMajor)
+			fmt.Println("ProtoMinor:", dsfr.ProtoMinor)
+
+			// We want to handle this request, reply with aSniffResultAccept
+			return plugin.SniffResultAccpet
+		}
+
+		// If the request URI does not match, we skip this request
+		fmt.Println("Skipping request with UUID: " + dsfr.GetRequestUUID())
+		return plugin.SniffResultSkip
+	})
+	pathRouter.RegisterDynamicCaptureHandle("/d_capture", http.DefaultServeMux, func(w http.ResponseWriter, r *http.Request) {
+		// This is the dynamic capture handler where it actually captures and handle the request
+		w.WriteHeader(http.StatusOK)
+		w.Write([]byte("Welcome to the dynamic capture handler!"))
+
+		// Print all the request info to the response writer
+		w.Write([]byte("\n\nRequest Info:\n"))
+		w.Write([]byte("Request URI: " + r.RequestURI + "\n"))
+		w.Write([]byte("Request Method: " + r.Method + "\n"))
+		w.Write([]byte("Request Headers:\n"))
+		headers := make([]string, 0, len(r.Header))
+		for key := range r.Header {
+			headers = append(headers, key)
+		}
+		sort.Strings(headers)
+		for _, key := range headers {
+			for _, value := range r.Header[key] {
+				w.Write([]byte(fmt.Sprintf("%s: %s\n", key, value)))
+			}
+		}
+	})
+
+	http.HandleFunc(UI_PATH+"/", RenderDebugUI)
+	fmt.Println("Dynamic capture example started at http://127.0.0.1:" + strconv.Itoa(runtimeCfg.Port))
+	http.ListenAndServe("127.0.0.1:"+strconv.Itoa(runtimeCfg.Port), nil)
+}
+
+// Render the debug UI
+func RenderDebugUI(w http.ResponseWriter, r *http.Request) {
+	fmt.Fprint(w, "**Plugin UI Debug Interface**\n\n[Recv Headers] \n")
+
+	headerKeys := make([]string, 0, len(r.Header))
+	for name := range r.Header {
+		headerKeys = append(headerKeys, name)
+	}
+	sort.Strings(headerKeys)
+	for _, name := range headerKeys {
+		values := r.Header[name]
+		for _, value := range values {
+			fmt.Fprintf(w, "%s: %s\n", name, value)
+		}
+	}
+	w.Header().Set("Content-Type", "text/html")
+}
+
+```
+
+---
+
+## 6. Expected Output
+
+To enable the plugin, add the plugin to one of the tags and assign the tag to your HTTP Proxy Rule. Here is an example of assigning the plugin to the "debug" tag and assigning it to a localhost loopback HTTP proxy rule.
+
+When the plugin is running, requests matching the sniff conditions will be intercepted and processed by the dynamic capture handler.
+
+If everything is correctly setup, you should see the following page when requesting any URL with prefix `(your_HTTP_proxy_rule_hostname)/foobar`
+
+![image-20250530205430254](img/4. Dynamic Capture Example/image-20250530205430254.png)
+
+
+
+Example terminal output for requesting `/foobar/*`:
+
+```
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Request captured by dynamic sniff path: /d_sniff/
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Header:
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Method: GET
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Hostname: a.localhost
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] URL: /foobar/test
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Accepting request with UUID: 8c916c58-0d6a-4d11-a2f0-f29d3d984509
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-Dest: document
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Accept-Encoding: gzip, deflate, br, zstd
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Accept-Language: zh-TW,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Cache-Control: max-age=0
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-User: ?1
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Upgrade-Insecure-Requests: 1
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36 Edg/136.0.0.0
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Priority: u=0, i
+[2025-05-30 20:44:26.143149] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Ch-Ua-Mobile: ?0
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Ch-Ua: "Chromium";v="136", "Microsoft Edge";v="136", "Not.A/Brand";v="99"
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Ch-Ua-Platform: "Windows"
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-Site: none
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-Mode: navigate
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] RemoteAddr: [::1]:54522
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Host: a.localhost
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] RequestURI: /foobar/test
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Proto: HTTP/2.0
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] ProtoMajor: 2
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] ProtoMinor: 0
+```
+
+---
+
+Now you know how to develop a plugin in Zoraxy that handles special routings!

docs/plugins/html/1. Introduction/1. What is Zoraxy Plugin.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/1. Introduction/2. Getting Started.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/1. Introduction/3. Installing Plugin.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/1. Introduction/4. Enable Plugins.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/1. Introduction/5. Viewing Plugin Info.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/2. Architecture/1. Plugin Architecture.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/2. Architecture/2. Introspect.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/2. Architecture/3. Configure.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/2. Architecture/4. Capture Modes.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/2. Architecture/5. Plugin UI.html

@@ -123,6 +123,9 @@
                   <a class="item is-active" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/2. Architecture/6. Compile a Plugin.html

@@ -0,0 +1,200 @@
+<!DOCTYPE html>
+<html lang="en" class="is-white">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" type="image/png" href="/favicon.png">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>
+      Compile a Plugin | Zoraxy Documentation
+    </title>
+    <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <!-- css -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tocas-ui/5.0.2/tocas.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/tocas-ui/5.0.2/tocas.min.js"></script>
+    <!-- Fonts -->
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+TC:wght@400;500;700&display=swap" rel="stylesheet">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <!-- Code highlight -->
+    <!-- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/default.min.css"> -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/vs2015.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/highlight.min.js"></script>
+    <!-- additional languages -->
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/go.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/c.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/javascript.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/css.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/xml.min.js"></script>
+    <style>
+      #msgbox{
+      position: fixed;
+      bottom: 1em;
+      right: 1em;
+      z-index: 9999;
+      }
+
+      @keyframes fadeIn {
+      from {
+      opacity: 0;
+      }
+      to {
+      opacity: 1;
+      }
+      }
+
+      dialog[open] {
+      animation: fadeIn 0.3s ease-in-out;
+      }
+
+      code{
+      border-radius: 0.5rem;
+      }
+    </style>
+    <script src="/html/assets/theme.js"></script>
+  </head>
+  <body>
+    <div class="ts-content">
+      <div class="ts-container">
+        <div style="float: right;">
+          <button class="ts-button is-icon" id="darkModeToggle">
+            <span class="ts-icon is-moon-icon"></span>
+          </button>
+        </div>
+        <div class="ts-tab is-pilled">
+          <a href="" class="item" style="user-select: none;">
+            <img id="sysicon" class="ts-image" style="height: 30px" white_src="/html/assets/logo.png" dark_src="/html/assets/logo_white.png" src="/html/assets/logo.png"></img>
+          </a>
+          <a href="#!" class="is-active item">
+            Documents
+          </a>
+          <a href="#!" class="item">
+            Examples
+          </a>
+        </div>
+      </div>
+    </div>
+    <div class="ts-divider"></div>
+    <div>
+      <div class="has-padded">
+        <div class="ts-grid mobile:is-stacked">
+          <div class="column is-4-wide">
+            <div class="ts-box">
+              <div class="ts-menu is-end-icon">
+                <a class="item">
+                  Introduction
+                  <span class="ts-icon is-caret-down-icon"></span>
+                </a>
+                <div class="ts-menu is-dense is-small is-horizontally-padded">
+                  <a class="item" href="/html/1. Introduction/1. What is Zoraxy Plugin.html">
+                    What is Zoraxy Plugin
+                  </a>
+                  <a class="item" href="/html/1. Introduction/2. Getting Started.html">
+                    Getting Started
+                  </a>
+                  <a class="item" href="/html/1. Introduction/3. Installing Plugin.html">
+                    Installing Plugin
+                  </a>
+                  <a class="item" href="/html/1. Introduction/4. Enable Plugins.html">
+                    Enable Plugins
+                  </a>
+                  <a class="item" href="/html/1. Introduction/5. Viewing Plugin Info.html">
+                    Viewing Plugin Info
+                  </a>
+                </div>
+                <a class="item">
+                  Architecture
+                  <span class="ts-icon is-caret-down-icon"></span>
+                </a>
+                <div class="ts-menu is-dense is-small is-horizontally-padded">
+                  <a class="item" href="/html/2. Architecture/1. Plugin Architecture.html">
+                    Plugin Architecture
+                  </a>
+                  <a class="item" href="/html/2. Architecture/2. Introspect.html">
+                    Introspect
+                  </a>
+                  <a class="item" href="/html/2. Architecture/3. Configure.html">
+                    Configure
+                  </a>
+                  <a class="item" href="/html/2. Architecture/4. Capture Modes.html">
+                    Capture Modes
+                  </a>
+                  <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
+                    Plugin UI
+                  </a>
+                  <a class="item is-active" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
+                </div>
+                <a class="item">
+                  Basic Examples
+                  <span class="ts-icon is-caret-down-icon"></span>
+                </a>
+                <div class="ts-menu is-dense is-small is-horizontally-padded">
+                  <a class="item" href="/html/3. Basic Examples/1. Hello World.html">
+                    Hello World
+                  </a>
+                  <a class="item" href="/html/3. Basic Examples/2. RESTful Example.html">
+                    RESTful Example
+                  </a>
+                  <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
+                    Static Capture Example
+                  </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
+                </div>
+                <a class="item" href="/html/index.html">
+                  index
+                </a>
+              </div>
+            </div>
+          </div>
+          <div class="column is-12-wide">
+            <div class="ts-box">
+              <div class="ts-container is-padded has-top-padded-large">
+                <h1 id="compile-a-plugin">
+                  Compile a Plugin
+                </h1>
+                <p>
+                  <p class="ts-text">
+                    A plugin is basically a go program with a HTTP Server / Listener. The steps required to build a plugin is identical as building a ordinary go program.
+                  </p>
+                </p>
+                <pre><code class="language-bash"># Assuming you are currently inside the root folder of your plugin
+go mod tidy
+go build
+
+# Validate if the plugin is correctly build using -introspect flag
+./{{your_plugin_name}} -introspect
+
+# You should see your plugin information printed to STDOUT as JSON string
+</code></pre>
+              </div>
+              <br>
+              <br>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+    <div class="ts-container">
+      <div class="ts-divider"></div>
+      <div class="ts-content">
+        <div class="ts-text">
+          Zoraxy © tobychui
+          <span class="thisyear">
+            2025
+          </span>
+        </div>
+      </div>
+    </div>
+    <script>
+      $(".thisyear").text(new Date().getFullYear());
+    </script>
+    <script>
+      hljs.highlightAll();
+    </script>
+  </body>
+</html>

docs/plugins/html/3. Basic Examples/1. Hello World.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/3. Basic Examples/2. RESTful Example.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index

docs/plugins/html/3. Basic Examples/3. Static Capture Example.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item is-active" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item" href="/html/index.html">
                   index
@@ -275,6 +281,19 @@ pathRouter.RegisterStaticCaptureHandle(STATIC_CAPTURE_INGRESS, http.DefaultServe
                     is used to handle exceptions where a request is forwarded to your plugin but it cannot be handled by any of your registered path handlers. This is usually an implementation bug on the plugin side and you can add some help message or debug log to this function if needed.
                   </p>
                 </p>
+                <p>
+                  <p class="ts-text">
+                    The
+                    <span class="ts-text is-code">
+                      RegisterStaticCaptureHandle
+                    </span>
+                    is used to register the static capture ingress endpoint, so Zoraxy knows where to forward the HTTP request when it thinks your plugin shall be the one handling the request. In this example,
+                    <span class="ts-text is-code">
+                      /s_capture
+                    </span>
+                    is used for static capture endpoint.
+                  </p>
+                </p>
                 <div class="ts-divider has-top-spaced-large"></div>
                 <h2 id="4-implement-handlers">
                   4. Implement Handlers

docs/plugins/html/3. Basic Examples/4. Dynamic Capture Example.html

@@ -0,0 +1,673 @@
+<!DOCTYPE html>
+<html lang="en" class="is-white">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" type="image/png" href="/favicon.png">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>
+      Dynamic Capture Example | Zoraxy Documentation
+    </title>
+    <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/showdown/2.1.0/showdown.min.js" integrity="sha512-LhccdVNGe2QMEfI3x4DVV3ckMRe36TfydKss6mJpdHjNFiV07dFpS2xzeZedptKZrwxfICJpez09iNioiSZ3hA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <!-- css -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/tocas-ui/5.0.2/tocas.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/tocas-ui/5.0.2/tocas.min.js"></script>
+    <!-- Fonts -->
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+TC:wght@400;500;700&display=swap" rel="stylesheet">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <!-- Code highlight -->
+    <!-- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/default.min.css"> -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/vs2015.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/highlight.min.js"></script>
+    <!-- additional languages -->
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/go.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/c.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/javascript.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/css.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/xml.min.js"></script>
+    <style>
+      #msgbox{
+      position: fixed;
+      bottom: 1em;
+      right: 1em;
+      z-index: 9999;
+      }
+
+      @keyframes fadeIn {
+      from {
+      opacity: 0;
+      }
+      to {
+      opacity: 1;
+      }
+      }
+
+      dialog[open] {
+      animation: fadeIn 0.3s ease-in-out;
+      }
+
+      code{
+      border-radius: 0.5rem;
+      }
+    </style>
+    <script src="/html/assets/theme.js"></script>
+  </head>
+  <body>
+    <div class="ts-content">
+      <div class="ts-container">
+        <div style="float: right;">
+          <button class="ts-button is-icon" id="darkModeToggle">
+            <span class="ts-icon is-moon-icon"></span>
+          </button>
+        </div>
+        <div class="ts-tab is-pilled">
+          <a href="" class="item" style="user-select: none;">
+            <img id="sysicon" class="ts-image" style="height: 30px" white_src="/html/assets/logo.png" dark_src="/html/assets/logo_white.png" src="/html/assets/logo.png"></img>
+          </a>
+          <a href="#!" class="is-active item">
+            Documents
+          </a>
+          <a href="#!" class="item">
+            Examples
+          </a>
+        </div>
+      </div>
+    </div>
+    <div class="ts-divider"></div>
+    <div>
+      <div class="has-padded">
+        <div class="ts-grid mobile:is-stacked">
+          <div class="column is-4-wide">
+            <div class="ts-box">
+              <div class="ts-menu is-end-icon">
+                <a class="item">
+                  Introduction
+                  <span class="ts-icon is-caret-down-icon"></span>
+                </a>
+                <div class="ts-menu is-dense is-small is-horizontally-padded">
+                  <a class="item" href="/html/1. Introduction/1. What is Zoraxy Plugin.html">
+                    What is Zoraxy Plugin
+                  </a>
+                  <a class="item" href="/html/1. Introduction/2. Getting Started.html">
+                    Getting Started
+                  </a>
+                  <a class="item" href="/html/1. Introduction/3. Installing Plugin.html">
+                    Installing Plugin
+                  </a>
+                  <a class="item" href="/html/1. Introduction/4. Enable Plugins.html">
+                    Enable Plugins
+                  </a>
+                  <a class="item" href="/html/1. Introduction/5. Viewing Plugin Info.html">
+                    Viewing Plugin Info
+                  </a>
+                </div>
+                <a class="item">
+                  Architecture
+                  <span class="ts-icon is-caret-down-icon"></span>
+                </a>
+                <div class="ts-menu is-dense is-small is-horizontally-padded">
+                  <a class="item" href="/html/2. Architecture/1. Plugin Architecture.html">
+                    Plugin Architecture
+                  </a>
+                  <a class="item" href="/html/2. Architecture/2. Introspect.html">
+                    Introspect
+                  </a>
+                  <a class="item" href="/html/2. Architecture/3. Configure.html">
+                    Configure
+                  </a>
+                  <a class="item" href="/html/2. Architecture/4. Capture Modes.html">
+                    Capture Modes
+                  </a>
+                  <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
+                    Plugin UI
+                  </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
+                </div>
+                <a class="item">
+                  Basic Examples
+                  <span class="ts-icon is-caret-down-icon"></span>
+                </a>
+                <div class="ts-menu is-dense is-small is-horizontally-padded">
+                  <a class="item" href="/html/3. Basic Examples/1. Hello World.html">
+                    Hello World
+                  </a>
+                  <a class="item" href="/html/3. Basic Examples/2. RESTful Example.html">
+                    RESTful Example
+                  </a>
+                  <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
+                    Static Capture Example
+                  </a>
+                  <a class="item is-active" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
+                </div>
+                <a class="item" href="/html/index.html">
+                  index
+                </a>
+              </div>
+            </div>
+          </div>
+          <div class="column is-12-wide">
+            <div class="ts-box">
+              <div class="ts-container is-padded has-top-padded-large">
+                <h1 id="dynamic-capture-example">
+                  Dynamic Capture Example
+                </h1>
+                <p>
+                  <p class="ts-text">
+                    Last Update: 29/05/2025
+                  </p>
+                </p>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <p>
+                  <p class="ts-text">
+                    This example demonstrates how to use dynamic capture in Zoraxy plugins. Dynamic capture allows you to intercept requests based on real-time conditions, so you can program your plugin in a way that it can decided if it want to handle the request or not.
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    <span class="ts-text is-heavy">
+                      Notes: This example assumes you have already read Hello World and Stataic Capture Example.
+                    </span>
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    Lets dive in!
+                  </p>
+                </p>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <h2 id="1-create-the-plugin-folder-structure">
+                  1. Create the plugin folder structure
+                </h2>
+                <p>
+                  <p class="ts-text">
+                    Follow the same steps as the Hello World example to set up the plugin folder structure. Refer to the Hello World example sections 1 to 5 for details.
+                  </p>
+                </p>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <h2 id="2-define-introspect">
+                  2. Define Introspect
+                </h2>
+                <p>
+                  <p class="ts-text">
+                    The introspect configuration specifies the dynamic capture sniff and ingress paths for your plugin.
+                  </p>
+                </p>
+                <pre><code class="language-go">runtimeCfg, err := plugin.ServeAndRecvSpec(&amp;plugin.IntroSpect{
+    ID:            &quot;org.aroz.zoraxy.dynamic-capture-example&quot;,
+    Name:          &quot;Dynamic Capture Example&quot;,
+    Author:        &quot;aroz.org&quot;,
+    AuthorContact: &quot;https://aroz.org&quot;,
+    Description:   &quot;This is an example plugin for Zoraxy that demonstrates how to use dynamic captures.&quot;,
+    URL:           &quot;https://zoraxy.aroz.org&quot;,
+    Type:          plugin.PluginType_Router,
+    VersionMajor:  1,
+    VersionMinor:  0,
+    VersionPatch:  0,
+
+    DynamicCaptureSniff:   &quot;/d_sniff&quot;,
+    DynamicCaptureIngress: &quot;/d_capture&quot;,
+
+    UIPath: UI_PATH,
+})
+if err != nil {
+    panic(err)
+}
+</code></pre>
+                <p>
+                  <p class="ts-text">
+                    Note the
+                    <span class="ts-text is-code">
+                      DynamicCaptureSniff
+                    </span>
+                    and
+                    <span class="ts-text is-code">
+                      DynamicCaptureIngress
+                    </span>
+                    . These paths define the sniffing and capturing behavior for dynamic requests. The sniff path is used to evaluate whether a request should be intercepted, while the ingress path handles the intercepted requests.
+                  </p>
+                </p>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <h2 id="3-register-dynamic-capture-handlers">
+                  3. Register Dynamic Capture Handlers
+                </h2>
+                <p>
+                  <p class="ts-text">
+                    Dynamic capture handlers are used to process requests that match specific conditions.
+                  </p>
+                </p>
+                <pre><code class="language-go">pathRouter := plugin.NewPathRouter()
+pathRouter.SetDebugPrintMode(true)
+
+pathRouter.RegisterDynamicSniffHandler(&quot;/d_sniff&quot;, http.DefaultServeMux, func(dsfr *plugin.DynamicSniffForwardRequest) plugin.SniffResult {
+    if strings.HasPrefix(dsfr.RequestURI, &quot;/foobar&quot;) {
+        fmt.Println(&quot;Accepting request with UUID: &quot; + dsfr.GetRequestUUID())
+        return plugin.SniffResultAccpet
+    }
+    fmt.Println(&quot;Skipping request with UUID: &quot; + dsfr.GetRequestUUID())
+    return plugin.SniffResultSkip
+})
+
+pathRouter.RegisterDynamicCaptureHandle(&quot;/d_capture&quot;, http.DefaultServeMux, func(w http.ResponseWriter, r *http.Request) {
+    w.WriteHeader(http.StatusOK)
+    w.Write([]byte(&quot;Welcome to the dynamic capture handler!\n\nRequest Info:\n&quot;))
+    w.Write([]byte(&quot;Request URI: &quot; + r.RequestURI + &quot;\n&quot;))
+    w.Write([]byte(&quot;Request Method: &quot; + r.Method + &quot;\n&quot;))
+    w.Write([]byte(&quot;Request Headers:\n&quot;))
+    headers := make([]string, 0, len(r.Header))
+    for key := range r.Header {
+        headers = append(headers, key)
+    }
+    sort.Strings(headers)
+    for _, key := range headers {
+        for _, value := range r.Header[key] {
+            w.Write([]byte(fmt.Sprintf(&quot;%s: %s\n&quot;, key, value)))
+        }
+    }
+})
+</code></pre>
+                <p>
+                  <p class="ts-text">
+                    The
+                    <span class="ts-text is-code">
+                      RegisterDynamicSniffHandler
+                    </span>
+                    evaluates incoming requests, while the
+                    <span class="ts-text is-code">
+                      RegisterDynamicCaptureHandle
+                    </span>
+                    processes the intercepted requests.
+                  </p>
+                </p>
+                <h3 id="sniffing-logic">
+                  Sniffing Logic
+                </h3>
+                <p>
+                  If a module registered a dynamic capture path, Zoraxy will forward the request headers as
+                  <span class="ts-text is-code">
+                    DynamicSniffForwardRequest
+                  </span>
+                  (
+                  <span class="ts-text is-code">
+                    dsfr
+                  </span>
+                  ) object to all the plugins that is assigned to this tag. And in each of the plugins, a dedicated logic will take in the object and &ldquo;think&rdquo; if they want to handle the request. You can get the following information from the dsfr object by directly accessing the members of it.
+                </p>
+                <pre><code class="language-go">type DynamicSniffForwardRequest struct {
+	Method     string              `json:&quot;method&quot;`
+	Hostname   string              `json:&quot;hostname&quot;`
+	URL        string              `json:&quot;url&quot;`
+	Header     map[string][]string `json:&quot;header&quot;`
+	RemoteAddr string              `json:&quot;remote_addr&quot;`
+	Host       string              `json:&quot;host&quot;`
+	RequestURI string              `json:&quot;request_uri&quot;`
+	Proto      string              `json:&quot;proto&quot;`
+	ProtoMajor int                 `json:&quot;proto_major&quot;`
+	ProtoMinor int                 `json:&quot;proto_minor&quot;`
+}
+</code></pre>
+                <p>
+                  <p class="ts-text">
+                    You can also use the
+                    <span class="ts-text is-code">
+                      GetRequest()
+                    </span>
+                    function to get the
+                    <span class="ts-text is-code">
+                      *http.Request
+                    </span>
+                    object or
+                    <span class="ts-text is-code">
+                      GetRequestUUID()
+                    </span>
+                    to get a
+                    <span class="ts-text is-code">
+                      string
+                    </span>
+                    value that is a UUID corresponding to this request for later matching with the incoming, forwarded request.
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    <span class="ts-text is-heavy">
+                      Note that since all request will pass through the sniffing function in your plugin, do not implement any blocking logic in your sniffing function, otherwise this will slow down all traffic going through the HTTP proxy rule with the plugin enabled.
+                    </span>
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    In the sniffing stage, you can choose to either return
+                    <span class="ts-text is-code">
+                      ControlStatusCode_CAPTURED
+                    </span>
+                    , where Zoraxy will forward the request to your plugin
+                    <span class="ts-text is-code">
+                      DynamicCaptureIngress
+                    </span>
+                    endpoint, or
+                    <span class="ts-text is-code">
+                      ControlStatusCode_UNHANDLED
+                    </span>
+                    , where Zoraxy will pass on the request to the next dynamic handling plugin or if there are no more plugins to handle the routing, to the upstream server.
+                  </p>
+                </p>
+                <h3 id="capture-handling">
+                  Capture Handling
+                </h3>
+                <p>
+                  <p class="ts-text">
+                    The capture handling is where Zoraxy formally forward you the HTTP request the client is requesting. In this situation,  you must response the request by properly handling the
+                    <span class="ts-text is-code">
+                      http.Request
+                    </span>
+                    by writing to the
+                    <span class="ts-text is-code">
+                      http.ResponseWriter
+                    </span>
+                    .
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    If there is a need to match the sniffing to the capture handling logic (Let say you want to design your plugin to run some kind of pre-processing before the actual request came in), you can use the
+                    <span class="ts-text is-code">
+                      X-Zoraxy-Requestid
+                    </span>
+                    header in the HTTP request. This is the same UUID as the one you get from
+                    <span class="ts-text is-code">
+                      dsfr.GetRequestUUID()
+                    </span>
+                    in the sniffing stage if they are the same request object on Zoraxy side.
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    The http request that Zoraxy forwards to the plugin capture handling endpoint contains header like these.
+                  </p>
+                </p>
+                <pre><code class="language-html">Request URI: /foobar/test
+Request Method: GET
+Request Headers:
+Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+Accept-Encoding: gzip, deflate, br, zstd
+(more fileds)
+X-Forwarded-For: 127.0.0.1
+X-Forwarded-Proto: https
+X-Real-Ip: 127.0.0.1
+X-Zoraxy-Requestid: d00619b8-f39e-4c04-acd8-c3a6f55b1566
+</code></pre>
+                <p>
+                  <p class="ts-text">
+                    You can extract the
+                    <span class="ts-text is-code">
+                      X-Zoraxy-Requestid
+                    </span>
+                    value from the request header and do your matching for implementing your function if needed.
+                  </p>
+                </p>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <h2 id="4-render-debug-ui">
+                  4. Render Debug UI
+                </h2>
+                <p>
+                  <p class="ts-text">
+                    This UI is used help validate the management Web UI is correctly shown in Zoraxy webmin interface. You should implement the required management interface for your plugin here.
+                  </p>
+                </p>
+                <pre><code class="language-go">func RenderDebugUI(w http.ResponseWriter, r *http.Request) {
+    fmt.Fprint(w, &quot;**Plugin UI Debug Interface**\n\n[Recv Headers] \n&quot;)
+    headerKeys := make([]string, 0, len(r.Header))
+    for name := range r.Header {
+        headerKeys = append(headerKeys, name)
+    }
+    sort.Strings(headerKeys)
+    for _, name := range headerKeys {
+        values := r.Header[name]
+        for _, value := range values {
+            fmt.Fprintf(w, &quot;%s: %s\n&quot;, name, value)
+        }
+    }
+    w.Header().Set(&quot;Content-Type&quot;, &quot;text/html&quot;)
+}
+</code></pre>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <h2 id="5-full-code">
+                  5. Full Code
+                </h2>
+                <p>
+                  <p class="ts-text">
+                    Here is the complete code for the dynamic capture example:
+                  </p>
+                </p>
+                <pre><code class="language-go">package main
+
+import (
+	&quot;fmt&quot;
+	&quot;net/http&quot;
+	&quot;sort&quot;
+	&quot;strconv&quot;
+	&quot;strings&quot;
+
+	plugin &quot;example.com/zoraxy/dynamic-capture-example/mod/zoraxy_plugin&quot;
+)
+
+const (
+	PLUGIN_ID              = &quot;org.aroz.zoraxy.dynamic-capture-example&quot;
+	UI_PATH                = &quot;/debug&quot;
+	STATIC_CAPTURE_INGRESS = &quot;/s_capture&quot;
+)
+
+func main() {
+	// Serve the plugin intro spect
+	// This will print the plugin intro spect and exit if the -introspect flag is provided
+	runtimeCfg, err := plugin.ServeAndRecvSpec(&amp;plugin.IntroSpect{
+		ID:            &quot;org.aroz.zoraxy.dynamic-capture-example&quot;,
+		Name:          &quot;Dynamic Capture Example&quot;,
+		Author:        &quot;aroz.org&quot;,
+		AuthorContact: &quot;https://aroz.org&quot;,
+		Description:   &quot;This is an example plugin for Zoraxy that demonstrates how to use dynamic captures.&quot;,
+		URL:           &quot;https://zoraxy.aroz.org&quot;,
+		Type:          plugin.PluginType_Router,
+		VersionMajor:  1,
+		VersionMinor:  0,
+		VersionPatch:  0,
+
+		DynamicCaptureSniff:   &quot;/d_sniff&quot;,
+		DynamicCaptureIngress: &quot;/d_capture&quot;,
+
+		UIPath: UI_PATH,
+
+		/*
+			SubscriptionPath: &quot;/subept&quot;,
+			SubscriptionsEvents: []plugin.SubscriptionEvent{
+		*/
+	})
+	if err != nil {
+		//Terminate or enter standalone mode here
+		panic(err)
+	}
+
+	// Setup the path router
+	pathRouter := plugin.NewPathRouter()
+	pathRouter.SetDebugPrintMode(true)
+
+	/*
+		Dynamic Captures
+	*/
+	pathRouter.RegisterDynamicSniffHandler(&quot;/d_sniff&quot;, http.DefaultServeMux, func(dsfr *plugin.DynamicSniffForwardRequest) plugin.SniffResult {
+		//In this example, we want to capture all URI
+		//that start with /foobar and forward it to the dynamic capture handler
+		if strings.HasPrefix(dsfr.RequestURI, &quot;/foobar&quot;) {
+			reqUUID := dsfr.GetRequestUUID()
+			fmt.Println(&quot;Accepting request with UUID: &quot; + reqUUID)
+
+			// Print all the values of the request
+			fmt.Println(&quot;Method:&quot;, dsfr.Method)
+			fmt.Println(&quot;Hostname:&quot;, dsfr.Hostname)
+			fmt.Println(&quot;URL:&quot;, dsfr.URL)
+			fmt.Println(&quot;Header:&quot;)
+			for key, values := range dsfr.Header {
+				for _, value := range values {
+					fmt.Printf(&quot;  %s: %s\n&quot;, key, value)
+				}
+			}
+			fmt.Println(&quot;RemoteAddr:&quot;, dsfr.RemoteAddr)
+			fmt.Println(&quot;Host:&quot;, dsfr.Host)
+			fmt.Println(&quot;RequestURI:&quot;, dsfr.RequestURI)
+			fmt.Println(&quot;Proto:&quot;, dsfr.Proto)
+			fmt.Println(&quot;ProtoMajor:&quot;, dsfr.ProtoMajor)
+			fmt.Println(&quot;ProtoMinor:&quot;, dsfr.ProtoMinor)
+
+			// We want to handle this request, reply with aSniffResultAccept
+			return plugin.SniffResultAccpet
+		}
+
+		// If the request URI does not match, we skip this request
+		fmt.Println(&quot;Skipping request with UUID: &quot; + dsfr.GetRequestUUID())
+		return plugin.SniffResultSkip
+	})
+	pathRouter.RegisterDynamicCaptureHandle(&quot;/d_capture&quot;, http.DefaultServeMux, func(w http.ResponseWriter, r *http.Request) {
+		// This is the dynamic capture handler where it actually captures and handle the request
+		w.WriteHeader(http.StatusOK)
+		w.Write([]byte(&quot;Welcome to the dynamic capture handler!&quot;))
+
+		// Print all the request info to the response writer
+		w.Write([]byte(&quot;\n\nRequest Info:\n&quot;))
+		w.Write([]byte(&quot;Request URI: &quot; + r.RequestURI + &quot;\n&quot;))
+		w.Write([]byte(&quot;Request Method: &quot; + r.Method + &quot;\n&quot;))
+		w.Write([]byte(&quot;Request Headers:\n&quot;))
+		headers := make([]string, 0, len(r.Header))
+		for key := range r.Header {
+			headers = append(headers, key)
+		}
+		sort.Strings(headers)
+		for _, key := range headers {
+			for _, value := range r.Header[key] {
+				w.Write([]byte(fmt.Sprintf(&quot;%s: %s\n&quot;, key, value)))
+			}
+		}
+	})
+
+	http.HandleFunc(UI_PATH+&quot;/&quot;, RenderDebugUI)
+	fmt.Println(&quot;Dynamic capture example started at http://127.0.0.1:&quot; + strconv.Itoa(runtimeCfg.Port))
+	http.ListenAndServe(&quot;127.0.0.1:&quot;+strconv.Itoa(runtimeCfg.Port), nil)
+}
+
+// Render the debug UI
+func RenderDebugUI(w http.ResponseWriter, r *http.Request) {
+	fmt.Fprint(w, &quot;**Plugin UI Debug Interface**\n\n[Recv Headers] \n&quot;)
+
+	headerKeys := make([]string, 0, len(r.Header))
+	for name := range r.Header {
+		headerKeys = append(headerKeys, name)
+	}
+	sort.Strings(headerKeys)
+	for _, name := range headerKeys {
+		values := r.Header[name]
+		for _, value := range values {
+			fmt.Fprintf(w, &quot;%s: %s\n&quot;, name, value)
+		}
+	}
+	w.Header().Set(&quot;Content-Type&quot;, &quot;text/html&quot;)
+}
+
+</code></pre>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <h2 id="6-expected-output">
+                  6. Expected Output
+                </h2>
+                <p>
+                  To enable the plugin, add the plugin to one of the tags and assign the tag to your HTTP Proxy Rule. Here is an example of assigning the plugin to the &ldquo;debug&rdquo; tag and assigning it to a localhost loopback HTTP proxy rule.
+                </p>
+                <p>
+                  <p class="ts-text">
+                    When the plugin is running, requests matching the sniff conditions will be intercepted and processed by the dynamic capture handler.
+                  </p>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    If everything is correctly setup, you should see the following page when requesting any URL with prefix
+                    <span class="ts-text is-code">
+                      (your_HTTP_proxy_rule_hostname)/foobar
+                    </span>
+                  </p>
+                </p>
+                <p>
+                  <div class="ts-image is-rounded" style="max-width: 800px">
+                    <img src="img/4. Dynamic Capture Example/image-20250530205430254.png" alt="image-20250530205430254" />
+                  </div>
+                </p>
+                <p>
+                  <p class="ts-text">
+                    Example terminal output for requesting
+                    <span class="ts-text is-code">
+                      /foobar/*
+                    </span>
+                    :
+                  </p>
+                </p>
+                <pre><span class="ts-text is-code">[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Request captured by dynamic sniff path: /d_sniff/
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Header:
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Method: GET
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Hostname: a.localhost
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] URL: /foobar/test
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Accepting request with UUID: 8c916c58-0d6a-4d11-a2f0-f29d3d984509
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-Dest: document
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Accept-Encoding: gzip, deflate, br, zstd
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Accept-Language: zh-TW,zh;q=0.9,en;q=0.8,en-GB;q=0.7,en-US;q=0.6
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Cache-Control: max-age=0
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-User: ?1
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Upgrade-Insecure-Requests: 1
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36 Edg/136.0.0.0
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Priority: u=0, i
+[2025-05-30 20:44:26.143149] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Ch-Ua-Mobile: ?0
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Ch-Ua: &quot;Chromium&quot;;v=&quot;136&quot;, &quot;Microsoft Edge&quot;;v=&quot;136&quot;, &quot;Not.A/Brand&quot;;v=&quot;99&quot;
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Ch-Ua-Platform: &quot;Windows&quot;
+[2025-05-30 20:44:26.142645] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-Site: none
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964]   Sec-Fetch-Mode: navigate
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] RemoteAddr: [::1]:54522
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Host: a.localhost
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] RequestURI: /foobar/test
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] Proto: HTTP/2.0
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] ProtoMajor: 2
+[2025-05-30 20:44:26.143165] [plugin-manager] [system:info] [Dynamic Capture Example:22964] ProtoMinor: 0
+</span></pre>
+                <div class="ts-divider has-top-spaced-large"></div>
+                <p>
+                  <p class="ts-text">
+                    Now you know how to develop a plugin in Zoraxy that handles special routings!
+                  </p>
+                </p>
+              </div>
+              <br>
+              <br>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+    <div class="ts-container">
+      <div class="ts-divider"></div>
+      <div class="ts-content">
+        <div class="ts-text">
+          Zoraxy © tobychui
+          <span class="thisyear">
+            2025
+          </span>
+        </div>
+      </div>
+    </div>
+    <script>
+      $(".thisyear").text(new Date().getFullYear());
+    </script>
+    <script>
+      hljs.highlightAll();
+    </script>
+  </body>
+</html>

docs/plugins/html/index.html

@@ -123,6 +123,9 @@
                   <a class="item" href="/html/2. Architecture/5. Plugin UI.html">
                     Plugin UI
                   </a>
+                  <a class="item" href="/html/2. Architecture/6. Compile a Plugin.html">
+                    Compile a Plugin
+                  </a>
                 </div>
                 <a class="item">
                   Basic Examples
@@ -138,6 +141,9 @@
                   <a class="item" href="/html/3. Basic Examples/3. Static Capture Example.html">
                     Static Capture Example
                   </a>
+                  <a class="item" href="/html/3. Basic Examples/4. Dynamic Capture Example.html">
+                    Dynamic Capture Example
+                  </a>
                 </div>
                 <a class="item is-active" href="/html/index.html">
                   index

docs/plugins/index.json

@@ -64,6 +64,11 @@
           "filename": "2. Architecture/5. Plugin UI.md",
           "title": "Plugin UI",
           "type": "file"
+        },
+        {
+          "filename": "2. Architecture/6. Compile a Plugin.md",
+          "title": "Compile a Plugin",
+          "type": "file"
         }
       ]
     },
@@ -86,6 +91,11 @@
           "filename": "3. Basic Examples/3. Static Capture Example.md",
           "title": "Static Capture Example",
           "type": "file"
+        },
+        {
+          "filename": "3. Basic Examples/4. Dynamic Capture Example.md",
+          "title": "Dynamic Capture Example",
+          "type": "file"
         }
       ]
     },

example/plugins/dynamic-capture-example/go.mod

@@ -0,0 +1,3 @@
+module example.com/zoraxy/dynamic-capture-example
+
+go 1.23.6

example/plugins/dynamic-capture-example/main.go

@@ -0,0 +1,131 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"sort"
+	"strconv"
+	"strings"
+
+	plugin "example.com/zoraxy/dynamic-capture-example/mod/zoraxy_plugin"
+)
+
+const (
+	PLUGIN_ID              = "org.aroz.zoraxy.dynamic-capture-example"
+	UI_PATH                = "/debug"
+	STATIC_CAPTURE_INGRESS = "/s_capture"
+)
+
+func main() {
+	// Serve the plugin intro spect
+	// This will print the plugin intro spect and exit if the -introspect flag is provided
+	runtimeCfg, err := plugin.ServeAndRecvSpec(&plugin.IntroSpect{
+		ID:            "org.aroz.zoraxy.dynamic-capture-example",
+		Name:          "Dynamic Capture Example",
+		Author:        "aroz.org",
+		AuthorContact: "https://aroz.org",
+		Description:   "This is an example plugin for Zoraxy that demonstrates how to use dynamic captures.",
+		URL:           "https://zoraxy.aroz.org",
+		Type:          plugin.PluginType_Router,
+		VersionMajor:  1,
+		VersionMinor:  0,
+		VersionPatch:  0,
+
+		DynamicCaptureSniff:   "/d_sniff",
+		DynamicCaptureIngress: "/d_capture",
+
+		UIPath: UI_PATH,
+
+		/*
+			SubscriptionPath: "/subept",
+			SubscriptionsEvents: []plugin.SubscriptionEvent{
+		*/
+	})
+	if err != nil {
+		//Terminate or enter standalone mode here
+		panic(err)
+	}
+
+	// Setup the path router
+	pathRouter := plugin.NewPathRouter()
+	pathRouter.SetDebugPrintMode(true)
+
+	/*
+		Dynamic Captures
+	*/
+	pathRouter.RegisterDynamicSniffHandler("/d_sniff", http.DefaultServeMux, func(dsfr *plugin.DynamicSniffForwardRequest) plugin.SniffResult {
+		//In this example, we want to capture all URI
+		//that start with /foobar and forward it to the dynamic capture handler
+		if strings.HasPrefix(dsfr.RequestURI, "/foobar") {
+			reqUUID := dsfr.GetRequestUUID()
+			fmt.Println("Accepting request with UUID: " + reqUUID)
+
+			// Print all the values of the request
+			fmt.Println("Method:", dsfr.Method)
+			fmt.Println("Hostname:", dsfr.Hostname)
+			fmt.Println("URL:", dsfr.URL)
+			fmt.Println("Header:")
+			for key, values := range dsfr.Header {
+				for _, value := range values {
+					fmt.Printf("  %s: %s\n", key, value)
+				}
+			}
+			fmt.Println("RemoteAddr:", dsfr.RemoteAddr)
+			fmt.Println("Host:", dsfr.Host)
+			fmt.Println("RequestURI:", dsfr.RequestURI)
+			fmt.Println("Proto:", dsfr.Proto)
+			fmt.Println("ProtoMajor:", dsfr.ProtoMajor)
+			fmt.Println("ProtoMinor:", dsfr.ProtoMinor)
+
+			// We want to handle this request, reply with aSniffResultAccept
+			return plugin.SniffResultAccpet
+		}
+
+		// If the request URI does not match, we skip this request
+		fmt.Println("Skipping request with UUID: " + dsfr.GetRequestUUID())
+		return plugin.SniffResultSkip
+	})
+	pathRouter.RegisterDynamicCaptureHandle("/d_capture", http.DefaultServeMux, func(w http.ResponseWriter, r *http.Request) {
+		// This is the dynamic capture handler where it actually captures and handle the request
+		w.WriteHeader(http.StatusOK)
+		w.Write([]byte("Welcome to the dynamic capture handler!"))
+
+		// Print all the request info to the response writer
+		w.Write([]byte("\n\nRequest Info:\n"))
+		w.Write([]byte("Request URI: " + r.RequestURI + "\n"))
+		w.Write([]byte("Request Method: " + r.Method + "\n"))
+		w.Write([]byte("Request Headers:\n"))
+		headers := make([]string, 0, len(r.Header))
+		for key := range r.Header {
+			headers = append(headers, key)
+		}
+		sort.Strings(headers)
+		for _, key := range headers {
+			for _, value := range r.Header[key] {
+				w.Write([]byte(fmt.Sprintf("%s: %s\n", key, value)))
+			}
+		}
+	})
+
+	http.HandleFunc(UI_PATH+"/", RenderDebugUI)
+	fmt.Println("Dynamic capture example started at http://127.0.0.1:" + strconv.Itoa(runtimeCfg.Port))
+	http.ListenAndServe("127.0.0.1:"+strconv.Itoa(runtimeCfg.Port), nil)
+}
+
+// Render the debug UI
+func RenderDebugUI(w http.ResponseWriter, r *http.Request) {
+	fmt.Fprint(w, "**Plugin UI Debug Interface**\n\n[Recv Headers] \n")
+
+	headerKeys := make([]string, 0, len(r.Header))
+	for name := range r.Header {
+		headerKeys = append(headerKeys, name)
+	}
+	sort.Strings(headerKeys)
+	for _, name := range headerKeys {
+		values := r.Header[name]
+		for _, value := range values {
+			fmt.Fprintf(w, "%s: %s\n", name, value)
+		}
+	}
+	w.Header().Set("Content-Type", "text/html")
+}

example/plugins/dynamic-capture-example/mod/zoraxy_plugin/embed_webserver.go

@@ -145,6 +145,24 @@ func (p *PluginUiRouter) RegisterTerminateHandler(termFunc func(), mux *http.Ser
 	})
 }
 
+// HandleFunc registers a handler function for the given pattern
+// The pattern should start with the handler prefix, e.g. /ui/hello
+// If the pattern does not start with the handler prefix, it will be prepended with the handler prefix
+func (p *PluginUiRouter) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request), mux *http.ServeMux) {
+	// If mux is nil, use the default ServeMux
+	if mux == nil {
+		mux = http.DefaultServeMux
+	}
+
+	// Make sure the pattern starts with the handler prefix
+	if !strings.HasPrefix(pattern, p.HandlerPrefix) {
+		pattern = p.HandlerPrefix + pattern
+	}
+
+	// Register the handler with the http.ServeMux
+	mux.HandleFunc(pattern, handler)
+}
+
 // Attach the embed UI handler to the target http.ServeMux
 func (p *PluginUiRouter) AttachHandlerToMux(mux *http.ServeMux) {
 	if mux == nil {

example/plugins/ztnc/README.md

@@ -1,11 +0,0 @@
-## Global Area Network Plugin
-
-This plugin implements a user interface for ZeroTier Network Controller in Zoraxy
-
-
-
-
-
-## License
-
-AGPL

example/plugins/ztnc/go.mod

@@ -1,11 +0,0 @@
-module aroz.org/zoraxy/ztnc
-
-go 1.23.6
-
-require (
-	github.com/boltdb/bolt v1.3.1
-	github.com/syndtr/goleveldb v1.0.0
-	golang.org/x/sys v0.30.0
-)
-
-require github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db // indirect

example/plugins/ztnc/go.sum

@@ -1,30 +0,0 @@
-github.com/boltdb/bolt v1.3.1 h1:JQmyP4ZBrce+ZQu0dY660FMfatumYDLun9hBCUVIkF4=
-github.com/boltdb/bolt v1.3.1/go.mod h1:clJnj/oiGkjum5o1McbSZDSLxVThjynRyGBgiAx27Ps=
-github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
-github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
-github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db h1:woRePGFeVFfLKN/pOkfl+p/TAqKOfFu+7KPlMVpok/w=
-github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
-github.com/hpcloud/tail v1.0.0 h1:nfCOvKYfkgYP8hkirhJocXT2+zOD8yUNjXaWfTlyFKI=
-github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
-github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
-github.com/onsi/ginkgo v1.7.0 h1:WSHQ+IS43OoUrWtD1/bbclrwK8TTH5hzp+umCiuxHgs=
-github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
-github.com/onsi/gomega v1.4.3 h1:RE1xgDvH7imwFD45h+u2SgIfERHlS2yNG4DObb5BSKU=
-github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=
-github.com/syndtr/goleveldb v1.0.0 h1:fBdIW9lB4Iz0n9khmH8w27SJ3QEJ7+IgjPEwGSZiFdE=
-github.com/syndtr/goleveldb v1.0.0/go.mod h1:ZVVdQEZoIme9iO1Ch2Jdy24qqXrMMOU6lpPAyBWyWuQ=
-golang.org/x/net v0.0.0-20180906233101-161cd47e91fd h1:nTDtHvHSdCn1m6ITfMRqtOd/9+7a3s8RBNOZ3eYZzJA=
-golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
-golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
-golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
-golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4=
-gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
-gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
-gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
-gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=
-gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

example/plugins/ztnc/main.go

@@ -1,83 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"net/http"
-	"strconv"
-
-	"embed"
-
-	"aroz.org/zoraxy/ztnc/mod/database"
-	"aroz.org/zoraxy/ztnc/mod/ganserv"
-	plugin "aroz.org/zoraxy/ztnc/mod/zoraxy_plugin"
-)
-
-const (
-	PLUGIN_ID       = "org.aroz.zoraxy.ztnc"
-	UI_RELPATH      = "/ui"
-	EMBED_FS_ROOT   = "/web"
-	DB_FILE_PATH    = "ztnc.db"
-	AUTH_TOKEN_PATH = "./authtoken.secret"
-)
-
-//go:embed web/*
-var content embed.FS
-
-var (
-	sysdb      *database.Database
-	ganManager *ganserv.NetworkManager
-)
-
-func main() {
-	// Serve the plugin intro spect
-	runtimeCfg, err := plugin.ServeAndRecvSpec(&plugin.IntroSpect{
-		ID:            PLUGIN_ID,
-		Name:          "ztnc",
-		Author:        "aroz.org",
-		AuthorContact: "zoraxy.aroz.org",
-		Description:   "UI for ZeroTier Network Controller",
-		URL:           "https://zoraxy.aroz.org",
-		Type:          plugin.PluginType_Utilities,
-		VersionMajor:  1,
-		VersionMinor:  0,
-		VersionPatch:  0,
-
-		// As this is a utility plugin, we don't need to capture any traffic
-		// but only serve the UI, so we set the UI (relative to the plugin path) to "/ui/" to match the HTTP Handler
-		UIPath: UI_RELPATH,
-	})
-	if err != nil {
-		//Terminate or enter standalone mode here
-		panic(err)
-	}
-
-	// Create a new PluginEmbedUIRouter that will serve the UI from web folder
-	uiRouter := plugin.NewPluginEmbedUIRouter(PLUGIN_ID, &content, EMBED_FS_ROOT, UI_RELPATH)
-	uiRouter.EnableDebug = true
-
-	// Register the shutdown handler
-	uiRouter.RegisterTerminateHandler(func() {
-		// Do cleanup here if needed
-		if sysdb != nil {
-			sysdb.Close()
-		}
-		fmt.Println("ztnc Exited")
-	}, nil)
-
-	// This will serve the index.html file embedded in the binary
-	targetHandler := uiRouter.Handler()
-	http.Handle(UI_RELPATH+"/", targetHandler)
-
-	// Start the GAN Network Controller
-	err = startGanNetworkController()
-	if err != nil {
-		panic(err)
-	}
-
-	// Initiate the API endpoints
-	initApiEndpoints()
-
-	// Start the HTTP server, only listen to loopback interface
-	fmt.Println("Plugin UI server started at http://127.0.0.1:" + strconv.Itoa(runtimeCfg.Port) + UI_RELPATH)
-	http.ListenAndServe("127.0.0.1:"+strconv.Itoa(runtimeCfg.Port), nil)
-}

example/plugins/ztnc/mod/database/database.go

@@ -1,146 +0,0 @@
-package database
-
-/*
-	ArOZ Online Database Access Module
-	author: tobychui
-
-	This is an improved Object oriented base solution to the original
-	aroz online database script.
-*/
-
-import (
-	"log"
-	"runtime"
-
-	"aroz.org/zoraxy/ztnc/mod/database/dbinc"
-)
-
-type Database struct {
-	Db          interface{} //This will be nil on openwrt, leveldb.DB on x64 platforms or bolt.DB on other platforms
-	BackendType dbinc.BackendType
-	Backend     dbinc.Backend
-}
-
-func NewDatabase(dbfile string, backendType dbinc.BackendType) (*Database, error) {
-	if runtime.GOARCH == "riscv64" {
-		log.Println("RISCV hardware detected, ignoring the backend type and using FS emulated database")
-	}
-	return newDatabase(dbfile, backendType)
-}
-
-// Get the recommended backend type for the current system
-func GetRecommendedBackendType() dbinc.BackendType {
-	//Check if the system is running on RISCV hardware
-	if runtime.GOARCH == "riscv64" {
-		//RISCV hardware, currently only support FS emulated database
-		return dbinc.BackendFSOnly
-	} else if runtime.GOOS == "windows" || (runtime.GOOS == "linux" && runtime.GOARCH == "amd64") {
-		//Powerful hardware
-		return dbinc.BackendBoltDB
-		//return dbinc.BackendLevelDB
-	}
-
-	//Default to BoltDB, the safest option
-	return dbinc.BackendBoltDB
-}
-
-/*
-	Create / Drop a table
-	Usage:
-	err := sysdb.NewTable("MyTable")
-	err := sysdb.DropTable("MyTable")
-*/
-
-// Create a new table
-func (d *Database) NewTable(tableName string) error {
-	return d.newTable(tableName)
-}
-
-// Check is table exists
-func (d *Database) TableExists(tableName string) bool {
-	return d.tableExists(tableName)
-}
-
-// Drop the given table
-func (d *Database) DropTable(tableName string) error {
-	return d.dropTable(tableName)
-}
-
-/*
-Write to database with given tablename and key. Example Usage:
-
-	type demo struct{
-		content string
-	}
-
-	thisDemo := demo{
-		content: "Hello World",
-	}
-
-err := sysdb.Write("MyTable", "username/message",thisDemo);
-*/
-func (d *Database) Write(tableName string, key string, value interface{}) error {
-	return d.write(tableName, key, value)
-}
-
-/*
-	Read from database and assign the content to a given datatype. Example Usage:
-
-	type demo struct{
-		content string
-	}
-	thisDemo := new(demo)
-	err := sysdb.Read("MyTable", "username/message",&thisDemo);
-*/
-
-func (d *Database) Read(tableName string, key string, assignee interface{}) error {
-	return d.read(tableName, key, assignee)
-}
-
-/*
-Check if a key exists in the database table given tablename and key
-
-	if sysdb.KeyExists("MyTable", "username/message"){
-		log.Println("Key exists")
-	}
-*/
-func (d *Database) KeyExists(tableName string, key string) bool {
-	return d.keyExists(tableName, key)
-}
-
-/*
-Delete a value from the database table given tablename and key
-
-err := sysdb.Delete("MyTable", "username/message");
-*/
-func (d *Database) Delete(tableName string, key string) error {
-	return d.delete(tableName, key)
-}
-
-/*
-	//List table example usage
-	//Assume the value is stored as a struct named "groupstruct"
-
-	entries, err := sysdb.ListTable("test")
-	if err != nil {
-		panic(err)
-	}
-	for _, keypairs := range entries{
-		log.Println(string(keypairs[0]))
-		group := new(groupstruct)
-		json.Unmarshal(keypairs[1], &group)
-		log.Println(group);
-	}
-
-*/
-
-func (d *Database) ListTable(tableName string) ([][][]byte, error) {
-	return d.listTable(tableName)
-}
-
-/*
-Close the database connection
-*/
-func (d *Database) Close() {
-	d.close()
-}

example/plugins/ztnc/mod/database/database_core.go

@@ -1,70 +0,0 @@
-//go:build !mipsle && !riscv64
-// +build !mipsle,!riscv64
-
-package database
-
-import (
-	"errors"
-
-	"aroz.org/zoraxy/ztnc/mod/database/dbbolt"
-	"aroz.org/zoraxy/ztnc/mod/database/dbinc"
-	"aroz.org/zoraxy/ztnc/mod/database/dbleveldb"
-)
-
-func newDatabase(dbfile string, backendType dbinc.BackendType) (*Database, error) {
-	if backendType == dbinc.BackendFSOnly {
-		return nil, errors.New("Unsupported backend type for this platform")
-	}
-
-	if backendType == dbinc.BackendLevelDB {
-		db, err := dbleveldb.NewDB(dbfile)
-		return &Database{
-			Db:          nil,
-			BackendType: backendType,
-			Backend:     db,
-		}, err
-	}
-
-	db, err := dbbolt.NewBoltDatabase(dbfile)
-	return &Database{
-		Db:          nil,
-		BackendType: backendType,
-		Backend:     db,
-	}, err
-}
-
-func (d *Database) newTable(tableName string) error {
-	return d.Backend.NewTable(tableName)
-}
-
-func (d *Database) tableExists(tableName string) bool {
-	return d.Backend.TableExists(tableName)
-}
-
-func (d *Database) dropTable(tableName string) error {
-	return d.Backend.DropTable(tableName)
-}
-
-func (d *Database) write(tableName string, key string, value interface{}) error {
-	return d.Backend.Write(tableName, key, value)
-}
-
-func (d *Database) read(tableName string, key string, assignee interface{}) error {
-	return d.Backend.Read(tableName, key, assignee)
-}
-
-func (d *Database) keyExists(tableName string, key string) bool {
-	return d.Backend.KeyExists(tableName, key)
-}
-
-func (d *Database) delete(tableName string, key string) error {
-	return d.Backend.Delete(tableName, key)
-}
-
-func (d *Database) listTable(tableName string) ([][][]byte, error) {
-	return d.Backend.ListTable(tableName)
-}
-
-func (d *Database) close() {
-	d.Backend.Close()
-}

example/plugins/ztnc/mod/database/database_openwrt.go

@@ -1,196 +0,0 @@
-//go:build mipsle || riscv64
-// +build mipsle riscv64
-
-package database
-
-import (
-	"encoding/json"
-	"errors"
-	"log"
-	"os"
-	"path/filepath"
-	"strings"
-
-	"aroz.org/zoraxy/ztnc/mod/database/dbinc"
-)
-
-/*
-	OpenWRT or RISCV backend
-
-	For OpenWRT or RISCV platform, we will use the filesystem as the database backend
-	as boltdb or leveldb is not supported on these platforms, including boltDB and LevelDB
-	in conditional compilation will create a build error on these platforms
-*/
-
-func newDatabase(dbfile string, backendType dbinc.BackendType) (*Database, error) {
-	dbRootPath := filepath.ToSlash(filepath.Clean(dbfile))
-	dbRootPath = "fsdb/" + dbRootPath
-	err := os.MkdirAll(dbRootPath, 0755)
-	if err != nil {
-		return nil, err
-	}
-
-	log.Println("Filesystem Emulated Key-value Database Service Started: " + dbRootPath)
-	return &Database{
-		Db:          dbRootPath,
-		BackendType: dbinc.BackendFSOnly,
-		Backend:     nil,
-	}, nil
-}
-
-func (d *Database) dump(filename string) ([]string, error) {
-	//Get all file objects from root
-	rootfiles, err := filepath.Glob(filepath.Join(d.Db.(string), "/*"))
-	if err != nil {
-		return []string{}, err
-	}
-
-	//Filter out the folders
-	rootFolders := []string{}
-	for _, file := range rootfiles {
-		if !isDirectory(file) {
-			rootFolders = append(rootFolders, filepath.Base(file))
-		}
-	}
-
-	return rootFolders, nil
-}
-
-func (d *Database) newTable(tableName string) error {
-
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	if !fileExists(tablePath) {
-		return os.MkdirAll(tablePath, 0755)
-	}
-	return nil
-}
-
-func (d *Database) tableExists(tableName string) bool {
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	if _, err := os.Stat(tablePath); errors.Is(err, os.ErrNotExist) {
-		return false
-	}
-
-	if !isDirectory(tablePath) {
-		return false
-	}
-
-	return true
-}
-
-func (d *Database) dropTable(tableName string) error {
-
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	if d.tableExists(tableName) {
-		return os.RemoveAll(tablePath)
-	} else {
-		return errors.New("table not exists")
-	}
-
-}
-
-func (d *Database) write(tableName string, key string, value interface{}) error {
-
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	js, err := json.Marshal(value)
-	if err != nil {
-		return err
-	}
-
-	key = strings.ReplaceAll(key, "/", "-SLASH_SIGN-")
-
-	return os.WriteFile(filepath.Join(tablePath, key+".entry"), js, 0755)
-}
-
-func (d *Database) read(tableName string, key string, assignee interface{}) error {
-	if !d.keyExists(tableName, key) {
-		return errors.New("key not exists")
-	}
-
-	key = strings.ReplaceAll(key, "/", "-SLASH_SIGN-")
-
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	entryPath := filepath.Join(tablePath, key+".entry")
-	content, err := os.ReadFile(entryPath)
-	if err != nil {
-		return err
-	}
-
-	err = json.Unmarshal(content, &assignee)
-	return err
-}
-
-func (d *Database) keyExists(tableName string, key string) bool {
-	key = strings.ReplaceAll(key, "/", "-SLASH_SIGN-")
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	entryPath := filepath.Join(tablePath, key+".entry")
-	return fileExists(entryPath)
-}
-
-func (d *Database) delete(tableName string, key string) error {
-
-	if !d.keyExists(tableName, key) {
-		return errors.New("key not exists")
-	}
-	key = strings.ReplaceAll(key, "/", "-SLASH_SIGN-")
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	entryPath := filepath.Join(tablePath, key+".entry")
-
-	return os.Remove(entryPath)
-}
-
-func (d *Database) listTable(tableName string) ([][][]byte, error) {
-	if !d.tableExists(tableName) {
-		return [][][]byte{}, errors.New("table not exists")
-	}
-	tablePath := filepath.Join(d.Db.(string), filepath.Base(tableName))
-	entries, err := filepath.Glob(filepath.Join(tablePath, "/*.entry"))
-	if err != nil {
-		return [][][]byte{}, err
-	}
-
-	var results [][][]byte = [][][]byte{}
-	for _, entry := range entries {
-		if !isDirectory(entry) {
-			//Read it
-			key := filepath.Base(entry)
-			key = strings.TrimSuffix(key, filepath.Ext(key))
-			key = strings.ReplaceAll(key, "-SLASH_SIGN-", "/")
-
-			bkey := []byte(key)
-			bval := []byte("")
-			c, err := os.ReadFile(entry)
-			if err != nil {
-				break
-			}
-
-			bval = c
-			results = append(results, [][]byte{bkey, bval})
-		}
-	}
-	return results, nil
-}
-
-func (d *Database) close() {
-	//Nothing to close as it is file system
-}
-
-func isDirectory(path string) bool {
-	fileInfo, err := os.Stat(path)
-	if err != nil {
-		return false
-	}
-
-	return fileInfo.IsDir()
-}
-
-func fileExists(name string) bool {
-	_, err := os.Stat(name)
-	if err == nil {
-		return true
-	}
-	if errors.Is(err, os.ErrNotExist) {
-		return false
-	}
-	return false
-}

example/plugins/ztnc/mod/database/dbbolt/dbbolt.go

@@ -1,141 +0,0 @@
-package dbbolt
-
-import (
-	"encoding/json"
-	"errors"
-
-	"github.com/boltdb/bolt"
-)
-
-type Database struct {
-	Db interface{} //This is the bolt database object
-}
-
-func NewBoltDatabase(dbfile string) (*Database, error) {
-	db, err := bolt.Open(dbfile, 0600, nil)
-	if err != nil {
-		return nil, err
-	}
-
-	return &Database{
-		Db: db,
-	}, err
-}
-
-// Create a new table
-func (d *Database) NewTable(tableName string) error {
-	err := d.Db.(*bolt.DB).Update(func(tx *bolt.Tx) error {
-		_, err := tx.CreateBucketIfNotExists([]byte(tableName))
-		if err != nil {
-			return err
-		}
-		return nil
-	})
-
-	return err
-}
-
-// Check is table exists
-func (d *Database) TableExists(tableName string) bool {
-	return d.Db.(*bolt.DB).View(func(tx *bolt.Tx) error {
-		b := tx.Bucket([]byte(tableName))
-		if b == nil {
-			return errors.New("table not exists")
-		}
-		return nil
-	}) == nil
-}
-
-// Drop the given table
-func (d *Database) DropTable(tableName string) error {
-	err := d.Db.(*bolt.DB).Update(func(tx *bolt.Tx) error {
-		err := tx.DeleteBucket([]byte(tableName))
-		if err != nil {
-			return err
-		}
-		return nil
-	})
-	return err
-}
-
-// Write to table
-func (d *Database) Write(tableName string, key string, value interface{}) error {
-	jsonString, err := json.Marshal(value)
-	if err != nil {
-		return err
-	}
-	err = d.Db.(*bolt.DB).Update(func(tx *bolt.Tx) error {
-		_, err := tx.CreateBucketIfNotExists([]byte(tableName))
-		if err != nil {
-			return err
-		}
-		b := tx.Bucket([]byte(tableName))
-		err = b.Put([]byte(key), jsonString)
-		return err
-	})
-	return err
-}
-
-func (d *Database) Read(tableName string, key string, assignee interface{}) error {
-	err := d.Db.(*bolt.DB).View(func(tx *bolt.Tx) error {
-		b := tx.Bucket([]byte(tableName))
-		v := b.Get([]byte(key))
-		json.Unmarshal(v, &assignee)
-		return nil
-	})
-	return err
-}
-
-func (d *Database) KeyExists(tableName string, key string) bool {
-	resultIsNil := false
-	if !d.TableExists(tableName) {
-		//Table not exists. Do not proceed accessing key
-		//log.Println("[DB] ERROR: Requesting key from table that didn't exist!!!")
-		return false
-	}
-	err := d.Db.(*bolt.DB).View(func(tx *bolt.Tx) error {
-		b := tx.Bucket([]byte(tableName))
-		v := b.Get([]byte(key))
-		if v == nil {
-			resultIsNil = true
-		}
-		return nil
-	})
-
-	if err != nil {
-		return false
-	} else {
-		if resultIsNil {
-			return false
-		} else {
-			return true
-		}
-	}
-}
-
-func (d *Database) Delete(tableName string, key string) error {
-	err := d.Db.(*bolt.DB).Update(func(tx *bolt.Tx) error {
-		tx.Bucket([]byte(tableName)).Delete([]byte(key))
-		return nil
-	})
-
-	return err
-}
-
-func (d *Database) ListTable(tableName string) ([][][]byte, error) {
-	var results [][][]byte
-	err := d.Db.(*bolt.DB).View(func(tx *bolt.Tx) error {
-		b := tx.Bucket([]byte(tableName))
-		c := b.Cursor()
-
-		for k, v := c.First(); k != nil; k, v = c.Next() {
-			results = append(results, [][]byte{k, v})
-		}
-		return nil
-	})
-	return results, err
-}
-
-func (d *Database) Close() {
-	d.Db.(*bolt.DB).Close()
-}

example/plugins/ztnc/mod/database/dbbolt/dbbolt_test.go

@@ -1,67 +0,0 @@
-package dbbolt_test
-
-import (
-	"os"
-	"testing"
-
-	"aroz.org/zoraxy/ztnc/mod/database/dbbolt"
-)
-
-func TestNewBoltDatabase(t *testing.T) {
-	dbfile := "test.db"
-	defer os.Remove(dbfile)
-
-	db, err := dbbolt.NewBoltDatabase(dbfile)
-	if err != nil {
-		t.Fatalf("Failed to create new Bolt database: %v", err)
-	}
-	defer db.Close()
-
-	if db.Db == nil {
-		t.Fatalf("Expected non-nil database object")
-	}
-}
-
-func TestNewTable(t *testing.T) {
-	dbfile := "test.db"
-	defer os.Remove(dbfile)
-
-	db, err := dbbolt.NewBoltDatabase(dbfile)
-	if err != nil {
-		t.Fatalf("Failed to create new Bolt database: %v", err)
-	}
-	defer db.Close()
-
-	err = db.NewTable("testTable")
-	if err != nil {
-		t.Fatalf("Failed to create new table: %v", err)
-	}
-}
-
-func TestTableExists(t *testing.T) {
-	dbfile := "test.db"
-	defer os.Remove(dbfile)
-
-	db, err := dbbolt.NewBoltDatabase(dbfile)
-	if err != nil {
-		t.Fatalf("Failed to create new Bolt database: %v", err)
-	}
-	defer db.Close()
-
-	tableName := "testTable"
-	err = db.NewTable(tableName)
-	if err != nil {
-		t.Fatalf("Failed to create new table: %v", err)
-	}
-
-	exists := db.TableExists(tableName)
-	if !exists {
-		t.Fatalf("Expected table %s to exist", tableName)
-	}
-
-	nonExistentTable := "nonExistentTable"
-	exists = db.TableExists(nonExistentTable)
-	if exists {
-		t.Fatalf("Expected table %s to not exist", nonExistentTable)
-	}
-}

example/plugins/ztnc/mod/database/dbinc/dbinc.go

@@ -1,39 +0,0 @@
-package dbinc
-
-/*
-	dbinc is the interface for all database backend
-*/
-type BackendType int
-
-const (
-	BackendBoltDB  BackendType = iota //Default backend
-	BackendFSOnly                     //OpenWRT or RISCV backend
-	BackendLevelDB                    //LevelDB backend
-
-	BackEndAuto = BackendBoltDB
-)
-
-type Backend interface {
-	NewTable(tableName string) error
-	TableExists(tableName string) bool
-	DropTable(tableName string) error
-	Write(tableName string, key string, value interface{}) error
-	Read(tableName string, key string, assignee interface{}) error
-	KeyExists(tableName string, key string) bool
-	Delete(tableName string, key string) error
-	ListTable(tableName string) ([][][]byte, error)
-	Close()
-}
-
-func (b BackendType) String() string {
-	switch b {
-	case BackendBoltDB:
-		return "BoltDB"
-	case BackendFSOnly:
-		return "File System Emulated Key-Value Store"
-	case BackendLevelDB:
-		return "LevelDB"
-	default:
-		return "Unknown"
-	}
-}

example/plugins/ztnc/mod/database/dbleveldb/dbleveldb.go

@@ -1,152 +0,0 @@
-package dbleveldb
-
-import (
-	"encoding/json"
-	"log"
-	"path/filepath"
-	"strings"
-	"sync"
-	"time"
-
-	"aroz.org/zoraxy/ztnc/mod/database/dbinc"
-	"github.com/syndtr/goleveldb/leveldb"
-	"github.com/syndtr/goleveldb/leveldb/util"
-)
-
-// Ensure the DB struct implements the Backend interface
-var _ dbinc.Backend = (*DB)(nil)
-
-type DB struct {
-	db               *leveldb.DB
-	Table            sync.Map      //For emulating table creation
-	batch            leveldb.Batch //Batch write
-	writeFlushTicker *time.Ticker  //Ticker for flushing data into disk
-	writeFlushStop   chan bool     //Stop channel for write flush ticker
-}
-
-func NewDB(path string) (*DB, error) {
-	//If the path is not a directory (e.g. /tmp/dbfile.db), convert the filename to directory
-	if filepath.Ext(path) != "" {
-		path = strings.ReplaceAll(path, ".", "_")
-	}
-
-	db, err := leveldb.OpenFile(path, nil)
-	if err != nil {
-		return nil, err
-	}
-
-	thisDB := &DB{
-		db:    db,
-		Table: sync.Map{},
-		batch: leveldb.Batch{},
-	}
-
-	//Create a ticker to flush data into disk every 1 seconds
-	writeFlushTicker := time.NewTicker(1 * time.Second)
-	writeFlushStop := make(chan bool)
-	go func() {
-		for {
-			select {
-			case <-writeFlushTicker.C:
-				if thisDB.batch.Len() == 0 {
-					//No flushing needed
-					continue
-				}
-				err = db.Write(&thisDB.batch, nil)
-				if err != nil {
-					log.Println("[LevelDB] Failed to flush data into disk: ", err)
-				}
-				thisDB.batch.Reset()
-			case <-writeFlushStop:
-				return
-			}
-		}
-	}()
-
-	thisDB.writeFlushTicker = writeFlushTicker
-	thisDB.writeFlushStop = writeFlushStop
-
-	return thisDB, nil
-}
-
-func (d *DB) NewTable(tableName string) error {
-	//Create a table entry in the sync.Map
-	d.Table.Store(tableName, true)
-	return nil
-}
-
-func (d *DB) TableExists(tableName string) bool {
-	_, ok := d.Table.Load(tableName)
-	return ok
-}
-
-func (d *DB) DropTable(tableName string) error {
-	d.Table.Delete(tableName)
-	iter := d.db.NewIterator(nil, nil)
-	defer iter.Release()
-
-	for iter.Next() {
-		key := iter.Key()
-		if filepath.Dir(string(key)) == tableName {
-			err := d.db.Delete(key, nil)
-			if err != nil {
-				return err
-			}
-		}
-	}
-
-	return nil
-}
-
-func (d *DB) Write(tableName string, key string, value interface{}) error {
-	data, err := json.Marshal(value)
-	if err != nil {
-		return err
-	}
-	d.batch.Put([]byte(filepath.ToSlash(filepath.Join(tableName, key))), data)
-	return nil
-}
-
-func (d *DB) Read(tableName string, key string, assignee interface{}) error {
-	data, err := d.db.Get([]byte(filepath.ToSlash(filepath.Join(tableName, key))), nil)
-	if err != nil {
-		return err
-	}
-	return json.Unmarshal(data, assignee)
-}
-
-func (d *DB) KeyExists(tableName string, key string) bool {
-	_, err := d.db.Get([]byte(filepath.ToSlash(filepath.Join(tableName, key))), nil)
-	return err == nil
-}
-
-func (d *DB) Delete(tableName string, key string) error {
-	return d.db.Delete([]byte(filepath.ToSlash(filepath.Join(tableName, key))), nil)
-}
-
-func (d *DB) ListTable(tableName string) ([][][]byte, error) {
-	iter := d.db.NewIterator(util.BytesPrefix([]byte(tableName+"/")), nil)
-	defer iter.Release()
-
-	var result [][][]byte
-	for iter.Next() {
-		key := iter.Key()
-		//The key contains the table name as prefix. Trim it before returning
-		value := iter.Value()
-		result = append(result, [][]byte{[]byte(strings.TrimPrefix(string(key), tableName+"/")), value})
-	}
-
-	err := iter.Error()
-	if err != nil {
-		return nil, err
-	}
-	return result, nil
-}
-
-func (d *DB) Close() {
-	//Write the remaining data in batch back into disk
-	d.writeFlushStop <- true
-	d.writeFlushTicker.Stop()
-	d.db.Write(&d.batch, nil)
-	d.db.Close()
-}

example/plugins/ztnc/mod/database/dbleveldb/dbleveldb_test.go

@@ -1,141 +0,0 @@
-package dbleveldb_test
-
-import (
-	"os"
-	"testing"
-
-	"aroz.org/zoraxy/ztnc/mod/database/dbleveldb"
-)
-
-func TestNewDB(t *testing.T) {
-	path := "/tmp/testdb"
-	defer os.RemoveAll(path)
-
-	db, err := dbleveldb.NewDB(path)
-	if err != nil {
-		t.Fatalf("Failed to create new DB: %v", err)
-	}
-	defer db.Close()
-}
-
-func TestNewTable(t *testing.T) {
-	path := "/tmp/testdb"
-	defer os.RemoveAll(path)
-
-	db, err := dbleveldb.NewDB(path)
-	if err != nil {
-		t.Fatalf("Failed to create new DB: %v", err)
-	}
-	defer db.Close()
-
-	err = db.NewTable("testTable")
-	if err != nil {
-		t.Fatalf("Failed to create new table: %v", err)
-	}
-}
-
-func TestTableExists(t *testing.T) {
-	path := "/tmp/testdb"
-	defer os.RemoveAll(path)
-
-	db, err := dbleveldb.NewDB(path)
-	if err != nil {
-		t.Fatalf("Failed to create new DB: %v", err)
-	}
-	defer db.Close()
-
-	db.NewTable("testTable")
-	if !db.TableExists("testTable") {
-		t.Fatalf("Table should exist")
-	}
-}
-
-func TestDropTable(t *testing.T) {
-	path := "/tmp/testdb"
-	defer os.RemoveAll(path)
-
-	db, err := dbleveldb.NewDB(path)
-	if err != nil {
-		t.Fatalf("Failed to create new DB: %v", err)
-	}
-	defer db.Close()
-
-	db.NewTable("testTable")
-	err = db.DropTable("testTable")
-	if err != nil {
-		t.Fatalf("Failed to drop table: %v", err)
-	}
-
-	if db.TableExists("testTable") {
-		t.Fatalf("Table should not exist")
-	}
-}
-
-func TestWriteAndRead(t *testing.T) {
-	path := "/tmp/testdb"
-	defer os.RemoveAll(path)
-
-	db, err := dbleveldb.NewDB(path)
-	if err != nil {
-		t.Fatalf("Failed to create new DB: %v", err)
-	}
-	defer db.Close()
-
-	db.NewTable("testTable")
-	err = db.Write("testTable", "testKey", "testValue")
-	if err != nil {
-		t.Fatalf("Failed to write to table: %v", err)
-	}
-
-	var value string
-	err = db.Read("testTable", "testKey", &value)
-	if err != nil {
-		t.Fatalf("Failed to read from table: %v", err)
-	}
-
-	if value != "testValue" {
-		t.Fatalf("Expected 'testValue', got '%v'", value)
-	}
-}
-func TestListTable(t *testing.T) {
-	path := "/tmp/testdb"
-	defer os.RemoveAll(path)
-
-	db, err := dbleveldb.NewDB(path)
-	if err != nil {
-		t.Fatalf("Failed to create new DB: %v", err)
-	}
-	defer db.Close()
-
-	db.NewTable("testTable")
-	err = db.Write("testTable", "testKey1", "testValue1")
-	if err != nil {
-		t.Fatalf("Failed to write to table: %v", err)
-	}
-	err = db.Write("testTable", "testKey2", "testValue2")
-	if err != nil {
-		t.Fatalf("Failed to write to table: %v", err)
-	}
-
-	result, err := db.ListTable("testTable")
-	if err != nil {
-		t.Fatalf("Failed to list table: %v", err)
-	}
-
-	if len(result) != 2 {
-		t.Fatalf("Expected 2 entries, got %v", len(result))
-	}
-
-	expected := map[string]string{
-		"testTable/testKey1": "\"testValue1\"",
-		"testTable/testKey2": "\"testValue2\"",
-	}
-
-	for _, entry := range result {
-		key := string(entry[0])
-		value := string(entry[1])
-		if expected[key] != value {
-			t.Fatalf("Expected value '%v' for key '%v', got '%v'", expected[key], key, value)
-		}
-	}
-}

example/plugins/ztnc/mod/ganserv/authkey.go

@@ -1,80 +0,0 @@
-package ganserv
-
-import (
-	"errors"
-	"log"
-	"os"
-	"runtime"
-	"strings"
-)
-
-func TryLoadorAskUserForAuthkey() (string, error) {
-	//Check for zt auth token
-	value, exists := os.LookupEnv("ZT_AUTH")
-	if !exists {
-		log.Println("Environment variable ZT_AUTH not defined. Trying to load authtoken from file.")
-	} else {
-		return value, nil
-	}
-
-	authKey := ""
-	if runtime.GOOS == "windows" {
-		if isAdmin() {
-			//Read the secret file directly
-			b, err := os.ReadFile("C:\\ProgramData\\ZeroTier\\One\\authtoken.secret")
-			if err == nil {
-				log.Println("Zerotier authkey loaded")
-				authKey = string(b)
-			} else {
-				log.Println("Unable to read authkey at C:\\ProgramData\\ZeroTier\\One\\authtoken.secret: ", err.Error())
-			}
-		} else {
-			//Elavate the permission to admin
-			ak, err := readAuthTokenAsAdmin()
-			if err == nil {
-				log.Println("Zerotier authkey loaded")
-				authKey = ak
-			} else {
-				log.Println("Unable to read authkey at C:\\ProgramData\\ZeroTier\\One\\authtoken.secret: ", err.Error())
-			}
-		}
-
-	} else if runtime.GOOS == "linux" {
-		if isAdmin() {
-			//Try to read from source using sudo
-			ak, err := readAuthTokenAsAdmin()
-			if err == nil {
-				log.Println("Zerotier authkey loaded")
-				authKey = strings.TrimSpace(ak)
-			} else {
-				log.Println("Unable to read authkey at /var/lib/zerotier-one/authtoken.secret: ", err.Error())
-			}
-		} else {
-			//Try read from source
-			b, err := os.ReadFile("/var/lib/zerotier-one/authtoken.secret")
-			if err == nil {
-				log.Println("Zerotier authkey loaded")
-				authKey = string(b)
-			} else {
-				log.Println("Unable to read authkey at /var/lib/zerotier-one/authtoken.secret: ", err.Error())
-			}
-		}
-
-	} else if runtime.GOOS == "darwin" {
-		b, err := os.ReadFile("/Library/Application Support/ZeroTier/One/authtoken.secret")
-		if err == nil {
-			log.Println("Zerotier authkey loaded")
-			authKey = string(b)
-		} else {
-			log.Println("Unable to read authkey at /Library/Application Support/ZeroTier/One/authtoken.secret ", err.Error())
-		}
-	}
-
-	authKey = strings.TrimSpace(authKey)
-
-	if authKey == "" {
-		return "", errors.New("Unable to load authkey from file")
-	}
-
-	return authKey, nil
-}

example/plugins/ztnc/mod/ganserv/authkeyLinux.go

@@ -1,37 +0,0 @@
-//go:build linux
-// +build linux
-
-package ganserv
-
-import (
-	"os"
-	"os/exec"
-	"os/user"
-	"strings"
-
-	"aroz.org/zoraxy/ztnc/mod/utils"
-)
-
-func readAuthTokenAsAdmin() (string, error) {
-	if utils.FileExists("./conf/authtoken.secret") {
-		authKey, err := os.ReadFile("./conf/authtoken.secret")
-		if err == nil {
-			return strings.TrimSpace(string(authKey)), nil
-		}
-	}
-
-	cmd := exec.Command("sudo", "cat", "/var/lib/zerotier-one/authtoken.secret")
-	output, err := cmd.Output()
-	if err != nil {
-		return "", err
-	}
-	return string(output), nil
-}
-
-func isAdmin() bool {
-	currentUser, err := user.Current()
-	if err != nil {
-		return false
-	}
-	return currentUser.Username == "root"
-}

example/plugins/ztnc/mod/ganserv/authkeyWin.go

@@ -1,62 +0,0 @@
-//go:build windows
-// +build windows
-
-package ganserv
-
-import (
-	"fmt"
-	"os"
-	"path/filepath"
-	"strings"
-	"syscall"
-
-	"aroz.org/zoraxy/ztnc/mod/utils"
-	"golang.org/x/sys/windows"
-)
-
-// Use admin permission to read auth token on Windows
-func readAuthTokenAsAdmin() (string, error) {
-	//Check if the previous startup already extracted the authkey
-	if utils.FileExists("./conf/authtoken.secret") {
-		authKey, err := os.ReadFile("./conf/authtoken.secret")
-		if err == nil {
-			return strings.TrimSpace(string(authKey)), nil
-		}
-	}
-
-	verb := "runas"
-	exe := "cmd.exe"
-	cwd, _ := os.Getwd()
-
-	output, _ := filepath.Abs(filepath.Join("./conf/", "authtoken.secret"))
-	os.WriteFile(output, []byte(""), 0775)
-	args := fmt.Sprintf("/C type \"C:\\ProgramData\\ZeroTier\\One\\authtoken.secret\" > \"" + output + "\"")
-
-	verbPtr, _ := syscall.UTF16PtrFromString(verb)
-	exePtr, _ := syscall.UTF16PtrFromString(exe)
-	cwdPtr, _ := syscall.UTF16PtrFromString(cwd)
-	argPtr, _ := syscall.UTF16PtrFromString(args)
-
-	var showCmd int32 = 1 //SW_NORMAL
-
-	err := windows.ShellExecute(0, verbPtr, exePtr, argPtr, cwdPtr, showCmd)
-	if err != nil {
-		return "", err
-	}
-
-	authKey, err := os.ReadFile("./conf/authtoken.secret")
-	if err != nil {
-		return "", err
-	}
-
-	return strings.TrimSpace(string(authKey)), nil
-}
-
-// Check if admin on Windows
-func isAdmin() bool {
-	_, err := os.Open("\\\\.\\PHYSICALDRIVE0")
-	if err != nil {
-		return false
-	}
-	return true
-}

example/plugins/ztnc/mod/ganserv/ganserv.go

@@ -1,130 +0,0 @@
-package ganserv
-
-import (
-	"log"
-	"net"
-
-	"aroz.org/zoraxy/ztnc/mod/database"
-)
-
-/*
-	Global Area Network
-	Server side implementation
-
-	This module do a few things to help manage
-	the system GANs
-
-	- Provide DHCP assign to client
-	- Provide a list of connected nodes in the same VLAN
-	- Provide proxy of packet if the target VLAN is online but not reachable
-
-	Also provide HTTP Handler functions for management
-	- Create Network
-	- Update Network Properties (Name / Desc)
-	- Delete Network
-
-	- Authorize Node
-	- Deauthorize Node
-	- Set / Get Network Prefered Subnet Mask
-	- Handle Node ping
-*/
-
-type Node struct {
-	Auth          bool   //If the node is authorized in this network
-	ClientID      string //The client ID
-	MAC           string //The tap MAC this client is using
-	Name          string //Name of the client in this network
-	Description   string //Description text
-	ManagedIP     net.IP //The IP address assigned by this network
-	LastSeen      int64  //Last time it is seen from this host
-	ClientVersion string //Client application version
-	PublicIP      net.IP //Public IP address as seen from this host
-}
-
-type Network struct {
-	UID         string  //UUID of the network, must be a 16 char random ASCII string
-	Name        string  //Name of the network, ASCII only
-	Description string  //Description of the network
-	CIDR        string  //The subnet masked use by this network
-	Nodes       []*Node //The nodes currently attached in this network
-}
-
-type NetworkManagerOptions struct {
-	Database  *database.Database
-	AuthToken string
-	ApiPort   int
-}
-
-type NetworkMetaData struct {
-	Desc string
-}
-
-type MemberMetaData struct {
-	Name string
-}
-
-type NetworkManager struct {
-	authToken        string
-	apiPort          int
-	ControllerID     string
-	option           *NetworkManagerOptions
-	networksMetadata map[string]NetworkMetaData
-}
-
-// Create a new GAN manager
-func NewNetworkManager(option *NetworkManagerOptions) *NetworkManager {
-	option.Database.NewTable("ganserv")
-
-	//Load network metadata
-	networkMeta := map[string]NetworkMetaData{}
-	if option.Database.KeyExists("ganserv", "networkmeta") {
-		option.Database.Read("ganserv", "networkmeta", &networkMeta)
-	}
-
-	//Start the zerotier instance if not exists
-
-	//Get controller info
-	instanceInfo, err := getControllerInfo(option.AuthToken, option.ApiPort)
-	if err != nil {
-		log.Println("ZeroTier connection failed: ", err.Error())
-		return &NetworkManager{
-			authToken:        option.AuthToken,
-			apiPort:          option.ApiPort,
-			ControllerID:     "",
-			option:           option,
-			networksMetadata: networkMeta,
-		}
-	}
-
-	return &NetworkManager{
-		authToken:        option.AuthToken,
-		apiPort:          option.ApiPort,
-		ControllerID:     instanceInfo.Address,
-		option:           option,
-		networksMetadata: networkMeta,
-	}
-}
-
-func (m *NetworkManager) GetNetworkMetaData(netid string) *NetworkMetaData {
-	md, ok := m.networksMetadata[netid]
-	if !ok {
-		return &NetworkMetaData{}
-	}
-
-	return &md
-}
-
-func (m *NetworkManager) WriteNetworkMetaData(netid string, meta *NetworkMetaData) {
-	m.networksMetadata[netid] = *meta
-	m.option.Database.Write("ganserv", "networkmeta", m.networksMetadata)
-}
-
-func (m *NetworkManager) GetMemberMetaData(netid string, memid string) *MemberMetaData {
-	thisMemberData := MemberMetaData{}
-	m.option.Database.Read("ganserv", "memberdata_"+netid+"_"+memid, &thisMemberData)
-	return &thisMemberData
-}
-
-func (m *NetworkManager) WriteMemeberMetaData(netid string, memid string, meta *MemberMetaData) {
-	m.option.Database.Write("ganserv", "memberdata_"+netid+"_"+memid, meta)
-}

example/plugins/ztnc/mod/ganserv/handlers.go

@@ -1,504 +0,0 @@
-package ganserv
-
-import (
-	"encoding/json"
-	"net"
-	"net/http"
-	"regexp"
-	"strings"
-
-	"aroz.org/zoraxy/ztnc/mod/utils"
-)
-
-func (m *NetworkManager) HandleGetNodeID(w http.ResponseWriter, r *http.Request) {
-	if m.ControllerID == "" {
-		//Node id not exists. Check again
-		instanceInfo, err := getControllerInfo(m.option.AuthToken, m.option.ApiPort)
-		if err != nil {
-			utils.SendErrorResponse(w, "unable to access node id information")
-			return
-		}
-
-		m.ControllerID = instanceInfo.Address
-	}
-
-	js, _ := json.Marshal(m.ControllerID)
-	utils.SendJSONResponse(w, string(js))
-}
-
-func (m *NetworkManager) HandleAddNetwork(w http.ResponseWriter, r *http.Request) {
-	networkInfo, err := m.createNetwork()
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	//Network created. Assign it the standard network settings
-	err = m.configureNetwork(networkInfo.Nwid, "192.168.192.1", "192.168.192.254", "192.168.192.0/24")
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	// Return the new network ID
-	js, _ := json.Marshal(networkInfo.Nwid)
-	utils.SendJSONResponse(w, string(js))
-}
-
-func (m *NetworkManager) HandleRemoveNetwork(w http.ResponseWriter, r *http.Request) {
-	networkID, err := utils.PostPara(r, "id")
-	if err != nil {
-		utils.SendErrorResponse(w, "invalid or empty network id given")
-		return
-	}
-
-	if !m.networkExists(networkID) {
-		utils.SendErrorResponse(w, "network id not exists")
-		return
-	}
-
-	err = m.deleteNetwork(networkID)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-	}
-
-	utils.SendOK(w)
-}
-
-func (m *NetworkManager) HandleListNetwork(w http.ResponseWriter, r *http.Request) {
-	netid, _ := utils.GetPara(r, "netid")
-	if netid != "" {
-		targetNetInfo, err := m.getNetworkInfoById(netid)
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-
-		js, _ := json.Marshal(targetNetInfo)
-		utils.SendJSONResponse(w, string(js))
-
-	} else {
-		// Return the list of networks as JSON
-		networkIds, err := m.listNetworkIds()
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-
-		networkInfos := []*NetworkInfo{}
-		for _, id := range networkIds {
-			thisNetInfo, err := m.getNetworkInfoById(id)
-			if err == nil {
-				networkInfos = append(networkInfos, thisNetInfo)
-			}
-		}
-
-		js, _ := json.Marshal(networkInfos)
-		utils.SendJSONResponse(w, string(js))
-	}
-
-}
-
-func (m *NetworkManager) HandleNetworkNaming(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "network id not given")
-		return
-	}
-
-	if !m.networkExists(netid) {
-		utils.SendErrorResponse(w, "network not eixsts")
-	}
-
-	newName, _ := utils.PostPara(r, "name")
-	newDesc, _ := utils.PostPara(r, "desc")
-	if newName != "" && newDesc != "" {
-		//Strip away html from name and desc
-		re := regexp.MustCompile("<[^>]*>")
-		newName := re.ReplaceAllString(newName, "")
-		newDesc := re.ReplaceAllString(newDesc, "")
-
-		//Set the new network name and desc
-		err = m.setNetworkNameAndDescription(netid, newName, newDesc)
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-
-		utils.SendOK(w)
-	} else {
-		//Get current name and description
-		name, desc, err := m.getNetworkNameAndDescription(netid)
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-
-		js, _ := json.Marshal([]string{name, desc})
-		utils.SendJSONResponse(w, string(js))
-	}
-}
-
-func (m *NetworkManager) HandleNetworkDetails(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "netid not given")
-		return
-	}
-
-	targetNetwork, err := m.getNetworkInfoById(netid)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	js, _ := json.Marshal(targetNetwork)
-	utils.SendJSONResponse(w, string(js))
-}
-
-func (m *NetworkManager) HandleSetRanges(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "netid not given")
-		return
-	}
-	cidr, err := utils.PostPara(r, "cidr")
-	if err != nil {
-		utils.SendErrorResponse(w, "cidr not given")
-		return
-	}
-	ipstart, err := utils.PostPara(r, "ipstart")
-	if err != nil {
-		utils.SendErrorResponse(w, "ipstart not given")
-		return
-	}
-	ipend, err := utils.PostPara(r, "ipend")
-	if err != nil {
-		utils.SendErrorResponse(w, "ipend not given")
-		return
-	}
-
-	//Validate the CIDR is real, the ip range is within the CIDR range
-	_, ipnet, err := net.ParseCIDR(cidr)
-	if err != nil {
-		utils.SendErrorResponse(w, "invalid cidr string given")
-		return
-	}
-
-	startIP := net.ParseIP(ipstart)
-	endIP := net.ParseIP(ipend)
-	if startIP == nil || endIP == nil {
-		utils.SendErrorResponse(w, "invalid start or end ip given")
-		return
-	}
-
-	withinRange := ipnet.Contains(startIP) && ipnet.Contains(endIP)
-	if !withinRange {
-		utils.SendErrorResponse(w, "given CIDR did not cover all of the start to end ip range")
-		return
-	}
-
-	err = m.configureNetwork(netid, startIP.String(), endIP.String(), strings.TrimSpace(cidr))
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	utils.SendOK(w)
-}
-
-// Handle listing of network members. Set details=true for listing all details
-func (m *NetworkManager) HandleMemberList(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.GetPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "netid is empty")
-		return
-	}
-
-	details, _ := utils.GetPara(r, "detail")
-
-	memberIds, err := m.getNetworkMembers(netid)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-	if details == "" {
-		//Only show client ids
-		js, _ := json.Marshal(memberIds)
-		utils.SendJSONResponse(w, string(js))
-	} else {
-		//Show detail members info
-		detailMemberInfo := []*MemberInfo{}
-		for _, thisMemberId := range memberIds {
-			memInfo, err := m.getNetworkMemberInfo(netid, thisMemberId)
-			if err == nil {
-				detailMemberInfo = append(detailMemberInfo, memInfo)
-			}
-		}
-
-		js, _ := json.Marshal(detailMemberInfo)
-		utils.SendJSONResponse(w, string(js))
-	}
-}
-
-// Handle Authorization of members
-func (m *NetworkManager) HandleMemberAuthorization(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "net id not set")
-		return
-	}
-
-	memberid, err := utils.PostPara(r, "memid")
-	if err != nil {
-		utils.SendErrorResponse(w, "memid not set")
-		return
-	}
-
-	//Check if the target memeber exists
-	if !m.memberExistsInNetwork(netid, memberid) {
-		utils.SendErrorResponse(w, "member not exists in given network")
-		return
-	}
-
-	setAuthorized, err := utils.PostPara(r, "auth")
-	if err != nil || setAuthorized == "" {
-		//Get the member authorization state
-		memberInfo, err := m.getNetworkMemberInfo(netid, memberid)
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-
-		js, _ := json.Marshal(memberInfo.Authorized)
-		utils.SendJSONResponse(w, string(js))
-	} else if setAuthorized == "true" {
-		m.AuthorizeMember(netid, memberid, true)
-	} else if setAuthorized == "false" {
-		m.AuthorizeMember(netid, memberid, false)
-	} else {
-		utils.SendErrorResponse(w, "unknown operation state: "+setAuthorized)
-	}
-}
-
-// Handle Delete or Add IP for a member in a network
-func (m *NetworkManager) HandleMemberIP(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "net id not set")
-		return
-	}
-
-	memberid, err := utils.PostPara(r, "memid")
-	if err != nil {
-		utils.SendErrorResponse(w, "memid not set")
-		return
-	}
-
-	opr, err := utils.PostPara(r, "opr")
-	if err != nil {
-		utils.SendErrorResponse(w, "opr not defined")
-		return
-	}
-
-	targetip, _ := utils.PostPara(r, "ip")
-
-	memberInfo, err := m.getNetworkMemberInfo(netid, memberid)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	if opr == "add" {
-		if targetip == "" {
-			utils.SendErrorResponse(w, "ip not set")
-			return
-		}
-
-		if !isValidIPAddr(targetip) {
-			utils.SendErrorResponse(w, "ip address not valid")
-			return
-		}
-
-		newIpList := append(memberInfo.IPAssignments, targetip)
-		err = m.setAssignedIps(netid, memberid, newIpList)
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-		utils.SendOK(w)
-
-	} else if opr == "del" {
-		if targetip == "" {
-			utils.SendErrorResponse(w, "ip not set")
-			return
-		}
-
-		//Delete user ip from the list
-		newIpList := []string{}
-		for _, thisIp := range memberInfo.IPAssignments {
-			if thisIp != targetip {
-				newIpList = append(newIpList, thisIp)
-			}
-		}
-
-		err = m.setAssignedIps(netid, memberid, newIpList)
-		if err != nil {
-			utils.SendErrorResponse(w, err.Error())
-			return
-		}
-		utils.SendOK(w)
-	} else if opr == "get" {
-		js, _ := json.Marshal(memberInfo.IPAssignments)
-		utils.SendJSONResponse(w, string(js))
-	} else {
-		utils.SendErrorResponse(w, "unsupported opr type: "+opr)
-	}
-}
-
-// Handle naming for members
-func (m *NetworkManager) HandleMemberNaming(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "net id not set")
-		return
-	}
-
-	memberid, err := utils.PostPara(r, "memid")
-	if err != nil {
-		utils.SendErrorResponse(w, "memid not set")
-		return
-	}
-
-	if !m.memberExistsInNetwork(netid, memberid) {
-		utils.SendErrorResponse(w, "target member not exists in given network")
-		return
-	}
-
-	//Read memeber data
-	targetMemberData := m.GetMemberMetaData(netid, memberid)
-
-	newname, err := utils.PostPara(r, "name")
-	if err != nil {
-		//Send over the member data
-		js, _ := json.Marshal(targetMemberData)
-		utils.SendJSONResponse(w, string(js))
-	} else {
-		//Write member data
-		targetMemberData.Name = newname
-		m.WriteMemeberMetaData(netid, memberid, targetMemberData)
-		utils.SendOK(w)
-	}
-}
-
-// Handle delete of a given memver
-func (m *NetworkManager) HandleMemberDelete(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "net id not set")
-		return
-	}
-
-	memberid, err := utils.PostPara(r, "memid")
-	if err != nil {
-		utils.SendErrorResponse(w, "memid not set")
-		return
-	}
-
-	//Check if that member is authorized.
-	memberInfo, err := m.getNetworkMemberInfo(netid, memberid)
-	if err != nil {
-		utils.SendErrorResponse(w, "member not exists in given GANet")
-		return
-	}
-
-	if memberInfo.Authorized {
-		//Deauthorized this member before deleting
-		m.AuthorizeMember(netid, memberid, false)
-	}
-
-	//Remove the memeber
-	err = m.deleteMember(netid, memberid)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	utils.SendOK(w)
-}
-
-// Check if a given network id is a network hosted on this zoraxy node
-func (m *NetworkManager) IsLocalGAN(networkId string) bool {
-	networks, err := m.listNetworkIds()
-	if err != nil {
-		return false
-	}
-
-	for _, network := range networks {
-		if network == networkId {
-			return true
-		}
-	}
-
-	return false
-}
-
-// Handle server instant joining a given network
-func (m *NetworkManager) HandleServerJoinNetwork(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "net id not set")
-		return
-	}
-
-	//Check if the target network is a network hosted on this server
-	if !m.IsLocalGAN(netid) {
-		utils.SendErrorResponse(w, "given network is not a GAN hosted on this node")
-		return
-	}
-
-	if m.memberExistsInNetwork(netid, m.ControllerID) {
-		utils.SendErrorResponse(w, "controller already inside network")
-		return
-	}
-
-	//Join the network
-	err = m.joinNetwork(netid)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	utils.SendOK(w)
-}
-
-// Handle server instant leaving a given network
-func (m *NetworkManager) HandleServerLeaveNetwork(w http.ResponseWriter, r *http.Request) {
-	netid, err := utils.PostPara(r, "netid")
-	if err != nil {
-		utils.SendErrorResponse(w, "net id not set")
-		return
-	}
-
-	//Check if the target network is a network hosted on this server
-	if !m.IsLocalGAN(netid) {
-		utils.SendErrorResponse(w, "given network is not a GAN hosted on this node")
-		return
-	}
-
-	//Leave the network
-	err = m.leaveNetwork(netid)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	//Remove it from target network if it is authorized
-	err = m.deleteMember(netid, m.ControllerID)
-	if err != nil {
-		utils.SendErrorResponse(w, err.Error())
-		return
-	}
-
-	utils.SendOK(w)
-}

example/plugins/ztnc/mod/ganserv/network.go

@@ -1,39 +0,0 @@
-package ganserv
-
-import (
-	"fmt"
-	"math/rand"
-	"net"
-	"time"
-)
-
-//Get a random free IP from the pool
-func (n *Network) GetRandomFreeIP() (net.IP, error) {
-	// Get all IP addresses in the subnet
-	ips, err := GetAllAddressFromCIDR(n.CIDR)
-	if err != nil {
-		return nil, err
-	}
-
-	// Filter out used IPs
-	usedIPs := make(map[string]bool)
-	for _, node := range n.Nodes {
-		usedIPs[node.ManagedIP.String()] = true
-	}
-	availableIPs := []string{}
-	for _, ip := range ips {
-		if !usedIPs[ip] {
-			availableIPs = append(availableIPs, ip)
-		}
-	}
-
-	// Randomly choose an available IP
-	if len(availableIPs) == 0 {
-		return nil, fmt.Errorf("no available IP")
-	}
-	rand.Seed(time.Now().UnixNano())
-	randIndex := rand.Intn(len(availableIPs))
-	pickedFreeIP := availableIPs[randIndex]
-
-	return net.ParseIP(pickedFreeIP), nil
-}

example/plugins/ztnc/mod/ganserv/network_test.go

@@ -1,55 +0,0 @@
-package ganserv_test
-
-import (
-	"fmt"
-	"net"
-	"strconv"
-	"testing"
-
-	"aroz.org/zoraxy/ztnc/mod/ganserv"
-)
-
-func TestGetRandomFreeIP(t *testing.T) {
-	n := ganserv.Network{
-		CIDR: "172.16.0.0/12",
-		Nodes: []*ganserv.Node{
-			{
-				Name:      "nodeC1",
-				ManagedIP: net.ParseIP("172.16.1.142"),
-			},
-			{
-				Name:      "nodeC2",
-				ManagedIP: net.ParseIP("172.16.5.174"),
-			},
-		},
-	}
-
-	// Call the function for 10 times
-	for i := 0; i < 10; i++ {
-		freeIP, err := n.GetRandomFreeIP()
-		fmt.Println("["+strconv.Itoa(i)+"] Free IP address assigned: ", freeIP)
-
-		// Assert that no error occurred
-		if err != nil {
-			t.Errorf("Unexpected error: %s", err.Error())
-		}
-
-		// Assert that the returned IP is a valid IPv4 address
-		if freeIP.To4() == nil {
-			t.Errorf("Invalid IP address format: %s", freeIP.String())
-		}
-
-		// Assert that the returned IP is not already used by a node
-		for _, node := range n.Nodes {
-			if freeIP.Equal(node.ManagedIP) {
-				t.Errorf("Returned IP is already in use: %s", freeIP.String())
-			}
-		}
-
-		n.Nodes = append(n.Nodes, &ganserv.Node{
-			Name:      "NodeT" + strconv.Itoa(i),
-			ManagedIP: freeIP,
-		})
-	}
-
-}

example/plugins/ztnc/mod/ganserv/utils.go

@@ -1,55 +0,0 @@
-package ganserv
-
-import (
-	"net"
-)
-
-//Generate all ip address from a CIDR
-func GetAllAddressFromCIDR(cidr string) ([]string, error) {
-	ip, ipnet, err := net.ParseCIDR(cidr)
-	if err != nil {
-		return nil, err
-	}
-
-	var ips []string
-	for ip := ip.Mask(ipnet.Mask); ipnet.Contains(ip); inc(ip) {
-		ips = append(ips, ip.String())
-	}
-	// remove network address and broadcast address
-	return ips[1 : len(ips)-1], nil
-}
-
-func inc(ip net.IP) {
-	for j := len(ip) - 1; j >= 0; j-- {
-		ip[j]++
-		if ip[j] > 0 {
-			break
-		}
-	}
-}
-
-func isValidIPAddr(ipAddr string) bool {
-	ip := net.ParseIP(ipAddr)
-	if ip == nil {
-		return false
-	}
-
-	return true
-}
-
-func ipWithinCIDR(ipAddr string, cidr string) bool {
-	// Parse the CIDR string
-	_, ipNet, err := net.ParseCIDR(cidr)
-	if err != nil {
-		return false
-	}
-
-	// Parse the IP address
-	ip := net.ParseIP(ipAddr)
-	if ip == nil {
-		return false
-	}
-
-	// Check if the IP address is in the CIDR range
-	return ipNet.Contains(ip)
-}

example/plugins/ztnc/mod/ganserv/zerotier.go

@@ -1,669 +0,0 @@
-package ganserv
-
-import (
-	"bytes"
-	"encoding/json"
-	"errors"
-	"fmt"
-	"io"
-	"net/http"
-	"os"
-	"strconv"
-	"strings"
-)
-
-/*
-	zerotier.go
-
-	This hold the functions that required to communicate with
-	a zerotier instance
-
-	See more on
-	https://docs.zerotier.com/self-hosting/network-controllers/
-
-*/
-
-type NodeInfo struct {
-	Address string `json:"address"`
-	Clock   int64  `json:"clock"`
-	Config  struct {
-		Settings struct {
-			AllowTCPFallbackRelay bool     `json:"allowTcpFallbackRelay,omitempty"`
-			ForceTCPRelay         bool     `json:"forceTcpRelay,omitempty"`
-			HomeDir               string   `json:"homeDir,omitempty"`
-			ListeningOn           []string `json:"listeningOn,omitempty"`
-			PortMappingEnabled    bool     `json:"portMappingEnabled,omitempty"`
-			PrimaryPort           int      `json:"primaryPort,omitempty"`
-			SecondaryPort         int      `json:"secondaryPort,omitempty"`
-			SoftwareUpdate        string   `json:"softwareUpdate,omitempty"`
-			SoftwareUpdateChannel string   `json:"softwareUpdateChannel,omitempty"`
-			SurfaceAddresses      []string `json:"surfaceAddresses,omitempty"`
-			TertiaryPort          int      `json:"tertiaryPort,omitempty"`
-		} `json:"settings"`
-	} `json:"config"`
-	Online               bool   `json:"online"`
-	PlanetWorldID        int    `json:"planetWorldId"`
-	PlanetWorldTimestamp int64  `json:"planetWorldTimestamp"`
-	PublicIdentity       string `json:"publicIdentity"`
-	TCPFallbackActive    bool   `json:"tcpFallbackActive"`
-	Version              string `json:"version"`
-	VersionBuild         int    `json:"versionBuild"`
-	VersionMajor         int    `json:"versionMajor"`
-	VersionMinor         int    `json:"versionMinor"`
-	VersionRev           int    `json:"versionRev"`
-}
-type ErrResp struct {
-	Message string `json:"message"`
-}
-
-type NetworkInfo struct {
-	AuthTokens            []interface{} `json:"authTokens"`
-	AuthorizationEndpoint string        `json:"authorizationEndpoint"`
-	Capabilities          []interface{} `json:"capabilities"`
-	ClientID              string        `json:"clientId"`
-	CreationTime          int64         `json:"creationTime"`
-	DNS                   []interface{} `json:"dns"`
-	EnableBroadcast       bool          `json:"enableBroadcast"`
-	ID                    string        `json:"id"`
-	IPAssignmentPools     []interface{} `json:"ipAssignmentPools"`
-	Mtu                   int           `json:"mtu"`
-	MulticastLimit        int           `json:"multicastLimit"`
-	Name                  string        `json:"name"`
-	Nwid                  string        `json:"nwid"`
-	Objtype               string        `json:"objtype"`
-	Private               bool          `json:"private"`
-	RemoteTraceLevel      int           `json:"remoteTraceLevel"`
-	RemoteTraceTarget     interface{}   `json:"remoteTraceTarget"`
-	Revision              int           `json:"revision"`
-	Routes                []interface{} `json:"routes"`
-	Rules                 []struct {
-		Not  bool   `json:"not"`
-		Or   bool   `json:"or"`
-		Type string `json:"type"`
-	} `json:"rules"`
-	RulesSource  string        `json:"rulesSource"`
-	SsoEnabled   bool          `json:"ssoEnabled"`
-	Tags         []interface{} `json:"tags"`
-	V4AssignMode struct {
-		Zt bool `json:"zt"`
-	} `json:"v4AssignMode"`
-	V6AssignMode struct {
-		SixPlane bool `json:"6plane"`
-		Rfc4193  bool `json:"rfc4193"`
-		Zt       bool `json:"zt"`
-	} `json:"v6AssignMode"`
-}
-
-type MemberInfo struct {
-	ActiveBridge                 bool          `json:"activeBridge"`
-	Address                      string        `json:"address"`
-	AuthenticationExpiryTime     int           `json:"authenticationExpiryTime"`
-	Authorized                   bool          `json:"authorized"`
-	Capabilities                 []interface{} `json:"capabilities"`
-	CreationTime                 int64         `json:"creationTime"`
-	ID                           string        `json:"id"`
-	Identity                     string        `json:"identity"`
-	IPAssignments                []string      `json:"ipAssignments"`
-	LastAuthorizedCredential     interface{}   `json:"lastAuthorizedCredential"`
-	LastAuthorizedCredentialType string        `json:"lastAuthorizedCredentialType"`
-	LastAuthorizedTime           int           `json:"lastAuthorizedTime"`
-	LastDeauthorizedTime         int           `json:"lastDeauthorizedTime"`
-	NoAutoAssignIps              bool          `json:"noAutoAssignIps"`
-	Nwid                         string        `json:"nwid"`
-	Objtype                      string        `json:"objtype"`
-	RemoteTraceLevel             int           `json:"remoteTraceLevel"`
-	RemoteTraceTarget            interface{}   `json:"remoteTraceTarget"`
-	Revision                     int           `json:"revision"`
-	SsoExempt                    bool          `json:"ssoExempt"`
-	Tags                         []interface{} `json:"tags"`
-	VMajor                       int           `json:"vMajor"`
-	VMinor                       int           `json:"vMinor"`
-	VProto                       int           `json:"vProto"`
-	VRev                         int           `json:"vRev"`
-}
-
-// Get the zerotier node info from local service
-func getControllerInfo(token string, apiPort int) (*NodeInfo, error) {
-	url := "http://localhost:" + strconv.Itoa(apiPort) + "/status"
-
-	req, err := http.NewRequest("GET", url, nil)
-	if err != nil {
-		return nil, err
-	}
-
-	req.Header.Set("X-ZT1-AUTH", token)
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return nil, err
-	}
-
-	//Read from zerotier service instance
-
-	defer resp.Body.Close()
-	payload, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, err
-	}
-
-	//Parse the payload into struct
-	thisInstanceInfo := NodeInfo{}
-	err = json.Unmarshal(payload, &thisInstanceInfo)
-	if err != nil {
-		return nil, err
-	}
-
-	return &thisInstanceInfo, nil
-}
-
-/*
-	Network Functions
-*/
-//Create a zerotier network
-func (m *NetworkManager) createNetwork() (*NetworkInfo, error) {
-	url := fmt.Sprintf("http://localhost:"+strconv.Itoa(m.apiPort)+"/controller/network/%s______", m.ControllerID)
-
-	data := []byte(`{}`)
-	req, err := http.NewRequest("POST", url, bytes.NewBuffer(data))
-	if err != nil {
-		return nil, err
-	}
-
-	req.Header.Set("X-ZT1-AUTH", m.authToken)
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return nil, err
-	}
-
-	defer resp.Body.Close()
-
-	payload, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, err
-	}
-
-	networkInfo := NetworkInfo{}
-	err = json.Unmarshal(payload, &networkInfo)
-	if err != nil {
-		return nil, err
-	}
-
-	return &networkInfo, nil
-}
-
-// List network details
-func (m *NetworkManager) getNetworkInfoById(networkId string) (*NetworkInfo, error) {
-	req, err := http.NewRequest("GET", os.ExpandEnv("http://localhost:"+strconv.Itoa(m.apiPort)+"/controller/network/"+networkId+"/"), nil)
-	if err != nil {
-		return nil, err
-	}
-	req.Header.Set("X-Zt1-Auth", m.authToken)
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return nil, err
-	}
-	defer resp.Body.Close()
-	if resp.StatusCode != 200 {
-		return nil, errors.New("network error. Status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	thisNetworkInfo := NetworkInfo{}
-	payload, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, err
-	}
-
-	err = json.Unmarshal(payload, &thisNetworkInfo)
-	if err != nil {
-		return nil, err
-	}
-
-	return &thisNetworkInfo, nil
-}
-
-func (m *NetworkManager) setNetworkInfoByID(networkId string, newNetworkInfo *NetworkInfo) error {
-	payloadBytes, err := json.Marshal(newNetworkInfo)
-	if err != nil {
-		return err
-	}
-	payloadBuffer := bytes.NewBuffer(payloadBytes)
-
-	// Create the HTTP request
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + networkId + "/"
-	req, err := http.NewRequest("POST", url, payloadBuffer)
-	if err != nil {
-		return err
-	}
-	req.Header.Set("X-Zt1-Auth", m.authToken)
-	req.Header.Set("Content-Type", "application/json")
-
-	// Send the HTTP request
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	// Print the response status code
-	if resp.StatusCode != 200 {
-		return errors.New("network error. status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-// List network IDs
-func (m *NetworkManager) listNetworkIds() ([]string, error) {
-	req, err := http.NewRequest("GET", "http://localhost:"+strconv.Itoa(m.apiPort)+"/controller/network/", nil)
-	if err != nil {
-		return []string{}, err
-	}
-	req.Header.Set("X-Zt1-Auth", m.authToken)
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return []string{}, err
-	}
-	defer resp.Body.Close()
-
-	if resp.StatusCode != 200 {
-		return []string{}, errors.New("network error")
-	}
-
-	networkIds := []string{}
-	payload, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return []string{}, err
-	}
-
-	err = json.Unmarshal(payload, &networkIds)
-	if err != nil {
-		return []string{}, err
-	}
-
-	return networkIds, nil
-}
-
-// wrapper for checking if a network id exists
-func (m *NetworkManager) networkExists(networkId string) bool {
-	networkIds, err := m.listNetworkIds()
-	if err != nil {
-		return false
-	}
-
-	for _, thisid := range networkIds {
-		if thisid == networkId {
-			return true
-		}
-	}
-
-	return false
-}
-
-// delete a network
-func (m *NetworkManager) deleteNetwork(networkID string) error {
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + networkID + "/"
-	client := &http.Client{}
-
-	// Create a new DELETE request
-	req, err := http.NewRequest("DELETE", url, nil)
-	if err != nil {
-		return err
-	}
-
-	// Add the required authorization header
-	req.Header.Set("X-Zt1-Auth", m.authToken)
-
-	// Send the request and get the response
-	resp, err := client.Do(req)
-	if err != nil {
-		return err
-	}
-
-	// Close the response body when we're done
-	defer resp.Body.Close()
-	s, err := io.ReadAll(resp.Body)
-	fmt.Println(string(s), err, resp.StatusCode)
-
-	// Print the response status code
-	if resp.StatusCode != 200 {
-		return errors.New("network error. status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-// Configure network
-// Example: configureNetwork(netid, "192.168.192.1", "192.168.192.254", "192.168.192.0/24")
-func (m *NetworkManager) configureNetwork(networkID string, ipRangeStart string, ipRangeEnd string, routeTarget string) error {
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + networkID + "/"
-	data := map[string]interface{}{
-		"ipAssignmentPools": []map[string]string{
-			{
-				"ipRangeStart": ipRangeStart,
-				"ipRangeEnd":   ipRangeEnd,
-			},
-		},
-		"routes": []map[string]interface{}{
-			{
-				"target": routeTarget,
-				"via":    nil,
-			},
-		},
-		"v4AssignMode": "zt",
-		"private":      true,
-	}
-
-	payload, err := json.Marshal(data)
-	if err != nil {
-		return err
-	}
-
-	req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
-	if err != nil {
-		return err
-	}
-
-	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("X-ZT1-AUTH", m.authToken)
-
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return err
-	}
-
-	defer resp.Body.Close()
-	// Print the response status code
-	if resp.StatusCode != 200 {
-		return errors.New("network error. status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-func (m *NetworkManager) setAssignedIps(networkID string, memid string, newIps []string) error {
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + networkID + "/member/" + memid
-	data := map[string]interface{}{
-		"ipAssignments": newIps,
-	}
-
-	payload, err := json.Marshal(data)
-	if err != nil {
-		return err
-	}
-
-	req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
-	if err != nil {
-		return err
-	}
-
-	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("X-ZT1-AUTH", m.authToken)
-
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return err
-	}
-
-	defer resp.Body.Close()
-	// Print the response status code
-	if resp.StatusCode != 200 {
-		return errors.New("network error. status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-func (m *NetworkManager) setNetworkNameAndDescription(netid string, name string, desc string) error {
-	// Convert string to rune slice
-	r := []rune(name)
-
-	// Loop over runes and remove non-ASCII characters
-	for i, v := range r {
-		if v > 127 {
-			r[i] = ' '
-		}
-	}
-
-	// Convert back to string and trim whitespace
-	name = strings.TrimSpace(string(r))
-
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + netid + "/"
-	data := map[string]interface{}{
-		"name": name,
-	}
-
-	payload, err := json.Marshal(data)
-	if err != nil {
-		return err
-	}
-
-	req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
-	if err != nil {
-		return err
-	}
-
-	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("X-ZT1-AUTH", m.authToken)
-
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return err
-	}
-
-	defer resp.Body.Close()
-	// Print the response status code
-	if resp.StatusCode != 200 {
-		return errors.New("network error. status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	meta := m.GetNetworkMetaData(netid)
-	if meta != nil {
-		meta.Desc = desc
-		m.WriteNetworkMetaData(netid, meta)
-	}
-
-	return nil
-}
-
-func (m *NetworkManager) getNetworkNameAndDescription(netid string) (string, string, error) {
-	//Get name from network info
-	netinfo, err := m.getNetworkInfoById(netid)
-	if err != nil {
-		return "", "", err
-	}
-
-	name := netinfo.Name
-
-	//Get description from meta
-	desc := ""
-	networkMeta := m.GetNetworkMetaData(netid)
-	if networkMeta != nil {
-		desc = networkMeta.Desc
-	}
-
-	return name, desc, nil
-}
-
-/*
-	Member functions
-*/
-
-func (m *NetworkManager) getNetworkMembers(networkId string) ([]string, error) {
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + networkId + "/member"
-	reqBody := bytes.NewBuffer([]byte{})
-	req, err := http.NewRequest("GET", url, reqBody)
-	if err != nil {
-		return nil, err
-	}
-
-	req.Header.Set("X-ZT1-AUTH", m.authToken)
-
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return nil, err
-	}
-
-	defer resp.Body.Close()
-
-	if resp.StatusCode != http.StatusOK {
-		return nil, errors.New("failed to get network members")
-	}
-
-	memberList := map[string]int{}
-	payload, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, err
-	}
-
-	err = json.Unmarshal(payload, &memberList)
-	if err != nil {
-		return nil, err
-	}
-
-	members := make([]string, 0, len(memberList))
-	for k := range memberList {
-		members = append(members, k)
-	}
-
-	return members, nil
-}
-
-func (m *NetworkManager) memberExistsInNetwork(netid string, memid string) bool {
-	//Get a list of member
-	memberids, err := m.getNetworkMembers(netid)
-	if err != nil {
-		return false
-	}
-	for _, thisMemberId := range memberids {
-		if thisMemberId == memid {
-			return true
-		}
-	}
-
-	return false
-}
-
-// Get a network memeber info by netid and memberid
-func (m *NetworkManager) getNetworkMemberInfo(netid string, memberid string) (*MemberInfo, error) {
-	req, err := http.NewRequest("GET", "http://localhost:"+strconv.Itoa(m.apiPort)+"/controller/network/"+netid+"/member/"+memberid, nil)
-	if err != nil {
-		return nil, err
-	}
-	req.Header.Set("X-Zt1-Auth", m.authToken)
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return nil, err
-	}
-	defer resp.Body.Close()
-
-	thisMemeberInfo := &MemberInfo{}
-	payload, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, err
-	}
-
-	err = json.Unmarshal(payload, &thisMemeberInfo)
-	if err != nil {
-		return nil, err
-	}
-
-	return thisMemeberInfo, nil
-}
-
-// Set the authorization state of a member
-func (m *NetworkManager) AuthorizeMember(netid string, memberid string, setAuthorized bool) error {
-	url := "http://localhost:" + strconv.Itoa(m.apiPort) + "/controller/network/" + netid + "/member/" + memberid
-	payload := []byte(`{"authorized": true}`)
-	if !setAuthorized {
-		payload = []byte(`{"authorized": false}`)
-	}
-
-	req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
-	if err != nil {
-		return err
-	}
-	req.Header.Set("X-ZT1-AUTH", m.authToken)
-	client := &http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	if resp.StatusCode != 200 {
-		return errors.New("network error. Status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-// Delete a member from the network
-func (m *NetworkManager) deleteMember(netid string, memid string) error {
-	req, err := http.NewRequest("DELETE", "http://localhost:"+strconv.Itoa(m.apiPort)+"/controller/network/"+netid+"/member/"+memid, nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Set("X-Zt1-Auth", os.ExpandEnv(m.authToken))
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	if resp.StatusCode != 200 {
-		return errors.New("network error. Status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-// Make the host to join a given network
-func (m *NetworkManager) joinNetwork(netid string) error {
-	req, err := http.NewRequest("POST", "http://localhost:"+strconv.Itoa(m.apiPort)+"/network/"+netid, nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Set("X-Zt1-Auth", os.ExpandEnv(m.authToken))
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	if resp.StatusCode != 200 {
-		return errors.New("network error. Status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}
-
-// Make the host to leave a given network
-func (m *NetworkManager) leaveNetwork(netid string) error {
-	req, err := http.NewRequest("DELETE", "http://localhost:"+strconv.Itoa(m.apiPort)+"/network/"+netid, nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Set("X-Zt1-Auth", os.ExpandEnv(m.authToken))
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	defer resp.Body.Close()
-
-	if resp.StatusCode != 200 {
-		return errors.New("network error. Status code: " + strconv.Itoa(resp.StatusCode))
-	}
-
-	return nil
-}

example/plugins/ztnc/mod/utils/conv.go

@@ -1,105 +0,0 @@
-package utils
-
-import (
-	"archive/zip"
-	"io"
-	"os"
-	"path/filepath"
-	"strconv"
-	"strings"
-)
-
-func StringToInt64(number string) (int64, error) {
-	i, err := strconv.ParseInt(number, 10, 64)
-	if err != nil {
-		return -1, err
-	}
-	return i, nil
-}
-
-func Int64ToString(number int64) string {
-	convedNumber := strconv.FormatInt(number, 10)
-	return convedNumber
-}
-
-func ReplaceSpecialCharacters(filename string) string {
-	replacements := map[string]string{
-		"#":  "%pound%",
-		"&":  "%amp%",
-		"{":  "%left_cur%",
-		"}":  "%right_cur%",
-		"\\": "%backslash%",
-		"<":  "%left_ang%",
-		">":  "%right_ang%",
-		"*":  "%aster%",
-		"?":  "%quest%",
-		" ":  "%space%",
-		"$":  "%dollar%",
-		"!":  "%exclan%",
-		"'":  "%sin_q%",
-		"\"": "%dou_q%",
-		":":  "%colon%",
-		"@":  "%at%",
-		"+":  "%plus%",
-		"`":  "%backtick%",
-		"|":  "%pipe%",
-		"=":  "%equal%",
-		".":  "_",
-		"/":  "-",
-	}
-
-	for char, replacement := range replacements {
-		filename = strings.ReplaceAll(filename, char, replacement)
-	}
-
-	return filename
-}
-
-/* Zip File Handler */
-// zipFiles compresses multiple files into a single zip archive file
-func ZipFiles(filename string, files ...string) error {
-	newZipFile, err := os.Create(filename)
-	if err != nil {
-		return err
-	}
-	defer newZipFile.Close()
-
-	zipWriter := zip.NewWriter(newZipFile)
-	defer zipWriter.Close()
-
-	for _, file := range files {
-		if err := addFileToZip(zipWriter, file); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
-// addFileToZip adds an individual file to a zip archive
-func addFileToZip(zipWriter *zip.Writer, filename string) error {
-	fileToZip, err := os.Open(filename)
-	if err != nil {
-		return err
-	}
-	defer fileToZip.Close()
-
-	info, err := fileToZip.Stat()
-	if err != nil {
-		return err
-	}
-
-	header, err := zip.FileInfoHeader(info)
-	if err != nil {
-		return err
-	}
-
-	header.Name = filepath.Base(filename)
-	header.Method = zip.Deflate
-
-	writer, err := zipWriter.CreateHeader(header)
-	if err != nil {
-		return err
-	}
-	_, err = io.Copy(writer, fileToZip)
-	return err
-}

example/plugins/ztnc/mod/utils/template.go

@@ -1,19 +0,0 @@
-package utils
-
-import (
-	"net/http"
-)
-
-/*
-	Web Template Generator
-
-	This is the main system core module that perform function similar to what PHP did.
-	To replace part of the content of any file, use {{paramter}} to replace it.
-
-
-*/
-
-func SendHTMLResponse(w http.ResponseWriter, msg string) {
-	w.Header().Set("Content-Type", "text/html")
-	w.Write([]byte(msg))
-}

example/plugins/ztnc/mod/utils/utils.go

@@ -1,202 +0,0 @@
-package utils
-
-import (
-	"errors"
-	"log"
-	"net"
-	"net/http"
-	"os"
-	"strconv"
-	"strings"
-	"time"
-)
-
-/*
-	Common
-
-	Some commonly used functions in ArozOS
-
-*/
-
-// Response related
-func SendTextResponse(w http.ResponseWriter, msg string) {
-	w.Write([]byte(msg))
-}
-
-// Send JSON response, with an extra json header
-func SendJSONResponse(w http.ResponseWriter, json string) {
-	w.Header().Set("Content-Type", "application/json")
-	w.Write([]byte(json))
-}
-
-func SendErrorResponse(w http.ResponseWriter, errMsg string) {
-	w.Header().Set("Content-Type", "application/json")
-	w.Write([]byte("{\"error\":\"" + errMsg + "\"}"))
-}
-
-func SendOK(w http.ResponseWriter) {
-	w.Header().Set("Content-Type", "application/json")
-	w.Write([]byte("\"OK\""))
-}
-
-// Get GET parameter
-func GetPara(r *http.Request, key string) (string, error) {
-	// Get first value from the URL query
-	value := r.URL.Query().Get(key)
-	if len(value) == 0 {
-		return "", errors.New("invalid " + key + " given")
-	}
-	return value, nil
-}
-
-// Get GET paramter as boolean, accept 1 or true
-func GetBool(r *http.Request, key string) (bool, error) {
-	x, err := GetPara(r, key)
-	if err != nil {
-		return false, err
-	}
-
-	// Convert to lowercase and trim spaces just once to compare
-	switch strings.ToLower(strings.TrimSpace(x)) {
-	case "1", "true", "on":
-		return true, nil
-	case "0", "false", "off":
-		return false, nil
-	}
-
-	return false, errors.New("invalid boolean given")
-}
-
-// Get POST parameter
-func PostPara(r *http.Request, key string) (string, error) {
-	// Try to parse the form
-	if err := r.ParseForm(); err != nil {
-		return "", err
-	}
-	// Get first value from the form
-	x := r.Form.Get(key)
-	if len(x) == 0 {
-		return "", errors.New("invalid " + key + " given")
-	}
-	return x, nil
-}
-
-// Get POST paramter as boolean, accept 1 or true
-func PostBool(r *http.Request, key string) (bool, error) {
-	x, err := PostPara(r, key)
-	if err != nil {
-		return false, err
-	}
-
-	// Convert to lowercase and trim spaces just once to compare
-	switch strings.ToLower(strings.TrimSpace(x)) {
-	case "1", "true", "on":
-		return true, nil
-	case "0", "false", "off":
-		return false, nil
-	}
-
-	return false, errors.New("invalid boolean given")
-}
-
-// Get POST paramter as int
-func PostInt(r *http.Request, key string) (int, error) {
-	x, err := PostPara(r, key)
-	if err != nil {
-		return 0, err
-	}
-
-	x = strings.TrimSpace(x)
-	rx, err := strconv.Atoi(x)
-	if err != nil {
-		return 0, err
-	}
-
-	return rx, nil
-}
-
-func FileExists(filename string) bool {
-	_, err := os.Stat(filename)
-	if err == nil {
-		// File exists
-		return true
-	} else if errors.Is(err, os.ErrNotExist) {
-		// File does not exist
-		return false
-	}
-	// Some other error
-	return false
-}
-
-func IsDir(path string) bool {
-	if !FileExists(path) {
-		return false
-	}
-	fi, err := os.Stat(path)
-	if err != nil {
-		log.Fatal(err)
-		return false
-	}
-	switch mode := fi.Mode(); {
-	case mode.IsDir():
-		return true
-	case mode.IsRegular():
-		return false
-	}
-	return false
-}
-
-func TimeToString(targetTime time.Time) string {
-	return targetTime.Format("2006-01-02 15:04:05")
-}
-
-// Check if given string in a given slice
-func StringInArray(arr []string, str string) bool {
-	for _, a := range arr {
-		if a == str {
-			return true
-		}
-	}
-	return false
-}
-
-func StringInArrayIgnoreCase(arr []string, str string) bool {
-	smallArray := []string{}
-	for _, item := range arr {
-		smallArray = append(smallArray, strings.ToLower(item))
-	}
-
-	return StringInArray(smallArray, strings.ToLower(str))
-}
-
-// Validate if the listening address is correct
-func ValidateListeningAddress(address string) bool {
-	// Check if the address starts with a colon, indicating it's just a port
-	if strings.HasPrefix(address, ":") {
-		return true
-	}
-
-	// Split the address into host and port parts
-	host, port, err := net.SplitHostPort(address)
-	if err != nil {
-		// Try to parse it as just a port
-		if _, err := strconv.Atoi(address); err == nil {
-			return false // It's just a port number
-		}
-		return false // It's an invalid address
-	}
-
-	// Check if the port part is a valid number
-	if _, err := strconv.Atoi(port); err != nil {
-		return false
-	}
-
-	// Check if the host part is a valid IP address or empty (indicating any IP)
-	if host != "" {
-		if net.ParseIP(host) == nil {
-			return false
-		}
-	}
-
-	return true
-}

example/plugins/ztnc/start.go

@@ -1,69 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"net/http"
-	"os"
-
-	"aroz.org/zoraxy/ztnc/mod/database"
-	"aroz.org/zoraxy/ztnc/mod/database/dbinc"
-	"aroz.org/zoraxy/ztnc/mod/ganserv"
-	"aroz.org/zoraxy/ztnc/mod/utils"
-)
-
-func startGanNetworkController() error {
-	fmt.Println("Starting ZeroTier Network Controller")
-	//Create a new database
-	var err error
-	sysdb, err = database.NewDatabase(DB_FILE_PATH, dbinc.BackendBoltDB)
-	if err != nil {
-		return err
-	}
-
-	//Initiate the GAN server manager
-	usingZtAuthToken := ""
-	ztAPIPort := 9993
-
-	if utils.FileExists(AUTH_TOKEN_PATH) {
-		authToken, err := os.ReadFile(AUTH_TOKEN_PATH)
-		if err != nil {
-			fmt.Println("Error reading auth config file:", err)
-			return err
-		}
-		usingZtAuthToken = string(authToken)
-		fmt.Println("Loaded ZeroTier Auth Token from file")
-	}
-
-	if usingZtAuthToken == "" {
-		usingZtAuthToken, err = ganserv.TryLoadorAskUserForAuthkey()
-		if err != nil {
-			fmt.Println("Error getting ZeroTier Auth Token:", err)
-		}
-	}
-
-	ganManager = ganserv.NewNetworkManager(&ganserv.NetworkManagerOptions{
-		AuthToken: usingZtAuthToken,
-		ApiPort:   ztAPIPort,
-		Database:  sysdb,
-	})
-
-	return nil
-}
-
-func initApiEndpoints() {
-	//UI_RELPATH must be the same as the one in the plugin intro spect
-	// as Zoraxy plugin UI proxy will only forward the UI path to your plugin
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/info", ganManager.HandleGetNodeID)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/add", ganManager.HandleAddNetwork)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/remove", ganManager.HandleRemoveNetwork)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/list", ganManager.HandleListNetwork)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/name", ganManager.HandleNetworkNaming)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/setRange", ganManager.HandleSetRanges)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/join", ganManager.HandleServerJoinNetwork)
-	http.HandleFunc(UI_RELPATH+"/api/gan/network/leave", ganManager.HandleServerLeaveNetwork)
-	http.HandleFunc(UI_RELPATH+"/api/gan/members/list", ganManager.HandleMemberList)
-	http.HandleFunc(UI_RELPATH+"/api/gan/members/ip", ganManager.HandleMemberIP)
-	http.HandleFunc(UI_RELPATH+"/api/gan/members/name", ganManager.HandleMemberNaming)
-	http.HandleFunc(UI_RELPATH+"/api/gan/members/authorize", ganManager.HandleMemberAuthorization)
-	http.HandleFunc(UI_RELPATH+"/api/gan/members/delete", ganManager.HandleMemberDelete)
-}

example/plugins/ztnc/web/details.html

@@ -1,752 +0,0 @@
-<!-- This is being loaded in index.html as ajax -->
-<div class="standardContainer">
-    <button onclick="exitToGanList();" class="ui large circular black icon button"><i class="angle left icon"></i></button>
-    <div style="max-width: 300px; margin-top: 1em;">
-        <button onclick='$("#gannetDetailEdit").slideToggle("fast");' class="ui mini basic right floated circular icon button" style="display: inline-block; margin-top: 2.5em;"><i class="ui edit icon"></i></button>
-        <h1 class="ui header">
-            <span class="ganetID"></span>
-            <div class="sub header ganetName"></div>
-        </h1>
-        <div class="ui divider"></div>
-        <p><span class="ganetDesc"></span></p>
-        
-    </div>
-    <div id="gannetDetailEdit" class="ui form" style="margin-top: 1em; display:none;">
-        <div class="ui divider"></div>
-        <p>You can change the network name and description below. <br>The name and description is only for easy management purpose and will not effect the network operation.</p>
-        <div class="field">
-            <label>Network Name</label>
-            <input type="text" id="gaNetNameInput" placeholder="">
-        </div>
-        <div class="field">
-        <label>Network Description</label>
-        <textarea id="gaNetDescInput" style="resize: none;"></textarea>
-        <button onclick="saveNameAndDesc(this);" class="ui basic right floated button" style="margin-top: 0.6em;"><i class="ui save icon"></i> Save</button>
-        <button onclick='$("#gannetDetailEdit").slideUp("fast");' class="ui basic right floated button" style="margin-top: 0.6em;"><i class="ui red remove icon"></i> Cancel</button>
-        </div>
-        <br><br>
-    </div>
-    <div class="ui divider"></div>
-    <h2>Settings</h2>
-    <div class="" style="overflow-x: auto;">
-        <table class="ui basic celled unstackable table" style="min-width: 560px;">
-            <thead>
-                <tr>
-                    <th colspan="4">IPv4 Auto-Assign</th>
-                </tr>
-            </thead>
-            <tbody id="ganetRangeTable">
-                
-            </tbody>
-        </table>
-    </div>
-    <br>
-    <div class="ui form">
-        <h3>Custom IP Range</h3>
-        <p>Manual IP Range Configuration. The IP range must be within the selected CIDR range. 
-        <br>Use <code>Utilities > IP to CIDR tool</code> if you are not too familiar with CIDR notations.</p>
-        <div class="two fields">
-            <div class="field">
-                <label>IP Start</label>
-                <input type="text" class="ganIpStart" placeholder="">
-            </div>
-            <div class="field">
-                <label>IP End</label>
-                <input type="text" class="ganIpEnd" placeholder="">
-            </div>
-        </div>
-    </div>
-    <button onclick="setNetworkRange();" class="ui basic button"><i class="ui blue save icon"></i> Save Settings</button>
-
-    <div class="ui divider"></div>
-    <h2>Members</h2>
-    <p>To join this network using command line, type <code>sudo zerotier-cli join <span class="ganetID"></span></code> on your device terminal</p>
-    <div class="ui checkbox" style="margin-bottom: 1em;">
-        <input id="showUnauthorizedMembers" type="checkbox" onchange="changeUnauthorizedVisibility(this.checked);" checked>
-        <label>Show Unauthorized Members</label>
-    </div>
-    <div class="" style="overflow-x: auto;">
-        <table class="ui celled unstackable table">
-            <thead>
-                <tr>
-                    <th>Auth</th>
-                    <th>Address</th>
-                    <th>Name</th>
-                    <th>Managed IP</th>
-                    <th>Authorized Since</th>
-                    <th>Version</th>
-                    <th>Remove</th>
-                </tr>
-            </thead>
-            <tbody id="networkMemeberTable">
-                <tr>
-                    
-                </tr>
-            </tbody>
-        </table>
-    </div>
-    <div class="ui divider"></div>
-    <h4>Add Controller as Member</h4>
-    <p>Optionally you can add the network controller (ZeroTier running on the Zoraxy node) as member for cross GAN reverse proxy to bypass NAT limitations.</p>
-    <button class="ui basic small button addControllerToNetworkBtn" onclick="ganAddControllerToNetwork(this);"><i class="green add icon"></i> Add Controller as Member</button>
-    <button class="ui basic small button removeControllerFromNetworkBtn" onclick="ganRemoveControllerFromNetwork(this);"><i class="red sign-out icon"></i> Remove Controller from Member</button>
-    <br><br>
-</div>
-<script>
-    $(".checkbox").checkbox();
-    var currentGANetID = "";
-    var currentGANNetMemeberListener = undefined;
-    var currentGaNetDetails = {};
-    var currentGANMemberList = [];
-    var netRanges = {
-            "10.147.17.*": "10.147.17.0/24",
-            "10.147.18.*": "10.147.18.0/24",
-            "10.147.19.*": "10.147.19.0/24",
-            "10.147.20.*": "10.147.20.0/24",
-            "10.144.*.*": "10.144.0.0/16",
-            "10.241.*.*": "10.241.0.0/16",
-            "10.242.*.*": "10.242.0.0/16",
-            "10.243.*.*": "10.243.0.0/16",
-            "10.244.*.*": "10.244.0.0/16",
-            "172.22.*.*": "172.22.0.0/15",
-            "172.23.*.*": "172.23.0.0/16",
-            "172.24.*.*": "172.24.0.0/14",
-            "172.25.*.*": "172.25.0.0/16",
-            "172.26.*.*": "172.26.0.0/15",
-            "172.27.*.*": "172.27.0.0/16",
-            "172.28.*.*": "172.28.0.0/15",
-            "172.29.*.*": "172.29.0.0/16",
-            "172.30.*.*": "172.30.0.0/15",
-            "192.168.191.*": "192.168.191.0/24",
-            "192.168.192.*": "192.168.192.0/24",
-            "192.168.193.*": "192.168.193.0/24",
-            "192.168.194.*": "192.168.194.0/24",
-            "192.168.195.*": "192.168.195.0/24",
-            "192.168.196.*": "192.168.196.0/24"
-        }
-
-    function generateIPRangeTable(netRanges) {
-        $("#ganetRangeTable").empty();
-        const tableBody = document.getElementById('ganetRangeTable');
-        const cidrs = Object.values(netRanges);
-        
-        // Set the number of rows and columns to display in the table
-        const numRows = 6;
-        const numCols = 4;
-
-        let row = document.createElement('tr');
-        let col = 0;
-        for (let i = 0; i < cidrs.length; i++) {
-            if (col >= numCols) {
-            tableBody.appendChild(row);
-            row = document.createElement('tr');
-            col = 0;
-            }
-
-            const td = document.createElement('td');
-            td.setAttribute('class', `clickable iprange`);
-            td.setAttribute('CIDR', cidrs[i]);
-            td.innerHTML = cidrs[i];
-            let thisCidr = cidrs[i];
-            td.onclick = function(){
-                selectNetworkRange(thisCidr, td);
-            };
-            
-            row.appendChild(td);
-            col++;
-        }
-
-        // Add any remaining cells to the table
-        if (col > 0) {
-            for (let i = col; i < numCols; i++) {
-                row.appendChild(document.createElement('td'));
-            }
-            tableBody.appendChild(row);
-        }
-    }
-
-    function highlightCurrentGANetCIDR(){
-        var currentCIDR = currentGaNetDetails.routes[0].target;
-        $(".iprange").each(function(){
-            if ($(this).attr("CIDR") == currentCIDR){
-                $(this).addClass("active");
-                populateStartEndIpByCidr(currentCIDR);
-            }
-        })
-    }
-
-    function populateStartEndIpByCidr(cidr){
-        function cidrToRange(cidr) {
-            var range = [2];
-            cidr = cidr.split('/');
-            var start = ip2long(cidr[0]);
-            range[0] = long2ip(start);
-            range[1] = long2ip(Math.pow(2, 32 - cidr[1]) + start - 1);
-            return range;
-        }
-        var cidrRange = cidrToRange(cidr);
-        $(".ganIpStart").val(cidrRange[0]);
-        $(".ganIpEnd").val(cidrRange[1]);
-    }
-
-    function selectNetworkRange(cidr, object){
-        populateStartEndIpByCidr(cidr);
-
-        $(".iprange.active").removeClass("active");
-        $(object).addClass("active");
-    }
-
-    function setNetworkRange(){
-        var ipstart = $(".ganIpStart").val().trim();
-        var ipend = $(".ganIpEnd").val().trim();
-
-        if (ipstart == ""){
-            $(".ganIpStart").parent().addClass("error");
-        }else{
-            $(".ganIpStart").parent().removeClass("error");
-        }
-
-        if (ipend == ""){
-            $(".ganIpEnd").parent().addClass("error");
-        }else{
-            $(".ganIpEnd").parent().removeClass("error");
-        }
-
-        //Get CIDR from selected range group
-        var cidr = $(".iprange.active").attr("cidr");
-
-        $.cjax({
-            url: "./api/gan/network/setRange",
-            metohd: "POST",
-            data:{
-                netid: currentGANetID,
-                cidr: cidr,
-                ipstart: ipstart,
-                ipend: ipend
-            },
-            success: function(data){
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 5000)
-                }else{
-                    parent.msgbox("Network Range Updated")
-                }
-            }
-        })
-    }
-
-
-    function saveNameAndDesc(object=undefined){
-        var name = $("#gaNetNameInput").val();
-        var desc = $("#gaNetDescInput").val();
-        if (object != undefined){
-            $(object).addClass("loading");
-        }
-        $.cjax({
-            url: "./api/gan/network/name",
-            method: "POST",
-            data: {
-                netid: currentGANetID,
-                name: name,
-                desc: desc,
-            },
-            success: function(data){
-                initNetNameAndDesc();
-                if (object != undefined){
-                    $(object).removeClass("loading");
-                    parent.msgbox("Network Metadata Updated");
-                }
-                $("#gannetDetailEdit").slideUp("fast");
-            }
-        });
-    }
-
-    function initNetNameAndDesc(){
-        //Get the details of the net
-        $.get("./api/gan/network/name?netid=" + currentGANetID, function(data){
-            if (data.error !== undefined){
-                parent.msgbox(data.error, false, 6000);
-            }else{
-                $("#gaNetNameInput").val(data[0]);
-                $(".ganetName").html(data[0]);
-                $("#gaNetDescInput").val(data[1]);
-                $(".ganetDesc").text(data[1]);
-            }
-        });
-    }
-
-    function initNetDetails(){
-        //Get the details of the net
-        $.get("./api/gan/network/list?netid=" + currentGANetID, function(data){
-            if (data.error !== undefined){
-                parent.msgbox(data.error, false, 6000);
-            }else{
-                currentGaNetDetails = data;
-                highlightCurrentGANetCIDR();
-            }
-        });
-    }
-
-    //Handle delete IP from memeber
-    function deleteIpFromMemeber(memberid, ip){
-        $.cjax({
-            url: "./api/gan/members/ip",
-            metohd: "POST",
-            data: {
-                netid: currentGANetID, 
-                memid: memberid,
-                opr: "del",
-                ip: ip,
-            },
-            success: function(data){
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 5000);
-                }else{
-                    parent.msgbox("IP removed from member " + memberid)
-                }
-                renderMemeberTable();
-            }
-        });
-    }
-
-    function addIpToMemeberFromInput(memberid, newip){
-        function isValidIPv4Address(address) {
-            // Split the address into its 4 components
-            const parts = address.split('.');
-            
-            // Check that there are 4 components
-            if (parts.length !== 4) {
-                return false;
-            }
-            
-            // Check that each component is a number between 0 and 255
-            for (let i = 0; i < 4; i++) {
-                const part = parseInt(parts[i], 10);
-                if (isNaN(part) || part < 0 || part > 255) {
-                return false;
-                }
-            }
-            
-            // The address is valid
-            return true;
-        }
-
-        if (!isValidIPv4Address(newip)){
-            parent.msgbox(newip + " is not a valid IPv4 address", false, 5000)
-            return
-        }
-
-        $.cjax({
-            url: "./api/gan/members/ip",
-            metohd: "POST",
-            data: {
-                netid: currentGANetID, 
-                memid: memberid,
-                opr: "add",
-                ip: newip,
-            },
-            success: function(data){
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 5000);
-                }else{
-                    parent.msgbox("IP added to member " + memberid)
-                }
-                renderMemeberTable();
-            }
-        })
-    }
-
-    //Member table populate
-    function renderMemeberTable(forceUpdate = false) {
-        $.ajax({
-            url: './api/gan/members/list?netid=' + currentGANetID + '&detail=true',
-            type: 'GET',
-            success: function(data) {
-                let tableBody = $('#networkMemeberTable');
-                if (tableBody.length == 0){
-                    return;
-                }
-                data.sort((a, b) => a.address.localeCompare(b.address));
-                //Check if the new object equal to the old one
-                if (objectEqual(currentGANMemberList, data) && !forceUpdate){
-                    //Do not need to update it
-                    return;
-                }
-                tableBody.empty();
-                currentGANMemberList = data;
-
-                var authroziedCount = 0;
-                data.forEach((member) => {
-                    let lastAuthTime = new Date(member.lastAuthorizedTime).toLocaleString();
-                    if (member.lastAuthorizedTime == 0){
-                        lastAuthTime = "Never";
-                    }
-
-                    let version = `${member.vMajor}.${member.vMinor}.${member.vProto}.${member.vRev}`;
-                    if (member.vMajor == -1){
-                        version = "Unknown";
-                    }
-
-                    let authorizedCheckbox = `<div class="ui fitted checkbox">
-                        <input type="checkbox" addr="${member.address}" name="isAuthrozied" onchange="handleMemberAuth(this);">
-                        <label></label>
-                    </div>`;
-                    if (member.authorized){
-                        authorizedCheckbox = `<div class="ui fitted checkbox">
-                            <input type="checkbox" addr="${member.address}" name="isAuthrozied" onchange="handleMemberAuth(this);" checked="">
-                            <label></label>
-                        </div>`
-                    }
-
-                    let rowClass = "authorized";
-                    let unauthorizedStyle = "";
-                    if (!$("#showUnauthorizedMembers")[0].checked && !member.authorized){
-                        unauthorizedStyle = "display:none;";
-                    }
-                    if (!member.authorized){
-                        rowClass = "unauthorized";
-                    }else{
-                        authroziedCount++;
-                    }
-                    
-                    let assignedIp = "";
-
-                    if (member.ipAssignments.length == 0){
-                        assignedIp = "Not assigned"
-                    }else{
-                        assignedIp = `<div class="ui list">`
-                        member.ipAssignments.forEach(function(thisIp){
-                            assignedIp += `<div class="item" style="width: 100%;">${thisIp} <a style="cursor:pointer; float: right;" title="Remove IP" onclick="deleteIpFromMemeber('${member.address}','${thisIp}');"><i class="red remove icon"></i></a></div>`;
-                        })
-                        assignedIp += `</div>`
-                    }
-                    const row = $(`<tr class="GANetMemberEntity ${rowClass}" style="${unauthorizedStyle}">`);
-                    row.append($(`<td class="GANetMember ${rowClass}" style="text-align: center;">`).html(authorizedCheckbox));
-                    row.append($('<td>').text(member.address));
-                    row.append($('<td>').html(`<span class="memberName" addr="${member.address}"></span> <a style="cursor:pointer; float: right;" title="Edit Memeber Name" onclick="renameMember('${member.address}');"><i class="grey edit icon"></i></a>`));
-                    row.append($('<td>').html(`${assignedIp}
-                        <div class="ui action mini fluid input" style="min-width: 200px;">
-                            <input type="text" placeholder="IPv4" onchange="$(this).val($(this).val().trim());">
-                            <button onclick="addIpToMemeberFromInput('${member.address}',$(this).parent().find('input').val());" class="ui basic icon button">
-                                <i class="add icon"></i>
-                            </button>
-                        </div>`));
-                    row.append($('<td>').text(lastAuthTime));
-                    row.append($('<td>').text(version));
-                    row.append($(`<td title="Deauthorize & Delete Memeber" style="text-align: center;" onclick="handleMemberDelete('${member.address}');">`).html(`<button class="ui basic mini icon button"><i class="red remove icon"></i></button>`));
-
-                    tableBody.append(row);
-                });
-
-                if (data.length == 0){
-                    tableBody.append(`<tr>
-                        <td colspan="7"><i class="green check circle icon"></i> No member has joined this network yet.</td>
-                    </tr>`);
-                }
-
-                if (data.length > 0 && authroziedCount == 0 && !$("#showUnauthorizedMembers")[0].checked){
-                    //All nodes are unauthorized. Show tips to enable unauthorize display
-                    tableBody.append(`<tr>
-                        <td colspan="7"><i class="yellow exclamation circle icon"></i> Unauthorized nodes detected. Enable "Show Unauthorized Member" to change member access permission.</td>
-                    </tr>`);
-                }
-
-                initNameForMembers();
-            },
-            error: function(xhr, status, error) {
-                console.log('Error:', error);
-            }
-        });
-    }
-
-    function initNameForMembers(){
-        $(".memberName").each(function(){
-            let addr = $(this).attr("addr");
-            let targetDOM = $(this);
-            $.cjax({
-                url: "./api/gan/members/name",
-                method: "POST",
-                data: {
-                    netid: currentGANetID,
-                    memid: addr,
-                },
-                success: function(data){
-                    if (data.error != undefined){
-                        $(targetDOM).text("N/A");
-                    }else{
-                        $(targetDOM).text(data.Name);
-                    }
-                }
-            });
-        })
-    }
-
-    function renameMember(targetMemberAddr){
-        if (targetMemberAddr == ""){
-            parent.msgbox("Member address cannot be empty", false, 5000)
-            return
-        }
-
-        let newname = prompt("Enter a easy manageable name for " + targetMemberAddr, "");
-        if (newname != null && newname.trim() != "") {
-        $.cjax({
-            url: "./api/gan/members/name",
-            method: "POST",
-            data: {
-                netid: currentGANetID,
-                memid: targetMemberAddr,
-                name: newname
-            },
-            success: function(data){
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 6000);
-                }else{
-                    parent.msgbox("Member Name Updated"); 
-                }
-                renderMemeberTable(true);
-            }
-        })
-        }
-    }
-
-    //Helper function to check if two objects are equal recursively
-    function objectEqual(obj1, obj2) {
-        // compare types
-        if (typeof obj1 !== typeof obj2) {
-            return false;
-        }
-
-        // compare values
-        if (typeof obj1 !== 'object' || obj1 === null) {
-            return obj1 === obj2;
-        }
-
-        const keys1 = Object.keys(obj1);
-        const keys2 = Object.keys(obj2);
-
-        // compare keys
-        if (keys1.length !== keys2.length) {
-            return false;
-        }
-
-        for (const key of keys1) {
-            if (!keys2.includes(key)) {
-            return false;
-            }
-
-            // recursively compare values
-            if (!objectEqual(obj1[key], obj2[key])) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-
-    function changeUnauthorizedVisibility(visable){
-        if(visable){
-            $(".GANetMemberEntity.unauthorized").show();
-        }else{
-            $(".GANetMemberEntity.unauthorized").hide();
-        }
-    }
-
-    function handleMemberAuth(object){
-        let targetMemberAddr = $(object).attr("addr");
-        let isAuthed = object.checked;
-        $.cjax({
-            url: "./api/gan/members/authorize",
-            method: "POST",
-            data: {
-                netid:currentGANetID, 
-                memid: targetMemberAddr, 
-                auth: isAuthed
-            },
-            success: function(data){
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 6000);
-                }else{
-                    if (isAuthed){
-                        parent.msgbox("Member Authorized");
-                    }else{
-                        parent.msgbox("Member Deauthorized");
-                    }
-                    
-                }
-
-                renderMemeberTable(true);
-            }
-        })
-    }
-
-    function handleMemberDelete(addr){
-       parent.confirmBox("Confirm delete member " + addr + " ?", function(choice){
-            if (choice){
-                $.cjax({
-                    url: "./api/gan/members/delete",
-                    method: "POST",
-                    data: {
-                        netid:currentGANetID, 
-                        memid: addr, 
-                    },
-                    success: function(data){
-                        if (data.error != undefined){
-                            parent.msgbox(data.error, false, 6000);
-                        }else{
-                            parent.msgbox("Member Deleted");
-                        }
-                        renderMemeberTable(true);
-                    }
-                });
-            }
-        });
-    }
-
-    //Add and remove this controller node to network as member
-    function ganAddControllerToNetwork(){
-        $(".addControllerToNetworkBtn").addClass("disabled");
-        $(".addControllerToNetworkBtn").addClass("loading");
-    
-        $.cjax({
-            url: "./api/gan/network/join",
-            method: "POST",
-            data: {
-                netid:currentGANetID, 
-            },
-            success: function(data){
-                $(".addControllerToNetworkBtn").removeClass("disabled");
-                $(".addControllerToNetworkBtn").removeClass("loading");
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 6000);
-                }else{
-                    parent.msgbox("Controller joint " + currentGANetID);
-                }
-                setTimeout(function(){
-                    renderMemeberTable(true);
-                }, 3000)
-            },
-            error: function(){
-                $(".addControllerToNetworkBtn").removeClass("disabled");
-                $(".addControllerToNetworkBtn").removeClass("loading");
-
-            }
-        });
-    }
-
-    function ganRemoveControllerFromNetwork(){
-        $(".removeControllerFromNetworkBtn").addClass("disabled");
-        $(".removeControllerFromNetworkBtn").addClass("loading");
-        
-        $.cjax({
-            url: "./api/gan/network/leave",
-            method: "POST",
-            data: {
-                netid:currentGANetID, 
-            },
-            success: function(data){
-                if (data.error != undefined){
-                    parent.msgbox(data.error, false, 6000);
-                }else{
-                    parent.msgbox("Controller left " + currentGANetID);
-                }
-                renderMemeberTable(true);
-                $(".removeControllerFromNetworkBtn").removeClass("disabled");
-                $(".removeControllerFromNetworkBtn").removeClass("loading");
-            }
-        });
-    }
-
-    //Entry points
-    function initGanetDetails(ganetId){
-        currentGANetID = ganetId;
-        $(".ganetID").text(ganetId);
-        initNetNameAndDesc(ganetId);
-        generateIPRangeTable(netRanges); 
-        initNetDetails();
-        renderMemeberTable(true);
-
-        //Setup a listener to listen for member list change
-        if (currentGANNetMemeberListener == undefined){
-            currentGANNetMemeberListener = setInterval(function(){
-                if ($('#networkMemeberTable').length > 0 && currentGANetID){
-                    renderMemeberTable();
-                }
-            }, 3000);
-        }
-        
-    }
-
-    //Exit point
-    function exitToGanList(){
-        location.href = "./index.html"
-    }
-
-    //Debug functions
-    if (typeof(msgbox) == "undefined"){
-        msgbox = function(msg, error=false, timeout=3000){
-            console.log(msg);
-        }
-    }
-
-    function ip2long (argIP) {
-        //  discuss at: https://locutus.io/php/ip2long/
-        // original by: Waldo Malqui Silva (https://waldo.malqui.info)
-        // improved by: Victor
-        //  revised by: fearphage (https://my.opera.com/fearphage/)
-        //  revised by: Theriault (https://github.com/Theriault)
-        //    estarget: es2015
-        //   example 1: ip2long('192.0.34.166')
-        //   returns 1: 3221234342
-        //   example 2: ip2long('0.0xABCDEF')
-        //   returns 2: 11259375
-        //   example 3: ip2long('255.255.255.256')
-        //   returns 3: false
-        let i = 0
-        // PHP allows decimal, octal, and hexadecimal IP components.
-        // PHP allows between 1 (e.g. 127) to 4 (e.g 127.0.0.1) components.
-        const pattern = new RegExp([
-            '^([1-9]\\d*|0[0-7]*|0x[\\da-f]+)',
-            '(?:\\.([1-9]\\d*|0[0-7]*|0x[\\da-f]+))?',
-            '(?:\\.([1-9]\\d*|0[0-7]*|0x[\\da-f]+))?',
-            '(?:\\.([1-9]\\d*|0[0-7]*|0x[\\da-f]+))?$'
-        ].join(''), 'i')
-        argIP = argIP.match(pattern) // Verify argIP format.
-        if (!argIP) {
-            // Invalid format.
-            return false
-        }
-        // Reuse argIP variable for component counter.
-        argIP[0] = 0
-        for (i = 1; i < 5; i += 1) {
-            argIP[0] += !!((argIP[i] || '').length)
-            argIP[i] = parseInt(argIP[i]) || 0
-        }
-        // Continue to use argIP for overflow values.
-        // PHP does not allow any component to overflow.
-        argIP.push(256, 256, 256, 256)
-        // Recalculate overflow of last component supplied to make up for missing components.
-        argIP[4 + argIP[0]] *= Math.pow(256, 4 - argIP[0])
-        if (argIP[1] >= argIP[5] ||
-            argIP[2] >= argIP[6] ||
-            argIP[3] >= argIP[7] ||
-            argIP[4] >= argIP[8]) {
-            return false
-        }
-        return argIP[1] * (argIP[0] === 1 || 16777216) +
-            argIP[2] * (argIP[0] <= 2 || 65536) +
-            argIP[3] * (argIP[0] <= 3 || 256) +
-            argIP[4] * 1
-    }
-
-    function long2ip (ip) {
-        //  discuss at: https://locutus.io/php/long2ip/
-        // original by: Waldo Malqui Silva (https://fayr.us/waldo/)
-        //   example 1: long2ip( 3221234342 )
-        //   returns 1: '192.0.34.166'
-        if (!isFinite(ip)) {
-            return false
-        }
-        return [ip >>> 24 & 0xFF, ip >>> 16 & 0xFF, ip >>> 8 & 0xFF, ip & 0xFF].join('.')
-    }
-    
-</script>

example/plugins/ztnc/web/index.html

@@ -1,267 +0,0 @@
-<html>
-    <head>
-        <meta name="apple-mobile-web-app-capable" content="yes" />
-        <meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=1, maximum-scale=1"/>
-        <meta charset="UTF-8">
-        <meta name="theme-color" content="#4b75ff">
-        <meta name="zoraxy.csrf.Token" content="{{.csrfToken}}">
-        <link rel="icon" type="image/png" href="/favicon.png" />
-        <title>Global Area Network | Zoraxy</title>
-        <link rel="stylesheet" href="/script/semantic/semantic.min.css">
-        <script src="/script/jquery-3.6.0.min.js"></script>
-        <script src="/script/semantic/semantic.min.js"></script>
-        <script src="/script/tablesort.js"></script>
-        <script src="/script/countryCode.js"></script>
-        <script src="/script/chart.js"></script>
-        <script src="/script/utils.js"></script>
-        <link rel="stylesheet" href="/main.css">
-        <style>
-            body{
-                background:none;
-            }
-        </style>
-    </head>
-<body>
-    <!-- Dark theme script must be included after body tag-->
-    <link rel="stylesheet" href="/darktheme.css">
-    <script src="/script/darktheme.js"></script>
-    <div id="ganetWindow" class="standardContainer">
-        <div class="ui basic segment">
-            <h2>Global Area Network</h2>
-            <p>Virtual Network Hub that allows all networked devices to communicate as if they all reside in the same physical data center or cloud region</p>
-        </div>
-        <div class="gansnetworks">
-            <div class="ganstats ui basic segment">
-                <div style="float: right; max-width: 300px; margin-top: 0.4em;">
-                    <h1 class="ui header" style="text-align: right;">
-                        <span class="ganControllerID"></span>
-                        <div class="sub header">Network Controller ID</div>
-                    </h1>
-                </div>
-                <div class="ui list">
-                    <div class="item">
-                        <i class="exchange icon"></i>
-                        <div class="content">
-                        <div class="header" style="font-size: 1.2em;" id="ganetCount">0</div>
-                        <div class="description">Networks</div>
-                        </div>
-                    </div>
-                    <div class="item">
-                        <i class="desktop icon"></i>
-                        <div class="content">
-                        <div class="header" style="font-size: 1.2em;" id="ganodeCount">0</div>
-                        <div class="description" id="connectedNodes" count="0">Connected Nodes</div>
-                    </div>
-                    </div>
-                </div>
-            </div>
-            <div class="ganlist">
-                <button class="ui basic orange button" onclick="addGANet();">Create New Network</button>
-                <div class="ui divider"></div>
-                <!-- 
-                <div class="ui icon input" style="margin-bottom: 1em;">
-                    <input type="text" placeholder="Search a Network">
-                    <i class="circular search link icon"></i>
-                </div>-->
-                <div style="width: 100%; overflow-x: auto;">
-                    <table class="ui celled basic unstackable striped table">
-                        <thead>
-                            <tr>
-                                <th>Network ID</th>
-                                <th>Name</th>
-                                <th>Description</th>
-                                <th>Subnet (Assign Range)</th>
-                                <th>Nodes</th>
-                                <th>Actions</th>
-                            </tr>
-                        </thead>
-                        <tbody id="GANetList">
-                            <tr>
-                                <td colspan="6"><i class="ui green circle check icon"></i> No Global Area Network Found on this host</td>
-                            </tr>
-                        </tbody>
-                    </table>
-                </div>
-            </div>
-        </div>
-    </div>
-    <script>
-        /*
-            Network Management Functions
-        */
-        function handleAddNetwork(){
-            let networkName = $("#networkName").val().trim();
-            if (networkName == ""){
-                parent.msgbox("Network name cannot be empty", false, 5000);
-                return;
-            }
-    
-            //Add network with default settings
-            addGANet(networkName, "192.168.196.0/24");
-            $("#networkName").val("");
-        }
-    
-        function initGANetID(){
-            $.get("./api/gan/network/info", function(data){
-                if (data.error !== undefined){
-                    parent.msgbox(data.error, false, 5000)
-                }else{
-                    if (data != ""){
-                        $(".ganControllerID").text(data);
-                    }
-                }
-            })
-        }
-    
-        function addGANet() {
-            $.cjax({
-                url: "./api/gan/network/add",
-                type: "POST",
-                dataType: "json",
-                data: {},
-                success: function(response) {
-                    if (response.error != undefined){
-                        parent.msgbox(response.error, false, 5000);
-                    }else{
-                        parent.msgbox("Network added successfully");
-                    }
-                    console.log("Network added successfully:", response);
-                    listGANet();
-                },
-                error: function(xhr, status, error) {
-                    console.log("Error adding network:", error);
-                }
-            });
-        }
-    
-        function listGANet(){
-            $("#connectedNodes").attr("count", "0");
-    
-            $.get("./api/gan/network/list", function(data){
-                $("#GANetList").empty();
-                if (data.error != undefined){
-                    console.log(data.error);
-                    parent.msgbox("Unable to load auth token for GANet", false, 5000);
-                    //token error or no zerotier found
-                    $(".gansnetworks").addClass("disabled");
-                    $("#GANetList").append(`<tr>
-                        <td colspan="6"><i class="red times circle icon"></i> Auth token access error or not found</td>
-                    </tr>`);
-                    $(".ganControllerID").text('Access Denied');
-                }else{
-                    var nodeCount = 0;
-                    data.forEach(function(gan){
-                        $("#GANetList").append(`<tr class="ganetEntry" addr="${gan.nwid}">
-                            <td><a href="#" onclick="event.preventDefault(); openGANetDetails('${gan.nwid}');">${gan.nwid}</a></td>
-                            <td>${gan.name}</td>
-                            <td class="gandesc" addr="${gan.nwid}"></td>
-                            <td class="ganetSubnet"></td>
-                            <td class="ganetNodes"></td>
-                            <td>
-                                <button onclick="openGANetDetails('${gan.nwid}');" class="ui tiny basic icon button" title="Edit Network"><i class="edit icon"></i></button>
-                                <button onclick="removeGANet('${gan.nwid}');" class="ui tiny basic icon button" title="Remove Network"><i class="red remove icon"></i></button>
-                            </td>
-                        </tr>`);
-    
-                        nodeCount += 0;
-                    });
-    
-                    if (data.length == 0){
-                        $("#GANetList").append(`<tr>
-                            <td colspan="6"><i class="ui green circle check icon"></i> No Global Area Network Found on this host</td>
-                        </tr>`);
-                    }
-    
-                    $("#ganodeCount").text(nodeCount);
-                    $("#ganetCount").text(data.length);
-    
-                    //Load description
-                    $(".gandesc").each(function(){
-                        let addr = $(this).attr("addr");
-                        let domEle = $(this);
-                        $.get("./api/gan/network/name?netid=" + addr, function(data){
-                            $(domEle).text(data[1]);
-                        });
-                    });
-    
-                    $(".ganetEntry").each(function(){
-                        let addr = $(this).attr("addr");
-                        let subnetEle = $(this).find(".ganetSubnet");
-                        let nodeEle = $(this).find(".ganetNodes");
-    
-                        $.get("./api/gan/network/list?netid=" + addr, function(data){
-                            if (data.routes != undefined && data.routes.length > 0){
-                                
-                                if (data.ipAssignmentPools != undefined && data.ipAssignmentPools.length > 0){
-                                    $(subnetEle).html(`${data.routes[0].target} <br> (${data.ipAssignmentPools[0].ipRangeStart} - ${data.ipAssignmentPools[0].ipRangeEnd})`);
-                                }else{
-                                    $(subnetEle).html(`${data.routes[0].target}<br>(Unassigned Range)`);
-                                }
-                            }else{
-                                $(subnetEle).text("Unassigned");
-                            }
-                            //console.log(data);
-                        });
-    
-                        $.get("./api/gan/members/list?netid=" + addr, function(data){
-                            $(nodeEle).text(data.length);
-                            let currentNodesCount = parseInt($("#connectedNodes").attr("count"));
-                            currentNodesCount += data.length;
-                            $("#connectedNodes").attr("count", currentNodesCount);
-                            $("#ganodeCount").text($("#connectedNodes").attr("count"));
-                        })
-                    });
-                }
-            })
-        }
-    
-        //Remove the given GANet
-        function removeGANet(netid){
-            //Reusing Zoraxy confirm box
-            parent.confirmBox("Confirm remove " + netid + "?", function(choice){
-                if (choice == true){
-                    $.cjax({
-                        url: "./api/gan/network/remove",
-                        type: "POST",
-                        dataType: "json",
-                        data: {
-                            id: netid,
-                        },
-                        success: function(data){
-                            if (data.error != undefined){
-                                parent.msgbox(data.error, false, 5000);
-                            }else{
-                                parent.msgbox("Net " + netid + " removed");
-                            }
-                            listGANet();
-                        }
-                    });
-                }
-            });
-            
-        }
-    
-        function openGANetDetails(netid){
-            $("#ganetWindow").load("./details.html", function(){
-                setTimeout(function(){
-                    initGanetDetails(netid);
-                });
-            });
-           
-        }
-        
-        $(document).ready(function(){
-            listGANet();
-            initGANetID();
-        });
-
-        if (typeof(msgbox) == "undefined"){
-            msgbox = function(msg, error=false, timeout=3000){
-                console.log(msg);
-            }
-        }
-
-       
-    </script>
-</body>
-</html>