patch-apk - App Bundle/Split APK Aware Patcher for Objection
An APK patcher, for use with objection, that supports Android app bundles/split APKs. It automates the following:
- Finding the full package name of an Android app.
- Finding the APK path(s) and pulling them from the device.
- Patching the APK(s) using
objection patchapk.- Combining split APKs into a single APK where necessary.
- Enabling support for user-installed CA certificates (e.g. Burp Suite's CA Cert).
- Uninstalling the original app from the device.
- Installing the patched app to the device, ready for use with objection.
Changelog
- 29th April 2021: Implemented a fix for an issue with
apktoolwhere the handling of some resource XML elements changed and the--use-aapt2flag is required (iBotPeaches/Apktool#2462). - 28th April 2021: Fixed a bug with
objectionversion detection when theobjection versioncommand output an update notice. - 1st August 2020: Updated for compatibility with
objectionversion 1.9.3 and above and fixed a bug with line endings when retrieving package names from the Android device/emulator. - 30th March 2020: Fixed a bug where dummy resource IDs were assumed to all have true names. Added a hack to resolve an issue with duplicate entries in res/values/styles.xml after decompiling with apktool.
- 29th March 2020: Added
--save-apkparameter to save a copy of the unpatched single APK for use with other tools. - 27th March 2020: Initial release supporting split APKs and the
--no-enable-user-certsflag.
Usage
Install the target Android application on your device and connect it to your computer/VM so that adb devices can see it, then run:
python3 patch-apk.py {package-name}
The package-name parameter can be the fully-qualified package name of the Android app, such as com.google.android.youtube, or a partial package name, such as tube.
Along with injecting an instrumentation gadget, the script also automatically enables support for user-installed CA certificates by injecting a network security configuration file into the APK. To disable this functionality, pass the --no-enable-user-certs parameter on the command line.
Examples
Basic usage: Simply install the target Android app on your device, make sure adb devices can see your device, then pass the package name to patch-apk.py.
$ python3 patch-apk.py com.whatsapp
Getting APK path(s) for package: com.whatsapp
[+] APK path: /data/app/com.whatsapp-NKLgchoExRFTDLkkbDqBGg==/base.apk
Pulling APK file(s) from device.
[+] Pulling: com.whatsapp-base.apk
Patching com.whatsapp-base.apk with objection.
Patching APK to enable support for user-installed CA certificates.
Uninstalling the original package from the device.
Installing the patched APK to the device.
Done, cleaning up temporary files.
When patch-apk.py is done, the installed app should be patched with objection and have support for user-installed CA certificates enabled. Launch the app on the device and run objection explore as you normally would to connect to the agent.
Partial Package Name Matching: Pass a partial package name to patch-apk.py and it'll automatically grab the correct package name or ask you to confirm from available options.
$ python3 patch-apk.py ovid
Multiple matching packages installed, select the package to patch.
[1] com.android.providers.telephony
[2] com.android.providers.calendar
[3] com.android.providers.media
[4] com.android.providers.downloads
[5] com.android.providers.downloads.ui
[6] com.android.providers.settings
[7] com.android.providers.partnerbookmarks
[8] com.android.bookmarkprovider
[9] com.android.providers.blockednumber
[10] com.android.providers.userdictionary
[11] com.joinzoe.covid_zoe
[12] com.android.providers.contacts
Choice:
Patching Split APKs: Split APKs are automatically detected and combined into a single APK before patching. Split APKs can be identified by multiple APK paths being returned by the adb shell pm path command as shown below.
$ adb shell pm path com.joinzoe.covid_zoe
package:/data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/base.apk
package:/data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/split_config.arm64_v8a.apk
package:/data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/split_config.en.apk
package:/data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/split_config.xxhdpi.apk
The following shows patch-apk.py detecting, rebuilding, and patching a split APK. Some output has been snipped for brevity.
$ python3 patch-apk.py covid
Getting APK path(s) for package: com.joinzoe.covid_zoe
[+] APK path: /data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/base.apk
[+] APK path: /data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/split_config.arm64_v8a.apk
[+] APK path: /data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/split_config.en.apk
[+] APK path: /data/app/com.joinzoe.covid_zoe-vck7Y7NlVGutCaaAbonakw==/split_config.xxhdpi.apk
Pulling APK file(s) from device.
[+] Pulling: com.joinzoe.covid_zoe-base.apk
[+] Pulling: com.joinzoe.covid_zoe-split_config.arm64_v8a.apk
[+] Pulling: com.joinzoe.covid_zoe-split_config.en.apk
[+] Pulling: com.joinzoe.covid_zoe-split_config.xxhdpi.apk
App bundle/split APK detected, rebuilding as a single APK.
Extracting individual APKs with apktool.
[+] Extracting: /tmp/tmp1kir74u_/com.joinzoe.covid_zoe-base.apk
[+] Extracting: /tmp/tmp1kir74u_/com.joinzoe.covid_zoe-split_config.arm64_v8a.apk
[+] Extracting: /tmp/tmp1kir74u_/com.joinzoe.covid_zoe-split_config.en.apk
[+] Extracting: /tmp/tmp1kir74u_/com.joinzoe.covid_zoe-split_config.xxhdpi.apk
Copying files and directories from split APKs into base APK.
[+] Creating directory in base APK: /lib
[+] Creating directory in base APK: /lib/arm64-v8a
[+] Moving file to base APK: /lib/arm64-v8a/libfb.so
...
[+] Moving file to base APK: /res/drawable-xxxhdpi/shell_launch_background_image.png
Found public.xml in the base APK, fixing resource identifiers across split APKs.
[+] Resolving 83 resource identifiers.
[+] Located 83 true resource names.
[+] Updated 83 dummy resource names with true names in the base APK.
[+] Updated 164 references to dummy resource names in the base APK.
Disabling APK splitting in AndroidManifest.xml of base APK.
Rebuilding as a single APK.
[+] Building APK with apktool.
[+] Signing new APK.
[+] Zip aligning new APK.
Patching com.joinzoe.covid_zoe-base.apk with objection.
Patching APK to enable support for user-installed CA certificates.
Uninstalling the original package from the device.
Installing the patched APK to the device.
Done, cleaning up temporary files.
After patch-apk.py completes, we can run adb shell pm path again to verify that there is now a single patched APK installed on the device.
$ adb shell pm path com.joinzoe.covid_zoe
package:/data/app/com.joinzoe.covid_zoe-9NuZnT-lK3qM_IZQEHhTgA==/base.apk
Combining Split APKs
Split APKs have been supported since Android 5/Lollipop (June 2014, API level 21). Essentially this allows an app to be split across multiple APK files, for example one might contain the main code and another might contain image resources for a given screen resolution. We can identify whether an app uses split APKs with the adb shell pm path command like so:
$ adb shell pm path com.joinzoe.covid_zoe
package:/data/app/com.joinzoe.covid_zoe-NW8ZbgI5VPzvSZ1NgMa4CQ==/base.apk
package:/data/app/com.joinzoe.covid_zoe-NW8ZbgI5VPzvSZ1NgMa4CQ==/split_config.arm64_v8a.apk
package:/data/app/com.joinzoe.covid_zoe-NW8ZbgI5VPzvSZ1NgMa4CQ==/split_config.en.apk
package:/data/app/com.joinzoe.covid_zoe-NW8ZbgI5VPzvSZ1NgMa4CQ==/split_config.xxhdpi.apk
These can be combined into a single APK for use with other tools such as objection patchapk. This is done by patch-apk.py as follows:
Step 1 - Extract APKs: First, the individual APK files are pulled from the device and extracted using apktool.
Step 2 - Combine Files: Next, we walk the directory trees of all but base.apk, and move files and directories from the split APKs into the base APK.
Step 3 - Fix Resource Identifiers: Some resource names might only be defined in one of the split APKs, so we need to gather these up and update base.apk with the correct resource names.
Step 4 - Disable Splitting: The AndroidManifest.xml in base.apk is updated to disable support for splitting before rebuilding, signing, and zip aligning the APK.
More details can be found on my blog.