diff --git a/README.md b/README.md index 14743a5..9e1dffb 100644 --- a/README.md +++ b/README.md @@ -25,25 +25,36 @@ python3 dystopy.py ``` # Command Line Arguments ``` -usage: dystopia.py [-h] [--port PORT] [--motd MOTD] [--max MAX] [--username USERNAME] [--password PASSWORD] - [--hostname HOSTNAME] [--localhost] [--save SAVE] [--load LOAD] +usage: dystopia.py [-h] [--port PORT] [--motd MOTD] [--max MAX] [--login] + [--username USERNAME] [--password PASSWORD] + [--hostname HOSTNAME] [--localhost] [--capture] + [--interface INTERFACE] [--save SAVE] [--load LOAD] -Dystopia | A python honeypot. +Dystopia | A python Honeypot. optional arguments: -h, --help show this help message and exit --port PORT, -P PORT specify a port to bind to --motd MOTD, -m MOTD specify the message of the day - --max MAX, -M MAX max number of clients allowed to be connected at once. + --max MAX, -M MAX max number of clients allowed to be connected at once + default is unlimited + --login, -f create a fake login prompt (no encryption) --username USERNAME, -u USERNAME - username for fake login prompt and the user for the honeypot session + username for fake login prompt and the user for the + Honeypot session default: 'ubuntu' --password PASSWORD, -p PASSWORD - password for fake login prompt + password for fake login prompt. Default: 'P@$$W0RD' --hostname HOSTNAME, -H HOSTNAME - hostname of the honeypot - --localhost, -L host honeypot on localhost - --save SAVE, -s SAVE save config to a json file - --load LOAD, -l LOAD load a config file + Hostname of the Honeypot default: 'localhost' + --localhost, -L start Honeypot on localhost + --capture, -c enable packet capturing using the tool Tcpdump + --interface INTERFACE, -i INTERFACE + interface to capture traffic on if --capture / -c is + used and no interface is configured, the default is: + 'eth0' + --save SAVE, -s SAVE save config to a json file E.g: '--save settings.json' + --load LOAD, -l LOAD load config from a json file E.g '--load + settings.json' ``` # How to add Support for More Commands You can add support to new commands by editing the file "commands.json". The format is command:output