Added example compose-file

This reverts commit 227ba127f8.

Dockerfile

@@ -7,7 +7,11 @@ WORKDIR /usr/src/app
 COPY package*.json ./
 RUN npm install
 
+RUN apt-get update
+RUN apt-get -y install \
+    tcpdump
+
 # Bundle app source
 COPY ./src/ .
 
-CMD ["npm", "run"]
+CMD ["npm", "run", "start"]

docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3'
+
+services:
+  rfmon:
+    container_name: rfmon
+    image: # TODO: Add image
+    restart: unless-stopped
+    network_mode: "host"
+    environment:
+      - LOGLEVEL=DEBUG
+      - WIFI_INTERFACE=wlan0
+      - INFLUX_URL=http://influxdb:8086/
+      - INFLUX_TOKEN=
+      - INFLUX_ORG=
+      - INFLUX_BUCKET=

package-lock.json

@@ -10,8 +10,10 @@
       "license": "AGPL-3.0",
       "dependencies": {
         "@influxdata/influxdb-client": "^1.20.0",
+        "@influxdata/influxdb-client-apis": "^1.20.0",
         "log4js": "^6.3.0",
-        "luxon": "^2.1.1"
+        "luxon": "^2.1.1",
+        "string-argv": "^0.3.1"
       }
     },
     "node_modules/@influxdata/influxdb-client": {
@@ -19,6 +21,14 @@
       "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client/-/influxdb-client-1.20.0.tgz",
       "integrity": "sha512-jaKSI63hmQ5VSkJrFJkYIXaKlhoF+mGd4HmOf7v/X7pmEi69ReHp922Wyx6/OeCrpndRMbsadk+XmGNdd43cFw=="
     },
+    "node_modules/@influxdata/influxdb-client-apis": {
+      "version": "1.20.0",
+      "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client-apis/-/influxdb-client-apis-1.20.0.tgz",
+      "integrity": "sha512-KMTmXH4rbpS+NWGpqDjxcKTyan2rbiT2IM5AdRElKhH2sHbH96xwLgziaxeC+OCJLeNAdehJgae3I8WiZjbwdg==",
+      "peerDependencies": {
+        "@influxdata/influxdb-client": "*"
+      }
+    },
     "node_modules/date-format": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/date-format/-/date-format-3.0.0.tgz",
@@ -128,6 +138,14 @@
         "node": ">=4.0"
       }
     },
+    "node_modules/string-argv": {
+      "version": "0.3.1",
+      "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz",
+      "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==",
+      "engines": {
+        "node": ">=0.6.19"
+      }
+    },
     "node_modules/universalify": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
@@ -143,6 +161,12 @@
       "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client/-/influxdb-client-1.20.0.tgz",
       "integrity": "sha512-jaKSI63hmQ5VSkJrFJkYIXaKlhoF+mGd4HmOf7v/X7pmEi69ReHp922Wyx6/OeCrpndRMbsadk+XmGNdd43cFw=="
     },
+    "@influxdata/influxdb-client-apis": {
+      "version": "1.20.0",
+      "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client-apis/-/influxdb-client-apis-1.20.0.tgz",
+      "integrity": "sha512-KMTmXH4rbpS+NWGpqDjxcKTyan2rbiT2IM5AdRElKhH2sHbH96xwLgziaxeC+OCJLeNAdehJgae3I8WiZjbwdg==",
+      "requires": {}
+    },
     "date-format": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/date-format/-/date-format-3.0.0.tgz",
@@ -228,6 +252,11 @@
         }
       }
     },
+    "string-argv": {
+      "version": "0.3.1",
+      "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz",
+      "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg=="
+    },
     "universalify": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",

package.json

@@ -2,10 +2,10 @@
   "name": "rfmon-to-influx",
   "version": "1.0.0",
   "description": "Writing (mostly meta-) data received in Wireless-Monitor-Mode into an InfluxDB",
-  "main": "src/main.js",
+  "main": "main.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "node src/main.js"
+    "start": "node main.js"
   },
   "repository": {
     "type": "git",
@@ -15,7 +15,9 @@
   "license": "AGPL-3.0",
   "dependencies": {
     "@influxdata/influxdb-client": "^1.20.0",
+    "@influxdata/influxdb-client-apis": "^1.20.0",
     "log4js": "^6.3.0",
-    "luxon": "^2.1.1"
+    "luxon": "^2.1.1",
+    "string-argv": "^0.3.1"
   }
 }

src/helper/exec.js

@@ -1,20 +1,15 @@
 const logger = require("./logger.js")("exec");
 
 const { spawn } = require("child_process");
+const { parseArgsStringToArgv } = require('string-argv');
 
 
-function exec(cmd, stdout, stderr, exit_handler){
+function exec(cmd, options){
-    const [bin, ...args] = cmd.split(' ')
+    const [bin, ...args] = parseArgsStringToArgv(cmd);
 
     logger.addContext("binary", "bin");
     logger.debug(`Spawn process '${cmd}'`);
-    let proc = spawn(bin, args);
+    return spawn(bin, args, options);
-
-    return {
-        "process": proc,
-        "stdout": proc.stdout,
-        "stderr": proc.stderr
-    }
 }
 
 // Specify exports

src/helper/influx-checks.js

@@ -0,0 +1,61 @@
+const logger = require.main.require("./helper/logger.js")("influx-checks");
+
+const Os = require("os");
+const { InfluxDB, Point } = require('@influxdata/influxdb-client')
+const Influx = require('@influxdata/influxdb-client-apis');
+
+
+function checkHealth(influxDb){
+    return new Promise((resolve, reject) => {
+        new Influx.HealthAPI(influxDb)    // Check influx health
+            .getHealth()
+            .catch((err) => {
+                logger.error("Could not communicate with Influx:");
+                logger.error(`Error [${err.code}]:`, err.message);
+                reject();
+            })
+            .then((res) => {
+                logger.debug("Server healthy.", "Version: ", res.version);
+                resolve(res);
+            });
+    });
+}
+
+function checkBucket(influxDb, options){
+    return new Promise((resolve, reject) => {
+        new Influx.BucketsAPI(influxDb).getBuckets(options)
+            .catch((err) => {       // Weirdly the influx-Api returns 404 for searches of non-existing buckets
+                logger.error("Could not get bucket:");
+                logger.error(`Error [${err.code}]:`, err.message);
+                reject();
+            }).then((res) => {      // But an empty list when the bucket exists, but token does not have permission to get details
+                logger.debug("Bucket found");
+                resolve(res);
+                // Now we know the bucket exists and we have some kind of permission.. but we still dont know if we are able to write to it..
+            });
+    });
+}
+
+function checkWriteApi(influxDb, options){
+    return new Promise((resolve, reject) => {
+        const writeApi = influxDb.getWriteApi(options.org, options.bucket);     // Get WriteAPI
+        writeApi.writePoint(new Point("worker_connectionTest").tag("hostname", Os.hostname()))    // Write point
+        writeApi.close()
+            .catch((err) => {
+                logger.error("Could not get writeApi:");
+                logger.error(`Error [${err.code}]:`, err.message);
+                reject();
+            }).then((res) => {
+                logger.debug("Writing ok");
+                resolve();
+            });
+    });
+}
+
+
+// Specify exports
+module.exports = {
+    checkHealth,
+    checkBucket,
+    checkWriteApi,
+};

src/helper/wifiStateAnalyzer.js

@@ -0,0 +1,43 @@
+const { HandshakeStage } = require.main.require('./dto/Packet.js');
+
+function keyInfoFromRaw(keyInfoRaw) {
+    return {
+        "KeyDescriptorVersion": keyInfoRaw>>0 & 0b111,
+        "KeyType":              keyInfoRaw>>3 & 0b1,
+        "KeyIndex":             keyInfoRaw>>4 & 0b11,
+        "Install":              keyInfoRaw>>6 & 0b1,
+        "KeyACK":               keyInfoRaw>>7 & 0b1,
+        "KeyMIC":               keyInfoRaw>>8 & 0b1,
+        "Secure":               keyInfoRaw>>9 & 0b1,
+        "Error":                keyInfoRaw>>10 & 0b1,
+        "Request":              keyInfoRaw>>11 & 0b1,
+        "EncryptedKeyData":     keyInfoRaw>>12 & 0b1,
+        "SMKMessage":           keyInfoRaw>>13 & 0b1,
+    };
+}
+
+const HANDSHAKE_STAGE_KEYINFO = {
+    "keys": ["Install", "KeyACK", "KeyMIC", "Secure"],
+    "0100": HandshakeStage[1],
+    "0010": HandshakeStage[2],
+    "1111": HandshakeStage[3],
+    "0011": HandshakeStage[4],
+};
+function handshakeStageFromKeyInfo(keyInfo){
+
+    // Extract compare-keys
+    let keyData = "";
+    for (const key of HANDSHAKE_STAGE_KEYINFO['keys']) {
+        keyData += keyInfo[key].toString();
+    }
+    
+    // Get and return stage
+    return  HANDSHAKE_STAGE_KEYINFO[keyData];
+}
+
+
+// Specify exports
+module.exports = {
+    keyInfoFromRaw,
+    handshakeStageFromKeyInfo,
+};

src/main.js

@@ -1,7 +1,17 @@
+"use strict";
 const logger = require("./helper/logger.js")("main");
 
 const { requireEnvVars } = require("./helper/env.js");
 const { exit } = require("process");
+const { exec } = require("./helper/exec.js");
+
+const { InfluxDB } = require('@influxdata/influxdb-client');
+const InfluxChecks = require('./helper/influx-checks.js');
+
+const { RegexBlockStream } = require("./streamHandler/RegexBlockStream.js");
+const { PacketStreamFactory } = require("./streamHandler/PacketStreamFactory.js");
+const { PacketInfluxPointFactory } = require("./streamHandler/PacketInfluxPointFactory.js");
+const { InfluxPointWriter } = require("./streamHandler/InfluxPointWriter.js");
 
 /// Setup ENVs
 const env = process.env;
@@ -9,8 +19,6 @@ const env = process.env;
 {
   env.LOGLEVEL            ??= "INFO";
   env.WIFI_INTERFACE      ??= "wlan0";
-  env.WIFI_CHANNEL        ??= [1,6,11];
-  env.WIFI_CHANNEL_TIME   ??= 1;
 }
 // Required vars
 let errorMsg = requireEnvVars([
@@ -22,3 +30,58 @@ if(errorMsg){
   exit(1);
 }
 
+(async function() {
+  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");
+
+  logger.info("Starting tcpdump..");
+  const TCPDUMP_BASECMD = "tcpdump -vvv -e -n -X -s0 -i"
+  let cmd = `${TCPDUMP_BASECMD} ${env.WIFI_INTERFACE}`;
+
+  let proc = exec(cmd);
+  logger.debug("Creating & Attaching streams..");
+  proc.stdout
+    .setEncoding("utf8")
+    .pipe(new RegexBlockStream(/^\d{2}:\d{2}:\d{2}.\d{6}.*(\n( {4,8}|\t\t?).*)+\n/gm))
+    .pipe(new PacketStreamFactory())
+    .pipe(new PacketInfluxPointFactory())
+    .pipe(new InfluxPointWriter(influxDb, env.INFLUX_ORG, env.INFLUX_BUCKET));
+
+  logger.debug("Attaching error-logger..");
+  proc.stderr.setEncoding("utf8").on("data", (data) => {
+    logger.error(data);
+  });
+
+  logger.debug("Attaching exit-handler..");
+  proc.on("exit", (code) => {
+    logger.info(`tcpdump exited code: ${code}`);
+    if (code) {
+      logger.fatal(`tcpdump exited with non-zero code: ${code}`);
+      exit(1);
+    }
+    logger.info("Shutdown");
+    exit(0);
+  });
+
+  logger.info("Startup complete");
+})();

src/streamHandler/InfluxPointWriter.js

@@ -0,0 +1,38 @@
+const logger = require.main.require("./helper/logger.js")("InfluxPointWriter");
+const { Writable } = require('stream');
+const {InfluxDB, Point, HttpError} = require('@influxdata/influxdb-client')
+
+/**
+ * Get points and write them into influx
+ */
+class InfluxPointWriter extends Writable{
+    /**
+     * 
+     * @param {InfluxDB} influxDb InfluxDb
+     * @param {string} org Organization to use
+     * @param {string} bucket Bucket to use
+     * @param {Partial<WriteOptions>} options Options for WriteApi
+     */
+    constructor(influxDb, org, bucket, options){
+        super({
+            objectMode: true
+        });
+        this._api = influxDb.getWriteApi(org, bucket, 'us', options);
+    }
+
+    _write(point, encoding, next){
+        this._api.writePoint(point);
+        next();
+    }
+
+    _flush(next){
+        this._api.flush(true)
+            .catch((err) => { next(new Error(`WriteApi rejected promise for flush: ${err}`)); })
+            .then(next);
+    }
+}
+
+// Specify exports
+module.exports = {
+    InfluxPointWriter
+};

src/streamHandler/PacketInfluxPointFactory.js

@@ -0,0 +1,84 @@
+const logger = require.main.require("./helper/logger.js")("PacketStreamFactory");
+const { Transform } = require('stream');
+const {Point} = require('@influxdata/influxdb-client')
+
+/** Keys to always use as tags */
+const TAG_LIST = [
+    "srcMac",
+    "dstMac",
+    "bssid",
+    "frequency",
+    "flags",
+];
+
+/** Measurement-name and corresponding field-key */
+const MEASUREMENT_MAP = new Map([
+    ["Signal", "signal"],
+    ["PayloadSize", "payloadSize"],
+    ["DataRate", "dataRate"],
+    ["SSID", "ssid"],
+    ["AuthenticationType", "authenticationType"],
+    ["AssociationSuccess", "associationIsSuccessful"],
+    ["DisassociationReason", "disassociationReason"],
+]);
+
+
+/**
+ * Get packets and convert them into influx-points
+ */
+class PacketInfluxPointFactory extends Transform{
+    constructor(){
+        super({
+            readableObjectMode: true,
+            writableObjectMode: true
+        });
+    }
+
+    _transform(packet, encoding, next){
+        // Create measurements
+        MEASUREMENT_MAP.forEach((objKey, measurement) => {
+            if(packet[objKey] == null) return;
+
+            let point = new Point(measurement);     // Create point
+            
+            // Set tags
+            TAG_LIST.filter(tag => Object.keys(packet).includes(tag))   // Filter tags available on object
+                    .filter(tag => packet[tag] != null)                         // Filter tags not falsy on object
+                    .forEach(tag => {
+                        tagObjectRecursively(point, tag, packet[tag]);
+                    });
+
+            point.setField('value', packet[objKey]);        // Set field
+
+            this.push(point);     // Push point into stream
+        });
+        
+        next();     // Get next packet
+    }
+}
+
+function tagObjectRecursively(point, tag, field, suffix = ""){
+    if(typeof(field) == "object"){
+        // TODO: Convert boolean-arrays like "packet.flags" to key: value
+        Object.entries(field).map(([key, value]) => {
+            tagObjectRecursively(point, tag, value, `_${key}${suffix}`);
+        });
+    }
+    else point.tag(tag+suffix, field);
+}
+
+/** Mapping for type -> field-method */
+const POINT_FIELD_TYPE = new Map([
+    ['boolean',   function(key, value){ return this.booleanField(key, value); }],
+    ['number',    function(key, value){ return this.intField(key, value); }],
+    ['string',    function(key, value){ return this.stringField(key, value); }],
+]);
+Point.prototype.setField = function(key, value){
+    let setField = POINT_FIELD_TYPE.get(typeof value);
+    return setField.apply(this, [key, value]);
+}
+
+// Specify exports
+module.exports = {
+    PacketInfluxPointFactory
+};

src/streamHandler/PacketStreamFactory.js

@@ -3,6 +3,7 @@ const { Transform } = require('stream');
 const { DateTime } = require("luxon");
 const { PacketType, FlagType, Packet, PacketWithSSID, BeaconPacket, ProbeRequestPacket, ProbeResponsePacket, AuthenticationPacket, AuthenticationType, AssociationResponsePacket, DisassociationPacket, HandshakePacket, HandshakeStage } = require.main.require('./dto/Packet.js');
 const hexConv = require.main.require("./helper/hexConverter.js");
+const wifiStateAnalyser = require.main.require("./helper/wifiStateAnalyzer.js");
 
 const PACKET_TYPE_MAP = {
     "Beacon":           PacketType.Beacon,
@@ -65,17 +66,22 @@ class PacketStreamFactory extends Transform{
             ?.forEach(match => packet.flags[FLAG_TYPE_MAP[match]] = true)       // Set them to true in flags
         );
 
-        packet.dataRate = Number(data.match(/(?<=^|\s)[0-9]+(\.[0-9]+)?(?=\sMb\/?s($|\s))/i)?.[0]) || null;
+        packet.dataRate = Number(data.match(/(?<=^|\s)\d+(\.\d+)?(?=\sMb\/?s($|\s))/i)?.[0]) || null;
-        packet.frequency = Number(data.match(/(?<=^|\s)[0-9]{4}(?=\sMHz($|\s))/i)?.[0]) || null;
+        packet.frequency = Number(data.match(/(?<=^|\s)\d{4}(?=\sMHz($|\s))/i)?.[0]) || null;
 
-        packet.durationMicros = Number(data.match(/(?<=^|\s)[0-9]{1,4}(?=us($|\s))/i)?.[0]) || null;
+        packet.durationMicros = Number(data.match(/(?<=^|\s)\d{1,4}(?=us($|\s))/i)?.[0]) || null;
 
-        packet.signal = Number(data.match(/(?<=^|\s)-[0-9]{2,3}(?=dBm\sSignal($|\s))/i)?.[0]) || null;
+        packet.signal = Number(data.match(/(?<=^|\s)-\d{2,3}(?=dBm\sSignal($|\s))/i)?.[0]) || null;
 
         let packetTypeStr = data.match(new RegExp('(?<=^|\\s)('+ PACKET_TYPES_REGEX +')(?=$|\\s)', 'i'))?.[0];
-        packet.packetType = packetTypeStr? PACKET_TYPE_MAP[packetTypeStr]: 
+        if(packetTypeStr)
-                            data.match(/(SA|TA|DA|RA|BSSID):.{17}\s*$/i)? PacketType.NoData:
+            packet.packetType = PACKET_TYPE_MAP[packetTypeStr];
-                            PacketType.Unknown;
+        else if(data.match(/(SA|TA|DA|RA|BSSID):.{17}\s*$/i)){
+            packet.packetType = PacketType.NoData
+        }
+        else {
+            packet.packetType = PacketType.Unknown;
+        }
 
         packet.srcMac = data.match(/(?<=(^|\s)(SA|TA):).{17}(?=$|\s)/i)?.[0] ?? null;
 
@@ -129,25 +135,9 @@ class PacketStreamFactory extends Transform{
 
                 // Read key-information
                 const keyInfoRaw = (packet.payloadData[0x5]<<0x8) + packet.payloadData[0x6];
-                const keyInfo = {
+                const keyInfo = wifiStateAnalyser.keyInfoFromRaw(keyInfoRaw);   // Convert
-                    "KeyDescriptorVersion": keyInfoRaw>>0 & 0b111,
-                    "KeyType":  keyInfoRaw>>3 & 0b1,
-                    "KeyIndex": keyInfoRaw>>4 & 0b11,
-                    "Install":  keyInfoRaw>>6 & 0b1,
-                    "KeyACK":   keyInfoRaw>>7 & 0b1,
-                    "KeyMIC":   keyInfoRaw>>8 & 0b1,
-                    "Secure":   keyInfoRaw>>9 & 0b1,
-                    "Error":    keyInfoRaw>>10 & 0b1,
-                    "Request":  keyInfoRaw>>11 & 0b1,
-                    "EncryptedKeyData": keyInfoRaw>>12 & 0b1,
-                    "SMKMessage":       keyInfoRaw>>13 & 0b1,
-                };
 
-                newPacket.handshakeStage =  (!keyInfo.Install &&  keyInfo.KeyACK && !keyInfo.KeyMIC && !keyInfo.Secure)? HandshakeStage[1] :
+                newPacket.handshakeStage =  wifiStateAnalyser.handshakeStageFromKeyInfo(keyInfo);   // Get stage
-                                            (!keyInfo.Install && !keyInfo.KeyACK &&  keyInfo.KeyMIC && !keyInfo.Secure)? HandshakeStage[2] :
-                                            ( keyInfo.Install &&  keyInfo.KeyACK &&  keyInfo.KeyMIC &&  keyInfo.Secure)? HandshakeStage[3] :
-                                            (!keyInfo.Install && !keyInfo.KeyACK &&  keyInfo.KeyMIC &&  keyInfo.Secure)? HandshakeStage[4] :
-                                            null;
                 break;
         }
         if(newPacket) packet = Object.assign(newPacket, packet);

src/streamHandler/RegexBlockStream.js

@@ -10,9 +10,10 @@ class RegexBlockStream extends Transform{
     matchAllOnFlush;
 
     /**
-     * @param {RegExp} matcher Block-match - WARNING: It should match a clean-block (including e.g. newline)! Otherwise buffer will get dirty and use more and more ressources.
+     * @param {RegExp} matcher Block-match
      * @param {boolean} withholdLastBlock When true, the last matches block will not be submitted to prevent submitting incomplete blocks.
      * @param {boolean} matchAllOnFlush (Only in combination with withholdLastBlock) When enabled, the buffer will be matched on last time on _flush (stream deconstruction) and write any, also incomplete, blocks
+     * @remarks WARNING: It should match a clean-block (including e.g. newline)! Otherwise buffer will get dirty and use more and more resources.
      */
     constructor(matcher, withholdLastBlock = true, matchAllOnFlush = false){
         super({
@@ -26,7 +27,7 @@ class RegexBlockStream extends Transform{
     }
 
     _transform(chunk, encoding, next){
-        chunk = this.readableBuffer.length? this.readableBuffer.join() + chunk: chunk;     // Add previous buffer to current chunk
+        chunk = this.readableBuffer.length? this.readableBuffer.join('') + chunk: chunk;     // Add previous buffer to current chunk
         this.readableBuffer.length && this.readableBuffer.clear();      // Clear buffer once we read it
 
         let matches = chunk.match(this.matcher);    // Match
@@ -51,7 +52,7 @@ class RegexBlockStream extends Transform{
 
     _flush(next){
         if(matchAllOnFlush){    // When requested, we'll match one last time over the remaining buffer
-            let chunk = this.readableBuffer.toString();
+            let chunk = this.readableBuffer.join('');
             let matches = chunk.match(this.matcher);    // Match remaining buffer
             _writeMatches(matches);    // Write matches including last element
         }