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

temp/networkmanager/0001-nm-dispatcher-dispatch-on-reapply.patch

-From 7c8d7639358820dc7c09f9f6160eb99ec126ea37 Mon Sep 17 00:00:00 2001
+From b3df6ab4f36539127254ab3668958f07a88c62b8 Mon Sep 17 00:00:00 2001
 From: Dylan Van Assche <me@dylanvanassche.be>
 Date: Sat, 23 Jul 2022 08:39:37 +0200
-Subject: [PATCH] nm-dispatcher: dispatch on reapply
+Subject: [PATCH 1/2] nm-dispatcher: dispatch on reapply
 
 Trigger a dispatcher event when a connection is reapplied on a NM device.
 Some devices such as phones have already a DHCP client running for accepting
@@ -19,71 +19,17 @@ To achieve this, add a new NetworkManager Dispatcher event
 device. This way, a dispatcher script can handle the case above by
 inspecting the IP method in the dispatcher script.
 ---
- man/NetworkManager-dispatcher.xml             |  8 ------
- src/core/devices/nm-device.c                  | 17 +++++++++++-
- src/core/nm-dispatcher.c                      | 27 ++++++++++---------
- src/core/nm-dispatcher.h                      |  3 ++-
- src/libnm-core-aux-extern/nm-dispatcher-api.h |  1 +
- 5 files changed, 33 insertions(+), 23 deletions(-)
+ src/core/devices/nm-device.c                  | 4 ++++
+ src/core/nm-dispatcher.c                      | 3 ++-
+ src/core/nm-dispatcher.h                      | 3 ++-
+ src/libnm-core-aux-extern/nm-dispatcher-api.h | 1 +
+ 4 files changed, 9 insertions(+), 2 deletions(-)
 
-diff --git a/man/NetworkManager-dispatcher.xml b/man/NetworkManager-dispatcher.xml
-index 4a603b1566..1f5eda5def 100644
---- a/man/NetworkManager-dispatcher.xml
-+++ b/man/NetworkManager-dispatcher.xml
-@@ -224,14 +224,6 @@
-             interface on which IP addresses and routes will be configured.
-           </para></listitem>
-         </varlistentry>
--        <varlistentry>
--          <term><varname>IP4_ADDRESS_N</varname></term>
--          <listitem><para>
--            The IPv4 address in the format "address/prefix gateway", where N is a number
--            from 0 to (# IPv4 addresses - 1). gateway item in this variable is deprecated,
--            use IP4_GATEWAY instead.
--          </para></listitem>
--        </varlistentry>
-         <varlistentry>
-           <term><varname>IP4_NUM_ADDRESSES</varname></term>
-           <listitem><para>
 diff --git a/src/core/devices/nm-device.c b/src/core/devices/nm-device.c
-index 93399cafb2..6cfa673500 100644
+index 93399cafb2..9979b57ef9 100644
 --- a/src/core/devices/nm-device.c
 +++ b/src/core/devices/nm-device.c
-@@ -584,6 +584,9 @@ typedef struct _NMDevicePrivate {
-     bool v4_route_table_initialized : 1;
-     bool v6_route_table_initialized : 1;
- 
-+    char *v4_method;
-+    char *v6_method;
-+
-     bool l3config_merge_flags_has : 1;
- 
-     bool v4_route_table_all_sync_before : 1;
-@@ -5785,7 +5788,7 @@ concheck_update_state(NMDevice           *self,
-         _dev_l3_register_l3cds(self, priv->l3cfg, TRUE, NM_TERNARY_DEFAULT);
- }
- 
--static const char *
-+const char *
- nm_device_get_effective_ip_config_method(NMDevice *self, int addr_family)
- {
-     NMDeviceClass *klass;
-@@ -12219,6 +12222,14 @@ activate_stage3_ip_config(NMDevice *self)
- 
-     activate_stage3_ip_config_for_addr_family(self, AF_INET, ipv4_method);
-     activate_stage3_ip_config_for_addr_family(self, AF_INET6, ipv6_method);
-+
-+    if (priv->v4_method)
-+        g_free(priv->v4_method);
-+    priv->v4_method = g_strdup(ipv4_method);
-+
-+    if (priv->v6_method)
-+        g_free(priv->v6_method);
-+    priv->v6_method = g_strdup(ipv6_method);
- }
- 
- void
-@@ -13038,6 +13049,10 @@ check_and_reapply_connection(NMDevice            *self,
+@@ -13038,6 +13038,10 @@ check_and_reapply_connection(NMDevice            *self,
      if (priv->state >= NM_DEVICE_STATE_ACTIVATED)
          nm_device_update_metered(self);
  
@@ -95,40 +41,16 @@ index 93399cafb2..6cfa673500 100644
  }
  
 diff --git a/src/core/nm-dispatcher.c b/src/core/nm-dispatcher.c
-index ab361faa7b..1e7a1fa99b 100644
+index ab361faa7b..01a6382609 100644
 --- a/src/core/nm-dispatcher.c
 +++ b/src/core/nm-dispatcher.c
-@@ -456,19 +456,20 @@ dispatcher_done_cb(GObject *source, GAsyncResult *result, gpointer user_data)
-     dispatcher_call_id_free(call_id);
- }
- 
--static const char *action_table[] = {[NM_DISPATCHER_ACTION_HOSTNAME]      = NMD_ACTION_HOSTNAME,
--                                     [NM_DISPATCHER_ACTION_PRE_UP]        = NMD_ACTION_PRE_UP,
--                                     [NM_DISPATCHER_ACTION_UP]            = NMD_ACTION_UP,
--                                     [NM_DISPATCHER_ACTION_PRE_DOWN]      = NMD_ACTION_PRE_DOWN,
--                                     [NM_DISPATCHER_ACTION_DOWN]          = NMD_ACTION_DOWN,
--                                     [NM_DISPATCHER_ACTION_VPN_PRE_UP]    = NMD_ACTION_VPN_PRE_UP,
--                                     [NM_DISPATCHER_ACTION_VPN_UP]        = NMD_ACTION_VPN_UP,
--                                     [NM_DISPATCHER_ACTION_VPN_PRE_DOWN]  = NMD_ACTION_VPN_PRE_DOWN,
--                                     [NM_DISPATCHER_ACTION_VPN_DOWN]      = NMD_ACTION_VPN_DOWN,
--                                     [NM_DISPATCHER_ACTION_DHCP_CHANGE_4] = NMD_ACTION_DHCP4_CHANGE,
--                                     [NM_DISPATCHER_ACTION_DHCP_CHANGE_6] = NMD_ACTION_DHCP6_CHANGE,
--                                     [NM_DISPATCHER_ACTION_CONNECTIVITY_CHANGE] =
+@@ -468,7 +468,8 @@ static const char *action_table[] = {[NM_DISPATCHER_ACTION_HOSTNAME]      = NMD_
+                                      [NM_DISPATCHER_ACTION_DHCP_CHANGE_4] = NMD_ACTION_DHCP4_CHANGE,
+                                      [NM_DISPATCHER_ACTION_DHCP_CHANGE_6] = NMD_ACTION_DHCP6_CHANGE,
+                                      [NM_DISPATCHER_ACTION_CONNECTIVITY_CHANGE] =
 -                                         NMD_ACTION_CONNECTIVITY_CHANGE};
-+static const char *action_table[] = {
-+    [NM_DISPATCHER_ACTION_HOSTNAME]            = NMD_ACTION_HOSTNAME,
-+    [NM_DISPATCHER_ACTION_PRE_UP]              = NMD_ACTION_PRE_UP,
-+    [NM_DISPATCHER_ACTION_UP]                  = NMD_ACTION_UP,
-+    [NM_DISPATCHER_ACTION_PRE_DOWN]            = NMD_ACTION_PRE_DOWN,
-+    [NM_DISPATCHER_ACTION_DOWN]                = NMD_ACTION_DOWN,
-+    [NM_DISPATCHER_ACTION_VPN_PRE_UP]          = NMD_ACTION_VPN_PRE_UP,
-+    [NM_DISPATCHER_ACTION_VPN_UP]              = NMD_ACTION_VPN_UP,
-+    [NM_DISPATCHER_ACTION_VPN_PRE_DOWN]        = NMD_ACTION_VPN_PRE_DOWN,
-+    [NM_DISPATCHER_ACTION_VPN_DOWN]            = NMD_ACTION_VPN_DOWN,
-+    [NM_DISPATCHER_ACTION_DHCP_CHANGE_4]       = NMD_ACTION_DHCP4_CHANGE,
-+    [NM_DISPATCHER_ACTION_DHCP_CHANGE_6]       = NMD_ACTION_DHCP6_CHANGE,
-+    [NM_DISPATCHER_ACTION_CONNECTIVITY_CHANGE] = NMD_ACTION_CONNECTIVITY_CHANGE,
-+    [NM_DISPATCHER_ACTION_REAPPLY]             = NMD_ACTION_REAPPLY};
++                                         NMD_ACTION_CONNECTIVITY_CHANGE,
++                                     [NM_DISPATCHER_ACTION_REAPPLY] = NMD_ACTION_REAPPLY};
  
  static const char *
  action_to_string(NMDispatcherAction action)