Android_Activity_Swagger

Give the Swagger (or hints) of Android Activities from apk

Prerequisites

You need a decompiled apk file, using jadx for instance:

$ ls base.apk
$ jadx base.apk -d decompiled_apk/
$ cd decompiled_apk/

Usage

$ python Android_Activity_Swagger.py --help
usage: Android_Activity_Swagger.py [-h] [--version] [--package PACKAGE] [--adb] [--verbose] [--read-manifest] [--directory DIRECTORY] activity

positional arguments:
  activity              Activity

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --package PACKAGE, -p PACKAGE
                        Package.
  --adb, -a             ADB helper.
  --verbose, -v         Verbose output.
  --read-manifest, -r   Read AndroidManifest.xml and extract exported activities.
  --directory DIRECTORY, -d DIRECTORY
                        Base directory

Examples

# List all exported activities
$ python Android_Activity_Swagger.py -r tests/AndroidManifest.xml
Package: com.example

com.example.activity.MyLauncherActivity
com.example.activity.WrongName
com.example.ui.RoutingActivity

# Display com.example.activity.WrongName
$ python Android_Activity_Swagger.py com.example.activity.WrongName -d tests/
[tests/com/example/activity/WrongName.java:+43] [onCreate]                 this.f4672b = getIntent().getExtras();
[tests/com/example/activity/WrongName.java:+53] [onCreate]             if (this.f4672b != null && this.f4672b.getBoolean("open_from_notification", false)) {
[tests/com/example/activity/WrongName.java:+54] [onCreate]                 if (this.f4672b.getBoolean("open_from_reminder_notification", false)) {
[tests/com/example/activity/WrongName.java:+56] [onCreate]                 } else if (this.f4672b.getBoolean("open_from_abandonned_cart_notification", false)) {
[tests/com/example/activity/WrongName.java:+61] [onCreate]                 this.g = this.f4672b.getInt("intent_request_code", -1);
[tests/com/example/activity/WrongName.java:+62] [onCreate]                 this.e = this.f4672b.getBoolean("from_deeplink");
[tests/com/example/activity/WrongName.java:+77] [extractData]                 str = getIntent().getDataString();
{
    "Boolean": [
        "open_from_notification",
        "open_from_reminder_notification",
        "open_from_abandonned_cart_notification",
        "from_deeplink"
    ],
    "Int": [
        "intent_request_code"
    ],
    "data-uri": true
}

# Display com.example.activity.WrongName with verbosity
$ python Android_Activity_Swagger.py com.example.activity.WrongName -d tests/ --verbose
Found activity: com.example.activity.WrongName
Activity's file path: tests/com/example/activity/WrongName.java
[tests/com/example/activity/WrongName.java:+43] [onCreate]                 this.f4672b = getIntent().getExtras();
[tests/com/example/activity/WrongName.java:+53] [onCreate]             if (this.f4672b != null && this.f4672b.getBoolean("open_from_notification", false)) {
[tests/com/example/activity/WrongName.java:+54] [onCreate]                 if (this.f4672b.getBoolean("open_from_reminder_notification", false)) {
[tests/com/example/activity/WrongName.java:+56] [onCreate]                 } else if (this.f4672b.getBoolean("open_from_abandonned_cart_notification", false)) {
[tests/com/example/activity/WrongName.java:+61] [onCreate]                 this.g = this.f4672b.getInt("intent_request_code", -1);
[tests/com/example/activity/WrongName.java:+62] [onCreate]                 this.e = this.f4672b.getBoolean("from_deeplink");
[tests/com/example/activity/WrongName.java:+77] [extractData]                 str = getIntent().getDataString();
Found parent: Activity

{
    "Boolean": [
        "open_from_notification",
        "open_from_reminder_notification",
        "open_from_abandonned_cart_notification",
        "from_deeplink"
    ],
    "Int": [
        "intent_request_code"
    ],
    "data-uri": true
}

# Display com.example.activity.WrongName with some adb command example
$ python Android_Activity_Swagger.py com.example.activity.WrongName -d tests/ -p com.example --adb
[tests/com/example/activity/WrongName.java:+43] [onCreate]                 this.f4672b = getIntent().getExtras();
[tests/com/example/activity/WrongName.java:+53] [onCreate]             if (this.f4672b != null && this.f4672b.getBoolean("open_from_notification", false)) {
[tests/com/example/activity/WrongName.java:+54] [onCreate]                 if (this.f4672b.getBoolean("open_from_reminder_notification", false)) {
[tests/com/example/activity/WrongName.java:+56] [onCreate]                 } else if (this.f4672b.getBoolean("open_from_abandonned_cart_notification", false)) {
[tests/com/example/activity/WrongName.java:+61] [onCreate]                 this.g = this.f4672b.getInt("intent_request_code", -1);
[tests/com/example/activity/WrongName.java:+62] [onCreate]                 this.e = this.f4672b.getBoolean("from_deeplink");
[tests/com/example/activity/WrongName.java:+77] [extractData]                 str = getIntent().getDataString();
{
    "Boolean": [
        "open_from_notification",
        "open_from_reminder_notification",
        "open_from_abandonned_cart_notification",
        "from_deeplink"
    ],
    "Int": [
        "intent_request_code"
    ],
    "data-uri": true
}
adb shell am start -n com.example/com.example.activity.WrongName --ez open_from_notification true
adb shell am start -n com.example/com.example.activity.WrongName --ez open_from_reminder_notification true
adb shell am start -n com.example/com.example.activity.WrongName --ez open_from_abandonned_cart_notification true
adb shell am start -n com.example/com.example.activity.WrongName --ez from_deeplink true
adb shell am start -n com.example/com.example.activity.WrongName --ei intent_request_code 0
adb shell am start -n com.example/com.example.activity.WrongName -d https://github.com/nbeguier/

Tests

$ pytest

# Android_Activity_Swagger.py com.example.activity.WrongName -d tests/
# Android_Activity_Swagger.py 'com.example.activity.WrongName$TrueName' -d tests/
# Android_Activity_Swagger.py com.example.activity.MyLauncherActivity -d tests/
# Android_Activity_Swagger.py com.example.ui.RoutingActivity -d tests/
# Android_Activity_Swagger.py com.example.ui.RoutingActivity -d tests/ -p com.example --adb

License

Android_Activity_Swagger is an open source and free software released under the AGPL (Affero General Public License). We are committed to ensure that Android_Activity_Swagger will remain a free and open source project on the long-run.

Copyright

Copyright (C) 2020-2023 Nicolas Beguier; (nbeguier - nicolas_beguier[at]hotmail[dot]com)