Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dwisiswant0/apkleaks
Scanning APK file for URIs, endpoints & secrets.
https://github.com/dwisiswant0/apkleaks
android-security apk apk-parser bugbounty mobile-security reverse-engineering scanning-apk static-analysis
Last synced: 5 days ago
JSON representation
Scanning APK file for URIs, endpoints & secrets.
- Host: GitHub
- URL: https://github.com/dwisiswant0/apkleaks
- Owner: dwisiswant0
- License: apache-2.0
- Created: 2020-05-29T21:26:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T01:50:46.000Z (14 days ago)
- Last Synced: 2024-10-22T22:51:06.689Z (12 days ago)
- Topics: android-security, apk, apk-parser, bugbounty, mobile-security, reverse-engineering, scanning-apk, static-analysis
- Language: Python
- Homepage:
- Size: 113 KB
- Stars: 4,905
- Watchers: 79
- Forks: 489
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome - dwisiswant0/apkleaks - Scanning APK file for URIs, endpoints & secrets. (Python)
- android-security-awesome - APKLeaks - Scanning APK file for URIs, endpoints & secrets. (Tools / Static Analysis Tools)
- awesome-mobile-security - APK Leaks – Scanning APK file for URIs, endpoints & secrets
- WebHackersWeapons - apkleaks
- MobileHackersWeapons - apkleaks
- awesome-hacking-lists - dwisiswant0/apkleaks - Scanning APK file for URIs, endpoints & secrets. (Python)
README
# APKLeaks
[](https://badge.fury.io/gh/dwisiswant0%2fapkleaks.svg)
[](https://github.com/dwisiswant0/apkleaks/issues)
Scanning APK file for URIs, endpoints & secrets.
- [Installation](#installation)
- [from Pypi](#from-pypi)
- [from Source](#from-source)
- [from Docker](#from-docker)
- [Usage](#usage)
- [Options](#options)
- [Output](#output)
- [Pattern](#pattern)
- [Arguments (for disassembler)](#arguments-for-disassembler)
- [License](#license)
- [Acknowledments](#acknowledments)
---
## Installation
It's fairly simple to install **APKLeaks**:
### from PyPi
```bash
$ pip3 install apkleaks
```
### from Source
Clone repository and install requirements:
```bash
$ git clone https://github.com/dwisiswant0/apkleaks
$ cd apkleaks/
$ pip3 install -r requirements.txt
```
### from Docker
Pull the Docker image by running:
```bash
$ docker pull dwisiswant0/apkleaks:latest
```
### Dependencies
The APKLeaks utilizes the [jadx](https://github.com/skylot/jadx) disassembler to decompile APK files. If jadx is not present in your system, it will prompt you to download it.
## Usage
Simply,
```bash
$ apkleaks -f ~/path/to/file.apk
# from Source
$ python3 apkleaks.py -f ~/path/to/file.apk
# or with Docker
$ docker run -it --rm -v /tmp:/tmp dwisiswant0/apkleaks:latest -f /tmp/file.apk
```
## Options
Here are all the options it supports.
| **Argument** | **Description** | **Example** |
|--------------- |--------------------------------------------- |------------------------------------------------------------- |
| -f, --file | APK file to scanning | `apkleaks -f file.apk` |
| -o, --output | Write to file results _(random if not set)_ | `apkleaks -f file.apk -o results.txt` |
| -p, --pattern | Path to custom patterns JSON | `apkleaks -f file.apk -p custom-rules.json` |
| -a, --args | Disassembler arguments | `apkleaks -f file.apk --args="--deobf --log-level DEBUG"` |
| --json | Save as JSON format | `apkleaks -f file.apk -o results.json --json` |
### Output
In general, if you don't provide `-o` argument, then it will generate results file automatically.
> [!TIP]
> By default it will also save the results in text format, use `--json` argument if you want JSON output format.
### Pattern
Custom patterns can be added with the following argument to provide sensitive _search rules_ in the JSON file format: `--pattern /path/to/custom-rules.json`. If no file is set, the tool will use the default patterns found in [regexes.json](https://github.com/dwisiswant0/apkleaks/blob/master/config/regexes.json) file.
Here's an example of what a custom pattern file could look like:
```json
// custom-rules.json
{
"Amazon AWS Access Key ID": "AKIA[0-9A-Z]{16}",
// ...
}
```
To run the tool using these custom rules, use the following command:
```bash
$ apkleaks -f /path/to/file.apk -p rules.json -o ~/Documents/apkleaks-results.txt
```
### Arguments (disassembler)
We give user complete discretion to pass the disassembler arguments. For example, if you want to activate threads in `jadx` decompilation process, you can add it with `-a/--args` argument, example: `--args="--threads-count 5"`.
```
$ apkleaks -f /path/to/file.apk -a "--deobf --log-level DEBUG"
```
> [!WARNING]
> Please pay attention to the default disassembler arguments we use to prevent collisions.
## License
`apkleaks` is distributed under Apache 2.
## Acknowledments
Since this tool includes some contributions, and I'm not an asshole, I'll publically thank the following users for their helps and resources:
- [@ndelphit](https://github.com/ndelphit) - for his inspiring `apkurlgrep`, that's why this tool was made.
- [@dxa4481](https://github.com/dxa4481) and y'all who contribute to `truffleHogRegexes`.
- [@GerbenJavado](https://github.com/GerbenJavado) & [@Bankde](https://github.com/Bankde) - for awesome pattern to discover URLs, endpoints & their parameters from `LinkFinder`.
- [@tomnomnom](https://github.com/tomnomnom/gf) - a `gf` patterns.
- [@pxb1988](https://github.com/pxb1988) - for awesome APK dissambler `dex2jar`.
- [@subho007](https://github.com/ph4r05) for standalone APK parser.
- `SHA2048#4361` _(Discord user)_ that help me porting code to Python3.
- [@Ry0taK](https://github.com/Ry0taK) because he had reported an [OS command injection bug](https://github.com/dwisiswant0/apkleaks/security/advisories/GHSA-8434-v7xw-8m9x).
- [@dee__see](https://twitter.com/dee__see) - for curated potentially sensitive tokens, `NotKeyHacks`.
- [All contributors](https://github.com/dwisiswant0/apkleaks/graphs/contributors).