Skip to content

Commit

Permalink
Updated README.md and change schema
Browse files Browse the repository at this point in the history
  • Loading branch information
guillaumeguirriec committed Nov 28, 2019
1 parent 4f41b82 commit 35a5ce6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
## Usage

To sniff data:
* Add in the .env file the values for `LISTENED_IP`, `LOCAL_IP` and `INTERFACE`
* Add in the .env file the [variables for the sniffer](#sniffer)
* Run `python3 sniffer.py`, you can also provide different options, run `python3 sniffer.py -h` to see them
* By default the program will generate a `capture.pcap` file in the root folder

To analyse sniffed data:
* Run `python3 analyse_packets.py`, you can also provide different options, run `python3 analyse_packets.py -h` to see them
* If you choose the "mongo" export mode, you need complete the variables about mongoDB in the .env file
* If you choose the "mongo" export mode, you need complete the [variables about mongoDB](#mongodb) in the .env file
* By default the program will generate a `results.csv` file in the root folder

### Schema
Expand All @@ -44,7 +44,7 @@ These variables are used for sniffing
* LISTENED_IPV6 (optional) : script will capture packets from conversation between LISTENED_IPV6 and other addresses
* LOCAL_IPV6 (optional) : IPv6 of the program host machine

LISTENED_IP (or LISTENED_IPV6) and LOCAL_IP (or LOCAL_IPV6) can be the same if you want to capture packets from conversation between the program host machine and and other addresses
LISTENED_IP (or LISTENED_IPV6) and LOCAL_IP (or LOCAL_IPV6) can be the same if program host machine and device are the same.

### MongoDB

Expand Down
Binary file modified assets/schema.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 35a5ce6

Please sign in to comment.