| Name | bungeegum JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A set of tools to test payloads within the context of a standard Android application |
| upload_time | 2024-09-16 14:18:27 |
| maintainer | None |
| docs_url | None |
| author | Zetier |
| requires_python | >=3.8 |
| license | None |
| keywords |
bungeegum
automation
android
testing
openstf
rce
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Bungeegum
Bungeegum is a set of tools designed to test code execution payloads within the
context of a standard Android application. By leveraging the powerful
[Frida](https://frida.re/docs/home/) instrumentation framework, it precisely
replicates the runtime conditions of an Android app, simulating the execution
of ELFs or shellcode as though they were triggered by a remote code execution
exploit.
## Prerequisites
- Python 3.8 or higher
- [Docker](https://docs.docker.com/get-docker/)
## Install
Note: Bungeegum is developed on and regularly tested with Ubuntu 18.04 and
Python 3.8. Other distributions and versions may work, but are currently
untested.
1. Clone the repository
2. Install dependencies
```sh
sudo apt-get update
sudo apt-get install python3-venv python3.8-venv make wget xz-utils -y
python3.8 -m venv venv
source venv/bin/activate
(venv) pip install --upgrade pip
```
3. Build the APK and install the Python package by running the `make` command:
```sh
make
```
## Supported Android Versions
Bungeegum has been tested successfully on Android 7, 9, 11, and 12.
## Usage
```sh
(venv) bungeegum -h
usage: bungeegum [-h] -d DEVICE [-r] (-s SHELLCODE | -e ELF) [-a [ARGS [ARGS ...]]]
Execute code within an application context
optional arguments:
-h, --help show this help message and exit
-d DEVICE, --device DEVICE
ADB device ID to run on
-r, --remote Set if the file to be executed is on the device
-s SHELLCODE, --shellcode SHELLCODE
Shellcode file to execute on the device
-e ELF, --elf ELF ELF file to execute on the device
-a [ARGS [ARGS ...]], --args [ARGS [ARGS ...]]
Optional args to pass to the ELF file
```
## Examples
- Run an ELF from the host on the device:
```sh
bungeegum --elf ~/my_elf/arm64-v8a/my_elf
```
- Run a shellcode blob on the device
```sh
bungeegum --shellcode ~/my_shellcode.bin
```
- Run an on-device ELF:
```sh
bungeegum --remote --elf /system/bin/log --args "hello world"
```
## Contributing
Contributions are welcome! If you find any issues or have suggestions for
improvements, please open an issue or submit a pull request.
## License
This project is licensed under the GPLv2 License.
Raw data
{
"_id": null,
"home_page": null,
"name": "bungeegum",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bungeegum, automation, android, testing, openstf, rce",
"author": "Zetier",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d0/a4/63b781a51a0f9c8190851422cef00a62804af0343a9227da41564fa0b15c/bungeegum-0.1.0.tar.gz",
"platform": null,
"description": "# Bungeegum\n\nBungeegum is a set of tools designed to test code execution payloads within the\ncontext of a standard Android application. By leveraging the powerful\n[Frida](https://frida.re/docs/home/) instrumentation framework, it precisely\nreplicates the runtime conditions of an Android app, simulating the execution\nof ELFs or shellcode as though they were triggered by a remote code execution\nexploit.\n\n## Prerequisites\n\n- Python 3.8 or higher\n- [Docker](https://docs.docker.com/get-docker/)\n\n## Install\n\nNote: Bungeegum is developed on and regularly tested with Ubuntu 18.04 and\nPython 3.8. Other distributions and versions may work, but are currently\nuntested.\n\n1. Clone the repository\n\n2. Install dependencies\n\n ```sh\n sudo apt-get update\n sudo apt-get install python3-venv python3.8-venv make wget xz-utils -y\n python3.8 -m venv venv\n source venv/bin/activate\n (venv) pip install --upgrade pip\n ```\n\n3. Build the APK and install the Python package by running the `make` command:\n\n ```sh\n make\n ```\n\n## Supported Android Versions\n\nBungeegum has been tested successfully on Android 7, 9, 11, and 12.\n\n## Usage\n\n```sh\n(venv) bungeegum -h\nusage: bungeegum [-h] -d DEVICE [-r] (-s SHELLCODE | -e ELF) [-a [ARGS [ARGS ...]]]\n\nExecute code within an application context\n\noptional arguments:\n -h, --help show this help message and exit\n -d DEVICE, --device DEVICE\n ADB device ID to run on\n -r, --remote Set if the file to be executed is on the device\n -s SHELLCODE, --shellcode SHELLCODE\n Shellcode file to execute on the device\n -e ELF, --elf ELF ELF file to execute on the device\n -a [ARGS [ARGS ...]], --args [ARGS [ARGS ...]]\n Optional args to pass to the ELF file\n```\n\n## Examples\n\n- Run an ELF from the host on the device:\n\n```sh\nbungeegum --elf ~/my_elf/arm64-v8a/my_elf\n```\n\n- Run a shellcode blob on the device\n\n```sh\nbungeegum --shellcode ~/my_shellcode.bin\n```\n\n- Run an on-device ELF:\n\n```sh\nbungeegum --remote --elf /system/bin/log --args \"hello world\"\n```\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for\nimprovements, please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the GPLv2 License.\n",
"bugtrack_url": null,
"license": null,
"summary": "A set of tools to test payloads within the context of a standard Android application",
"version": "0.1.0",
"project_urls": {
"Issues": "https://github.com/Zetier/bungeegum/issues",
"Repository": "https://github.com/Zetier/bungeegum"
},
"split_keywords": [
"bungeegum",
" automation",
" android",
" testing",
" openstf",
" rce"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73559ff3a828c21ebafe681c7af4b0825ab9509fa0bcb0d21e094c15e90f2e92",
"md5": "9cb75597a92595908e8936f76ae6c7a5",
"sha256": "71cc91eb2d28224ae80785aa845e0fddeefb6b41dbb51994008a842c961147b0"
},
"downloads": -1,
"filename": "bungeegum-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9cb75597a92595908e8936f76ae6c7a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20291321,
"upload_time": "2024-09-16T14:18:23",
"upload_time_iso_8601": "2024-09-16T14:18:23.879251Z",
"url": "https://files.pythonhosted.org/packages/73/55/9ff3a828c21ebafe681c7af4b0825ab9509fa0bcb0d21e094c15e90f2e92/bungeegum-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0a463b781a51a0f9c8190851422cef00a62804af0343a9227da41564fa0b15c",
"md5": "bcd74fe047b4459f0b0c1c93f4da710b",
"sha256": "4135c572891088e626157acafdb406e94005bbe0ebb6a299d825f521618f505a"
},
"downloads": -1,
"filename": "bungeegum-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bcd74fe047b4459f0b0c1c93f4da710b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20292014,
"upload_time": "2024-09-16T14:18:27",
"upload_time_iso_8601": "2024-09-16T14:18:27.874553Z",
"url": "https://files.pythonhosted.org/packages/d0/a4/63b781a51a0f9c8190851422cef00a62804af0343a9227da41564fa0b15c/bungeegum-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 14:18:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Zetier",
"github_project": "bungeegum",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bungeegum"
}
