RepoReaver

Pre-clone repo security scanner. Answers one question: "Can this codebase safely be cloned, reviewed, built, or executed?"

Quick Start

pip install reporeaver
reporeaver scan ./suspicious-repo
reporeaver scan project.zip --html report.html --sarif results.sarif

What It Catches

Installation

# Core (includes YAML policy support)
pip install reporeaver

# With dashboard server
pip install reporeaver[dashboard]

# Everything
pip install reporeaver[all]

# From source
git clone https://github.com/srinathsankara/reporeaver.git
cd reporeaver
pip install -e ".[all]"

Usage

Scan Commands

reporeaver scan ./repo                          # Basic scan
reporeaver scan ./repo --verbose                 # Include medium-severity findings
reporeaver scan archive.zip --html report.html   # Scan archive, generate HTML dashboard
reporeaver scan . --diff-only                    # Only scan files changed in this branch
reporeaver scan . --skip entropy,behavioral      # Disable specific analyzers
reporeaver scan . --no-cache                     # Disable content-based caching
reporeaver scan . --policy my-policy.yaml        # Custom policy file

Output Formats

reporeaver scan ./repo --json                    # Machine-readable JSON
reporeaver scan ./repo --sarif results.sarif     # SARIF (GitHub Security tab)
reporeaver scan ./repo --html report.html        # Self-contained HTML dashboard

View History

reporeaver history --last 20                     # Recent scans
reporeaver history --stats                       # Aggregate stats
reporeaver history --delete 3                    # Delete a scan record

Dashboard Server

reporeaver dashboard                             # Launch at http://127.0.0.1:9520

# With auth token
REPOREAVER_DASHBOARD_TOKEN=my-secret reporeaver dashboard

# Custom host/port
reporeaver dashboard --host 0.0.0.0 --port 9000

Pre-commit Hook

reporeaver init-precommit                        # Installs hook into .git/hooks/
# Runs on staged files before every commit. Bypass with: git commit --no-verify

Configuration Files

RepoReaver auto-discovers these config files in order:

1. ./reporeaver.yaml
2. ./.reporeaver.yaml
3. ~/.config/reporeaver/config.yaml

Example reporeaver.yaml:

severity_threshold: high
skip_analyzers:
  - entropy
  - yara
max_size_mb: 5
policy: my-policy.yaml

GitHub Action

# .github/workflows/reporeaver.yml
name: RepoReaver Security Gate
on: [push, pull_request]
jobs:
  security-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: reporeaver/reporeaver@v1
        with:
          target: .
          severity-threshold: high
          diff-only: true
          github-token: ${{ github.token }}

The Action:

• Fails CI if risk score exceeds threshold
• Posts a GitHub Check Run with score and summary
• Uploads SARIF to GitHub Security tab
• Attaches HTML/JSON/SARIF as workflow artifacts

Docker

docker build -t reporeaver .
docker run --rm -v "${PWD}:/scan" reporeaver scan /scan
docker run --rm -v "${PWD}:/scan" reporeaver scan /scan --html /scan/report.html

Architecture

reporeaver/
├── cli.py                 # argparse CLI: scan, dashboard, history, init-precommit
├── engine.py              # Orchestrator: ingest -> analyze -> score -> output
├── models.py              # Finding, RiskScore, FileEntry, ScanResult
├── policy.py              # YAML policy engine (allow/block/severity)
├── config.py              # Auto-discover reporeaver.yaml
├── logging.py             # Structured logging to file + console
├── history.py             # SQLite scan history (for dashboard)
├── feeds.py               # OSV, MalwareBazaar, C2 threat feed integration
├── hooks.py               # Pre-commit hook installer
├── analyzers/             # 15 plugin-based detection modules
│   ├── base.py            # Plugin base class + registry
│   ├── svg_analyzer.py, unicode_analyzer.py, secrets_analyzer.py, ...
├── deobfuscation/         # Unicode, encoding, JS deobfuscation
├── ingest/                # File, directory, archive (recursive) ingest
├── output/                # Report, SARIF, HTML dashboard
├── ui/                    # FastAPI dashboard server
└── utils/                 # MIME detection, sandbox

Security Model

• Never executes repo code on host — all analysis is static
• Offline by default — threat feeds are opt-in, cached locally
• Sandboxed extraction — archives extracted to isolated temp dirs
• No shell injection — all subprocess.run() calls use list form, never shell=True
• Safe YAML — uses yaml.safe_load(), not yaml.load()
• Minimal dependencies — core requires only pyyaml

Exit Codes

Development

git clone https://github.com/srinathsankara/reporeaver.git
cd reporeaver
pip install -e ".[dev]"
python -m pytest tests/ -v
python -m reporeaver scan ./tests/fixtures

Contributing

See CONTRIBUTING.md. All contributions welcome — bugs, features, docs, tests.

License

MIT. See LICENSE.

Related Projects

• truffleHog — secrets scanning
• Gitleaks — git secrets scanning
• Semgrep — static analysis
• Checkov — IaC security
• Bearer — SAST for data security