aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4cdc323..41576ed 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@ Tarpit command application that may slow down malicious attempts to scan a syste
Supported Protocols:
- SSH
+- HTTP
# Building and Running
@@ -13,11 +14,11 @@ GOOS=linux GOARCH=amd64 go build -o "build/tarpit-linux-amd64"
This command will build the application in `build/tarpit-linux-amd64`. We can then run the tarpit on an unprivileged port (e.g. 2222).
-`$ ./build/tarpit-linux-amd64 -p 2222`
+`$ ./build/tarpit-linux-amd64 -P ssh -p 2222`
Or you can run it on a privileged port with `sudo`.
-`$ sudo ./build/tarpit-linux-amd64 -p 22`
+`$ sudo ./build/tarpit-linux-amd64 -P ssh -p 22`
## Options
@@ -26,7 +27,7 @@ Usage of ./tarpit:
-b, --bind-address string address to bind the socket to
-d, --delay string delay between the tarpit keep-alive data packets (default "10s")
-g, --gid uint16 setgid, after creating a listening socket
- -p, --port uint16 TCP port (default 22)
+ -p, --port uint16 TCP port, leave it 0 for service default
-P, --proto string protocol to tarpit (default "ssh")
-u, --uid uint16 setuid, after creating a listening socket
-v, --version show current version
@@ -36,7 +37,7 @@ Usage of ./tarpit:
The ports `< 1024` require superuser privileges. The command allows to drop superuser privileges (using setuid/setgid), right after it acquires a listening socket. Thus, allowing to bind to a privileged port and start serving as a regular unprivileged user. This is done by running the command as a superuser (e.g. with `sudo`) and setting the `-u/--uid <uid>` and `-g/--gid <gid>` command line flags.
-`$ sudo ./build/tarpit-linux-amd64 -p 22 -u "$(id -u)" -g "$(id -g)"`
+`$ sudo ./build/tarpit-linux-amd64 -P ssh -p 22 -u "$(id -u)" -g "$(id -g)"`
# Acknowledgements