How maaz-ansari-cys/digital-forensics-tool-vellum-ir- works
VellumIR is an offline DFIR investigation platform: an analyst creates a case, uploads artifacts, and receives normalized events, detections, correlated attack sessions, enrichment, dashboard views, and downloadable reports. Flask coordinates ingestion and analysis; format detection dispatches to the unified parser set, while SQLite persists case evidence and analysis results. The README documents all seven parser formats and the dashboard/reporting capabilities; some wiring and subsystems are represented at their exact directory path because their implementation was not sampled. Dashed edges mark UI/API interaction not directly shown in the excerpts.
Main entry points: app.py Flask API · enrichment.py IP Enrichment · detector.py Format Detector · parsers Log Parsers
Components 18
Evidence Ingestion
- Flask API
app.py - Format Detector
core/detector.py - Log Parsers
parsers - Event Normalizer
core/normalizer.py
Forensic Analysis
- Detection Rules
core/rules.py - Session Correlator
core/correlator.py - Time Filtering
core/time_filter.py - Dashboard Metrics
core/extended_metrics.py
Threat Intelligence
- IOC Matching
intel/ioc_matcher.py - IP Enrichment
intel/enrichment.py
Case Data
- SQLite Evidence Store
core/storage.py
Investigation Outputs
- Web Interface
web - Executive Summary
reports/summary_generator.py - Remediation Guidance
reports/recommendations.py - HTML Reports
reports/html_report.py - PDF Reports
reports/pdf_report.py
Other components
- Analyst
- ip-api.com
Connections 18
- Analyst → Web Interface: uses
README.md - Web Interface → Flask API: calls API
- Flask API → Format Detector: detects formats
app.py - Format Detector → Log Parsers: dispatches to
core/detector.py - Log Parsers → Event Normalizer: normalizes events
parsers/auth_log.py - Flask API → SQLite Evidence Store: persists evidence
app.py - Flask API → Detection Rules: runs detection
app.py - Flask API → Session Correlator: correlates events
app.py - Flask API → Time Filtering: filters metrics
app.py - Flask API → Dashboard Metrics: gets metrics
app.py - Flask API → IOC Matching: matches indicators
app.py - Flask API → IP Enrichment: enriches IPs
app.py - IP Enrichment → ip-api.com: queries
intel/enrichment.py - IP Enrichment → SQLite Evidence Store: caches results
intel/enrichment.py - Flask API → Executive Summary: generates summary
app.py - Flask API → Remediation Guidance: gets guidance
app.py - Flask API → HTML Reports: generates report
app.py - Flask API → PDF Reports: generates report
app.py