How abrignoni/rleapp works
Project type and purpose
• From the README and file tree, RLEAPP is a Python-based DFIR (Digital Forensics and Incident Response) tool that can be run as a CLI or GUI.
• It ingests a data source (archive or file system), dynamically loads “artifact” plugins, parses forensic artifacts, and emits HTML/TSV reports and timeline data.
File structure
• Top‐level entrypoints:
• rleapp.py (CLI)
• rleappGUI.py (Tkinter GUI)
• Administrative:
• admin/docs, admin/scripts – module metadata/maintenance
• Assets:
• Dependency listing: requirements.txt
• scripts/ directory: the core of the system, subdivided into:
• plugin_loader.py – dynamically discovers and loads artifact modules
• artifacts/ – ~300+ individual artifact extractor modules, each defining __artifacts_v2__ and an entry function
• filetypes/ – classes to identify different file formats
• ilapfuncs.py & artifact_report.py & report*.py – reporting utilities (HTML, TSV, timeline)
• html_parts.py – HTML templating fragments
• parse3.py, lavafuncs.py, names/, areacodes/, etc. – supporting lookup & parsing data
• version_info.py – version metadata
• pyinstaller/ – packaging hooks and spec files for building standalone executables
Key architectural insights from README
• Core workflow:
Input → File seeker → Plugin loader → Artifact modules → Report generator
• Plugin contract (__artifacts_v2__, entry-point signature, output expectations)
• Support for both CLI parameters and GUI invocation
• Output: HTML reports, TSV exports, timeline records
1. User Interfaces
• CLI Runner (rleapp.py)
• GUI Runner (rleappGUI.py + Tkinter)
2. Core Engine
• Argument Parser & Controller
• File Seeker (discovers files based on paths/patterns)
• Plugin Loader (scans scripts/artifacts folder, loads __artifacts_v2__ dicts)
3. Artifact Modules
• Conforms to plugin contract, calls specific extraction functions
4. Supporting Libraries
• Filetype detectors (scripts/filetypes)
• Parsing utilities (parse3.py, lavafuncs.py)
• Data lookups (names/, areacodes/)
5. Reporting Layer
• HTML parts & ArtifactHtmlReport (artifact_report.py, html_parts.py)
• TSV and timeline generators (ilapfuncs.py)
6. Output Storage
• Report folder with HTML/TSV/timeline files
7. Packaging
• PyInstaller specs for building executables (scripts/pyinstaller)
• User clicks “Run CLI/GUI” → Core Engine
• Core Engine passes input path to File Seeker → returns list of candidate files
• Plugin Loader discovers artifact modules → for each, invokes its entry function with files_found, report_folder, seeker, wrap_text
• Artifact functions use filetypes & parsing utilities → produce rows of data
• Reporting Layer consumes rows → creates HTML, TSV, timeline outputs → writes to Output Storage
c. Architectural patterns & principles
• Plugin architecture: loose coupling between core engine and artifact modules
• Separation of concerns: file discovery vs. data extraction vs. report generation
• Extensibility: new artifacts simply drop in scripts/artifacts with correct __artifacts_v2__ signature
• Reusability: shared utility modules (filetypes, parse functions)
d. Key technologies & frameworks
• Python 3.9+
• Tkinter (for GUI)
• PyInstaller (for bundling executables)
• Standard libs: argparse, glob, importlib, datetime, html templating