Metadata-Version: 2.5
Name: malvbox
Version: 1.0.8
Summary: Offensive-security container CLI wired to the malveillance platform VPN
License-Expression: MIT
Keywords: docker,offensive-security,pentest,wireguard
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# malvbox

An all-in-one offensive-security container, wired straight to the **malveillance**
platform VPN. Name it, launch it, work — in a single command.

## Install

```bash
pipx install malvbox
```

**Requirements:** Docker, bash (already present on Linux/WSL/macOS), and the
`wireguard` kernel module.

The package ships only the launcher. The full toolset (Kali + wordlists +
privesc scripts + a large curated tool set) lives in the Docker image
`ghcr.io/loicosternaud/malvbox:default`, pulled automatically on first run.

## Use

```bash
# 1. Download your VPN config from your platform profile  ->  malveillance.conf
# 2. Launch a named box, plugged into the VPN, sharing a folder:
malvbox start redteam --vpn ~/malveillance.conf -s ~/share
```

Inside the box:

```bash
ip a show wg           # your 10.98.x.y VPN address
nmap -sn 10.13.0.0/24  # the target range
firefox                # opens on your screen (FoxyProxy preset for Burp/Caido)
```

Graphical tools display on your screen automatically. Your `~/work` folder is a
persistent volume that survives restarts.

## Commands

| Command | What it does |
|---|---|
| `malvbox start <name>` | create the box (or reopen it) and drop into a shell |
| `malvbox exec <name> <cmd…>` | run a command without opening a shell |
| `malvbox update <name>` | pull the latest image and recreate the box |
| `malvbox info <name>` | show a box's status and mounts |
| `malvbox list` | list boxes and their state |
| `malvbox stop <name>` | stop a box (workspace kept) |
| `malvbox rm <name> --purge` | remove a box and its workspace |
