# m66b/netguard architecture

> Architecture diagram of the GitHub repository m66b/netguard, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/m66b/netguard
- Repository: https://github.com/m66b/netguard

## Overview

NetGuard is an Android no-root firewall: users configure per-app and connection rules, enable its VPN-based filtering, and inspect access logs and usage. The central workflow runs from the app list and rule editor through ServiceSinkhole, with persistent logs and usage handled by DatabaseHelper. Settings also expose DNS, forwarding, hosts-file blocking and PRO features. The tree and README establish these capabilities, but the excerpts do not show how the Java VPN service dispatches packets into the native protocol implementation, so that link is omitted.

Main entry points: [`app/src/main/java/eu/faircode/netguard/ServiceSinkhole.java`](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ServiceSinkhole.java) (VPN firewall), [`app/src/main/java/eu/faircode/netguard/ActivityLog.java`](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityLog.java) (Traffic log), [`app/src/main/java/eu/faircode/netguard/ActivitySettings.java`](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivitySettings.java) (Settings), [`app/src/main/java/eu/faircode/netguard/ActivityMain.java`](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityMain.java) (Firewall screen)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_configuration["Rules &amp; settings"]
  node_main["Firewall screen<br/>[ActivityMain.java]"]
  node_rule_adapter["Rule editor<br/>[AdapterRule.java]"]
  node_rule_model["App rules<br/>[Rule.java]"]
  node_settings["Settings"]
  node_forwarding["Port forwarding"]
  node_dns["DNS screen<br/>[ActivityDns.java]"]
  node_hosts_download["Hosts download<br/>[DownloadTask.java]"]
end

subgraph group_filtering["VPN filtering"]
  node_vpn["VPN firewall"]
  node_external_service["External service"]
end

subgraph group_observability["Logs &amp; usage"]
  node_database[("Firewall database")]
  node_log_screen["Traffic log<br/>[ActivityLog.java]"]
  node_pro["Pro features<br/>[ActivityPro.java]"]
  node_log_adapter["Log display<br/>[AdapterLog.java]"]
  node_pcap["PCAP records<br/>[Packet.java]"]
end

subgraph group_native["Packet engine"]
  node_native_core["Native packet core<br/>[netguard.c]"]
  node_native_tcp["TCP handling<br/>[tcp.c]"]
  node_native_udp["UDP handling<br/>[udp.c]"]
  node_native_dns["DNS handling<br/>[dns.c]"]
  node_native_ip["IP handling<br/>[ip.c]"]
  node_native_tls["TLS inspection<br/>[tls.c]"]
  node_native_session["Sessions<br/>[session.c]"]
end

node_user(("User"))

node_user -->|"configures firewall"| node_main
node_main -->|"displays rules"| node_rule_adapter
node_rule_adapter -->|"updates rules"| node_rule_model
node_main -->|"starts filtering"| node_vpn
node_main -->|"loads access state"| node_database
node_settings -->|"reloads filtering"| node_vpn
node_settings -->|"starts download"| node_hosts_download
node_hosts_download -->|"reloads rules"| node_vpn
node_settings -->|"opens forwarding"| node_forwarding
node_settings -->|"opens DNS"| node_dns
node_vpn -->|"records traffic"| node_database
node_log_screen -->|"queries logs"| node_database
node_log_screen -->|"displays entries"| node_log_adapter
node_log_screen -->|"controls logging"| node_vpn
node_log_screen -->|"checks access"| node_pro
node_log_screen -->|"manages capture"| node_pcap
node_vpn -->|"delegates service"| node_external_service

click node_main "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityMain.java"
click node_rule_adapter "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/AdapterRule.java"
click node_rule_model "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/Rule.java"
click node_settings "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivitySettings.java"
click node_forwarding "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityForwarding.java"
click node_dns "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityDns.java"
click node_hosts_download "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/DownloadTask.java"
click node_vpn "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ServiceSinkhole.java"
click node_external_service "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ServiceExternal.java"
click node_native_core "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/netguard.c"
click node_native_tcp "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/tcp.c"
click node_native_udp "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/udp.c"
click node_native_dns "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/dns.c"
click node_native_ip "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/ip.c"
click node_native_tls "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/tls.c"
click node_native_session "https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/session.c"
click node_database "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/DatabaseHelper.java"
click node_log_screen "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityLog.java"
click node_pro "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityPro.java"
click node_log_adapter "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/AdapterLog.java"
click node_pcap "https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/Packet.java"

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_main,node_rule_adapter,node_rule_model,node_settings,node_forwarding,node_dns,node_hosts_download,node_user toneBlue
class node_vpn,node_external_service toneAmber
class node_database,node_log_screen,node_pro,node_log_adapter,node_pcap toneMint
class node_native_core,node_native_tcp,node_native_udp,node_native_dns,node_native_ip,node_native_tls,node_native_session toneRose
```

## Components

### Rules & settings

- [Firewall screen](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityMain.java): `app/src/main/java/eu/faircode/netguard/ActivityMain.java`
- [Rule editor](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/AdapterRule.java): `app/src/main/java/eu/faircode/netguard/AdapterRule.java`
- [App rules](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/Rule.java): `app/src/main/java/eu/faircode/netguard/Rule.java`
- [Settings](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivitySettings.java): `app/src/main/java/eu/faircode/netguard/ActivitySettings.java`
- [Port forwarding](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityForwarding.java): `app/src/main/java/eu/faircode/netguard/ActivityForwarding.java`
- [DNS screen](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityDns.java): `app/src/main/java/eu/faircode/netguard/ActivityDns.java`
- [Hosts download](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/DownloadTask.java): `app/src/main/java/eu/faircode/netguard/DownloadTask.java`

### VPN filtering

- [VPN firewall](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ServiceSinkhole.java): `app/src/main/java/eu/faircode/netguard/ServiceSinkhole.java`
- [External service](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ServiceExternal.java): `app/src/main/java/eu/faircode/netguard/ServiceExternal.java`

### Logs & usage

- [Firewall database](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/DatabaseHelper.java): `app/src/main/java/eu/faircode/netguard/DatabaseHelper.java`
- [Traffic log](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityLog.java): `app/src/main/java/eu/faircode/netguard/ActivityLog.java`
- [Pro features](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/ActivityPro.java): `app/src/main/java/eu/faircode/netguard/ActivityPro.java`
- [Log display](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/AdapterLog.java): `app/src/main/java/eu/faircode/netguard/AdapterLog.java`
- [PCAP records](https://github.com/m66b/netguard/blob/master/app/src/main/java/eu/faircode/netguard/Packet.java): `app/src/main/java/eu/faircode/netguard/Packet.java`

### Packet engine

- [Native packet core](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/netguard.c): `app/src/main/jni/netguard/netguard.c`
- [TCP handling](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/tcp.c): `app/src/main/jni/netguard/tcp.c`
- [UDP handling](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/udp.c): `app/src/main/jni/netguard/udp.c`
- [DNS handling](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/dns.c): `app/src/main/jni/netguard/dns.c`
- [IP handling](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/ip.c): `app/src/main/jni/netguard/ip.c`
- [TLS inspection](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/tls.c): `app/src/main/jni/netguard/tls.c`
- [Sessions](https://github.com/m66b/netguard/blob/master/app/src/main/jni/netguard/session.c): `app/src/main/jni/netguard/session.c`

### Other components

- **User**

## Connections

- User → Firewall screen: configures firewall
- Firewall screen → Rule editor: displays rules (evidence: `app/src/main/java/eu/faircode/netguard/ActivityMain.java`)
- Rule editor → App rules: updates rules (evidence: `app/src/main/java/eu/faircode/netguard/AdapterRule.java`)
- Firewall screen → VPN firewall: starts filtering (evidence: `app/src/main/java/eu/faircode/netguard/ActivityMain.java`)
- Firewall screen → Firewall database: loads access state (evidence: `app/src/main/java/eu/faircode/netguard/ActivityMain.java`)
- Settings → VPN firewall: reloads filtering (evidence: `app/src/main/java/eu/faircode/netguard/ActivitySettings.java`)
- Settings → Hosts download: starts download (evidence: `app/src/main/java/eu/faircode/netguard/ActivitySettings.java`)
- Hosts download → VPN firewall: reloads rules (evidence: `app/src/main/java/eu/faircode/netguard/DownloadTask.java`)
- Settings → Port forwarding: opens forwarding (evidence: `app/src/main/java/eu/faircode/netguard/ActivitySettings.java`)
- Settings → DNS screen: opens DNS (evidence: `app/src/main/java/eu/faircode/netguard/ActivitySettings.java`)
- VPN firewall → Firewall database: records traffic (evidence: `app/src/main/java/eu/faircode/netguard/ServiceSinkhole.java`)
- Traffic log → Firewall database: queries logs (evidence: `app/src/main/java/eu/faircode/netguard/ActivityLog.java`)
- Traffic log → Log display: displays entries (evidence: `app/src/main/java/eu/faircode/netguard/ActivityLog.java`)
- Traffic log → VPN firewall: controls logging (evidence: `app/src/main/java/eu/faircode/netguard/ActivityLog.java`)
- Traffic log → Pro features: checks access (evidence: `app/src/main/java/eu/faircode/netguard/ActivityLog.java`)
- Traffic log → PCAP records: manages capture (evidence: `app/src/main/java/eu/faircode/netguard/ActivityLog.java`)
- VPN firewall → External service: delegates service (evidence: `app/src/main/java/eu/faircode/netguard/ServiceExternal.java`)
