postmarketos-base-ui: enable USB tethering v2

USB tethering support

Enable USB tethering on postmarketOS' setup with unudhpcd and NetworkManager. Users can share their WWAN or WiFi iface of their phones with desktops/laptops over USB while still accessing the phone over USB with SSH.

What is USB tethering?

Several Android/iOS phones allow you to share your WiFi or WWAN interface to a connected laptop/desktop over USB. This is similar to a WiFi hotspot, but over USB. As an user, you benefit from lower power consumption, no need to secure your hotspot, and you can share your WiFi connection as well. Bonus: US carriers cannot see that we're tethering and charge for this feature like on Android/iOS as we don't report this to the carrier like Android/iOS OS does :)

How does it work?

NetworkManager supports tethering out-of-the-box under the IPv4/IPv6 method shared which spawns dnsmasq for DHCP requests from the connected client and DNS forwarding from the client to the DNS server configured on the phone. However, this heavily conflicts with postmarketOS setup in its initfs as unudhcpd also acts as DHCP server. Moreover, by default, NetworkManager does not manage USB Ethernet gadgets like we create in initfs.

This MR solves these problems as followed:

1. Expand NetworkManager with a reapply dispatcher action so we can add on the iface changes that are applied when a NetworkManager connection profile is changed. After a change to the connection profile, a reapply job needs to be executed which triggers the dispatcher action.
2. Execute a dispatcher script when the connection profile is reapplied:

• manual mode which is like in initfs, IP is static set to 172.16.42.1 for the phone, 172.16.42.2 for the connected client, iface becomes managed by NetworkManager and unudhcpd handles DHCP requests. If unudhcpd is not running, it gets spawned.
• shared mode which is USB tethering, NetworkManager spawns dnsmasq and uses IP is 172.16.42.1 for the phone and a DHCP server for the connected client. The whole available range is used. If unudhcpd is running, it gets killed to avoid conflicts with dnsmasq. NetworkManager will also arrange the necessary configs so IP forwarding is enabled in the kernel and firewall. These configs are removed when tethering is disabled again.

When the mode is changed, UDC of the gadget is reactivated to trigger a disconnect/connect event on the connected client. This way, we ensure that the client performs a DHCP request to request an IP from either unudhcpd or dnsmasq, depending on the mode. The script logs with logger to syslog under the tag nm-tethering.

No matter which mode is active, SSH login over USB still works as the phone still uses the same IP 172.16.42.1.

How to test this?

Checkout the branch and build it with pmbootstrap. mrtest does not work as the CI times out, CI builds skipped.

To use this feature:

1. Connect your phone over USB to your desktop.
2. On the phone, open Settings
3. Go to the Network panel tab.
4. You should see 1 wired connection at the top, tab the edit settings button (gear)
5. An old panel opens which doesn't fit your screen (use Phosh Mobile Settings to enable scale-to-fit for this panel only, it will be shown in the list of active apps).
6. Go to the IPv4 tab.
7. Select 'Shared to other computers' and tab the Apply button in the right corner.

NM should now launch its own dnsmasq instance, configure the firewall to allow internet sharing over usb0. It will trigger a script to re-establish the USB ethernet connection with the desktop. This way, the desktop will get an IP in the 10.X.X.X range and also a DNS server to which it can send DNS queries for this connection. Normally, you should be able to access the Web over usb0 now if you have WiFi or WWAN turned ON on the phone.

TODOs

• Once unplugged, it does not autoconnect anymore when plugged in again. NetworkManager blocks everything until the user manually enables the USB Ethernet device in GNOME Settings. This is resolved by setting the connection autoconnect property to true.
• On each boot, NetworkManager creates a new connection profile for usb0.
• GNOME Settings does not seem to perform a reapply of the connection on the iface when pressing 'Apply' in the connection setting UI.
• dnsane support (!3805 (closed))?

Draft until these TODOs are addressed or a solution if on the way for them.

Upstream

• NetworkManager MR 1311
• NetworkManager dnsmasq fix MR 43470
• GNOME Settings reapply on device fix MR 1642
• NetworkManager upgrade to 1.42.0 MR 44105
• GNOME Settings reapply patch backported to Alpine MR 44146
• dnsmasq missing pre-install script MR 44152

Issues & merge requests

Fixes #1904 (moved)
Fixes unudhcpd#1 (moved)
Contributes to #1518
Superseeds !3301 (closed)

Tested on Plasma Mobile, but Settings cannot set the connection to shared mode and back. So only the CLI way is available there.

CC: @craftyguy

main/postmarketos-base-ui/APKBUILD

 # Maintainer: Clayton Craft <clayton@craftyguy.net>
 pkgname=postmarketos-base-ui
-pkgver=6
-pkgrel=2
+pkgver=7
+pkgrel=0
 pkgdesc="Meta package for minimal postmarketOS UI base"
 url="https://postmarketos.org"
 arch="noarch"
@@ -37,6 +37,7 @@ replaces_priority=100  # leave plenty for alpine
 
 _source644="
 	etc/NetworkManager/conf.d/hostname-mode.conf
+	etc/NetworkManager/conf.d/tethering.conf
 	etc/chrony/chrony.conf
 	etc/conf.d/tinydm
 	etc/conf.d/wpa_supplicant
@@ -58,7 +59,7 @@ flatpath() {
 		echo "rootfs-$i" | sed s./.-.g
 	done
 }
-source="$(flatpath $_source644 $_source755)"
+source="$(flatpath $_source644 $_source755) tethering.sh"
 
 package() {
 	local i
@@ -124,12 +125,16 @@ networkmanager() {
 		networkmanager-openrc
 		networkmanager-tui
 		networkmanager-wifi
-		networkmanager-wwan"
+		networkmanager-wwan
+		networkmanager-dnsmasq"
 	amove etc/NetworkManager/conf.d/hostname-mode.conf
+	install -Dm755 "$srcdir"/tethering.sh \
+		"$subpkgdir"/etc/NetworkManager/dispatcher.d/85-tethering
 }
 
 sha512sums="
 3c9ae7415f4891bee8595166ed6a42cb577a837f741c6b5409d193558626348b41516888a01d0c4895282c5f4e9a1ff838c19712888750b2ef68429bb4b42ee3  rootfs-etc-NetworkManager-conf.d-hostname-mode.conf
+2b4e5f4f0753d468a642bb223fd5f65dd41871aff8f9042b3a78e67fd82937c64a5c0e89c0c38ec105cce08d8f3a11638bd54c61dd66d96d2b9e0bce1954a6a0  rootfs-etc-NetworkManager-conf.d-tethering.conf
 e5d049db1d82c510bab9246208b51b8ec2711d008d67792fc10d4c0b65ed4dece7b5ae3c3dd28a8539d177b6849c1f921cb9fef3d2c7bee0355451f7b4757ec6  rootfs-etc-chrony-chrony.conf
 44e4283c6f77de83915977dd3bc2d8e2d96b3ed6cc68d3cc156304359ae649b5a8b0bac843e517ec6faa2066dd43ba85e313899b1eda04862f864fb9eb508aa0  rootfs-etc-conf.d-tinydm
 fe0651904c1f40ffa67d83daca190af199f63247e53642a59a1e1147cd06776fcf20b7b2fcc5373783d50b8bd6ce8d1354c8e5f4d582d319727b9ceefd1e8e16  rootfs-etc-conf.d-wpa_supplicant
@@ -140,4 +145,5 @@ fe0651904c1f40ffa67d83daca190af199f63247e53642a59a1e1147cd06776fcf20b7b2fcc53737
 cac604e25c46e695dd30bd5a10cfd2d69595fcc3bc290096ac94b76b10834d591ea6576afb79c46b5da492a1dbf8660cf87b6110cd39937e15237bc74fa7a5c6  rootfs-etc-X11-Xwrapper.config
 d1ddd43489e6016e3ffd716027ed2bae4a2ab5f213118bdbcb96750e267ab7c0367cd0e0e386300aa5550352653144f5caeddd790621fe0879f83ca1995bb65c  rootfs-etc-tinydm.d-env-wayland.d-50-firefox-wayland.sh
 ecaa57d033a119a53a6574c27636b7c89d659d75ea48a973a6a4ff6f90e5d07202529fd489bfc9dfc7430f5b60f40612f6d5c06f7fab47e681b0a3112a874058  rootfs-etc-tinydm.d-env-wayland.d-50-sdl-wayland.sh
+f333ce548f8a96240eb2420d005e1bf61ee3bd2ab51ce1f14e44c4d3a1cd277589cd937cdc3cc48d2251a9f502c591c8aa09dff9cee2d4fed52b6938b22ce456  tethering.sh
 "