Repository files navigation

If you want to contribute hit me up on twitter:https://twitter.com/AlexisBrignoni

Details in blog post here:https://abrignoni.blogspot.com/2020/02/aleapp-android-logs-events-and-protobuf.html

Python 3.9 or above (older versions of 3.x will also work with the exception of one or two modules)

Dependencies for your python environment are listed inrequirements.txt. Install them using the below command. Ensurethepy part is correct for your environment, egpy,python, orpython3, etc.

py -m pip install -r requirements.txtorpip3 install -r requirements.txt

To run onLinux, you will also need to installtkinter separately like so:

sudo apt-get install python3-tk

To compile to an executable so you can run this on a system without python installed.

To create aleapp.exe, run:

pyinstaller --onefile aleapp.spec

To create aleappGUI.exe, run:

pyinstaller --onefile --noconsole aleappGUI.spec

$ python aleapp.py -t <zip | tar | fs | gz> -i <path_to_extraction> -o <path_for_report_output>

$ python aleappGUI.py

$ python aleapp.py --help

Each plugin is a Python source file which should be added to thescripts/artifacts folder which will be loaded dynamically each time ALEAPP is run.

The plugin source file must contain a dictionary named__artifacts_v2__ at the very beginning of the module, which defines the artifacts that the plugin processes. The keys in the__artifacts_v2__ dictionary should be IDs for the artifact(s) which must be unique within ALEAPP. The values should be dictionaries containing the following keys:

• name: The name of the artifact as a string.
• description: A description of the artifact as a string.
• author: The author of the plugin as a string.
• version: The version of the artifact as a string.
• date: The date of the last update to the artifact as a string.
• requirements: Any requirements for processing the artifact as a string.
• category: The category of the artifact as a string.
• notes: Any additional notes as a string.
• paths: A tuple of strings containing glob search patterns to match the path of the data that the plugin expects for the artifact.
• function: The name of the function which is the entry point for the artifact's processing as a string.

For example:

__artifacts_v2__= {"cool_artifact_1": {"name":"Cool Artifact 1","description":"Extracts cool data from database files","author":"@username","version":"0.1","date":"2022-10-25","requirements":"none","category":"Really cool artifacts","notes":"","paths": ('*/com.android.cooldata/databases/database*.db',),"function":"get_cool_data1"    },"cool_artifact_2": {"name":"Cool Artifact 2","description":"Extracts cool data from XML files","author":"@username","version":"0.1","date":"2022-10-25","requirements":"none","category":"Really cool artifacts","notes":"","paths": ('*/com.android.cooldata/files/cool.xml',),"function":"get_cool_data2"    }}

The functions referenced as entry points in the__artifacts__ dictionary must take the following arguments:

• An iterable of the files found which are to be processed (as strings)
• The path of ALEAPP's output folder(as a string)
• The seeker (of type FileSeekerBase) which found the files
• A Boolean value indicating whether or not the plugin is expected to wrap text

For example:

defget_cool_data1(files_found,report_folder,seeker,wrap_text):pass# do processing here

Plugins are generally expected to provide output in ALEAPP's HTML output format, TSV, and optionally submit records tothe timeline. Functions for generating this output can be found in theartifact_report andilapfuncs modules.At a high level, an example might resemble:

__artifacts_v2__= {"cool_artifact_1": {"name":"Cool Artifact 1","description":"Extracts cool data from database files","author":"@username",# Replace with the actual author's username or name"version":"0.1",# Version number"date":"2022-10-25",# Date of the latest version"requirements":"none","category":"Really cool artifacts","notes":"","paths": ('*/com.android.cooldata/databases/database*.db',),"function":"get_cool_data1"    }}importdatetimefromscripts.artifact_reportimportArtifactHtmlReportimportscripts.ilapfuncsdefget_cool_data1(files_found,report_folder,seeker,wrap_text):# let's pretend we actually got this data from somewhere:rows= [     (datetime.datetime.now(),"Cool data col 1, value 1","Cool data col 1, value 2","Cool data col 1, value 3"),     (datetime.datetime.now(),"Cool data col 2, value 1","Cool data col 2, value 2","Cool data col 2, value 3"),    ]headers= ["Timestamp","Data 1","Data 2","Data 3"]# HTML output:report=ArtifactHtmlReport("Cool stuff")report_name="Cool DFIR Data"report.start_artifact_report(report_folder,report_name)report.add_script()report.write_artifact_data_table(headers,rows,files_found[0])# assuming only the first file was processedreport.end_artifact_report()# TSV output:scripts.ilapfuncs.tsv(report_folder,headers,rows,report_name,files_found[0])# assuming first file only# Timeline:scripts.ilapfuncs.timeline(report_folder,report_name,rows,headers)

This tool is the result of a collaborative effort of many people in the DFIR community.