Skip to content

secure-software-engineering/jadx-taintdoc

Repository files navigation

TB-Extractor (JADX Extension Created within the TaintBench Project)

Build Status Code Coverage SonarQube Bugs License semantic-release

jadx - Dex to Java decompiler

Command line and GUI tools for produce Java source code from Android Dex and Apk files

jadx-gui screenshot

Manual Analysis Taint Flow Documentation

Short tutorial video: https://www.youtube.com/watch?v=rTLNIGXELS0

Shortcuts in main window:

Key Operation
F2 Mark/unmark currently focussed line as source
F3 Mark/unmark currently focussed line as intermediate flow
F4 Mark/unmark currently focussed line as sink
F5 Create and switch to new finding
Ctrl + F5 Delete current finding
F6 Navigate to previous finding
F7 Navigate to next finding
F9 Save report to file

Shortcuts in Inspection Documentation window:

Key Operation
W Move currently marked intermediate up
S Move currently marked intermediate down
  • Double-clicking Source/Intermediate/Sink navigates to the position in the main window
  • Checkboxes set attribute for finding (serialized to JSON when saving)
  • Target names can be entered into the respective input field. The field is marked yellow if the target name is not a substring of the respective source line.
  • Custom attributes can be added below the predefined attribute checkboxes, one per line

Process:

  • Open apk file in Jadx
  • Add finding (F5)
  • Click a line to set focus
  • Mark focussed line as source/intermediate/sink (F2/F3/F4)
  • Click different line for next mark etc ...
  • When done with current finding, add next finding
  • When done with all findings, save report (F9)

Downloads

After download unpack zip file go to bin directory and run:

  • jadx - command line version
  • jadx-gui - graphical version

On Windows run .bat files with double-click
Note: ensure you have installed Java 8 64-bit version

Related projects:

Building jadx from source

JDK 8 or higher must be installed:

git clone https://github.com/skylot/jadx.git
cd jadx
./gradlew dist

(on Windows, use gradlew.bat instead of ./gradlew)

Scripts for run jadx will be placed in build/jadx/bin and also packed to build/jadx-<version>.zip

Run

Run jadx on itself:

cd build/jadx/
bin/jadx -d out lib/jadx-core-*.jar
# or
bin/jadx-gui lib/jadx-core-*.jar

Usage

jadx[-gui] [options] <input file> (.dex, .apk, .jar or .class)
options:
 -d,  --output-dir           - output directory
 -ds, --output-dir-src       - output directory for sources
 -dr, --output-dir-res       - output directory for resources
 -j,  --threads-count        - processing threads count
 -r,  --no-res               - do not decode resources
 -s,  --no-src               - do not decompile source code
 -e,  --export-gradle        - save as android gradle project
      --show-bad-code        - show inconsistent code (incorrectly decompiled)
      --no-imports           - disable use of imports, always write entire package name
      --no-replace-consts    - don't replace constant value with matching constant field
      --escape-unicode       - escape non latin characters in strings (with \u)
      --deobf                - activate deobfuscation
      --deobf-min            - min length of name
      --deobf-max            - max length of name
      --deobf-rewrite-cfg    - force to save deobfuscation map
      --deobf-use-sourcename - use source file name as class name alias
      --cfg                  - save methods control flow graph to dot file
      --raw-cfg              - save methods control flow graph (use raw instructions)
 -f,  --fallback             - make simple dump (using goto instead of 'if', 'for', etc)
 -v,  --verbose              - verbose output
 -h,  --help                 - print this help
Example:
 jadx -d out classes.dex

These options also worked on jadx-gui running from command line and override options from preferences dialog

Troubleshooting

Out of memory error:
  • Reduce processing threads count (-j option)
  • Increase maximum java heap size:
    • command line (example for linux): JAVA_OPTS="-Xmx4G" jadx -j 1 some.apk
    • edit 'jadx' script (jadx.bat on Windows) and setup bigger heap size: DEFAULT_JVM_OPTS="-Xmx2500M"

Licensed under the Apache 2.0 License

Copyright 2018 by Skylot