maltrail

(β˜… 8,582)

Malicious traffic detection system

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .gitattributes
  • .gitignore
  • CHANGELOG
  • CITATION.cff
  • install.sh
  • LICENSE
  • maltrail-sensor.service
  • maltrail-server.service
  • maltrail.conf
  • README.md
  • ruff.toml
  • SECURITY.md
  • server.py

# Installation Guide

1. Get the code
git clone https://github.com/stamparm/maltrail

Downloads the entire project code from GitHub to your computer.

cd maltrail

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
curl -fsSL https://raw.githubusercontent.com/stamparm/maltrail/master/install.sh | sudo sh

Type this command into your terminal and run it.

sudo apt-get install cargo libpcap-dev libcap2-bin python3

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker/docker-compose.yml up -d

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r old/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python server.py

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
sudo apt-get install cargo libpcap-dev libcap2-bin python3

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo dnf install cargo libpcap-devel libcap python3

Type this command into your terminal and run it.

sudo zypper install cargo rust libpcap-devel libcap-progs python311

Type this command into your terminal and run it.

cargo build --release --manifest-path sensor/Cargo.toml

Compiles the Rust project.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation