Overview
The RAPTOR devcontainer provides a complete, pre-configured development environment with all security tools, debuggers, and dependencies installed. This eliminates manual installation and ensures consistency across platforms.What's Included
- Python 3.12 environment
- All security testing tools (Semgrep, CodeQL, AFL++)
- Debuggers (GDB, rr)
- Build tools (gcc, clang, make, cmake)
- Browser automation (Playwright)
- All Python dependencies
Quick Start
Open in VS Code
Open the RAPTOR repository in VS Code or any compatible editor:Then use the command: Dev Container: Open Folder in Container
Wait for Build
The first build takes 5-10 minutes (container is ~6GB). Subsequent starts are instant.
Alternative: Docker Build
Build and run the container manually with Docker:The
--privileged flag is required for the rr debugger to function properly.Included Tools
Security Analysis Tools
Semgrep
Version: LatestPattern-based static analysis scanner
CodeQL CLI
Version: 2.15.5Semantic code analysis engine
AFL++
Version: LatestAmerican Fuzzy Lop fuzzer with enhancements
rr Debugger
Platform: Linux x86_64 onlyDeterministic record-replay debugger
Build & Debugging Tools
Compilers & Build Systems
Compilers & Build Systems
- gcc - GNU C/C++ compiler with coverage support (gcov)
- g++ - GNU C++ compiler
- clang-format - Code formatter
- make - Build automation
- cmake - Cross-platform build system
- autoconf, automake, libtool - GNU build tools
Debuggers
Debuggers
- gdb - GNU Debugger
- gdb-multiarch - Multi-architecture debugging
- rr - Record-replay debugger (Linux x86_64)
Binary Analysis
Binary Analysis
- binutils - GNU binary utilities (nm, addr2line, objdump, strings)
- file - File type identification
Web Testing (Alpha)
Playwright Browser Automation
Playwright Browser Automation
Pre-installed browsers:
- Chromium
- Firefox
- WebKit
Python Environment
- Python: 3.12
- Base Image:
mcr.microsoft.com/devcontainers/python:1-3.12-bookworm - Dependencies: All packages from
requirements.txtandrequirements-dev.txt - PYTHONPATH: Pre-configured for RAPTOR imports
Environment Configuration
The devcontainer sets up several environment variables:The PYTHONPATH configuration allows importing RAPTOR packages from anywhere:
Usage Instructions
Basic Workflow
Working Directory
The container’s working directory is/workspaces/raptor, which maps to your local repository.
Troubleshooting
rr debugger fails with 'Permission denied'
rr debugger fails with 'Permission denied'
Problem: rr requires kernel performance monitoring permissions.Solution:
- Ensure container runs with
--privilegedflag - Set kernel parameter (inside container):
- Or add to devcontainer.json:
CodeQL not found in PATH
CodeQL not found in PATH
Problem: CodeQL binary not accessible.Solution:
- Check installation:
- Manually add to PATH:
- Restart container if issue persists
Python module import errors
Python module import errors
Problem: Cannot import RAPTOR packages.Solution:
- Verify PYTHONPATH:
- Set manually if needed:
- Test import:
Container build fails or is very slow
Container build fails or is very slow
Problem: First build takes 5-10 minutes and downloads ~6GB.Solutions:
- Slow internet: Wait for download to complete (one-time only)
- Disk space: Ensure 10GB+ free space
- Build errors: Check Docker logs for specific errors
- Platform issues: Some tools (like rr) are Linux x86_64 only
AFL++ fuzzing not working
AFL++ fuzzing not working
Problem: AFL++ requires specific kernel configurations.Solution:
- Check AFL++ system settings:
- Apply recommended settings (may require privileged mode)
-
For testing, use AFL++ with
-dflag to disable CPU binding:
Playwright browsers not working
Playwright browsers not working
Problem: Playwright browser automation fails.Solution:
- Verify browsers are installed:
- Reinstall if needed:
- Check X11 for GUI (if needed):
Container Size & Performance
Container Size
~6GB total
- Base Python 3.12 image: ~2GB
- Security tools: ~1.5GB
- Playwright browsers: ~1.5GB
- Build tools & dependencies: ~1GB
Build Time
5-10 minutes (first time)
- Download: 3-5 minutes
- Build: 2-5 minutes
- Subsequent starts: <10 seconds
The container caches layers, so rebuilds after changes are fast (typically <1 minute).
OSS Forensics Configuration
For OSS forensics investigations, configure Google Cloud credentials:Create Service Account
- Go to Google Cloud Console
- Create a service account with BigQuery access
- Download credentials JSON file
See Dependencies for more details on Google Cloud BigQuery setup.
Customization
Modify.devcontainer/Dockerfile to customize the environment:
Platform Compatibility
Full Support
Linux (x86_64)All tools including rr debugger
Partial Support
macOS (ARM64) / Windows (WSL2)All tools except rr debuggerContainer builds with warnings for unavailable tools
Next Steps
Run Tests
Verify your environment with the test suite
Start Scanning
Begin using RAPTOR for security testing
Dependencies
Learn about licenses and restrictions
Contributing
Contribute to RAPTOR development