Protocol Reverse Engineering Documentation¶
Welcome to the Protocol Reverse Engineering pipeline documentation.
Overview¶
This pipeline analyzes binary protocol traffic from PCAP files and automatically infers protocol structure, message types, field boundaries, and semantic roles without requiring prior protocol knowledge.
Documentation¶
Getting Started¶
- Getting Started Guide - Installation, prerequisites, first analysis, and basic usage
Technical Documentation¶
- Architecture - System design, components, and data flow
Contributing¶
- Documentation Guide - How to build and contribute to documentation
Quick Links¶
- Installation
- First Analysis
- Usage Guide
- Troubleshooting
- Pipeline Architecture
- Feature Modes
- LLM Integration
- Ground Truth Evaluation
Building Documentation¶
This project uses MkDocs with the Material theme.
Install MkDocs¶
pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python
Serve Locally¶
# From project root
mkdocs serve
# Open browser to http://127.0.0.1:8000
Build Static Site¶
# From project root
mkdocs build
# Output in site/ directory
Deploy to GitHub Pages¶
mkdocs gh-deploy
Support¶
For issues or questions, please refer to the Troubleshooting section or open an issue on GitHub.