diff --git a/README.md b/README.md index 9efa5ef3..8e8435b3 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,113 @@ function onResponse(req, res) { } ``` +## Interactive Mode + +Interactive mode allows you to start and stop modules manually on the fly, change options and apply new firewall rules on the fly, the basic commands are: + +| Command | Description | +| ------- | ------------| +| help | Display list of available commands. | +| active | Show information about active modules. | +| exit | Close the session and exit. | +| sleep SECONDS | Sleep for the given amount of seconds. | +| get NAME | Get the value of variable NAME, use * for all. | +| set NAME VALUE | Set the VALUE of variable NAME. | + +For instance you can view a list of declared variables with `get *` and set new ones, for example `set some.new.variable some-value`, for a list of every module and its parameters, issue the `help` command: + + 192.168.1.0/24 > 192.168.1.17 » help + + Basic commands: + + help : Display list of available commands. + active : Show information about active modules. + exit : Close the session and exit. + sleep SECONDS : Sleep for the given amount of seconds. + get NAME : Get the value of variable NAME, use * for all. + set NAME VALUE : Set the VALUE of variable NAME. + + ARP Spoofer [not active] + Keep spoofing selected hosts on the network. + + arp.spoof on : Start ARP spoofer. + arp.spoof off : Stop ARP spoofer. + + Parameters + + arp.spoof.targets : IP addresses to spoof. (default=) + + + Events Stream [active] + Print events as a continuous stream. + + events.stream on : Start events stream. + events.stream off : Stop events stream. + events.clear : Clear events stream. + + HTTP Proxy [not active] + A full featured HTTP proxy that can be used to inject malicious contents into webpages, all HTTP traffic will be redirected to it. + + http.proxy on : Start HTTP proxy. + http.proxy off : Stop HTTP proxy. + + Parameters + + http.port : HTTP port to redirect when the proxy is activated. (default=80) + http.proxy.address : Address to bind the HTTP proxy to. (default=) + http.proxy.port : Port to bind the HTTP proxy to. (default=8080) + http.proxy.script : Path of a proxy JS script. (default=) + + + Network Prober [not active] + Keep probing for new hosts on the network by sending dummy UDP packets to every possible IP on the subnet. + + net.probe on : Start network hosts probing in background. + net.probe off : Stop network hosts probing in background. + + Parameters + + net.probe.throttle : If greater than 0, probe packets will be throttled by this value in milliseconds. (default=10) + + + Network Recon [not active] + Read periodically the ARP cache in order to monitor for new hosts on the network. + + net.recon on : Start network hosts discovery. + net.recon off : Stop network hosts discovery. + net.show : Show current hosts list. + + Network Sniffer [not active] + Sniff packets from the network. + + net.sniffer stats : Print sniffer session configuration and statistics. + net.sniffer on : Start network sniffer in background. + net.sniffer off : Stop network sniffer in background. + + Parameters + + net.sniffer.verbose : Print captured packets to screen. (default=true) + net.sniffer.local : If true it will consider packets from/to this computer, otherwise it will skip them. (default=false) + net.sniffer.filter : BPF filter for the sniffer. (default=not arp) + net.sniffer.regexp : If filled, only packets matching this regular expression will be considered. (default=) + net.sniffer.output : If set, the sniffer will write captured packets to this file. (default=) + + + REST API [not active] + Expose a RESTful API. + + api.rest on : Start REST API server. + api.rest off : Stop REST API server. + + Parameters + + api.rest.address : Address to bind the API REST server to. (default=) + api.rest.port : Port to bind the API REST server to. (default=8083) + api.rest.username : API authentication username. (default=) + api.rest.certificate : API TLS certificate. (default=~/.bettercap-ng.api.rest.certificate.pem) + api.rest.key : API TLS key (default=~/.bettercap-ng.api.rest.key.pem) + api.rest.password : API authentication password. (default=) + ## License `bettercap` and `bettercap-ng` are made with ♥ by [Simone Margaritelli](https://www.evilsocket.net/) and they're released under the GPL 3 license.