diff options
| author | Emiliano Ciavatta | 2020-09-30 21:21:40 +0000 |
|---|---|---|
| committer | Emiliano Ciavatta | 2020-09-30 21:21:40 +0000 |
| commit | efe02b4569d827c60fabf1d8b95074a7911b21bd (patch) | |
| tree | 3f27c135ce943b2f67c536c71af74f6dfc262960 /README.md | |
| parent | b4c9f42725356c3f38a39125b339b10fe900d527 (diff) | |
Update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 3 insertions, 4 deletions
@@ -1,10 +1,9 @@ -# [WIP] Caronte +# Caronte [](https://travis-ci.com/eciavatta/caronte) [](https://codecov.io/gh/eciavatta/caronte) [](https://www.codacy.com/manual/eciavatta/caronte?utm_source=github.com&utm_medium=referral&utm_content=eciavatta/caronte&utm_campaign=Badge_Grade) -<img align="left" src="https://divinacommedia.weebly.com/uploads/5/5/2/3/5523249/1299707879.jpg"> Caronte is a tool to analyze the network flow during capture the flag events of type attack/defence. It reassembles TCP packets captured in pcap files to rebuild TCP connections, and analyzes each connection to find user-defined patterns. The patterns can be defined as regex or using protocol specific rules. @@ -18,7 +17,7 @@ There are two ways to install Caronte: ### Run with Docker The only things to do are: - clone the repo, with `git clone https://github.com/eciavatta/caronte.git` -- inside the `caronte` folder, run `docker-compose up --build -d` +- inside the `caronte` folder, run `docker-compose up -d` - wait for the image to be compiled and open browser at `http://localhost:3333` ### Manually installation @@ -44,7 +43,7 @@ Run the binary with `./caronte`. The available configuration options are: ``` ## Configuration -The configuration takes place at runtime on the first start via the graphical interface (TO BE IMPLEMENTED) or via API. It is necessary to setup: +The configuration takes place at runtime on the first start via the graphical interface or via API. It is necessary to setup: - the `server_address`: the ip address of the vulnerable machine. Must be the destination address of all the connections in the pcaps. If each vulnerable service has an own ip, this param accept also a CIDR address. The address can be either IPv4 both IPv6 - the `flag_regex`: the regular expression that matches a flag. Usually provided on the competition rules page - `auth_required`: if true a basic authentication is enabled to protect the analyzer |