rework configure-interfaces.py to system-quickstart.py

mmguero · mmguero · commit 2dfd84671d0a · 2025-11-18T15:14:39.000Z
diff --git a/docs/malcolm-hedgehog-e2e-iso-install.md b/docs/malcolm-hedgehog-e2e-iso-install.md
@@ -171,7 +171,7 @@ Alternatively, to configure a network interface with a static IP address (recomm
 
 ### <a name="MalcolmTimeSync"></a> Configure Hostname and Time Sync
 
-If users wish to change Malcolm's hostname or configure system time synchronization, they can open a terminal (the icon immediately to the right of the **Applications** menu icon at the top of the Malcolm desktop) and run `configure-interfaces` then enter the user (if the user is part of the `sudo` group) or `root` password.
+If users wish to change Malcolm's hostname or configure system time synchronization, they can open a terminal (the icon immediately to the right of the **Applications** menu icon at the top of the Malcolm desktop) and run `system-quickstart` then enter the user (if the user is part of the `sudo` group) or `root` password.
 
 Here users can configure Malcolm to keep its time synchronized with either an NTP server (using the NTP protocol), another [Malcolm]({{ site.github.repository_url }}) aggregator or another HTTP/HTTPS server. On the next dialog, choose the time synchronization method to configure.
 
@@ -614,7 +614,7 @@ The panel bordering the top of the Malcolm desktop is home to a number of useful
 
 ## <a name="HedgehogInterfaces"></a> Configure Hostname, Interfaces and Time Sync
 
-The first step of sensor configuration is to configure the network interfaces and sensor hostname. Clicking the **Configure Interfaces and Hostname** toolbar icon (or running `configure-interfaces` at a command line prompt) will prompt for the root password created during installation, after which the configuration welcome screen is shown. Select **Continue** to proceed.
+The first step of sensor configuration is to configure the network interfaces and sensor hostname. Clicking the **Configure Interfaces and Hostname** toolbar icon (or running `system-quickstart` at a command line prompt) will prompt for the root password created during installation, after which the configuration welcome screen is shown. Select **Continue** to proceed.
 
 Users may next select whether to configure the network interfaces, hostname, or time synchronization.
 
diff --git a/docs/time-sync.md b/docs/time-sync.md
@@ -1,6 +1,6 @@
 # <a name="ConfigTime"></a>Time synchronization
 
-If you wish to set up time synchronization via [NTP](http://www.ntp.org/) or `htpdate`, open a terminal and run `sudo configure-interfaces.py`. Select **Continue**, then choose **Time Sync**. Here you can configure the operating system to keep its time synchronized with either an NTP server (using the NTP protocol), another Malcolm instance, or another HTTP/HTTPS server. On the next dialog, choose the time synchronization method you wish to configure.
+If you wish to set up time synchronization via [NTP](http://www.ntp.org/) or `htpdate`, open a terminal and run `system-quickstart`. Select **Continue**, then choose **Time Sync**. Here you can configure the operating system to keep its time synchronized with either an NTP server (using the NTP protocol), another Malcolm instance, or another HTTP/HTTPS server. On the next dialog, choose the time synchronization method you wish to configure.
 
 If **htpdate** is selected, you will be prompted to enter the IP address or hostname and port of an HTTP/HTTPS server (for a Malcolm instance, port `9200` may be used) and the time synchronization check frequency in minutes. A test connection will be made to determine if the time can be retrieved from the server.
 
diff --git a/hedgehog-iso/config/hooks/normal/0910-sensor-build.hook.chroot b/hedgehog-iso/config/hooks/normal/0910-sensor-build.hook.chroot
@@ -134,7 +134,6 @@ if [[ ! "${ARCH,,}" =~ ^arm ]]; then
 !/root(/|$)
 !/run(/|$)
 !/tmp(/|$)
-!/usr/local/lib/python.*/dist-packages/debinterface(/|$)
 !/var/backups(/|$)
 !/var/cache(/|$)
 !/var/lib/AccountsService(/|$)
diff --git a/hedgehog-iso/config/includes.chroot/etc/bash.bash_aliases b/hedgehog-iso/config/includes.chroot/etc/bash.bash_aliases
@@ -1,7 +1,7 @@
 # some more ls aliases
 
 # sensor
-alias configure-interfaces="su -l -c /usr/local/bin/configure-interfaces.py"
+alias system-quickstart="su -l -c /usr/local/bin/system-quickstart.py"
 alias configure-capture="/usr/local/bin/configure-capture.py"
 
 #safety
diff --git a/hedgehog-iso/config/includes.chroot/etc/skel/.config/xfce4/panel/launcher-21/16346760027.desktop b/hedgehog-iso/config/includes.chroot/etc/skel/.config/xfce4/panel/launcher-21/16346760027.desktop
@@ -1,11 +1,11 @@
 [Desktop Entry]
 Version=1.0
-Name=Configure Interfaces and Hostname
-Exec=/usr/bin/tilix --maximize -t "Configure Interfaces and Hostname" -e su -l -c /usr/local/bin/configure-interfaces.py
+Name=System Quickstart
+Exec=/usr/bin/tilix --maximize -t "System Quickstart" -e su -l -c /usr/local/bin/system-quickstart.py
 Terminal=false
 X-MultipleArgs=false
 Type=Application
 Icon=network-wired
 Categories=Network;
 StartupNotify=true
-X-XFCE-Source=file:///usr/share/applications/configure-interfaces.desktop
+X-XFCE-Source=file:///usr/share/applications/system-quickstart.desktop
diff --git a/hedgehog-iso/config/includes.chroot/usr/share/applications/configure-interfaces.desktop b/hedgehog-iso/config/includes.chroot/usr/share/applications/configure-interfaces.desktop
diff --git a/hedgehog-iso/config/includes.chroot/usr/share/applications/system-quickstart.desktop b/hedgehog-iso/config/includes.chroot/usr/share/applications/system-quickstart.desktop
@@ -0,0 +1,10 @@
+[Desktop Entry]
+Version=1.0
+Name=System Quickstart
+Exec=/usr/bin/tilix --maximize -t "System Quickstart" -e su -l -c /usr/local/bin/system-quickstart.py
+Terminal=false
+X-MultipleArgs=false
+Type=Application
+Icon=network-wired
+Categories=Network;
+StartupNotify=true
diff --git a/hedgehog-iso/config/requirements.txt b/hedgehog-iso/config/requirements.txt
@@ -1,6 +1,5 @@
 clamd==1.0.2
 dateparser==1.2.2
-debinterface==3.5.0
 dominate==2.9.1
 git+https://github.com/mmguero-dev/mandiant-ti-client
 git+https://github.com/mmguero-dev/python-humanfriendly.git
diff --git a/malcolm-iso/config/hooks/normal/0910-agg-build.hook.chroot b/malcolm-iso/config/hooks/normal/0910-agg-build.hook.chroot
@@ -52,7 +52,6 @@ cat << 'EOF' >> /etc/aide/aide.conf.d/00_local_excludes
 !/root(/|$)
 !/run(/|$)
 !/tmp(/|$)
-!/usr/local/lib/python.*/dist-packages/debinterface(/|$)
 !/var/backups(/|$)
 !/var/cache(/|$)
 !/var/lib/AccountsService(/|$)
diff --git a/malcolm-iso/config/includes.chroot/etc/bash.bash_functions b/malcolm-iso/config/includes.chroot/etc/bash.bash_functions
@@ -533,11 +533,11 @@ function dregls () {
 ########################################################################
 # malcolm-specific
 ########################################################################
-configure-interfaces() {
+system-quickstart() {
   if groups | grep -q '\bsudo\b'; then
-    sudo /usr/local/bin/configure-interfaces.py
+    sudo /usr/local/bin/system-quickstart.py
   else
-    su -l -c /usr/local/bin/configure-interfaces.py
+    su -l -c /usr/local/bin/system-quickstart.py
   fi
 }
 
diff --git a/malcolm-iso/config/requirements.txt b/malcolm-iso/config/requirements.txt
@@ -1,4 +1,3 @@
-debinterface==3.5.0
 kubernetes==34.1.0
 python-dotenv==1.2.1
 ruamel.yaml==0.18.16
diff --git a/scripts/malcolm_utils.py b/scripts/malcolm_utils.py
@@ -26,6 +26,7 @@
 import types
 
 from base64 import b64encode, b64decode, binascii
+from dataclasses import dataclass
 from datetime import datetime
 from multiprocessing import RawValue
 from shutil import move as sh_move, which as sh_which, copyfile as sh_copyfile
@@ -273,6 +274,57 @@ def check_socket(host, port):
             return False
 
 
+###################################################################################################
+# determine a list of available (non-virtual) adapters (Iface's)
+@dataclass
+class NetworkInterface:
+    name: str = ''
+    description: str = ''
+
+
+def get_available_adapters():
+    available_adapters = []
+    _, all_iface_list = run_subprocess("find /sys/class/net/ -mindepth 1 -maxdepth 1 -type l -printf '%P %l\\n'")
+    available_iface_list = [x.split(" ", 1)[0] for x in all_iface_list if 'virtual' not in x]
+
+    # for each adapter, determine its MAC address and link speed
+    for adapter in available_iface_list:
+        mac_address = '??:??:??:??:??:??'
+        speed = '?'
+        try:
+            with open(f"/sys/class/net/{adapter}/address", 'r') as f:
+                mac_address = f.readline().strip()
+        except Exception:
+            pass
+        try:
+            with open(f"/sys/class/net/{adapter}/speed", 'r') as f:
+                speed = f.readline().strip()
+        except Exception:
+            pass
+        description = f"{mac_address} ({speed} Mbits/sec)"
+        iface = NetworkInterface(name=adapter, description=description)
+        available_adapters.append(iface)
+
+    return available_adapters
+
+
+###################################################################################################
+# identify the specified adapter using ethtool --identify
+def identify_adapter(adapter, duration=10, background=False):
+    if background:
+        subprocess.Popen(
+            ["/sbin/ethtool", "--identify", adapter, str(duration)],
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        return True
+    else:
+        retCode, _ = run_subprocess(
+            f"/sbin/ethtool --identify {adapter} {duration}", stdout=False, stderr=False, timeout=duration * 2
+        )
+        return retCode == 0
+
+
 ###################################################################################################
 def contains_whitespace(s):
     return True in [c in s for c in string.whitespace]
diff --git a/shared/bin/common-init.sh b/shared/bin/common-init.sh
@@ -94,7 +94,7 @@ function InitializeSensorNetworking() {
   unset NEED_NETWORKING_RESTART
 
   # /etc/network/interfaces.d/sensor will manage network interfaces, not /etc/network/interfaces
-  # interfaces are configured by the system admin via configure-interfaces.py.
+  # interfaces are configured by the system admin via system-quickstart.py.
   NET_IFACES_LINES=$(wc -l /etc/network/interfaces | awk '{print $1}')
   if [ $NET_IFACES_LINES -gt 4 ] ; then
     echo -e "source /etc/network/interfaces.d/*\n\nauto lo\niface lo inet loopback" > /etc/network/interfaces
diff --git a/shared/bin/configure-interfaces.py b/shared/bin/configure-interfaces.py
diff --git a/shared/bin/sensorcommon.py b/shared/bin/sensorcommon.py
diff --git a/shared/bin/system-quickstart.py b/shared/bin/system-quickstart.py
