Skip to content

Commit 9db24b1

Browse files
committed
Update documentation
1 parent 5b0c60d commit 9db24b1

File tree

3 files changed

+29
-7
lines changed

3 files changed

+29
-7
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Easily Expandable Wireless Intrusion Detection System
2-
**Note:** This project is still under development and far away from being ready or perfect. However, feel free to play around and open issues if you see something interesting. Also have a look at the [getting-started](doc/getting-started.md) section first.
2+
3+
**Note:** While this project may is in a state in which it can be used, it still needs a lot of development and thus is far away from being ready or perfect. However, feel free to play around and open issues if you see something interesting. Also have a look at the [getting-started](doc/getting-started.md) section before starting.
34

45
## Background
56
[Analyzing 0x90/wifi-arsenal](https://github.com/techge/wifi-arsenal) especially in search of wireless intrusion detection systems (WIDS) I realized that there just is no complete ready-to-go solution yet, at least regarding free and open source software (FOSS). For me a WIDS should
@@ -22,3 +23,13 @@ Let's look at a [honey pot](https://en.wikipedia.org/wiki/Honeypot_(computing))
2223
Another advantage is the freedom of choice of visualization/analyzing software. It is easily possible to include either influxdata's [TICK stack](https://www.influxdata.com/time-series-platform/) or the [ElasticSearch stack](https://www.elastic.co/), both Open Source analyzing software which also have anomaly detection methods. These stacks and other software already have interfaces to access RabbitMQ and to read json-formatted data and thus it is easy to extract the collected information as needed. Eewids already integrates InfluxDB with Grafana for visualization of captured data.
2324

2425
This should make it easy to extend Eewids in various ways. Let's see what can happen.
26+
27+
## TODOs
28+
29+
These are limitations and problems that would be nice to get addressed (beside a lot of others ;-) ):
30+
31+
* fix time problems -> in influxdb the time when telegraf is sending the data is stored -> we want to store the actual capture time. This might be decided by pcap on device or by RabbitMQ arrival time or something else
32+
* pcapng-export tool -> export pcapng stream by getting all messages of the capture-raw exchange during a specific time frame and craft it to a pcapng
33+
* look for the tag_keys problem: telegraf is getting the data as json from rabbitmq and is sending this data to influxdb - we can only use these values in the 'where' part of a query in grafana that we have defined as 'tag_keys' in etc/telegraf.conf before hand. this is most annoying
34+
* Look if Kapacitor (Influx stack) could add any value to Eewids
35+
* Add RabbitMQ metric to Grafana https://www.rabbitmq.com/prometheus.html

doc/getting-started.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,35 @@ cd eewids
3232
sudo ./start.sh --server
3333
```
3434

35-
To use the capture tool separately e.g. to connect multiple sources to Eewids, you need to build the capture tool first on the machine. The capture tool needs libpcap and librabbitmq to get build successfully. For example on a Debian-based system you would need to install the following:
35+
To use the capture tool separately e.g. to connect multiple sources to Eewids, you need to build the capture tool first on the machine. It needs libpcap and librabbitmq to get build successfully. For example on a Debian-based system you would need to install the following:
3636

3737
```
38-
sudo apt-get update && sudo apt-get install build-essential libpcap-dev librabbitmq-dev
38+
sudo apt-get update
39+
sudo apt-get install \
40+
build-essential \
41+
libcap-dev \
42+
libnl-3-dev \
43+
libnl-genl-3-dev \
44+
libnm-dev \
45+
libpcap-dev \
46+
librabbitmq-dev \
47+
pkg-config
3948
```
4049

4150
After installing the depencies you can clone the repo and build the capture tool.
4251

4352
```
4453
git clone https://github.com/techge/eewids.git
45-
cd eewids/eewids-capture
46-
gcc -lpcap -lrabbitmq -o eewids-capture eewids-cap.c amqp-utils.c
54+
cd eewids/kiscap2amqp
55+
./configure
56+
make
4757
```
4858

4959
Now you can start the capture tool by typing the following:
5060

5161
```
52-
./eewids-capture wlan0 eewids-server
62+
./capture_linux_wifi/kiscap2amqp_linux_wifi --source wlan0 --rabbitmq localhost:5672 --capexchange capture-raw
5363
```
54-
where ```wlan0``` is the Wi-Fi interface and ```eewids-server``` is the hostname of the machine you entered the start.sh script command.
64+
65+
where `wlan0` is the Wi-Fi interface and `--rabbitmq` points to the RabbitMQ server on machine you entered the `start.sh --server` script command.
5566

framework_layout.png

10.2 KB
Loading

0 commit comments

Comments
 (0)