aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc7a9dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# preload-slowloris
+
+This library hooks the send(2) and socket(2) symbols and forces the data on
+sockets of SOCK_STREAM type (most likely TCP, might also work on other stream
+protocols) to be split into multiple segments for transmit.
+
+## Building
+
+Running `make` should suffice on a system with a working C compiler.
+
+## Usage
+
+Force the library to be loaded using `LD_PRELOAD`
+
+```shell
+LD_PRELOAD=./slowloris.so curl 10.23.25.3
+```
+
+A delay between individual send() calls (in microseconds) can be set by
+providing `SLOWLORIS_DELAY` like so:
+
+```shell
+SLOWLORIS_DELAY=1000 LD_PRELOAD=./slowloris.so curl 10.23.25.3
+```