ARPSCAN to plugin rewrite

front/plugins/arp_scan/script.py

@@ -1,48 +1,121 @@
 #!/usr/bin/env python
-# test script by running python script.py devices=test,dummy
 
 import os
 import pathlib
 import argparse
 import sys
+import re
+import subprocess
+from time import strftime
 
 sys.path.append("/home/pi/pialert/front/plugins")
 
-from plugin_helper import Plugin_Objects
+from plugin_helper import Plugin_Object, Plugin_Objects
 
 CUR_PATH = str(pathlib.Path(__file__).parent.resolve())
-LOG_FILE = os.path.join(CUR_PATH , 'script.log')
-RESULT_FILE = os.path.join(CUR_PATH , 'last_result.log')
-
+LOG_FILE = os.path.join(CUR_PATH, 'script.log')
+RESULT_FILE = os.path.join(CUR_PATH, 'last_result.log')
 
 
 def main():
-
-    # the script expects a parameter in the format of devices=device1,device2,...
+    # the script expects a parameter in the format of userSubnets=subnet1,subnet2,...
     parser = argparse.ArgumentParser(description='Import devices from settings')
-    parser.add_argument('devices',  action="store",  help="list of device names separated by ','")
+    parser.add_argument('userSubnets', nargs='+', help="list of subnets with options")
     values = parser.parse_args()
 
-    UNDIS_devices = Plugin_Objects( RESULT_FILE )
+    devices = Plugin_Objects(RESULT_FILE)
 
-    if values.devices:
-        for fake_dev in values.devices.split('=')[1].split(','):
-            UNDIS_devices.add_object(
-                primaryId=fake_dev,    # MAC (Device Name)
-                secondaryId="0.0.0.0", # IP Address (always 0.0.0.0)
-                watched1=fake_dev,     # Device Name
-                watched2="",
-                watched3="",
-                watched4="",
-                extra="",
-                foreignKey="")
+    subnets_list = []
 
-    UNDIS_devices.write_result_file()
+    if isinstance(values.userSubnets, list):
+        subnets_list = values.userSubnets
+    else:
+        subnets_list = [values.userSubnets]
+
+    unique_devices = execute_arpscan(subnets_list)
+
+    for device in unique_devices:
+        devices.add_object(
+            primaryId=device['mac'],  # MAC (Device Name)
+            secondaryId=device['ip'],  # IP Address            
+            watched1=device['ip'],    # Device Name
+            watched2=device.get('hw', ''),  # Vendor (assuming it's in the 'hw' field)
+            watched3=device.get('interface', ''),  # Add the interface             
+            watched4='',
+            extra='arp-scan', 
+            foreignKey="")
+
+    devices.write_result_file()
 
     return 0
 
+
+def execute_arpscan(userSubnets):
+        # output of possible multiple interfaces
+    arpscan_output = ""
+    devices_list = []
+
+    # scan each interface
+    
+    for interface in userSubnets :   
+
+        arpscan_output = execute_arpscan_on_interface (interface)        
+
+        print(arpscan_output)
+    
+        # Search IP + MAC + Vendor as regular expresion
+        re_ip = r'(?P<ip>((2[0-5]|1[0-9]|[0-9])?[0-9]\.){3}((2[0-5]|1[0-9]|[0-9])?[0-9]))'
+        re_mac = r'(?P<mac>([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2}))'
+        re_hw = r'(?P<hw>.*)'
+        re_pattern = re.compile (re_ip + '\s+' + re_mac + '\s' + re_hw)
+
+        devices_list_tmp = [
+            {**device.groupdict(), "interface": interface}
+            for device in re.finditer(re_pattern, arpscan_output)
+        ]
+
+        devices_list += devices_list_tmp
+
+    # mylog('debug', ['[ARP Scan] Found: Devices including duplicates ', len(devices_list) ]) 
+    
+    # Delete duplicate MAC
+    unique_mac = [] 
+    unique_devices = [] 
+
+    for device in devices_list :
+        if device['mac'] not in unique_mac: 
+            unique_mac.append(device['mac'])
+            unique_devices.append(device)    
+
+    # return list
+    # mylog('debug', ['[ARP Scan] Found: Devices without duplicates ', len(unique_devices)  ]) 
+
+    print("Devices List len:", len(devices_list))  # Add this line to print devices_list
+    print("Devices List:", devices_list)  # Add this line to print devices_list
+
+    return devices_list
+
+
+def execute_arpscan_on_interface(interface):
+    # Prepare command arguments
+    arpscan_args = ['sudo', 'arp-scan', '--ignoredups', '--retry=6'] + interface.split()
+
+    # Execute command
+    try:
+        # try running a subprocess safely
+        result = subprocess.check_output(arpscan_args, universal_newlines=True)
+    except subprocess.CalledProcessError as e:
+        # An error occurred, handle it
+        error_type = type(e).__name__  # Capture the error type
+        result = ""
+
+    return result
+
+
+
+
 #===============================================================================
 # BEGIN
 #===============================================================================
 if __name__ == '__main__':
-    main()
+    main()