Skylot
126 lines
6.3 KiB
Markdown
126 lines
6.3 KiB
Markdown
## JADX
|
|
|
|
[](https://travis-ci.org/skylot/jadx)
|
|
[](https://codecov.io/gh/skylot/jadx)
|
|
[](https://lgtm.com/projects/g/skylot/jadx/alerts/)
|
|
[](https://sonarcloud.io/dashboard?id=jadx)
|
|
[](http://www.apache.org/licenses/LICENSE-2.0.html)
|
|
[](https://github.com/semantic-release/semantic-release)
|
|
|
|
**jadx** - Dex to Java decompiler
|
|
|
|
Command line and GUI tools for produce Java source code from Android Dex and Apk files
|
|
|
|
**Main features:**
|
|
- decompile Dalvik bytecode to java classes from APK, dex, aar and zip files
|
|
- decode `AndroidManifest.xml` and other resources from `resources.arsc`
|
|
- deobfuscator included
|
|
|
|
**jadx-gui features:**
|
|
- view decompiled code with highlighted syntax
|
|
- jump to declaration
|
|
- find usage
|
|
- full text search
|
|
|
|
See these features in action here: [jadx-gui features overview](https://github.com/skylot/jadx/wiki/jadx-gui-features-overview)
|
|
|
|
|
|
|
|
|
|
|
|
### Download
|
|
- latest [unstable build:  ](https://bintray.com/skylot/jadx/unstable/_latestVersion#files)
|
|
- release from [github: ](https://github.com/skylot/jadx/releases/latest)
|
|
- release from [bintray:  ](https://bintray.com/skylot/jadx/releases/_latestVersion#files)
|
|
|
|
After download unpack zip file go to `bin` directory and run:
|
|
- `jadx` - command line version
|
|
- `jadx-gui` - UI version
|
|
|
|
On Windows run `.bat` files with double-click\
|
|
**Note:** ensure you have installed Java 8 or later 64-bit version.
|
|
For windows you can download it from [adoptopenjdk.net](https://adoptopenjdk.net/releases.html?variant=openjdk11&jvmVariant=hotspot#x64_win) (select "Install JRE").
|
|
|
|
### Install
|
|
1. Arch linux
|
|
```bash
|
|
sudo pacman -S jadx
|
|
```
|
|
2. macOS
|
|
```bash
|
|
brew install jadx
|
|
```
|
|
|
|
### Build 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`
|
|
|
|
### Usage
|
|
```
|
|
jadx[-gui] [options] <input file> (.apk, .dex, .jar, .class, .smali, .zip, .aar, .arsc)
|
|
options:
|
|
-d, --output-dir - output directory
|
|
-ds, --output-dir-src - output directory for sources
|
|
-dr, --output-dir-res - output directory for resources
|
|
-r, --no-res - do not decode resources
|
|
-s, --no-src - do not decompile source code
|
|
--single-class - decompile a single class
|
|
--output-format - can be 'java' or 'json', default: java
|
|
-e, --export-gradle - save as android gradle project
|
|
-j, --threads-count - processing threads count, default: 4
|
|
--show-bad-code - show inconsistent code (incorrectly decompiled)
|
|
--no-imports - disable use of imports, always write entire package name
|
|
--no-debug-info - disable debug info
|
|
--no-inline-anonymous - disable anonymous classes inline
|
|
--no-replace-consts - don't replace constant value with matching constant field
|
|
--escape-unicode - escape non latin characters in strings (with \u)
|
|
--respect-bytecode-access-modifiers - don't change original access modifiers
|
|
--deobf - activate deobfuscation
|
|
--deobf-min - min length of name, renamed if shorter, default: 3
|
|
--deobf-max - max length of name, renamed if longer, default: 64
|
|
--deobf-rewrite-cfg - force to save deobfuscation map
|
|
--deobf-use-sourcename - use source file name as class name alias
|
|
--rename-flags - what to rename, comma-separated, 'case' for system case sensitivity, 'valid' for java identifiers, 'printable' characters, 'none' or 'all' (default)
|
|
--fs-case-sensitive - treat filesystem as case sensitive, false by default
|
|
--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 (set --log-level to DEBUG)
|
|
-q, --quiet - turn off output (set --log-level to QUIET)
|
|
--log-level - set log level, values: QUIET, PROGRESS, ERROR, WARN, INFO, DEBUG, default: PROGRESS
|
|
--version - print jadx version
|
|
-h, --help - print this help
|
|
Example:
|
|
jadx -d out classes.dex
|
|
jadx --rename-flags "none" classes.dex
|
|
jadx --rename-flags "valid,printable" classes.dex
|
|
jadx --log-level error app.apk
|
|
```
|
|
These options also worked on jadx-gui running from command line and override options from preferences dialog
|
|
|
|
### Troubleshooting
|
|
Please check wiki page [Troubleshooting Q&A](https://github.com/skylot/jadx/wiki/Troubleshooting-Q&A)
|
|
|
|
### Contributing
|
|
To support this project you can:
|
|
- Post thoughts about new features/optimizations that important to you
|
|
- Submit decompilation issues, please read before proceed: [Open issue](CONTRIBUTING.md#Open-Issue)
|
|
- Open pull request, please follow these rules: [Pull Request Process](CONTRIBUTING.md#Pull-Request-Process)
|
|
|
|
### Related projects:
|
|
- [PyJadx](https://github.com/romainthomas/pyjadx) - python binding for jadx by [@romainthomas](https://github.com/romainthomas)
|
|
|
|
---------------------------------------
|
|
*Licensed under the Apache 2.0 License*
|
|
|
|
*Copyright 2019 by Skylot*
|