How gutschke/wgrtc works
Wgrtc is an Android WireGuard manager for joining or hosting tunnels, including NAT traversal, phone-to-phone wormhole pairing, and multiple concurrent joiner tunnels. The principal flow runs from Android UI through the ViewModel into tunnel configuration and a VPN service; signaling discovers and refreshes peer endpoints, while native bridge code carries tunnel traffic. The README also describes a Linux daemon, but its runtime source is absent from this tree, so it is not mapped. Some connections below reflect explicit documentation or source-index references; unsampled internals limit detail.
Main entry points: WgrtcViewModel.kt Tunnel workflow · WgBridgeNative.kt Native bridge API · WormholeHostController.kt Wormhole host · WormholeJoinController.kt Wormhole join
Components 23
Android app
- App navigation
android/app/src/main/kotlin/com/gutschke/wgrtc/MainActivity.kt - Tunnel workflow
android/app/src/main/kotlin/com/gutschke/wgrtc/WgrtcViewModel.kt - App lifecycle
android/app/src/main/kotlin/com/gutschke/wgrtc/WgrtcApp.kt - Tunnel model
android/app/src/main/kotlin/com/gutschke/wgrtc/data/Tunnel.kt - Tunnel state
android/app/src/main/kotlin/com/gutschke/wgrtc/data/TunnelStateRegistry.kt
Pairing and signaling
- Enrollment client
android/signalling/src/main/kotlin/com/gutschke/wgrtc/signalling/EnrollClient.kt - Wormhole host
android/app/src/main/kotlin/com/gutschke/wgrtc/data/WormholeHostController.kt - Wormhole join
android/app/src/main/kotlin/com/gutschke/wgrtc/data/WormholeJoinController.kt - Pairing codes
android/signalling/src/main/kotlin/com/gutschke/wgrtc/signalling/WormholeCode.kt - Roam recovery
android/signalling/src/main/kotlin/com/gutschke/wgrtc/signalling/RoamController.kt
Tunnel runtime
- VPN configuration
android/app/src/main/kotlin/com/gutschke/wgrtc/data/JoinerVpnConfig.kt - Joiner orchestration
android/app/src/main/kotlin/com/gutschke/wgrtc/data/JoinerNController.kt - Shared VPN service
android/app/src/main/kotlin/com/gutschke/wgrtc/service/JoinerNVpnService.kt - Single VPN service
android/app/src/main/kotlin/com/gutschke/wgrtc/service/JoinerVpnService.kt - Host VPN service
android/app/src/main/kotlin/com/gutschke/wgrtc/service/HostModeVpnService.kt - Userspace stack
android/app/src/main/kotlin/com/gutschke/wgrtc/data/JoinerStackBackend.kt
Networking features
- DNS proxy
android/app/src/main/kotlin/com/gutschke/wgrtc/data/DnsProxy.kt - DNS listener
android/app/src/main/kotlin/com/gutschke/wgrtc/data/DnsService.kt
Native bridge
- Native bridge API
android/app/src/main/kotlin/com/gutschke/wgrtc/data/WgBridgeNative.kt - Bridge implementation
android/wgbridge_native/api.go
Other components
- User
- Signaling broker
- Peer network
Connections 26
- User → App navigation: uses
android/app/src/main/kotlin/com/gutschke/wgrtc/MainActivity.kt - App navigation → Tunnel workflow: invokes
android/app/src/main/kotlin/com/gutschke/wgrtc/MainActivity.kt - Tunnel workflow → Tunnel model: manages
android/app/src/main/kotlin/com/gutschke/wgrtc/WgrtcViewModel.kt - Tunnel workflow → Shared VPN service: connects
- Tunnel workflow → Single VPN service: connects
- Tunnel workflow → Wormhole host: starts
android/app/src/main/kotlin/com/gutschke/wgrtc/MainActivity.kt - Tunnel workflow → Wormhole join: starts
android/app/src/main/kotlin/com/gutschke/wgrtc/MainActivity.kt - App lifecycle → Tunnel state: reconciles
- App lifecycle → Signaling broker: registers listeners
- Wormhole host → Pairing codes: uses
android/app/src/main/kotlin/com/gutschke/wgrtc/data/WormholeHostController.kt - Wormhole join → Pairing codes: uses
android/app/src/main/kotlin/com/gutschke/wgrtc/data/WormholeJoinController.kt - Wormhole host → Signaling broker: signals
- Wormhole join → Signaling broker: signals
- Enrollment client → Signaling broker: enrolls
android/signalling/src/main/kotlin/com/gutschke/wgrtc/signalling/EnrollClient.kt - Roam recovery → Peer network: races endpoints
- Shared VPN service → Joiner orchestration: delegates
android/app/src/main/kotlin/com/gutschke/wgrtc/service/JoinerNVpnService.kt - Joiner orchestration → Userspace stack: rebuilds
android/app/src/main/kotlin/com/gutschke/wgrtc/data/JoinerNController.kt - Shared VPN service → Native bridge API: installs protector
android/app/src/main/kotlin/com/gutschke/wgrtc/service/JoinerNVpnService.kt - Single VPN service → VPN configuration: applies
android/app/src/main/kotlin/com/gutschke/wgrtc/service/JoinerVpnService.kt - Single VPN service → Native bridge API: uses
android/app/src/main/kotlin/com/gutschke/wgrtc/service/JoinerVpnService.kt - Host VPN service → Native bridge API: protects sockets
android/app/src/main/kotlin/com/gutschke/wgrtc/service/HostModeVpnService.kt - Userspace stack → Native bridge API: calls
android/app/src/main/kotlin/com/gutschke/wgrtc/data/JoinerStackBackend.kt - Native bridge API → Bridge implementation: bridges to
- DNS listener → DNS proxy: handles queries
android/app/src/main/kotlin/com/gutschke/wgrtc/data/DnsService.kt - DNS listener → Userspace stack: listens on
android/app/src/main/kotlin/com/gutschke/wgrtc/data/DnsService.kt - Bridge implementation → Peer network: forwards traffic