Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 4.63 KB

README.md

File metadata and controls

101 lines (67 loc) · 4.63 KB
Raw

Android Package (APK) Permission and Tracking Analysis Tool

A simple tool to statically analyze permission references and trackers within decompiled Android apps.

Context

With the release of Android 6.0 (Android M / API Level 23), users can now grant system and 3rd party permissions at runtime instead of during installation.

This increases an application's susceptibility to over and underprivileging. If a normal (as opposed to dangerous) permission is defined in the app manifest, the system grants that permission automatically -- even if the app is not using the permission directly. However, users can grant all permissions, including dangerous, within a permission group by requiring a single permission. This may result in overprivileging.

Setup

APKPerm (Android PacKage PERMission, apkperm) requires Python >=3.5 and the latest openJDK release.

Before your first run, please, follow those steps:

  • Use your distribution package manager to install the dexdump tool;

  • Install the required python modules:

$ pip install -r ./requirements.txt
  • Execute the setup.py file to download the third-party libraries:
$ python3 ./setup.py

Once it's done, you'll find the appropriate libraries under the ./lib/ directory.

Bellow you'll find a list with all required third-party libraries:

Dependencies

Usage

The tool can be run incrementally with the following flags:

$ python3 apkperm.py -d [--decompile] apk_path              # decompiles APK and moves it to sample_apk/ - This could take a few minutes depending on the size of the APK
$ python3 apkperm.py -a [--analyze]   decompiled_apk_path [android_api_version_number_targeted]   # analyze and prints source report / analysis report against the specified API level number

Or in a single pass, like this:

$ python3 apkperm.py -f [--fullprocess]   apk_path [android_api_version_number_targeted]   # decompiles APK, analyzes against the specified API level number and prints source report / analysis report, then deletes the decompiled source folder

You can provide any version of the API between 23 and 29 for analysis.

As output the software will generate a couple of files inside of the ./reports/ folder:

  • source_report_package_name.txt - Includes all files and code snippets where calls to permissions were made;
  • analysis_package_name.txt - Includes an in-depth analysis about permissions found in the source analysis;
  • analysis_package_name.json - A JSON version of the previous file;
  • trackers_package_name.json - Includes all third-party and trackers found in the source analysis;
  • package_name.csv - A resume of all information found during the static analysis.

Troubleshooting

In the event of any issues, please:

  1. Make sure you have the latest versions of the required libraries;
  2. Make sure the apps being examined are compatible with Android API 23 (Marshmallow) or greater.

In any case, please feel free to fill a bug report if you think something is wrong on our side.

Acknowledgement

This tool is a partial rewrite of the original MPermission code, written by the following amazing and Free Software loving people:

  • Piper Chester
  • Daniel Krutz
  • Cesar Perez
  • Chris Jones

Big Hugs!

References

  1. http://developer.android.com/guide/topics/security/permissions.html#normal-dangerous
  2. https://www.wikiwand.com/en/Android_application_package
  3. https://git-scm.com/book/en/v2/Git-Tools-Submodules
  4. https://github.com/kocsenc/android-scraper/tree/master/tools/apk-decompiler/
  5. https://github.com/dan7800/MPermission/wiki
  6. http://ibotpeaches.github.io/Apktool/
  7. https://sourceforge.net/projects/dex2jar/files/
  8. https://github.com/nviennot/jd-core-java
  9. http://www.oracle.com/technetwork/pt/java/javase/downloads/index.html
  10. https://www.mercurial-scm.org/
  11. https://exodus-privacy.eu.org/en/