feat: allow the user to display DroidGround's IP address in the UI

Author: thelicato

.env.sample

@@ -23,4 +23,5 @@ DROIDGROUND_TERMINAL_DISABLED=false # Feature enabled by default if not set othe
 DROIDGROUND_RESET_DISABLED=false # Feature enabled by default if not set otherwise
 DROIDGROUND_EXPLOIT_APP_DURATION=10 # The time (in seconds) the exploit app will be active before the target app is restarted. This field makes sense only if the App Manager is enabled. Default value is 10
 DROIDGROUND_NUM_TEAMS=0 # Number of teams playing, this enables the usage of team-based tokens/keys to lock down the usage of installed apps and log servers
-DROIDGROUND_TEAM_TOKEN_1=RANDOMSTRING # Token for team #1, this only makes sense if DROIDGROUND_NUM_TEAMS is higher than 0. If a team token is not explicitly defined it'll be randomly generated on boot and present in the output logs
+DROIDGROUND_TEAM_TOKEN_1=RANDOMSTRING # Token for team #1, this only makes sense if DROIDGROUND_NUM_TEAMS is higher than 0. If a team token is not explicitly defined it'll be randomly generated on boot and present in the output logs
+DROIDGROUND_IP_IFACE=eth0 # If this is set the UI will display the IP address associated with it. Useful to provide to the users the IP of the exploit server if dynamic. Empty by default

src/client/views/ExploitServer.tsx

@@ -57,9 +57,16 @@ export const ExploitServer: React.FC = () => {
 
   return (
     <div className="w-full flex flex-col gap-2">
-      <div className="flex gap-2 items-center mb-2">
-        <BiSolidServer size={32} />
-        <h1 className="text-2xl font-semibold select-none">Exploit Server</h1>
+      <div className="flex items-center justify-between mb-2">
+        <div className="flex items-center gap-2">
+          <BiSolidServer size={32} />
+          <h1 className="text-2xl font-semibold select-none">Exploit Server</h1>
+        </div>
+        {featuresConfig.ipAddress.length > 0 && (
+          <span className="indicator-item badge badge-primary">
+            <b>IP Address:</b> <code>{featuresConfig.ipAddress}</code>
+          </span>
+        )}
       </div>
       <div className="card bg-base-300 border border-base-300">
         <div className="card-body p-4">

src/server/manager.ts

@@ -15,7 +15,7 @@ import { AppStatus, WebsocketClient } from "@server/utils/types";
 import { setupFrida } from "@server/utils/frida";
 import { setupScrcpy } from "@server/utils/scrcpy";
 import { AdbScrcpyClient } from "@yume-chan/adb-scrcpy";
-import { safeFileExists } from "@server/utils/helpers";
+import { getIP, safeFileExists } from "@server/utils/helpers";
 
 export class ManagerSingleton {
   private static instance: ManagerSingleton;
@@ -45,6 +45,9 @@ export class ManagerSingleton {
     // private constructor prevents direct instantiation
     const port: any = process.env.DROIDGROUND_ADB_PORT ?? "";
     const exploitAppDuration: any = process.env.DROIDGROUND_EXPLOIT_APP_DURATION ?? "";
+    // Check if IP address should be displayed
+    const iface = process.env.DROIDGROUND_IP_IFACE ?? "";
+    const ipAddress = getIP(iface); // Either an empty string or the IP address
     // Check team-mode
     const teamNumEnv: any = process.env.DROIDGROUND_NUM_TEAMS ?? "";
     const teamNum = isNaN(teamNumEnv) || teamNumEnv.trim().length === 0 ? 0 : teamNumEnv;
@@ -74,6 +77,7 @@ export class ManagerSingleton {
         fridaType: process.env.DROIDGROUND_FRIDA_TYPE === "full" ? "full" : "jail",
         exploitAppDuration:
           isNaN(exploitAppDuration) || exploitAppDuration.trim().length === 0 ? 10 : parseInt(exploitAppDuration),
+        ipAddress: ipAddress,
       },
       teams: teams,
       debugToken: crypto.randomBytes(64).toString("hex"),

src/server/utils/helpers.ts

@@ -1,5 +1,6 @@
 // Package imports
 import * as fs from "fs";
+import { NetworkInterfaceInfo, networkInterfaces } from "os";
 import { LsEntry } from "@server/utils/types";
 import { fileURLToPath } from "url";
 import path, { dirname } from "path";
@@ -164,3 +165,21 @@ export const buildExtra = (extra: IntentExtra): string[] => {
 export const shellEscape = (value: string): string => {
   return `'${value.replace(/'/g, `'\\''`)}'`;
 };
+
+export const getIP = (name: string) => {
+  // Return an empty string by default
+  let ipAddress = "";
+
+  const interfaces = networkInterfaces();
+  if (!Object.keys(interfaces).includes(name)) {
+    return ipAddress;
+  }
+
+  const iface = (interfaces[name] as NetworkInterfaceInfo[]).find(i => i.family === "IPv4");
+
+  if (!iface || iface.internal) {
+    return ipAddress;
+  }
+
+  return iface.address;
+};

src/shared/types.ts

@@ -18,6 +18,7 @@ export interface DroidGroundFeatures {
   teamModeEnabled: boolean;
   fridaType: "full" | "jail";
   exploitAppDuration: number;
+  ipAddress: string;
 }
 
 export interface DroidGroundTeam {