How limseonghyeon/volatility3_ui works
Project Type and Purpose
• This is a single-repo, full-stack Python application using Streamlit to provide a web UI for Volatility3 memory forensics on Windows.
• The front-end (UI folder) handles user interactions, while the back-end (common folder + external Volatility3 CLI) executes forensic analysis asynchronously.
File Structure Analysis
• Top-level
• main.py: Streamlit entrypoint
• requirements.txt / fix_encoding.bat / .env (user-provided): environment & dependency config
• resources/: JSON config for plugins & welcome text
• UI/
• config.py: loads environment variables & JSON plugin files
• navbar.py, mainSection.py, components.py, async_components.py, explain.py: Streamlit UI widgets & layout
• common/
• async_manager.py: manages asyncio tasks & progress updates
• volatility.py (in README as volatility.py, named volatility.py in common): wraps calls to external Volatility3 CLI using subprocess
• cache_manager.py: caches intermediate results to avoid re-runs
• utils.py: shared helper functions (parsing, file I/O, CSV export)
Key Architecture Insights from README
• Asynchronous, non-blocking analysis with real-time progress updates
• Category-based plugin system (system info, process, network, malware, advanced, PID)
• Local file I/O for result dumps and CSV exports
• External dependency: Volatility3 CLI (configured via VOL_PATH in .env)
a. Main Components
1. Browser / Client: interacts with Streamlit front-end via HTTP/websocket
2. Streamlit Server (main.py)
3. UI Layer (UI/*.py)
4. Business Logic Layer (common/*.py)
5. Configuration Layer (resources/*.json, .env)
6. External Service: Volatility3 CLI (vol.py)
7. Local Storage: file system for dumps, CSV, cache
b. Relationships & Data Flow
1. User actions in browser → HTTP/WebSocket → Streamlit Server
2. UI Layer → calls async_manager to launch analysis tasks
3. async_manager → spawns subprocess to run Volatility3 CLI via volatility.py
4. Volatility3 → returns raw results → cache_manager stores parsed output → async_manager updates progress
5. Results → utils formats as tables/CSV → UI Layer updates UI in real time
6. On export → UI writes CSV/dump files to OUTPUT_PATH
c. Architectural Patterns & Principles
• Layered separation: Presentation (UI), Application (async manager + business logic), Infrastructure (file system, external CLI)
• Asynchronous/event-driven pattern for non-blocking analysis
• Plugin-based extensibility: JSON-driven categories for dynamic loading of commands
• Single process, modular Python package
d. Key Technologies
• Python 3.8+
• Streamlit 1.28+ for front-end
• asyncio & subprocess in async_manager & volatility.py
• JSON config files for plugin definitions
• Local FS I/O for caches, dumps, CSV exports