Package: droidlysis
DroidLysisDroidLysis is apre-analysis tool for Android apps: it performs repetitive and boring tasks we'd typically do at the beginning of any reverse engineering. It disassembles the Android sample, organizes output in directories, and searches for suspicious spots in the code to look at.
The output helps the reverse engineer speed up the first few steps of analysis.DroidLysis can be used over Android packages (apk), Dalvik executables (dex), Zip files (zip), Rar files (rar) or directories of files.Quick setupCan't wait to use DroidLysis? Then, use a Docker container:$ docker pull cryptax/droidlysis:2023.05
$ docker run -it --rm -v /tmp/share:/share cryptax/droidlysis:2023.05  /bin/bash
$ cd /opt/droidlysis
$ python3 ./droidlysis3.py --helpInstalling DroidLysisInstall required system packagessudo apt-get install default-jre git python3 python3-pip unzip wget libmagic-dev libxml2-dev libxslt-devInstall Android disassembly toolsApktool,Baksmali, and optionallyDex2jarandProcyon(note that Procyon only works with Java 8, not Java 11).$ mkdir -p ~/softs
$ cd ~/softs
$ wget https://bitbucket.org/iBotPeaches/apktool/downloads/apktool_2.7.0.jar
$ wget https://bitbucket.org/JesusFreke/smali/downloads/baksmali-2.5.2.jar
$ wget https://github.com/pxb1988/dex2jar/releases/download/v2.2-SNAPSHOT-2021-10-31/dex-tools-2.2-SNAPSHOT-2021-10-31.zip
$ unzip dex-tools-2.2-SNAPSHOT-2021-10-31.zip 
$ rm -f dex-tools-2.2-SNAPSHOT-2021-10-31.zipGet DroidLysis from the Git repository (preferred) or from pipInstall from Git in a Python virtual environment:$ python3 -m venv venv
$ source ./venv/bin/activate
(venv) $ pip3 install git+https://github.com/cryptax/droidlysisAlternatively, you can install DroidLysis directly from PyPi (pip3 install droidlysis).Configureconf/general.conf. In particular make sure to change/home/axellewith your appropriate directories.[tools]
apktool = /home/axelle/softs/apktool_2.7.0.jar
baksmali = /home/axelle/softs/baksmali-2.5.2.jar
dex2jar = /home/axelle/softs/dex-tools-2.2-SNAPSHOT/d2j-dex2jar.sh
procyon = /home/axelle/softs/procyon-decompiler-0.5.30.jar
keytool = /usr/bin/keytool
...Run it:python3 ./droidlysis3.py --helpConfigurationThe configuration file is./conf/general.conf(you can switch to another file with the--configoption).
This is where you configure the location of various external tools (e.g. Apktool), the name of pattern files
(by default./conf/smali.conf,./conf/wide.conf,./conf/arm.conf,./conf/kit.conf) and the name of
the database file (only used if you specify--enable-sql)Be sure to specify the correct paths for disassembly tools, or DroidLysis won't find them.UsageDroidLysis usesPython 3. To launch it and get options:droidlysis --helpFor example, test it onSignal's APK:droidlysis --input Signal-website-universal-release-4.52.4.apk --output /tmpDroidLysis outputs:A summary on the console (see image above)The unzipped, pre-processed sample in a subdirectory of your output dir. The subdirectory is named using the sample's filename and sha256 sum. For example, if we analyze the Signal application and set--output /tmp, the analysis will be written to/tmp/Signalwebsiteuniversalrelease4.52.4.apk-f3c7d5e38df23925dd0b2fe1f44bfa12bac935a6bc8fe3a485a4436d4487a290.A database (by default, SQLitedroidlysis.db) containing properties it noticed.OptionsGet usage withdroidlysis --helpThe input can be a file or a directory of files to recursively look into. DroidLysis knows how to process Android packages, DEX, ODEX and ARM executables, ZIP, RAR. DroidLysis won't fail on other type of files (unless there is a bug...) but won't be able to understand the content.When processing directories of files, it is typically quite helpful to move processed samples to another location to know what has been processed. This is handled by option--movein.  Also, if you are only interested in statistics, you should probably clear the output directory which contains detailed information for each sample: this is option--clearoutput. If you want to store all statistics in a SQL database, use--enable-sql(seehere)DEX decompilation is quite long with Procyon, so this option isdisabledby default. If you want to decompile to Java, use--enable-procyon.DroidLysis's analysis does not inspect known 3rd party SDK by default, i.e. for instance it won't report any suspicious activity from these. If you want them to be inspected, use option--no-kit-exception. This usually creates many more detected properties for the sample, as SDKs (e.g. advertisment) use lots of flagged APIs (get GPS location, get IMEI, get IMSI, HTTP POST...).Sample output directory (--output DIR)This directory contains (when applicable):A readableAndroidManifest.xmlReadable resources inresLibrarieslib, assetsassetsDisassembled Smali code:smali(and others)Package meta information:META-INFPackage contents when simply unzipped in./unzippedDEX executableclasses.dex(and others), and converted to jar:classes-dex2jar.jar, and unjarred in./unjarredThe following files are generated by DroidLysis:autoanalysis.md: lists each pattern DroidLysis detected and where.report.md: same as what was printed on the consoleIf you do not need the sample output directory to be generated, use the option--clearoutput.SQLite database{#sqlite_database}If you want to process a directory of samples, you'll probably like to store the properties DroidLysis found in a database, to easily parse and query the findings. In that case, use the option--enable-sql. This will automatically dump all results in a database nameddroidlysis.db, in a table namedsamples. Each entry in the table is relative to a given sample. Each column is properties DroidLysis tracks.For example, to retrieve all filename, SHA256 sum and smali properties of the database:sqlite> select sha256, sanitized_basename, smali_properties from samples;
f3c7d5e38df23925dd0b2fe1f44bfa12bac935a6bc8fe3a485a4436d4487a290|Signalwebsiteuniversalrelease4.52.4.apk|{"send_sms": true, "receive_sms": true, "abort_broadcast": true, "call": false, "email": false, "answer_call": false, "end_call": true, "phone_number": false, "intent_chooser": true, "get_accounts": true, "contacts": false, "get_imei": true, "get_external_storage_stage": false, "get_imsi": false, "get_network_operator": false, "get_active_network_info": false, "get_line_number": true, "get_sim_country_iso": true,
...Property patternsWhat DroidLysis detects can be configured and extended in the files of the./confdirectory.A pattern consist of:atagname: examplesend_sms. This is to name the property. Must be unique across the.conffile.apattern: this is a regexp to be matched. Ex:;->sendTextMessage|;->sendMultipartTextMessage|SmsManager;->sendDataMessage. In thesmali.conffile, this regexp is match on Smali code. In this particular case, there are 3 different ways to send SMS messages from the code: sendTextMessage, sendMultipartTextMessage and sendDataMessage.adescription(optional): explains the importance of the property and what it means.[send_sms]
pattern=;->sendTextMessage|;->sendMultipartTextMessage|SmsManager;->sendDataMessage
description=Sending SMS messagesImporting Exodus Privacy TrackersExodus Privacy maintains a list of various SDKs which are interesting to rule out in our analysis viaconf/kit.conf.
Add option--import_exodusto the droidlysis command line: this will parse existing trackers Exodus Privacy knows and which aren't yet in yourkit.conf. Finally, it willappendall new trackers to~/.cache/droidlysis/kit.conf.Afterwards, you may want to sort yourkit.conffile:importconfigparserimportcollectionsimportosconfig=configparser.ConfigParser({},collections.OrderedDict)config.read(os.path.expanduser('~/.cache/droidlysis/kit.conf'))# Order all sections alphabeticallyconfig._sections=collections.OrderedDict(sorted(config._sections.items(),key=lambdat:t[0]))withopen('sorted.conf','w')asf:config.write(f)Updatesv3.4.5 - Creating a writable user kit.conf filev3.4.4 - Bug fix #14v3.4.3 - Using configuration filesv3.4.2 - Adding import of Exodus Privacy Trackersv3.4.1 - Removed dependency to Androguardv3.4.0 - Multidex supportv3.3.1 - Improving detection of Base64 stringsv3.3.0 - Dumping data to JSONv3.2.1 - IP address detectionv3.2.0 - Dex2jar is optionalv3.1.0 - Detection of Base64 strings