How abrignoni/aleapp works
Project type and purpose
• This is a standalone Python-based forensic tool called ALEAPP (Android Logs Events And Protobuf Parser).
• It provides both a CLI front-end (aleapp.py) and a GUI front-end (aleappGUI.py).
• It dynamically discovers and loads “artifact” plugins (in scripts/artifacts/) to parse Android artefact data from an extracted file system, archive or image, then generates HTML/TSV/timeline reports.
File structure
• Top-level:
• aleapp.py & aleappGUI.py – entry points for CLI and GUI.
• requirements.txt – Python dependencies.
• scripts/ – core engine:
– plugin_loader.py – dynamic loading of scripts/artifacts/* modules.
– report.py & artifact_report.py – HTML report generation.
– ilapfuncs.py – TSV and timeline helpers.
– filetypes/ – classification of input file types.
– ccl/ – support for compressed logs via leveldb, proto, snappy.
– pyinstaller/ – spec files for building executables.
– artifacts/ – >300 plugin scripts, each defining a __artifacts_v2__ dictionary and extraction function(s).
• The presence of CLI, GUI, plugin directory, file seeker, report modules suggests a modular, plugin-based architecture.
README for additional insights
• Confirms dynamic plugin architecture: each plugin registers metadata and a function to be invoked.
• Describes input types (zip|tar|fs|gz), output folder, HTML/TSV/timeline generation.
• Notes dependencies (Python ≥3.9, tkinter for GUI).
a. Main components
1) User Interface Layer
• CLI (aleapp.py)
2) Core Engine
• Argument Parser / Command Dispatcher
• FileSeeker (identifies files via scripts/filetypes/ & scripts/ccl/)
• Plugin Loader (plugin_loader.py)
• Artifact Plugins (scripts/artifacts/*.py)
3) Report Generation
• HTML report (artifact_report.py)
• TSV & Timeline (ilapfuncs.py)
4) Packaging (optional)
• PyInstaller specs (scripts/pyinstaller/*.spec)
5) Data I/O
• Input: extracted file tree (zip|tar|fs|gz)
• Output: report_folder/ with HTML, TSV, timeline files
b. Relationships and interactions
• User invokes CLI or GUI → Core Engine
• Core Engine parses args → initializes FileSeeker
• FileSeeker discovers candidate files → Plugin Loader
• Plugin Loader iterates __artifacts_v2__, for each plugin:
• Calls plugin function(files_found, report_folder, seeker, wrap_text)
• Plugin functions use artifact_report & ilapfuncs to write output
• Generated reports are stored under report_folder
c. Architectural patterns / design principles
• Plugin architecture (dynamic module loading, discovery by directory)
• Separation of concerns (UI vs core logic vs reporting)
• Modularization (file type detection, artifact extraction, output formatting)
• Data flow pipeline: Input → Discovery → Extraction → Reporting → Output
d. Key technologies & libraries
• Python ≥3.9 standard library (argparse, importlib)
• Tkinter (for GUI)
• PyInstaller (for packaging)
• Custom modules: plugin_loader.py, filetypes, ccl, artifact_report.py, ilapfuncs.py
• Blue rectangles for UI components
• Green for core engine modules
• Yellow for plugin artifacts
• Orange for report generators