first commit

README.md

@@ -0,0 +1,40 @@
+# Portnut
+
+Portnut is a tcp port scanner / stresser.
+
+The scanning function simply tries to connect to the tcp ports given.
+The stressing function sends a payload every 10 milliseconds, to every ports given at the same time. The payload can be passed via a pipe (optionnal).
+
+```
+1637 justine@portnut > target/release/portnut -a 127.0.0.1 -w 3 -p 8080,22   
+Scanning 127.0.0.1
+TCP/8080 => REJECT
+TCP/22 => REJECT
+
+#First scan the ports, and stress the available ones.
+justine@portnut > echo "My payload" | target/release/portnut -a 127.0.0.1 -p 22,8080 -w 3 -s
+Scanning 127.0.0.1
+TCP/22 => REJECT
+Scanning 127.0.0.1
+TCP/8080 => ACCEPT
+
+Stressing...
+
+```
+
+See the help :
+```
+1648 justine@portnut > target/release/portnut -h
+A simple TCP port scanner / stresser. If stressing, you can pass a payload via a pipe
+
+Usage: portnut [OPTIONS] --address <ADDRESS>
+
+Options:
+  -a, --address <ADDRESS>  IP address to scan
+  -t, --timeout <TIMEOUT>  Timeout for each connection in seconds [default: 1]
+  -w, --wait <WAIT>        Number of milliseconds to wait in between scans when scanning OR duration of stress when stress testing (in seconds) [default: 30]
+  -p, --ports <PORTS>...   Ports to stress / scan, separated by commas (22,80)
+  -s, --stress             Set this flag to stress the ports instead of scanning them
+  -h, --help               Print help
+  -V, --version            Print version
+```