Merge pull request #231 from zenzen666/plugin/net-pos

net-pos plugin: saves handshake wifi position and retrieve geo location when online

pwnagotchi/defaults.yml

@@ -29,6 +29,9 @@ main:
         commands:
           - 'tar czf /tmp/backup.tar.gz {files}'
           - 'scp /tmp/backup.tar.gz pwnagotchi@10.0.0.1:/home/pwnagotchi/backups/backup-$(date +%s).tar.gz'
+      net-pos:
+        enabled: false
+        api_key: 'test'
       gps:
         enabled: false
         speed: 19200

pwnagotchi/plugins/default/net-pos.py

@@ -0,0 +1,144 @@
+__author__ = 'zenzen san'
+__version__ = '1.0.0'
+__name__ = 'net-pos'
+__license__ = 'GPL3'
+__description__ = """Saves a json file with the access points with more signal
+                     whenever a handshake is captured.
+                     When internet is available the files are converted in geo locations
+                     using Mozilla LocationService """
+
+import logging
+import json
+import os
+import requests
+
+MOZILLA_API_URL = 'https://location.services.mozilla.com/v1/geolocate?key={api}'
+ALREADY_SAVED = None
+SKIP = None
+READY = False
+OPTIONS = {}
+
+
+def on_loaded():
+    global ALREADY_SAVED
+    global SKIP
+    global READY
+
+    SKIP = list()
+
+    if 'api_key' not in OPTIONS or ('api_key' in OPTIONS and OPTIONS['api_key'] is None):
+        logging.error("NET-POS: api_key isn't set. Can't use mozilla's api.")
+        return
+
+    try:
+        with open('/root/.net_pos_saved', 'r') as f:
+            ALREADY_SAVED = f.read().splitlines()
+    except OSError:
+        logging.warning('NET-POS: No net-pos-file found.')
+        ALREADY_SAVED = []
+
+    READY = True
+    logging.info("net-pos plugin loaded.")
+
+def _append_saved(path):
+    to_save = list()
+    if isinstance(path, str):
+        to_save.append(path)
+    elif isinstance(path, list):
+        to_save += path
+    else:
+        raise TypeError("Expected list or str, got %s" % type(path))
+
+    with open('/root/.net_pos_saved', 'a') as saved_file:
+        for x in to_save:
+            saved_file.write(x + "\n")
+
+def on_internet_available(agent):
+    global SKIP
+
+    if READY:
+        config = agent.config()
+        display = agent.view()
+        handshake_dir = config['bettercap']['handshakes']
+
+        all_files = os.listdir(handshake_dir)
+        all_np_files = [os.path.join(handshake_dir, filename)
+                     for filename in all_files
+                     if filename.endswith('.net-pos.json')]
+        new_np_files = set(all_np_files) - set(ALREADY_SAVED) - set(SKIP)
+
+        if new_np_files:
+            logging.info("NET-POS: Found {num} new net-pos files. Fetching positions ...", len(new_np_files))
+            display.set('status', f"Found {len(new_np_files)} new net-pos files. Fetching positions ...")
+            display.update(force=True)
+            for idx, np_file in enumerate(new_np_files):
+
+                geo_file = np_file.replace('.net-pos.json', '.geo.json')
+                if os.path.exists(geo_file):
+                    # got already the position
+                    ALREADY_SAVED.append(np_file)
+                    _append_saved(np_file)
+                    continue
+
+                try:
+                    geo_data = _get_geo_data(np_file) # returns json obj
+                except requests.exceptions.RequestException as req_e:
+                    logging.error("NET-POS: %s", req_e)
+                    SKIP += np_file
+                except json.JSONDecodeError as js_e:
+                    logging.error("NET-POS: %s", js_e)
+                    SKIP += np_file
+                except OSError as os_e:
+                    logging.error("NET-POS: %s", os_e)
+                    SKIP += np_file
+
+                with open(geo_file, 'w+t') as sf:
+                    json.dump(geo_data, sf)
+
+                ALREADY_SAVED.append(np_file)
+                _append_saved(np_file)
+
+                display.set('status', f"Fetching positions ({idx+1}/{len(new_np_files)})")
+                display.update(force=True)
+
+
+def on_handshake(agent, filename, access_point, client_station):
+    netpos = _get_netpos(agent)
+    netpos_filename = filename.replace('.pcap', '.net-pos.json')
+    logging.info("NET-POS: Saving net-location to %s", netpos_filename)
+
+    try:
+        with open(netpos_filename, 'w+t') as fp:
+            json.dump(netpos, fp)
+    except OSError as os_e:
+        logging.error("NET-POS: %s", os_e)
+
+
+def _get_netpos(agent):
+    aps = agent.get_access_points()
+    netpos = {}
+    netpos['wifiAccessPoints'] = list()
+    # 6 seems a good number to save a wifi networks location
+    for access_point in sorted(aps, key=lambda i: i['rssi'], reverse=True)[:6]:
+        netpos['wifiAccessPoints'].append({'macAddress': access_point['mac'],
+                                           'signalStrength': access_point['rssi']})
+    return netpos
+
+def _get_geo_data(path, timeout=30):
+    geourl = MOZILLA_API_URL.format(api=OPTIONS['api_key'])
+
+    try:
+        with open(path, "r") as json_file:
+            data = json.load(json_file)
+    except json.JSONDecodeError as js_e:
+        raise js_e
+    except OSError as os_e:
+        raise os_e
+
+    try:
+        result = requests.post(geourl,
+                json=data,
+                timeout=timeout)
+        return result.json()
+    except requests.exceptions.RequestException as req_e:
+        raise req_e