Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/user1342/AutoDroid

A tool for automating interactions with Android devices - including ADB, AndroGuard, and Frida interactivity.
https://github.com/user1342/AutoDroid

adb androguard android android-application frida malware-analysis reverse-engineering

Last synced: 3 days ago
JSON representation

A tool for automating interactions with Android devices - including ADB, AndroGuard, and Frida interactivity.

Awesome Lists containing this project

README 

        




    

  



 📱 A tool for automating interactions with Android devices - including ADB, AndroGuard, and Frida interactivity. ⬇️ 







AutoDroid is a Python tool for programmatically scripting bulk interactions with one or more Android devices. Possible uses include:

- Downloading and extracting all APKs from all connected devices. ⚙️

- Testing a developed application on multiple devices at once. 📲

- Testing potential malware against a suite of AV products. ☢️



# 💪 Getting Started

To use AutoDroid you will need to install the dependencies, these are specified in the requirements file and can be installed by following the below command.



```bash

pip install -r REQUIREMENTS.txt

```



AutoDroid needs to be provided a valid Json configuration file as a command line argument. The below shows a simple configuration file example that will retrieve all applications from all connected devices one at a time and extract the APKs to zips using AndroGuard.



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["adb pull !app_path !app_id.apk","reverse: !app_id.apk"]

}

```



Once you have created a valid AutoDroid configuration file you can begin device interaction by running the ```AutoDroid.py``` python file with the configuration file as it's command line parameter.



```bash

python AutoDroid.py example_config.json

```

# 🧱 Commands and blocks

The AutoDroid configuration file can be provided with a series of commands to execute on the target devices, these commands are run locally on your machine and so the programs and files being called must be present. These commands can be in either a list format (as can be seen in the example above) or as a key value pair map/ dict. These key value pairs are defined as blocks of commands, where the key is the block name and the value is a list of commands. The constant (described below) ```block:``` can be used to run a block and provides a simple loop/ call-back feature. An example of using blocks can be seen below.



```json 

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": {

      "test_user_input":["adb -s !device_id shell monkey -v 5 -p !app_id"],

      "retrieve_apk":["adb -s !device_id pull !app_path !app_id.apk","sleep:5"]

    }

}

```



# 📱 Devices and apps

Two additional fields that are instrumental to AutoDroid are the ```devices``` and ```apps``` fields. These fields define the adb device ID for the device(s) being targeted (a list of strings) and the application reverse domain notation name (i.e. ```com.example.application```) for the applications being targeted on the device (a list of strings). Both of these fields can be empty, a list of strings, or defined as ```*``` where all available devices and apps will be targeted. In the backend the way this works is when a value is provided in these fields the program will loop through all commands in order for each application on each device. An example of specifying a specific device and app can be seen below:



```json

{

  "devices": ["09261JEC216934"],

    "apps": ["com.google.android.networkstack.tethering"],

    "commands": ["adb -s !device_id pull !app_path !app_id.apk"]

}

```



When the devices field is not empty (i.e. not ```"devices":[],```) a variable (see below) of ```!device_id``` is created. This variable can be used in your commands to denote the ADB device ID for the current targeted device. Similarly the variables ```!app_id```, and ```!app_path``` are added when the app field is not empty and can be used in commands to define the app reverse domain notation name and the path to that application's APK file.



# 📣 Variables

To save time, AutoDroid allows for an infinite amount of variables to be set in a script. These variables are constructed in a key value pair format. When the key of a variable is located in a command it will be replaced for the value. An example configuration that utilises variables can be seen below, in this configuration file the variable ```!test``` has been added as short hand for a ```monkey``` adb command and the built-in variable ```!app_id``` is also used. 



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "variables": {"!test": "adb -s !device_id shell monkey -v 500 -p"},

    "commands": ["!test !app_id"]

}

```



The preferred standard for using variables is to precede them with a ```!``` and to use ```_``` instead of spaces. 



## Setting variables at runtime 

Variables can be set at runtime using the ``` ?``` operator. Where the operator followed by a variable name is set to either what the following commands output is or if the command has no output the command itself. An example can be seen below:



```json

{

  "devices": [],

    "apps": [],

    "commands": ["?!files dir", "print: !files"]

}

```



## Reserved variables 

The below is a list of reserved variables that are already used in AutoDroid and should be avoided from adding to your config file. If these variables are added they will be overwritten at runtime.

-	```!device_id``` - When one or more devices are provided in the config, this variable is populated at runtime. And is set as the ADB device ID for the current device. Each device is looped through in turn with the configured commands being run for each device.

-	```!adb_connect``` – This is a shorthand variable that translates to ```adb -s !device_id```, using this instead of ```adb``` will insure that all adb commands are run on the correct device.

-	```!app_id``` - When one or more apps are provided in the config, this variable is populated at runtime. And is set as the application reverse domain notation name (i.e. ```com.example.myapplication```) for the current application. Each application is looped through in turn with the configured commands being run for each app.

-	```!app_path``` - Similar to the above. When one or more apps are provided in the config, this variable is populated at runtime. And is set as the path to the current application APK file on the target device. Each application is looped through in turn with the configured commands being run for each app.



# 📢 Constants

Constants are commands specific to AutoDroid and relate to specific functionality. Normally broken down into a keyword followed by a ```:``` and then one or more parameters separated by a ```;```. These constants must be used at the start of a command and should always be in lower case. Examples will be given in the individual sections.



## Frida 

AutoDroid has built in functionality to run Frida JavaScript files as part of an AutoDroid run. This constant is defined as ```frida:``` and must be provided the path to the JavaScript file being used, followed by a ```;``` and then the application reverse notation name of the application being targeted. In addition to applying variables to the command, variables are also applied to the contents of the file provided. 



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["frida:myJavascript.js;!app_id"]

}

```



***note*** while the Frida integration is implemented, it is currently untested. 



## AndroGuard 

AutoDroid supports reverse engineering APKs via AndroGuard. This constant is structured as ```reverse:``` and takes a path to a locally stored APK. Using this will save an unbundled version of the APK as a ZIP with the name ```.apk```.



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["adb -s !device_id pull !app_path !app_id.apk","reverse: !app_id.apk"]

}

```



When using the reverse constant the apk path can be followed by any number of paramiters (seperated by a ```;```), these including ```info``` (which will save a Json file of application information, ```decompile``` (which on Linux will save a txt summary of the decompiled methods), ```manifest``` (which will save the xml manifest file, and ```zip``` which will perform the same action as if no paramiters were provided and saves the unbundled APK to a zip file. An example of using these parameters can be seen below:



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": {

      "get_app": ["adb -s !device_id pull !app_path !app_id.apk"],

      "reverse_app":["reverse: !app_id.apk;info",

                     "reverse: !app_id.apk;manifest;decompile"]

    }

}

```



## Sleep 

This constant provides simple functionality for pausing execution of the tooling for a specific amount of time. This constant is structured as ```sleep:``` followed by the amount of seconds to wait.



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["adb pull !app_path !app_id.apk","sleep:5"]

}

```



## Block

The block constant provides simple looping and call-back functionality. This constant is structured as ```block:``` followed by the name of the block of commands to execute. If no blocks have been provided (i.e. commands have been provided in a list format), then commands are added to a block called ```main```.



```json 

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": {

      "test_user_input":["adb shell monkey -v 5 -p !app_id"],

      "retrieve_apk":["adb pull !app_path !app_id.apk"],

      "test_again": ["block: test_user_input","sleep:5"]

    }

}

```



## Find

The keyword 'find' followed by a path to an apk and a regex string to find will both print to the console the path to the apk and the string found if they are present in an APK. This can be used in conjunction with other commands to run the find strings in all processed apps. An example of this can be seen below:



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["adb pull !app_path !app_id.apk","find: !app_id.apk;my_string"]

}

```



## Print

Another simple constant. The ```print:``` constant can be used to print a message to the console. An example of using this can be seen below:

```json 

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["print: device id !device_id, app id !app_id, app path !app_path"]

}

```



## Write

The write constant allows for a variable or command to be written to a file. Used with the ```write:``` string followed by the file to write to, followed by a ```;```, and then the command or variable to write to the file.



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": {

      "get_stats": ["?!stats device id !device_id, app id !app_id, app path !app_path"],

      "write_stats": ["write: !device_id-!app_id-stats.txt;!stats"]

    }

}

```



## Read

The ``` read:``` constant is provided a path to a file to read, followed by a ```;```, and then the variable to save the output to. This variable can be a newly declared or existing variable.



```json

{

  "devices": [],

    "apps": [],

    "commands": ["read:test.txt;!data","print: !data"]

}

```



## Append

Similar to write. The append constant allows for a variable or command to be written to a file. Used with the ```append:``` string followed by the file to write to, followed by a ```;```, and then the command or variable to write to the file. Unlike write which will create or write over an existing file, append will only add to an existing file. If the file does not exist then AutoDroid will error.



```json

{

  "devices": ["*"],

    "apps": ["*"],

    "commands": ["append:test.txt;!app_id !app_path"]

}

```



# 📚 More complex configs

## Malware analysis

The below is an example of using AutoDroid to test potential malware on Android devices. This config installs the potential malware, records the screen, retrieves the screen capture, and uninstalls the application.



```json 

{

  "devices": ["*"],

    "apps": [],

    "commands": {

      "record_screen": ["adb shell screenrecord /data/local/tmp/test.mp4 --time-limit 120"],

      "install_eicar":["adb install com.fsecure.eicar.antivirus.test.apk"],

      "user_input":["adb shell monkey -p com.fsecure.eicar.antivirus.test -v 1","sleep: 20"],

      "uninstall": ["adb uninstall com.fsecure.eicar.antivirus.test"],

      "get_video": ["adb pull /data/local/tmp/test.mp4", "sleep: 20","adb shell rm /data/local/tmp/test.mp4"]

    }

}

```



## Application reverse engineering

The below is an example of using AutoDroid's implementation of AndroGuard to reverse engineering an APK off a device and retrieve a json of info about the app, a decompiled summary of methods, the xml manifest file, and an unbundled zip file of the APK.



```json

{

  "devices": ["*"],

    "apps": ["me.jamesstevenson.onelist"],

    "commands": {

      "get_app": ["adb pull !app_path !app_id.apk"],

      "reverse_app":["reverse: !app_id.apk;info;decompile;manifest;zip"]

    }

}

```



# ➕ More on AutoDroid

- Get the free official read me and cheat sheet here: https://ko-fi.com/s/66735cc6a0

- Read an article on bulk reverse engineering Android applications here: https://www.jamesstevenson.me/bulk-android-app-reverse-engineering-with-autodroid/



# 📜 License

[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/)