Skip to content

Commit

Permalink
Added more info on running the program
Browse files Browse the repository at this point in the history
  • Loading branch information
paul1278 committed Mar 9, 2023
1 parent c6bc47d commit 52d0645
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Network-Editor
# Network-Editor: PInterceptor
> **This product is for educational purposes only! You are not allowed to use it for anything illegal or something, you don't have permissions for.**
This tool will allow you to modify network traffic as a Man-in-the-middle.
You can define `filter`, which must match packets and will trigger `actions`.
You can define a `filter`, which matches packets against your conditions and will trigger `actions`.
Those will modify the packets.

It is pretty simple to use - as long you can write some simple `python`-code.
Expand Down Expand Up @@ -51,6 +51,34 @@ localmac2: 02:42:ac:13:00:05
rewriteMAC: true
```
## Running the tool
After installing the package, you can use it under `pinterceptor`.
Otherwise, run `start.py` using `python3`.

The command-line is pretty simple:
```
root@interceptor:/main# python3 start.py -h
( (
)\ ))\ ) ) )
(()/(()/( ( /( ( ( ( ( /( (
/(_))(_))( )\())))\ )( ( ))\` ) )\())( )(
(_))(_)) )\ )(_))//((_|()\ )\ /((_)(/( (_))/ )\(()\
| _ \_ _|_(_/(| |_(_)) ((_)((_|_))((_)_\| |_ ((_)((_)
| _/| || ' \)) _/ -_)| '_/ _|/ -_) '_ \) _/ _ \ '_|
|_| |___|_||_| \__\___||_| \__|\___| .__/ \__\___/_|
|_|
[+] Starting up
usage: start.py [-h] [-w WORKSPACE] [-i] [-v]
options:
-h, --help show this help message and exit
-w WORKSPACE, --workspace WORKSPACE
Give a path to a ready workspace
-i, --interactive Start with a UI
-v, --verbose Enable debug mode without config
```
If you want to see debug output on incoming / outgoing packets, we suggest turning on verbose-mode.

## Running the demo
The demo consists of three parts:
* COFFEE_SERVER: A server which will return a price-list for a COFFEE_MACHINE
Expand Down

0 comments on commit 52d0645

Please sign in to comment.