diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..f44615e --- /dev/null +++ b/README.MD @@ -0,0 +1,22 @@ +# Suricata-Logger + +This sofware is aimed to everyone that would like +to have interactive feedback from Suricata, like +in CTF competitions, or Threat Analyses run +independently. + +## How to use it + +You need to start the software with `deno run` and +then run `suricata -i insert_tap_device_here`. + +> [!NOTE] +> This is ***not*** a comprehensive list on ***how to +> run Suricata***. As long as you have Suricata output +> its `eve` file like a `unix_stream` and modify the +> socket accordingly, everything should work. + +> [!CAUTION] +> Since you are streaming data, be sure to ***exclude +> this traffic*** from being logged, otherwise you'll +> have a ***feedback loop***