vamp-entropy-watch

Real-time Shannon entropy monitor for early ransomware detection and encrypted file analysis
VampSecure Labs · Security Research Division

---

Overview

vamp-entropy-watch monitors directories for ransomware activity by computing the Shannon entropy of files as they are created or modified. Encrypted content approaches the theoretical maximum of 8 bits/byte and is statistically distinguishable from plaintext (~3–5 bits/byte) and even from legitimately compressed data (~7–7.5 bits/byte). When a file exceeds the configured entropy threshold, the tool raises an alert and optionally moves the file to a quarantine directory with read-only permissions to contain further damage.

It operates in two modes: a continuous monitor mode with a live Rich terminal table, and a one-shot scan mode for point-in-time audits and CI/CD pipeline integration.

Features

• Shannon entropy calculation per file: H(X) = −Σ P(xᵢ) · log₂ P(xᵢ) over all 256 byte values; reads up to 1 MB per file for performance on large datasets
• Four entropy levels: ENCRYPTED (≥ threshold, default 7.0) / HIGH (≥ 88% of threshold) / MEDIUM (≥ 5.0) / SAFE (< 5.0)
• Continuous monitor mode with mtime/size change detection and configurable polling interval; displays a live-updating Rich table sorted by entropy descending
• Automatic quarantine — moves alert-triggering files to a configurable quarantine directory and sets them read-only (0o444) to prevent further modification; collision-safe naming with timestamp prefix
• One-shot scan mode — processes all files in the target directory once, prints the entropy table, and optionally exports JSON output sorted by entropy descending
• Recursive directory support via --recursive flag in both modes
• Default extension exclusions for already-compressed/binary formats (.jpg, .zip, .gz, .exe, .dll, etc.) that would generate spurious alerts
• Configurable entropy threshold — adjust to match the specific file corpus: --threshold 7.5 for stricter detection, --threshold 6.5 for broader coverage
• JSON export with per-file entropy, status label, size in bytes, and scan metadata
• Unified VSL client report (HTML/PDF) via --report-html / --report-pdf in both modes

Requirements

pip install -r requirements.txt

Package	Version
rich	>= 13.7.0

Standard library: argparse, json, math, os, shutil, sys, time, datetime, pathlib.

Installation

pip install vamp-entropy-watch
# o con Homebrew:
brew install vampsecure-labs/labs/vamp-entropy-watch

git clone https://github.com/belky-me/vamp-entropy-watch.git
cd vamp-entropy-watch
pip install -r requirements.txt

Usage

python vamp_entropy_watch.py --help

Two subcommands are available: monitor and scan.

usage: vamp-entropy-watch {monitor,scan} ...

subcommands:
  monitor   Continuous directory surveillance
  scan      One-shot entropy audit

Examples

Continuously monitor the current directory with default threshold (7.0):

python vamp_entropy_watch.py monitor

Monitor a specific path, recursive, with quarantine enabled:

python vamp_entropy_watch.py monitor -p /data/uploads -r --quarantine /data/quarantine

Monitor without automatic quarantine (alert-only mode):

python vamp_entropy_watch.py monitor -p /var/www --no-quarantine

Monitor with a stricter threshold and 5-second polling interval:

python vamp_entropy_watch.py monitor -p /home --threshold 7.5 --interval 5

One-shot scan, recursive, export results to JSON:

python vamp_entropy_watch.py scan -p /srv/data -r -o entropy_report.json

One-shot scan with lowered threshold for broader suspicious-file coverage:

python vamp_entropy_watch.py scan -p . --threshold 6.5

Entropy Level Reference

Label	Entropy Range	Typical Content
ENCRYPTED	≥ 7.0 (configurable)	Ransomware output, AES/ChaCha ciphertext
HIGH	≥ ~6.2	Dense binary, some archive formats
MEDIUM	≥ 5.0	Mixed binary/text, executables
SAFE	< 5.0	Plaintext, source code, HTML

Output Formats

Format	Flag	Description
Console (Rich)	(default)	Live table with per-file entropy, status, size, and detection time
JSON	-o FILE (scan mode)	Structured report with scan metadata and file list sorted by entropy

Exit Codes

Code	Meaning
0	No files exceeded the alert threshold
1	One or more files exceeded the alert threshold

Part of VampSecure Labs Toolkit

This tool is part of the VampSecure Labs Security Toolkit — a collection of research-grade security tools for authorized penetration testing and red/blue team exercises.

• Full toolkit: github.com/belky-me
• Orchestrator: github.com/belky-me/vamp-orchestrator

---

© VampSecure Studios — VampSecure Labs Security Research Division
For authorized security testing only.

---

Versión

v2.1 — VampSecure Labs Security Research Division