Home

Awesome

PATDroid Build Status Maven Central

<img align="right" src="img/icon-small.png" /> PATDroid is a collection of tools and data structures for analyzing Android applications and the system itself. We intend to build it as a common base for developing novel mobile software debugging, refactoring, reverse engineering tools.
dependencies {
    compile group: 'mxia.me', name: 'patdroid', version: '1.0.0'
}

The master branch is the nightly dev branch, which could diverge greatly from the maven artifacts.

Packages

Here is a one-sentence description for each package. Find the detailed usage tutorials on our wiki by clicking on the package name to redirect to their wiki pages. Most public APIs are Java-doced. PATDroid requires Java6+. It goes well with Oracle/OpenJDK 1.6, 1.7, Dalvik (Yes, you can run it on a smartphone). Gradle (wrapper) is the default build system. You can import the project to IntelliJ IDEA (File->Import from Gradle Project) and Eclipse (similar).

Closely related functionality:

History and Philosophy

PATDroid was part of AppAudit, which is a tool that simulates the execution of app code and checks if it leaks sensitive user data. You can find out more details from our S&P'15 paper. We make part of AppAudit public to be useful to researchers and developers. Overall, we try to make the entire project

  1. concise (with fewer abstractions as possible such that users wont feel like searching a needle in the ocean)
  2. properly documented (javadoc, and wiki tutorial)
  3. loosely coupled (packages trying to be self-contained)
  4. efficient (graduate students need life with bf/gf not waiting for computers to complete analyses)
  5. look like good code

If you want to contribute, make sure you follow these traditions and feel free to submit a pull request. Note that quick-and-dirty patches require many efforts to make them ready, and thus take more time to merge. I am always open to suggestions and willing to hear interesting projects that make use of PATDroid. Right now, several exciting research projects across McGill University and Shanghai Jiao Tong University are using PATDroid. We will update links to them soon.