# sa-fw-an/android-rat architecture

> Architecture diagram of the GitHub repository sa-fw-an/android-rat, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sa-fw-an/android-rat
- Repository: https://github.com/sa-fw-an/android-rat

## Overview

Android-RAT is a Python CLI for generating Android Meterpreter APKs, modifying and signing them for modern Android compatibility, and starting a Metasploit listener. The main user workflow starts in the menu: payload generation invokes msfvenom and then its manifest patch/align/sign routine; users can also separately patch an APK, sign one, or launch a handler. The README documents compatibility and deployment capabilities, but device installation is not implemented in the shown source. The two patching paths are distinct. Relationships are limited to calls visible in excerpts or capabilities documented in the README.

Main entry points: [`cli.py`](https://github.com/sa-fw-an/android-rat/blob/main/cli.py) (Interactive menu), [`builder/payload_generator.py`](https://github.com/sa-fw-an/android-rat/blob/main/builder/payload_generator.py) (Payload generation), [`builder/apk_patch.py`](https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_patch.py) (Manifest patching), [`builder/apk_patcher.py`](https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_patcher.py) (Visible UI patching)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI"]
  node_menu["Interactive menu<br/>[cli.py]"]
end

subgraph group_apk["APK workflows"]
  node_generate["Payload generation"]
  node_compat_patch["Manifest patching<br/>[apk_patch.py]"]
  node_visible_patch["Visible UI patching<br/>[apk_patcher.py]"]
  node_sign["APK signing<br/>[apk_signer.py]"]
  node_output["Generated APK files<br/>[README.md]"]
end

subgraph group_network["Handler"]
  node_metasploit["Metasploit handler"]
end

node_user(("Operator"))
node_msfvenom["msfvenom"]
node_apktool["apktool"]
node_zipalign["zipalign"]
node_apksigner["apksigner"]
node_listener["Metasploit Framework"]

node_user -->|"chooses action"| node_menu
node_menu -->|"calls build"| node_generate
node_menu -->|"calls patch"| node_visible_patch
node_menu -->|"calls signing"| node_sign
node_menu -->|"starts listener"| node_metasploit
node_generate -->|"runs command"| node_msfvenom
node_generate -->|"calls patch/sign"| node_compat_patch
node_compat_patch -->|"decodes and rebuilds"| node_apktool
node_compat_patch -->|"aligns APK"| node_zipalign
node_compat_patch -->|"signs APK"| node_apksigner
node_visible_patch -->|"decodes and rebuilds"| node_apktool
node_visible_patch -->|"aligns APK"| node_zipalign
node_visible_patch -->|"signs APK"| node_apksigner
node_sign -->|"runs signing"| node_apksigner
node_generate -->|"writes APK"| node_output
node_metasploit -->|"runs msfconsole"| node_listener
node_user -.->|"installs APK"| node_output

click node_menu "https://github.com/sa-fw-an/android-rat/blob/main/cli.py"
click node_generate "https://github.com/sa-fw-an/android-rat/blob/main/builder/payload_generator.py"
click node_compat_patch "https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_patch.py"
click node_visible_patch "https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_patcher.py"
click node_sign "https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_signer.py"
click node_metasploit "https://github.com/sa-fw-an/android-rat/blob/main/builder/metasploit_handler.py"
click node_output "https://github.com/sa-fw-an/android-rat/blob/main/output/README.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_menu toneBlue
class node_generate,node_compat_patch,node_visible_patch,node_sign,node_output toneAmber
class node_metasploit toneMint
class node_user,node_msfvenom,node_apktool,node_zipalign,node_apksigner,node_listener toneIndigo
```

## Components

### CLI

- [Interactive menu](https://github.com/sa-fw-an/android-rat/blob/main/cli.py): `cli.py`

### APK workflows

- [Payload generation](https://github.com/sa-fw-an/android-rat/blob/main/builder/payload_generator.py): `builder/payload_generator.py`
- [Manifest patching](https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_patch.py): `builder/apk_patch.py`
- [Visible UI patching](https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_patcher.py): `builder/apk_patcher.py`
- [APK signing](https://github.com/sa-fw-an/android-rat/blob/main/builder/apk_signer.py): `builder/apk_signer.py`
- [Generated APK files](https://github.com/sa-fw-an/android-rat/blob/main/output/README.md): `output/README.md`

### Handler

- [Metasploit handler](https://github.com/sa-fw-an/android-rat/blob/main/builder/metasploit_handler.py): `builder/metasploit_handler.py`

### Other components

- **Operator**
- **msfvenom**
- **apktool**
- **zipalign**
- **apksigner**
- **Metasploit Framework**

## Connections

- Operator → Interactive menu: chooses action (evidence: `cli.py`)
- Interactive menu → Payload generation: calls build (evidence: `cli.py`)
- Interactive menu → Visible UI patching: calls patch (evidence: `cli.py`)
- Interactive menu → APK signing: calls signing (evidence: `cli.py`)
- Interactive menu → Metasploit handler: starts listener (evidence: `cli.py`)
- Payload generation → msfvenom: runs command (evidence: `builder/payload_generator.py`)
- Payload generation → Manifest patching: calls patch/sign (evidence: `builder/payload_generator.py`)
- Manifest patching → apktool: decodes and rebuilds (evidence: `builder/apk_patch.py`)
- Manifest patching → zipalign: aligns APK (evidence: `builder/apk_patch.py`)
- Manifest patching → apksigner: signs APK (evidence: `builder/apk_patch.py`)
- Visible UI patching → apktool: decodes and rebuilds (evidence: `builder/apk_patcher.py`)
- Visible UI patching → zipalign: aligns APK (evidence: `builder/apk_patcher.py`)
- Visible UI patching → apksigner: signs APK (evidence: `builder/apk_patcher.py`)
- APK signing → apksigner: runs signing (evidence: `builder/apk_signer.py`)
- Payload generation → Generated APK files: writes APK (evidence: `builder/payload_generator.py`)
- Metasploit handler → Metasploit Framework: runs msfconsole (evidence: `builder/metasploit_handler.py`)
- Operator → Generated APK files: installs APK (evidence: `README.md`)
