Merge 1097deeaf8 into 36f06a064a

.vscode/settings.json

@@ -10,5 +10,6 @@
     ]
   },
   "git.ignoreLimitWarning": true,
-  "cmake.sourceDirectory": "/workspaces/kvm-static-ip/internal/native/cgo"
+  "cmake.sourceDirectory": "/workspaces/kvm-static-ip/internal/native/cgo",
+  "cmake.ignoreCMakeListsMissing": true
 }

jsonrpc.go

@@ -932,6 +932,10 @@ func rpcSetCloudUrl(apiUrl string, appUrl string) error {
 		disconnectCloud(fmt.Errorf("cloud url changed from %s to %s", currentCloudURL, apiUrl))
 	}
 
+	if publicIPState != nil {
+		publicIPState.SetCloudflareEndpoint(apiUrl)
+	}
+
 	if err := SaveConfig(); err != nil {
 		return fmt.Errorf("failed to save config: %w", err)
 	}
@@ -1248,4 +1252,6 @@ var rpcHandlers = map[string]RPCHandler{
 	"setKeyboardMacros":      {Func: setKeyboardMacros, Params: []string{"params"}},
 	"getLocalLoopbackOnly":   {Func: rpcGetLocalLoopbackOnly},
 	"setLocalLoopbackOnly":   {Func: rpcSetLocalLoopbackOnly, Params: []string{"enabled"}},
+	"getPublicIPAddresses":   {Func: rpcGetPublicIPAddresses, Params: []string{"refresh"}},
+	"checkPublicIPAddresses": {Func: rpcCheckPublicIPAddresses},
 }

main.go

@@ -126,6 +126,7 @@ func Main() {
 
 	// As websocket client already checks if the cloud token is set, we can start it here.
 	go RunWebsocketClient()
+	initPublicIPState()
 
 	initSerialPort()
 	sigs := make(chan os.Signal, 1)

network.go

@@ -3,12 +3,17 @@ package kvm
 import (
 	"context"
 	"fmt"
+	"net"
+	"net/http"
 	"reflect"
+	"time"
 
 	"github.com/jetkvm/kvm/internal/confparser"
 	"github.com/jetkvm/kvm/internal/mdns"
 	"github.com/jetkvm/kvm/internal/network/types"
+	"github.com/jetkvm/kvm/pkg/myip"
 	"github.com/jetkvm/kvm/pkg/nmlite"
+	"github.com/jetkvm/kvm/pkg/nmlite/link"
 )
 
 const (
@@ -17,6 +22,7 @@ const (
 
 var (
 	networkManager *nmlite.NetworkManager
+	publicIPState  *myip.PublicIPState
 )
 
 type RpcNetworkSettings struct {
@@ -115,6 +121,14 @@ func networkStateChanged(_ string, state types.InterfaceState) {
 	if state.Online {
 		networkLogger.Info().Msg("network state changed to online, triggering time sync")
 		triggerTimeSyncOnNetworkStateChange()
+
+		if publicIPState != nil {
+			publicIPState.SetIPv4AndIPv6(state.IPv4Ready, state.IPv6Ready)
+		}
+	} else {
+		if publicIPState != nil {
+			publicIPState.SetIPv4AndIPv6(false, false)
+		}
 	}
 
 	// always restart mDNS when the network state changes
@@ -164,6 +178,40 @@ func initNetwork() error {
 	return nil
 }
 
+func initPublicIPState() {
+	// the feature will be only enabled if the cloud has been adopted
+	// due to privacy reasons
+
+	// but it will be initialized anyway to avoid nil pointer dereferences
+	ps := myip.NewPublicIPState(&myip.PublicIPStateConfig{
+		Logger:             networkLogger,
+		CloudflareEndpoint: config.CloudURL,
+		APIEndpoint:        "",
+		IPv4:               false,
+		IPv6:               false,
+		HttpClientGetter: func(family int) *http.Client {
+			transport := http.DefaultTransport.(*http.Transport).Clone()
+			transport.Proxy = config.NetworkConfig.GetTransportProxyFunc()
+			transport.DialContext = func(ctx context.Context, network, addr string) (net.Conn, error) {
+				netType := network
+				switch family {
+				case link.AfInet:
+					netType = "tcp4"
+				case link.AfInet6:
+					netType = "tcp6"
+				}
+				return (&net.Dialer{}).DialContext(ctx, netType, addr)
+			}
+
+			return &http.Client{
+				Transport: transport,
+				Timeout:   30 * time.Second,
+			}
+		},
+	})
+	publicIPState = ps
+}
+
 func setHostname(nm *nmlite.NetworkManager, hostname, domain string) error {
 	if nm == nil {
 		return nil
@@ -312,3 +360,25 @@ func rpcToggleDHCPClient() error {
 
 	return rpcReboot(true)
 }
+
+func rpcGetPublicIPAddresses(refresh bool) ([]myip.PublicIP, error) {
+	if publicIPState == nil {
+		return nil, fmt.Errorf("public IP state not initialized")
+	}
+
+	if refresh {
+		if err := publicIPState.ForceUpdate(); err != nil {
+			return nil, err
+		}
+	}
+
+	return publicIPState.GetAddresses(), nil
+}
+
+func rpcCheckPublicIPAddresses() error {
+	if publicIPState == nil {
+		return fmt.Errorf("public IP state not initialized")
+	}
+
+	return publicIPState.ForceUpdate()
+}

pkg/myip/check.go

@@ -0,0 +1,142 @@
+package myip
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"net"
+	"net/http"
+	"net/url"
+	"strings"
+	"sync"
+	"time"
+
+	"github.com/jetkvm/kvm/pkg/nmlite/link"
+)
+
+func (ps *PublicIPState) request(ctx context.Context, url string, family int) ([]byte, error) {
+	client := ps.httpClient(family)
+
+	req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
+	if err != nil {
+		return nil, fmt.Errorf("error creating request: %w", err)
+	}
+
+	resp, err := client.Do(req)
+	if err != nil {
+		return nil, fmt.Errorf("error sending request: %w", err)
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, fmt.Errorf("error reading response body: %w", err)
+	}
+
+	return body, err
+}
+
+// checkCloudflare uses cdn-cgi/trace to get the public IP address
+func (ps *PublicIPState) checkCloudflare(ctx context.Context, family int) (*PublicIP, error) {
+	u, err := url.JoinPath(ps.cloudflareEndpoint, "/cdn-cgi/trace")
+	if err != nil {
+		return nil, fmt.Errorf("error joining path: %w", err)
+	}
+
+	body, err := ps.request(ctx, u, family)
+	if err != nil {
+		return nil, err
+	}
+
+	for line := range strings.SplitSeq(string(body), "\n") {
+		key, value, ok := strings.Cut(line, "=")
+		if !ok || key != "ip" {
+			continue
+		}
+
+		return &PublicIP{
+			IPAddress:   net.ParseIP(value),
+			LastUpdated: time.Now(),
+		}, nil
+	}
+
+	return nil, fmt.Errorf("no IP address found")
+}
+
+// checkAPI uses the API endpoint to get the public IP address
+func (ps *PublicIPState) checkAPI(_ context.Context, _ int) (*PublicIP, error) {
+	return nil, fmt.Errorf("not implemented")
+}
+
+// checkIPs checks both IPv4 and IPv6 public IP addresses in parallel
+// and updates the IPAddresses slice with the results
+func (ps *PublicIPState) checkIPs(ctx context.Context, checkIPv4, checkIPv6 bool) error {
+	var wg sync.WaitGroup
+	var mu sync.Mutex
+	var ips []PublicIP
+	var errors []error
+
+	checkFamily := func(family int, familyName string) {
+		wg.Add(1)
+		go func(f int, name string) {
+			defer wg.Done()
+
+			ip, err := ps.checkIPForFamily(ctx, f)
+			mu.Lock()
+			defer mu.Unlock()
+			if err != nil {
+				errors = append(errors, fmt.Errorf("%s check failed: %w", name, err))
+				return
+			}
+			if ip != nil {
+				ips = append(ips, *ip)
+			}
+		}(family, familyName)
+	}
+
+	if checkIPv4 {
+		checkFamily(link.AfInet, "IPv4")
+	}
+
+	if checkIPv6 {
+		checkFamily(link.AfInet6, "IPv6")
+	}
+
+	wg.Wait()
+
+	if len(ips) > 0 {
+		ps.mu.Lock()
+		defer ps.mu.Unlock()
+
+		ps.addresses = ips
+		ps.lastUpdated = time.Now()
+	}
+
+	if len(errors) > 0 && len(ips) == 0 {
+		return errors[0]
+	}
+
+	return nil
+}
+
+func (ps *PublicIPState) checkIPForFamily(ctx context.Context, family int) (*PublicIP, error) {
+	if ps.apiEndpoint != "" {
+		ip, err := ps.checkAPI(ctx, family)
+		if err == nil && ip != nil {
+			return ip, nil
+		}
+	}
+
+	if ps.cloudflareEndpoint != "" {
+		ip, err := ps.checkCloudflare(ctx, family)
+		if err == nil && ip != nil {
+			return ip, nil
+		}
+	}
+
+	return nil, fmt.Errorf("all IP check methods failed for family %d", family)
+}

pkg/myip/ip.go

@@ -0,0 +1,212 @@
+package myip
+
+import (
+	"context"
+	"fmt"
+	"net"
+	"net/http"
+	"net/url"
+	"sync"
+	"time"
+
+	"github.com/jetkvm/kvm/internal/logging"
+	"github.com/rs/zerolog"
+)
+
+type PublicIP struct {
+	IPAddress   net.IP    `json:"ip"`
+	LastUpdated time.Time `json:"last_updated"`
+}
+
+type HttpClientGetter func(family int) *http.Client
+
+type PublicIPState struct {
+	addresses   []PublicIP
+	lastUpdated time.Time
+
+	cloudflareEndpoint string // cdn-cgi/trace domain
+	apiEndpoint        string // api endpoint
+	ipv4               bool
+	ipv6               bool
+	httpClient         HttpClientGetter
+	logger             *zerolog.Logger
+
+	timer  *time.Timer
+	ctx    context.Context
+	cancel context.CancelFunc
+	mu     sync.Mutex
+}
+
+type PublicIPStateConfig struct {
+	CloudflareEndpoint string
+	APIEndpoint        string
+	IPv4               bool
+	IPv6               bool
+	HttpClientGetter   HttpClientGetter
+	Logger             *zerolog.Logger
+}
+
+func stripURLPath(s string) string {
+	parsed, err := url.Parse(s)
+	if err != nil {
+		return ""
+	}
+	scheme := parsed.Scheme
+	if scheme != "http" && scheme != "https" {
+		scheme = "https"
+	}
+
+	return fmt.Sprintf("%s://%s", scheme, parsed.Host)
+}
+
+// NewPublicIPState creates a new PublicIPState
+func NewPublicIPState(config *PublicIPStateConfig) *PublicIPState {
+	if config.Logger == nil {
+		config.Logger = logging.GetSubsystemLogger("publicip")
+	}
+
+	ctx, cancel := context.WithCancel(context.Background())
+	ps := &PublicIPState{
+		addresses:          make([]PublicIP, 0),
+		lastUpdated:        time.Now(),
+		cloudflareEndpoint: stripURLPath(config.CloudflareEndpoint),
+		apiEndpoint:        config.APIEndpoint,
+		ipv4:               config.IPv4,
+		ipv6:               config.IPv6,
+		httpClient:         config.HttpClientGetter,
+		ctx:                ctx,
+		cancel:             cancel,
+		logger:             config.Logger,
+	}
+	// Start the timer automatically
+	ps.Start()
+	return ps
+}
+
+// SetFamily sets if we need to track IPv4 and IPv6 public IP addresses
+func (ps *PublicIPState) SetIPv4AndIPv6(ipv4, ipv6 bool) {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	ps.ipv4 = ipv4
+	ps.ipv6 = ipv6
+}
+
+// SetIPv4 sets if we need to track IPv4 public IP addresses
+func (ps *PublicIPState) SetIPv4(ipv4 bool) {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	ps.ipv4 = ipv4
+}
+
+// SetIPv6 sets if we need to track IPv6 public IP addresses
+func (ps *PublicIPState) SetIPv6(ipv6 bool) {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	ps.ipv6 = ipv6
+}
+
+// SetCloudflareEndpoint sets the Cloudflare endpoint
+func (ps *PublicIPState) SetCloudflareEndpoint(endpoint string) {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	ps.cloudflareEndpoint = stripURLPath(endpoint)
+}
+
+// SetAPIEndpoint sets the API endpoint
+func (ps *PublicIPState) SetAPIEndpoint(endpoint string) {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	ps.apiEndpoint = endpoint
+}
+
+// GetAddresses returns the public IP addresses
+func (ps *PublicIPState) GetAddresses() []PublicIP {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	return ps.addresses
+}
+
+// Start starts the timer loop to check public IP addresses periodically
+func (ps *PublicIPState) Start() {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	// Stop any existing timer
+	if ps.timer != nil {
+		ps.timer.Stop()
+	}
+
+	if ps.cancel != nil {
+		ps.cancel()
+	}
+
+	// Create new context and cancel function
+	ps.ctx, ps.cancel = context.WithCancel(context.Background())
+
+	// Start the timer loop in a goroutine
+	go ps.timerLoop(ps.ctx)
+}
+
+// Stop stops the timer loop
+func (ps *PublicIPState) Stop() {
+	ps.mu.Lock()
+	defer ps.mu.Unlock()
+
+	if ps.cancel != nil {
+		ps.cancel()
+		ps.cancel = nil
+	}
+
+	if ps.timer != nil {
+		ps.timer.Stop()
+		ps.timer = nil
+	}
+}
+
+// ForceUpdate forces an update of the public IP addresses
+func (ps *PublicIPState) ForceUpdate() error {
+	return ps.checkIPs(context.Background(), true, true)
+}
+
+// timerLoop runs the periodic IP check loop
+func (ps *PublicIPState) timerLoop(ctx context.Context) {
+	timer := time.NewTimer(5 * time.Minute)
+	defer timer.Stop()
+
+	// Store timer reference for Stop() to access
+	ps.mu.Lock()
+	ps.timer = timer
+	checkIPv4 := ps.ipv4
+	checkIPv6 := ps.ipv6
+	ps.mu.Unlock()
+
+	// Perform initial check immediately
+	checkIPs := func() {
+		if err := ps.checkIPs(ctx, checkIPv4, checkIPv6); err != nil {
+			ps.logger.Error().Err(err).Msg("failed to check public IP addresses")
+		}
+	}
+
+	checkIPs()
+
+	for {
+		select {
+		case <-timer.C:
+			// Perform the check
+			checkIPs()
+
+			// Reset the timer for the next check
+			timer.Reset(5 * time.Minute)
+
+		case <-ctx.Done():
+			// Timer was stopped
+			return
+		}
+	}
+}

ui/localization/messages/en.json

@@ -897,5 +897,11 @@
     "wake_on_lan_invalid_mac": "Invalid MAC address",
     "wake_on_lan_magic_sent_success": "Magic Packet sent successfully",
     "welcome_to_jetkvm": "Welcome to JetKVM",
-    "welcome_to_jetkvm_description": "Control any computer remotely"
+    "welcome_to_jetkvm_description": "Control any computer remotely","connection_stats_remote_ip_address": "Remote IP Address",
+    "connection_stats_remote_ip_address_description": "The IP address of the remote device.",
+    "connection_stats_remote_ip_address_copy_error": "Failed to copy remote IP address",
+    "connection_stats_remote_ip_address_copy_success": "Remote IP address { ip } copied to clipboard",
+    "public_ip_card_header": "Public IP addresses",
+    "public_ip_card_refresh": "Refresh",
+    "public_ip_card_refresh_error": "Failed to refresh public IP addresses: {error}"
 }

ui/src/components/PublicIPCard.tsx

@@ -0,0 +1,86 @@
+import { LuRefreshCcw } from "react-icons/lu";
+import { useCallback, useEffect, useState } from "react";
+
+import { Button } from "@components/Button";
+import { GridCard } from "@components/Card";
+import { PublicIP } from "@hooks/stores";
+import { m } from "@localizations/messages.js";
+import { JsonRpcResponse, useJsonRpc } from "@hooks/useJsonRpc";
+import notifications from "@/notifications";
+
+
+export default function PublicIPCard() {
+  const { send } = useJsonRpc();
+
+  const [publicIPs, setPublicIPs] = useState<PublicIP[]>([]);
+  const refreshPublicIPs = useCallback(() => {
+    send("getPublicIPAddresses", { refresh: true }, (resp: JsonRpcResponse) => {
+      setPublicIPs([]);
+      if ("error" in resp) {
+        notifications.error(m.public_ip_card_refresh_error({ error: resp.error.data || m.unknown_error() }));
+        return;
+      }
+      const publicIPs = resp.result as PublicIP[];
+      setPublicIPs(publicIPs.sort(({ ip: aIp }, { ip: bIp }) => {
+        const aIsIPv6 = aIp.includes(":");
+        const bIsIPv6 = bIp.includes(":");
+        if (aIsIPv6 && !bIsIPv6) return 1;
+        if (!aIsIPv6 && bIsIPv6) return -1;
+        return aIp.localeCompare(bIp);
+      }));
+    });
+  }, [send, setPublicIPs]);
+
+  useEffect(() => {
+    refreshPublicIPs();
+  }, [refreshPublicIPs]);
+
+  return (
+    <GridCard>
+      <div className="animate-fadeIn p-4 text-black opacity-0 animation-duration-500 dark:text-white">
+        <div className="space-y-3">
+          <div className="flex items-center justify-between">
+            <h3 className="text-base font-bold text-slate-900 dark:text-white">
+              {m.public_ip_card_header()}
+            </h3>
+
+            <div>
+              <Button
+                size="XS"
+                theme="light"
+                type="button"
+                className="text-red-500"
+                text={m.public_ip_card_refresh()}
+                LeadingIcon={LuRefreshCcw}
+                onClick={refreshPublicIPs}
+              />
+            </div>
+          </div>
+          {publicIPs.length === 0 ? (
+            <div>
+              <div className="space-y-4">
+                <div className="animate-pulse space-y-2">
+                  <div className="h-4 w-1/4 rounded bg-slate-200 dark:bg-slate-700" />
+                  <div className="h-4 w-1/3 rounded bg-slate-200 dark:bg-slate-700" />
+                  <div className="h-4 w-1/2 rounded bg-slate-200 dark:bg-slate-700" />
+                </div>
+              </div>
+            </div>
+          ) : (
+            <div className="flex gap-x-6 gap-y-2">
+              <div className="flex-1 space-y-2">
+                {publicIPs?.map(ip => (
+                  <div key={ip.ip} className="flex justify-between border-slate-800/10 pt-2 dark:border-slate-300/20">
+                    <span className="text-sm font-medium">
+                      {ip.ip}
+                    </span>
+                  </div>
+                ))}
+              </div>
+            </div>
+          )}
+        </div>
+      </div>
+    </GridCard>
+  );
+}

ui/src/components/sidebar/connectionStats.tsx

@@ -1,4 +1,6 @@
 import { useInterval } from "usehooks-ts";
+import { LuCopy } from "react-icons/lu";
+import { useState } from "react";
 
 import { m } from "@localizations/messages.js";
 import { useRTCStore, useUiStore } from "@hooks/stores";
@@ -6,6 +8,10 @@ import { createChartArray, Metric } from "@components/Metric";
 import { SettingsSectionHeader } from "@components/SettingsSectionHeader";
 import SidebarHeader from "@components/SidebarHeader";
 import { someIterable } from "@/utils";
+import { GridCard } from "@components/Card";
+import { Button } from "@components/Button";
+import { useCopyToClipboard } from "@components/useCopyToClipBoard";
+import notifications from "@/notifications";
 
 export default function ConnectionStatsSidebar() {
   const { sidebarView, setSidebarView } = useUiStore();
@@ -21,6 +27,8 @@ export default function ConnectionStatsSidebar() {
     appendDiskDataChannelStats,
   } = useRTCStore();
 
+  const [remoteIPAddress, setRemoteIPAddress] = useState<string | null>(null);
+
   useInterval(function collectWebRTCStats() {
     (async () => {
       if (!mediaStream) return;
@@ -49,6 +57,7 @@ export default function ConnectionStatsSidebar() {
         } else if (report.type === "remote-candidate") {
           if (successfulRemoteCandidateId === report.id) {
             appendRemoteCandidateStats(report);
+            setRemoteIPAddress(report.address);
           }
         } else if (report.type === "data-channel" && report.label === "disk") {
           appendDiskDataChannelStats(report);
@@ -93,6 +102,8 @@ export default function ConnectionStatsSidebar() {
     return { date: d.date, metric: valueMs };
   });
 
+  const { copy } = useCopyToClipboard();
+
   return (
     <div className="grid h-full grid-rows-(--grid-headerBody) shadow-xs">
       <SidebarHeader title={m.connection_stats_sidebar()} setSidebarView={setSidebarView} />
@@ -106,6 +117,27 @@ export default function ConnectionStatsSidebar() {
                   title={m.connection_stats_connection()}
                   description={m.connection_stats_connection_description()}
                 />
+                {remoteIPAddress && (
+                  <div className="flex items-center justify-between">
+                    <div className="text-sm text-slate-600 dark:text-slate-400">
+                      {m.connection_stats_remote_ip_address()}
+                    </div>
+                    <div className="flex items-center">
+                      <GridCard cardClassName="rounded-r-none">
+                        <div className="h-[34px] flex items-center text-xs select-all text-black font-mono dark:text-white px-3 ">
+                          {remoteIPAddress}
+                        </div>
+                      </GridCard>
+                      <Button className="rounded-l-none border-l-slate-800/30 dark:border-slate-300/20" size="SM" type="button" theme="light" LeadingIcon={LuCopy} onClick={async () => {
+                        if (await copy(remoteIPAddress)) {
+                          notifications.success((m.connection_stats_remote_ip_address_copy_success({ ip: remoteIPAddress })));
+                        } else {
+                          notifications.error(m.connection_stats_remote_ip_address_copy_error());
+                        }
+                      }} />
+                    </div>
+                  </div>
+                )}
                 <Metric
                   title={m.connection_stats_round_trip_time()}
                   description={m.connection_stats_round_trip_time_description()}

ui/src/hooks/stores.ts

@@ -752,6 +752,11 @@ export interface IPv6Address {
   flag_tentative?: boolean;
 }
 
+export interface PublicIP {
+  ip: string;
+  last_updated: Date;
+}
+
 export interface NetworkState {
   interface_name?: string;
   mac_address?: string;

ui/src/routes/devices.$id.settings.network.tsx

@@ -6,6 +6,7 @@ import dayjs from "dayjs";
 import relativeTime from "dayjs/plugin/relativeTime";
 import validator from "validator";
 
+import PublicIPCard from "@components/PublicIPCard";
 import { NetworkSettings, NetworkState, useNetworkStateStore, useRTCStore } from "@hooks/stores";
 import { useJsonRpc } from "@hooks/useJsonRpc";
 import AutoHeight from "@components/AutoHeight";
@@ -460,6 +461,8 @@ export default function SettingsNetworkRoute() {
                 />
               </SettingsItem>
 
+              <PublicIPCard />
+
               <div>
                 <AutoHeight>
                   {formState.isLoading ? (
@@ -540,7 +543,7 @@ export default function SettingsNetworkRoute() {
                 </AutoHeight>
               </div>
 
-              { isLLDPAvailable &&
+              {isLLDPAvailable &&
                 (
                   <div className="hidden space-y-4">
                     <SettingsItem