AndroidFridaManager


NameAndroidFridaManager JSON
Version 1.7.2 PyPI version JSON
download
home_pagehttps://github.com/fkie-cad/AndroidFridaManager
SummaryA python API in order to install and run the frida-server on an Android device.
upload_time2024-06-11 18:13:48
maintainerNone
docs_urlNone
authorDaniel Baier
requires_python>=3.6
licenseGPL v3
keywords mobile instrumentation frida hook android
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # AndroidFridaManager

AndroidFridaManager is a Python API designed to simplify the installation and management of Frida on Android devices. It provides an easy-to-use interface for installing and running the latest Frida server, as well as the flexibility to install specific versions as needed.

Key Features

    Frida Server Management: Seamlessly install and run the latest Frida server on your Android device, or choose to install a specific version as required.
    Job Management: Execute Frida scripts as independent jobs, managed by the `JobManager()`. This feature allows for concurrent execution of multiple Frida scripts, with each job running in its own thread.
    `afrim` Tool Integration: Utilize the `afrim` tool to check for existing Frida server installations on your device and ensure you are always running the latest version.


The project was inspired by [Frida-Python-Binding](https://github.com/Mind0xP/Frida-Python-Binding/tree/master).

## Install

Just install it via pip:
```bash
python3 -m pip install AndroidFridaManager
```

This will install the `afrim`-command to your system.

## Usage

In order to easily install the latest frida-server version to your Android device just run the following command:

```bash
$ afrim 
```


In order to check only if frida-server is running invoke it with the `-r`-parameter:

```bash
$ afrim -r
```


## API Usage

In order to install and run Frida on your Android device use the `FridaManager`-API:
```python
from AndroidFridaManager import FridaManager
...
afm_obj = FridaManager(is_remote=False, socket="ip:port", verbose=False, frida_install_dst="/data/local/tmp/")
afm_obj.install_frida_server()
afm_obj.run_frida_server()
```

For running Frida scripts as jobs use the `JobManager`-API:
```python
from AndroidFridaManager import JobManager
...
app_package = "net.classwindexampleyear.bookseapiececountry"
frida_script_path = "./frida_script1.js"
job_manager = JobManager()
job_manager.setup_frida_session(app_package, myAwesomeHookingHandler)
job_manager.start_job(frida_script_path, myAwesomeHookingHandler)
print("Running jobs:", job_manager.running_jobs())
job_manager.stop_app_with_closing_frida(app_package)
``` 

The `setup_frida_session()` function accepts a callback function as its second parameter, typically provided by `script.on('message', on_message)`. This initializes the first job and, by default, is the only job where you can activate [child_gating and spawn_gating](https://frida.re/news/#child-gating). To execute the job, you must invoke the `start_job()` function.

## API

```python
install_frida_server(dst_dir="/data/local/tmp/", version="latest")
run_frida_server()
is_frida_server_running()
stop_frida_server()
remove_frida_server()

# JobManager
JobManager(host="", enable_spawn_gating=False)
running_jobs() # list running jobs
start_android_app(package_name, main_activity = None, extras = None) # returns the PID of the start app
setup_frida_session(target_process, frida_callback_function, should_spawn=True,foreground=False)
start_job(frida_script_name, frida_callback_function)
stop_jobs() # stops all running jobs
stop_job_with_id(job_id) # stop only job with job_id
detach_from_app() # will also be invoked when running stop_app_with_closing_frida()
stop_app_with_closing_frida(app_package)
stop_app(app_package)
kill_app(pid)
setup_frida_handler(host="", enable_spawn_gating=False) # returns the device object and is used by setup_frida_session()

# setup_frida_handler,setup_frida_session will raise the FridaBasedException(Exception). Ensure to handle it
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/fkie-cad/AndroidFridaManager",
    "name": "AndroidFridaManager",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "mobile, instrumentation, frida, hook, android",
    "author": "Daniel Baier",
    "author_email": "daniel.baier@fkie.fraunhofer.de",
    "download_url": "https://files.pythonhosted.org/packages/8c/c5/e33f4d4eab704b4b537cc5b2273993bc9cd43879f913e7de9b10c755df2d/androidfridamanager-1.7.2.tar.gz",
    "platform": null,
    "description": "# AndroidFridaManager\n\nAndroidFridaManager is a Python API designed to simplify the installation and management of Frida on Android devices. It provides an easy-to-use interface for installing and running the latest Frida server, as well as the flexibility to install specific versions as needed.\n\nKey Features\n\n    Frida Server Management: Seamlessly install and run the latest Frida server on your Android device, or choose to install a specific version as required.\n    Job Management: Execute Frida scripts as independent jobs, managed by the `JobManager()`. This feature allows for concurrent execution of multiple Frida scripts, with each job running in its own thread.\n    `afrim` Tool Integration: Utilize the `afrim` tool to check for existing Frida server installations on your device and ensure you are always running the latest version.\n\n\nThe project was inspired by [Frida-Python-Binding](https://github.com/Mind0xP/Frida-Python-Binding/tree/master).\n\n## Install\n\nJust install it via pip:\n```bash\npython3 -m pip install AndroidFridaManager\n```\n\nThis will install the `afrim`-command to your system.\n\n## Usage\n\nIn order to easily install the latest frida-server version to your Android device just run the following command:\n\n```bash\n$ afrim \n```\n\n\nIn order to check only if frida-server is running invoke it with the `-r`-parameter:\n\n```bash\n$ afrim -r\n```\n\n\n## API Usage\n\nIn order to install and run Frida on your Android device use the `FridaManager`-API:\n```python\nfrom AndroidFridaManager import FridaManager\n...\nafm_obj = FridaManager(is_remote=False, socket=\"ip:port\", verbose=False, frida_install_dst=\"/data/local/tmp/\")\nafm_obj.install_frida_server()\nafm_obj.run_frida_server()\n```\n\nFor running Frida scripts as jobs use the `JobManager`-API:\n```python\nfrom AndroidFridaManager import JobManager\n...\napp_package = \"net.classwindexampleyear.bookseapiececountry\"\nfrida_script_path = \"./frida_script1.js\"\njob_manager = JobManager()\njob_manager.setup_frida_session(app_package, myAwesomeHookingHandler)\njob_manager.start_job(frida_script_path, myAwesomeHookingHandler)\nprint(\"Running jobs:\", job_manager.running_jobs())\njob_manager.stop_app_with_closing_frida(app_package)\n``` \n\nThe `setup_frida_session()` function accepts a callback function as its second parameter, typically provided by `script.on('message', on_message)`. This initializes the first job and, by default, is the only job where you can activate [child_gating and spawn_gating](https://frida.re/news/#child-gating). To execute the job, you must invoke the `start_job()` function.\n\n## API\n\n```python\ninstall_frida_server(dst_dir=\"/data/local/tmp/\", version=\"latest\")\nrun_frida_server()\nis_frida_server_running()\nstop_frida_server()\nremove_frida_server()\n\n# JobManager\nJobManager(host=\"\", enable_spawn_gating=False)\nrunning_jobs() # list running jobs\nstart_android_app(package_name, main_activity = None, extras = None) # returns the PID of the start app\nsetup_frida_session(target_process, frida_callback_function, should_spawn=True,foreground=False)\nstart_job(frida_script_name, frida_callback_function)\nstop_jobs() # stops all running jobs\nstop_job_with_id(job_id) # stop only job with job_id\ndetach_from_app() # will also be invoked when running stop_app_with_closing_frida()\nstop_app_with_closing_frida(app_package)\nstop_app(app_package)\nkill_app(pid)\nsetup_frida_handler(host=\"\", enable_spawn_gating=False) # returns the device object and is used by setup_frida_session()\n\n# setup_frida_handler,setup_frida_session will raise the FridaBasedException(Exception). Ensure to handle it\n```\n",
    "bugtrack_url": null,
    "license": "GPL v3",
    "summary": "A python API in order to install and run the frida-server on an Android device.",
    "version": "1.7.2",
    "project_urls": {
        "Homepage": "https://github.com/fkie-cad/AndroidFridaManager"
    },
    "split_keywords": [
        "mobile",
        " instrumentation",
        " frida",
        " hook",
        " android"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b23432dcad02240eaf25f454513155551663934aa38f28e8ec3b10b148c5f9ff",
                "md5": "fb9b93a60376ad88ffbdc35990017377",
                "sha256": "a1523c6c77766148e09f9a05be77fc9127a12b359b36fe181fcf672511a7f95e"
            },
            "downloads": -1,
            "filename": "AndroidFridaManager-1.7.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fb9b93a60376ad88ffbdc35990017377",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 23885,
            "upload_time": "2024-06-11T18:13:46",
            "upload_time_iso_8601": "2024-06-11T18:13:46.057460Z",
            "url": "https://files.pythonhosted.org/packages/b2/34/32dcad02240eaf25f454513155551663934aa38f28e8ec3b10b148c5f9ff/AndroidFridaManager-1.7.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8cc5e33f4d4eab704b4b537cc5b2273993bc9cd43879f913e7de9b10c755df2d",
                "md5": "8ead886eb90e5e91f06660c3af632235",
                "sha256": "f208c570ab64b1c91569576aa1363b5caa2daf748bd8ba8bf7ff13d4fec7dfa5"
            },
            "downloads": -1,
            "filename": "androidfridamanager-1.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8ead886eb90e5e91f06660c3af632235",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 24660,
            "upload_time": "2024-06-11T18:13:48",
            "upload_time_iso_8601": "2024-06-11T18:13:48.553514Z",
            "url": "https://files.pythonhosted.org/packages/8c/c5/e33f4d4eab704b4b537cc5b2273993bc9cd43879f913e7de9b10c755df2d/androidfridamanager-1.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-11 18:13:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fkie-cad",
    "github_project": "AndroidFridaManager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "androidfridamanager"
}
        
Elapsed time: 0.26677s