diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 19 insertions, 15 deletions
@@ -12,25 +12,25 @@ The connection flows are saved into a database and can be visualized with the we ## Installation There are two ways to install Caronte: -- with Docker and docker-compose, the fastest and easiest way -- manually installing dependencies and compiling the project +- with Docker and docker-compose, the fastest and easiest way +- manually installing dependencies and compiling the project ### 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` -- wait for the image to be compiled and open browser at `http://localhost:3333` +- clone the repo, with `git clone https://github.com/eciavatta/caronte.git` +- inside the `caronte` folder, run `docker-compose up --build -d` +- wait for the image to be compiled and open browser at `http://localhost:3333` ### Manually installation The first thing to do is to install the dependencies: -- go >= 1.14 [https://golang.org/doc/install](https://golang.org/doc/install) -- node >= v12 [https://nodejs.org/it/download/](https://nodejs.org/it/download/) -- yarnpkg [https://classic.yarnpkg.com/en/docs/install/](https://classic.yarnpkg.com/en/docs/install/) -- hyperscan >= v5 [https://www.hyperscan.io/downloads/](https://www.hyperscan.io/downloads/) +- go >= 1.14 [https://golang.org/doc/install](https://golang.org/doc/install) +- node >= v12 [https://nodejs.org/it/download/](https://nodejs.org/it/download/) +- yarnpkg [https://classic.yarnpkg.com/en/docs/install/](https://classic.yarnpkg.com/en/docs/install/) +- hyperscan >= v5 [https://www.hyperscan.io/downloads/](https://www.hyperscan.io/downloads/) Next you need to compile the project, which is composed of two parts: -- the backend, which can be compiled with `go mod download && go build` -- the frontend, which can be compiled with `cd frontend && yarn install && yarn build` +- the backend, which can be compiled with `go mod download && go build` +- the frontend, which can be compiled with `cd frontend && yarn install && yarn build` Before running Caronte starts an instance of MongoDB [https://docs.mongodb.com/manual/administration/install-community/](https://docs.mongodb.com/manual/administration/install-community/) that has no authentication. _Be careful not to expose the MongoDB port on the public interface._ @@ -45,7 +45,11 @@ 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 `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 -- an optional `accounts` array, which contains the credentials of authorized users +- 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 +- an optional `accounts` array, which contains the credentials of authorized users + +## Documentation +The backend, written in Go language, it is designed as a service. It exposes REST API that are used by the frontend written using React. The list of available APIs with their explanation is available here: [https://app.swaggerhub.com/apis-docs/eciavatta/caronte/WIP](https://app.swaggerhub.com/apis-docs/eciavatta/caronte/WIP) + |