Dockerfile

@@ -1,29 +1,19 @@
-# ---- Base ----
-FROM alpine:3 AS base
+FROM node:16-alpine
 
 # Create app directory
 WORKDIR /usr/src/app
 
-# Copy project file
-COPY package.json .
-
-# Install required apk-packages
-RUN apk add --no-cache nodejs npm tcpdump
-
-
-# ---- Dependencies ----
-FROM base AS dependencies
-
 # Install app dependencies
-RUN npm install --only=production
+COPY package*.json ./
+RUN npm install
 
+# remove development dependencies
+RUN npm prune --production
 
-# ---- Release ----
-FROM base AS release
+# Install required apk-packages & delete cache
+RUN apk update && apk add tcpdump && rm -rf /var/cache/apk/*
 
-# copy from build image
-COPY --from=dependencies /usr/src/app/ ./
 # Bundle app source
 COPY ./src/ .
 
-CMD ["npm", "run", "start"]
+CMD ["npm", "run", "start"]

README.md

@@ -14,26 +14,24 @@ Table of contents
 =================
 <!-- TOC -->
 - [1. Description](#1-description)
-  - [1.1. What kind of data](#11-what-kind-of-data)
-  - [1.2. Data-Usage](#12-data-usage)
-  - [1.3. Tools used](#13-tools-used)
-  - [1.4. Architecture](#14-architecture)
+    - [1.1. What kind of data](#11-what-kind-of-data)
+    - [1.2. Data-Usage](#12-data-usage)
+    - [1.3. Tools used](#13-tools-used)
 - [2. Usage/Installation](#2-usageinstallation)
-  - [2.1. Prerequisites](#21-prerequisites)
-  - [2.2. Choosing an Export-Method](#22-choosing-an-export-method)
-  - [2.3. Running with Docker](#23-running-with-docker)
-  - [2.4. Environment-Variables](#24-environment-variables)
+    - [2.1. Prerequisites](#21-prerequisites)
+    - [2.2. Running with Docker](#22-running-with-docker)
+    - [2.3. Environment-Variables](#23-environment-variables)
 - [3. Data collected](#3-data-collected)
-  - [3.1. Data-Types](#31-data-types)
-  - [3.2. Metric-Overview](#32-metric-overview)
-  - [3.3. Metric-Details](#33-metric-details)
-  - [3.4. Tag-Overview](#34-tag-overview)
-  - [3.5. Tag-Details](#35-tag-details)
+    - [3.1. Data-Types](#31-data-types)
+    - [3.2. Metric-Overview](#32-metric-overview)
+    - [3.3. Metric-Details](#33-metric-details)
+    - [3.4. Tag-Overview](#34-tag-overview)
+    - [3.5. Tag-Details](#35-tag-details)
 - [4. Potential Issues](#4-potential-issues)
-  - [4.1. Channel/Frequency](#41-channelfrequency)
-  - [4.2. Technology](#42-technology)
-  - [4.3. Data protection](#43-data-protection)
-  - [4.4. Ethical](#44-ethical)
+    - [4.1. Channel/Frequency](#41-channelfrequency)
+    - [4.2. Technology](#42-technology)
+    - [4.3. Data protection](#43-data-protection)
+    - [4.4. Ethical](#44-ethical)
 <!-- /TOC -->
 <br>
 
@@ -82,14 +80,6 @@ e.g.
 The program uses `tcpdump` for listening in a subProcess and then extract the metadata when packets arrive.
 
 
-<br>
-
-## 1.4. Architecture
-
-![](docs/img/1.4.architecture.png)
-
-The system heavily uses NodeJS-Streams to read, transform and pass data around.
-
 <br>
 
 # 2. Usage/Installation
@@ -123,34 +113,18 @@ iw dev <interface> set channel <channelNumber>
 
 <br>
 
-## 2.2. Choosing an Export-Method
-
-The system allows exporting directly into [InfluxDB](https://docs.influxdata.com/influxdb) version >= 2.0 or into any system using the [InfluxDb-Line-Protocol](https://docs.influxdata.com/influxdb/v2.1/reference/syntax/line-protocol/) e.g. [QuestDB](https://questdb.io/) over TCP.
-
-As of writing (using InfluxDB v2.1 and using the *flux*-language), the data written by this system was a bit too much for InfluxDB and it struggled very quickly on a fairly beefy machine.
-
-Thats why the additional LineProtocol-Export-Method was added. Freedom of choice of the Time-Database.
-
-<br>
-
-If you want to use the InfluxDB-Line-Protocol, simply set the environment variable `USE_INFLUXDB_LINEPROTOCOL` to `true` along with the-other necessary Host and Port-variables.
-
-<br>
-
-## 2.3. Running with Docker
+## 2.2. Running with Docker
 
-### 2.3.1. Permissions
+### 2.2.1. Permissions
 
 The container must run as **root**, to have permission to listen on the wifi-interface.
 
 <br>
 
-### 2.3.2. docker run
+### 2.2.2. docker run
 
 Either run with docker directly.
 
-<details><summary>for InfluxDB</summary>
-
 ```sh
 docker run
   -d
@@ -160,35 +134,18 @@ docker run
   -e INFLUX_URL="http://influxdb:8086/"
   -e INFLUX_TOKEN="<yourToken>"
   -e INFLUX_ORG="<yourOrganisation>"
+  -e INFLUX_BUCKET="<yourBucket>"
   ruakij/rfmon-to-influx:2
 ```
-</details>
-
-<details><summary>for InfluxDB-Line-Protocol</summary>
-
-```sh
-docker run
-  -d
-  --restart unless-stopped 
-  --network host
-  -e WIFI_INTERFACE="<yourInterfaceName or leave empty for wlan0>"
-  -e USE_INFLUXDB_LINEPROTOCOL="true"
-  -e INFLUXDB_LINEPROTOCOL_HOST="<host>"
-  -e INFLUXDB_LINEPROTOCOL_PORT="<port>"
-  ruakij/rfmon-to-influx:2
-```
-</details>
 
 <br>
 
-### 2.3.3. docker-compose
+### 2.2.3. docker-compose
 
 Or use the more preferred way with docker-compose.
 
 `docker-compose.yml`
 
-<details><summary>for InfluxDB</summary>
-
 ```yaml
 version: '3'
 
@@ -205,28 +162,6 @@ services:
       - INFLUX_ORG="<yourOrganisation>"
       - INFLUX_BUCKET="<yourBucket>"
 ```
-</details>
-
-<details><summary>for InfluxDB-Line-Protocol</summary>
-
-```yaml
-version: '3'
-
-services:
-  rfmon:
-    container_name: rfmon
-    image: ruakij/rfmon-to-influx:2
-    restart: unless-stopped
-    network_mode: "host"
-    environment:
-      - WIFI_INTERFACE="<yourInterfaceName or leave empty for wlan0>"
-      - USE_INFLUXDB_LINEPROTOCOL="true"
-      - INFLUXDB_LINEPROTOCOL_HOST="<host>"
-      - INFLUXDB_LINEPROTOCOL_PORT="<port>"
-```
-</details>
-
-<br>
 
 And then pull&start the container:
 ```sh
@@ -235,11 +170,9 @@ docker-compose up -d
 
 <br>
 
-## 2.4. Environment-Variables
+## 2.3. Environment-Variables
 
-### 2.4.1. Necessary
-
-<details><summary>for InfluxDB</summary>
+### 2.3.1. Necessary
 
 Variable|Description
 ---|---
@@ -247,25 +180,15 @@ Variable|Description
 `INFLUX_TOKEN`  | Token with write-access
 `INFLUX_ORG`    | Organisation and..
 `INFLUX_BUCKET` | Bucket to write into
-</details>
-
-<details><summary>for InfluxDB-Line-Protocol</summary>
-
-Variable|Description
----|---
-`USE_INFLUXDB_LINEPROTOCOL`     | Enable LineProtocol
-`INFLUXDB_LINEPROTOCOL_HOST`    | Host and..
-`INFLUXDB_LINEPROTOCOL_PORT`    | Port of your server
-</details>
 
 <br>
 
-### 2.4.2. Optional
+### 2.3.2. Optional
 
 Variable|Default|Description
 ---|---|---
 `LOGLEVEL`          | INFO              | Loglevel
-`WIFI_INTERFACE`    | wlan0             | Wifi-Interface name in Monitor-Mode
+`WIFI_INTERFACE`    | wlan0             | Token with write-access
 ~~`HOSTNAME`~~          | ~~Device's Hostname~~ | ~~Hostname to use as global hostname-tag~~ *(Unused)*
 
 <br>

build/docker-multiarch.sh

@@ -1,9 +0,0 @@
-TAG="ruakij/rfmon-to-influx"
-PLATFORM="linux/amd64,linux/arm64/v8,linux/arm/v7"
-EXTRA_ARGS="$@"
-
-docker buildx build \
---platform $PLATFORM \
---tag $TAG \
-$EXTRA_ARGS \
-.

build/docker-ownarch.sh

@@ -1,7 +0,0 @@
-TAG="ruakij/rfmon-to-influx"
-EXTRA_ARGS="$@"
-
-docker build \
---tag $TAG \
-$EXTRA_ARGS \
-.

src/main.js

@@ -14,8 +14,6 @@ const { RegexBlockStream } = require("./streamHandler/RegexBlockStream.js");
 const { PacketStreamFactory } = require("./streamHandler/PacketStreamFactory.js");
 const { PacketInfluxPointFactory } = require("./streamHandler/PacketInfluxPointFactory.js");
 const { InfluxPointWriter } = require("./streamHandler/InfluxPointWriter.js");
-const { InfluxDbLineProtocolWriter } = require("./streamHandler/InfluxDbLineProtocolWriter.js");
-const { InfluxPointToLineProtoStream } = require("./streamHandler/InfluxPointToLineProtoStream.js");
 
 const userHelper = require("./helper/userHelper.js");
 
@@ -27,89 +25,43 @@ const env = process.env;
     env.LOGLEVEL            ??= "INFO";
     env.WIFI_INTERFACE      ??= "wlan0";
     env.HOSTNAME            ??= Os.hostname();
-
-    env.USE_INFLUXDB_LINEPROTOCOL   ??= false;
 }
 // Required vars
-let errorMsg = requireEnvVars(
-    env.USE_INFLUXDB_LINEPROTOCOL? [    // When lineprotocol is enabled, we need host and port
-        "INFLUXDB_LINEPROTOCOL_HOST", "INFLUXDB_LINEPROTOCOL_PORT",
-    ] : [       // When its disabled, influxdb-data
-        "INFLUX_URL", "INFLUX_TOKEN",
-        "INFLUX_ORG", "INFLUX_BUCKET"
-    ]);
+let errorMsg = requireEnvVars([
+    "INFLUX_URL", "INFLUX_TOKEN",
+    "INFLUX_ORG", "INFLUX_BUCKET"
+]);
 if(errorMsg){
     logger.fatal(errorMsg);
     exit(1);
 }
 
 (async function() {
-    let pointWriter;
-    if(!env.USE_INFLUXDB_LINEPROTOCOL){
-        logger.info("Setup Influx..");
-        const influxDb = new InfluxDB({url: env.INFLUX_URL, token: env.INFLUX_TOKEN});
-
-        await InfluxChecks.checkHealth(influxDb)
-            .then((res) => {return InfluxChecks.checkBucket(influxDb, {
-                org: env.INFLUX_ORG,
-                name: env.INFLUX_BUCKET
-            });})
-            .then((res) => {return InfluxChecks.checkWriteApi(influxDb, {
-                org: env.INFLUX_ORG,
-                bucket: env.INFLUX_BUCKET
-            });})
-            .catch((err) => {
-                if(err) {
-                    logger.error("Error whilst checking influx:");
-                    logger.error(err);
-                }
-                logger.fatal("Setup influx failed!");
-                exit(1);
-            });
-
-        logger.debug("Get WriteApi & set default-hostname to", `'${env.HOSTNAME}'`);
-        const influxWriteApi = influxDb.getWriteApi(env.INFLUX_ORG, env.INFLUX_BUCKET, "us");
-        //influxWriteApi.useDefaultTags({"hostname": env.HOSTNAME});
-
-        pointWriter = new InfluxPointWriter(influxWriteApi);
+    logger.info("Setup Influx..");
+    const influxDb = new InfluxDB({url: env.INFLUX_URL, token: env.INFLUX_TOKEN});
+
+    await InfluxChecks.checkHealth(influxDb)
+        .then((res) => {return InfluxChecks.checkBucket(influxDb, {
+            org: env.INFLUX_ORG,
+            name: env.INFLUX_BUCKET
+        });})
+        .then((res) => {return InfluxChecks.checkWriteApi(influxDb, {
+            org: env.INFLUX_ORG,
+            bucket: env.INFLUX_BUCKET
+        });})
+        .catch((err) => {
+            if(err) {
+                logger.error("Error whilst checking influx:");
+                logger.error(err);
+            }
+            logger.fatal("Setup influx failed!");
+            exit(1);
+        });
 
-        logger.info("Influx ok");
-    }
-    else {
-        logger.info("Setup Influxdb-LineProtocol..");
-
-        let lineProtocolWriter = new InfluxDbLineProtocolWriter(env.INFLUXDB_LINEPROTOCOL_HOST, env.INFLUXDB_LINEPROTOCOL_PORT);
-
-        logger.debug("Create PointToLineProto and pipe to LineProtocolWriter");
-        pointWriter = new InfluxPointToLineProtoStream();
-        pointWriter
-            .setEncoding("utf8")
-            .pipe(lineProtocolWriter);
-        
-        logger.debug("Waiting for connection..");
-        await new Promise((resolve, reject) => {
-            lineProtocolWriter.once("connect", () => {
-                resolve();
-            });
-            lineProtocolWriter.once("error", (err) => {
-                reject(err);
-            });
-            setTimeout(() => {  // After timeout, reject promise
-                reject("Timeout whilst waiting to connect");
-            }, 6500);
-        })
-            .then(() => {
-                logger.info("Influxdb-LineProtocol ok");
-            })
-            .catch((err) => {
-                if(err) {
-                    logger.error("Error whilst checking Influxdb-LineProtocol:");
-                    logger.error(err);
-                }
-                logger.fatal("Setup Influxdb-LineProtocol failed!");
-                exit(1);
-            });
-    }
+    logger.debug("Get WriteApi & set default-hostname to", `'${env.HOSTNAME}'`);
+    const influxWriteApi = influxDb.getWriteApi(env.INFLUX_ORG, env.INFLUX_BUCKET, "us");
+    //influxWriteApi.useDefaultTags({"hostname": env.HOSTNAME});
+    logger.info("Influx ok");
 
     logger.info("Starting tcpdump..");
     const TCPDUMP_BASECMD = "tcpdump -vvv -e -n -X -s0 -i";
@@ -120,12 +72,13 @@ if(errorMsg){
     let regexBlockStream = new RegexBlockStream(/^\d{2}:\d{2}:\d{2}.\d{6}.*(\n( {4,8}|\t\t?).*)+\n/gm);
     let packetStreamFactory = new PacketStreamFactory();
     let packetInfluxPointFactory = new PacketInfluxPointFactory();
+    let influxPointWriter = new InfluxPointWriter(influxWriteApi);
     proc.stdout
         .setEncoding("utf8")
         .pipe(regexBlockStream)
         .pipe(packetStreamFactory)
         .pipe(packetInfluxPointFactory)
-        .pipe(pointWriter);
+        .pipe(influxPointWriter);
 
     logger.debug("Attaching error-logger..");
     const loggerTcpdump = logFactory("tcpdump");

src/streamHandler/InfluxDbLineProtocolWriter.js

@@ -1,72 +0,0 @@
-const logger = require.main.require("./helper/logger.js")("InfluxDbLineProtocolWriter");
-const net = require("net");
-
-/**
- * Get points and write them into influx
- */
-class InfluxDbLineProtocolWriter extends net.Socket{
-    /**
-     * 
-     * @param {string} host Host of line-server
-     * @param {string} port Port of line-server
-     * @param {object} options Options for further configuration
-     */
-    constructor(host, port, options = {}) {
-        super();
-
-        this._host = host;
-        this._port = port;
-
-        // options defaults
-        options.autoConnect     ??= true;
-        options.timeout         ??= 5000;
-        options.autoReconnect   ??= true;
-        options.autoReconnectBackoffTime    ??= 3000;
-        this._options = options;
-
-        this._isConnected = false;
-
-        super.setKeepAlive(true, 5000);
-
-        // Register auto-Reconnect if enabled
-        if(this._options.autoReconnect){
-            this.on("connect", () => {
-                logger.debug("Connection established!");
-                this._isConnected = true;
-
-                if(this._autoReconnectTimeout)
-                    clearInterval(this._autoReconnectTimeout);
-                this._autoReconnectTimeout = 0;
-            });
-
-            this.on("error", (err) => {
-                logger.error(err.code, "TCP ERROR");
-                this._isConnected = false;
-                
-                if(!this._autoReconnectTimeout)
-                    this._autoReconnectTimeout = setInterval(() => {
-                        this.connect();
-                    },
-                    this._options.autoReconnectBackoffTime);
-            });
-        }
-
-        // Autoconnect if requested
-        if(this._options.autoConnect) this.connect();
-    }
-
-    get host(){ return this._host; }
-    get port(){ return this._port; }
-
-    get isConnected(){ return this._isConnected; }
-
-    connect(){
-        logger.debug("Connecting..");
-        super.connect(this._port, this._host);
-    }
-}
-
-// Specify exports
-module.exports = {
-    InfluxDbLineProtocolWriter
-};

src/streamHandler/InfluxPointToLineProtoStream.js

@@ -1,22 +0,0 @@
-const logger = require.main.require("./helper/logger.js")("InfluxPointToLineProtoStream");
-const { Transform } = require("stream");
-
-/**
- * Get points and converts them to Line-protocol
- */
-class InfluxPointToLineProtoStream extends Transform{
-    constructor(){
-        super({
-            writableObjectMode: true
-        });
-    }
-
-    _transform(point, encoding, next){
-        next(null, point.toLineProtocol() +"\n");
-    }
-}
-
-// Specify exports
-module.exports = {
-    InfluxPointToLineProtoStream
-};

src/streamHandler/PacketStreamFactory.js

@@ -47,15 +47,8 @@ class PacketStreamFactory extends Transform{
     }
 
     _transform(chunk, encoding, next){
-        if(!chunk){
-            const err = "Chunk was invalid!";
-            logger.error(err);
-            next(err);
-            return;
-        }
-
         let packet = new Packet();
-        
+
         const lines = chunk.split("\n");
         const header = lines.splice(0, 1)[0];       // Grab first line, "lines" is now the payload
         packet = this._handleHeader(packet, header);