From be246fee21fc74ea91adb64ae868ef834af28af6 Mon Sep 17 00:00:00 2001 From: Jonathan Flueren Date: Sun, 13 Aug 2023 22:12:47 +0200 Subject: [PATCH] README fixes --- README.md | 12 +++++++----- scanner/identities.yaml | 5 ----- website/identities.json | 2 +- 3 files changed, 8 insertions(+), 11 deletions(-) delete mode 100644 scanner/identities.yaml diff --git a/README.md b/README.md index 7004ae1..171a8d2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # CZI presence detector Tool to detect the presence of pre-defined devices by their WiFi MAC addresses. -## How it works -Sets the wifi adapter into monitor mode, then listens to surrounding packets listing all detected devices into `wifi_map.yaml`. Resets the wifi adapter to normal mode for uploading the results, filters the results by the mac addresses in `identities.yaml` and sends all matched identities to the front-end webhook server in `public`. This server stores the presence information locally and displays it with `public/index.php` with a timestamp of the last update. +## How scanning works +Sets the wifi adapter into monitor mode, then listens to surrounding packets listing all detected devices into `wifi_map.yaml`. Resets the wifi adapter to normal mode for uploading the results, filters the results by the mac addresses in `identities.yaml` and sends all matched identities to the front-end webhook server in `website`. This server stores the presence information locally and displays it with `website/index.php` with a timestamp of the last update. + +## What the website is capable of +Shows the last update of the `upload.py` routine. It also allows to add identities by their name and mac and to delete identities by their mac. The mac addresses are hashed server-side and then stored into the world-accessible `identities.json`. ## Set-up Dependencies: Python3, trackerjacker (pip3), php (front-end) Configs to change: -- wifi adapter in `scan.sh` - system-specific wifi commands in `scan.sh` +- identities URL in `upload.py` - webhook URL and secret in `upload.py` -- webhook secret in `public/update.php` -- mac-name-identities in `identities.yaml` \ No newline at end of file +- webhook secret in `public/update.php` \ No newline at end of file diff --git a/scanner/identities.yaml b/scanner/identities.yaml deleted file mode 100644 index 0ed435e..0000000 --- a/scanner/identities.yaml +++ /dev/null @@ -1,5 +0,0 @@ -identities: - - mac: 00:00:00:00:00:00 - name: Jon - - mac: ff:ff:ff:ff:ff:ff - name: BROADCAST \ No newline at end of file diff --git a/website/identities.json b/website/identities.json index d201437..b8134c7 100644 --- a/website/identities.json +++ b/website/identities.json @@ -1 +1 @@ -[{"name":"Jon","mac_hash":"38fbdde984330e50c02382e647c576b71f41cc5c45b193d4f3177e6ee8f22a78"},{"name":"BROADCAST","mac_hash":"ef85d972b07fccdd79085ddb4713cd487c3838e128a7c4d11092909675c2022d"}] \ No newline at end of file +[{"name":"Null","mac_hash":"38fbdde984330e50c02382e647c576b71f41cc5c45b193d4f3177e6ee8f22a78"},{"name":"BROADCAST","mac_hash":"ef85d972b07fccdd79085ddb4713cd487c3838e128a7c4d11092909675c2022d"}] \ No newline at end of file