Hotspot captive portal: welcome page with the WROLPi's address (#709)
Some checks are pending
CodeQL / Analyze (push) Waiting to run
Controller Tests / controller-tests (push) Waiting to run
Jest Tests / jest-tests (push) Waiting to run

* Hotspot captive portal: welcome page with the WROLPi's address

Devices that join the hotspot probe a fixed plain-HTTP URL to check for
Internet access.  NetworkManager's shared-mode dnsmasq now resolves those
probe hostnames (and `wrolpi`) to the hotspot address via an include the
Controller writes when the hotspot starts, the probes land on the Controller
(port 80), and are redirected to /portal: "This is your WROLPi, its address is
10.42.0.1, open WROLPi / open the Controller".

Only the probe hostnames are hijacked so the hotspot keeps forwarding
everything else when the WROLPi has an uplink.  The include is corrected and
the connection re-activated once if NetworkManager picked a non-default
subnet.  Writing the include is best-effort; the hotspot starts regardless.

`hotspot.captive_portal` (controller.yaml, default true) toggles the probe
redirects and the include; like the other hotspot settings it applies on the
next hotspot start, so saving while the hotspot is up reports
restart_required and both Controller UIs say so.  The status endpoint gains
the hotspot address and portal URL, shown in both UIs.  repair.sh only
creates the include directory so a disabled setting survives upgrades.
Native only: Docker has no hotspot.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* captive portal: address review

* React: re-read the hotspot address whenever the HotspotToggle starts or
  stops the hotspot, matching the fallback UI's refresh-on-status.
* A WPA3 start that reverts to WPA2 leaves the hotspot up, so it now gets
  the captive portal address correction too.
* The corrective `nmcli connection up` logs a warning on a non-zero exit;
  dnsmasq would otherwise keep the old address silently.
* HotspotStatusResponse.captive_portal defaults to true like everywhere else.
* Trim design narrative from the module docstring and React comments.
* The include-before-activate test now observes the include at the moment
  of the `nmcli ... hotspot` call instead of inferring from call order.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* captive portal: never forward any record type for probe hosts

`address=` only synthesizes A/AAAA answers.  iOS also asks for the HTTPS
record type; dnsmasq forwarded that upstream, Apple's answer aliased to
captive.g.aaplimg.com, and the phone fetched the genuine "Success" from
Apple instead of the portal.  Each probe host now also gets `local=`, so
dnsmasq answers every type itself, and the CDN alias is a probe host too.

Observed with dnsmasq query logging on a hotspot with an eth0 uplink.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* captive portal: let acknowledged clients finish so the OS offers "Done"

A phone's sign-in sheet only shows "Done" once the OS re-probes and gets
the genuine success reply.  The Controller now remembers each client (by
hotspot IP) that has loaded the portal page and answers its later probes
with the reply each OS expects (Apple "Success" HTML, Android 204, Windows
"Microsoft Connect Test", ...).  The set is cleared when the hotspot
starts so a new session shows the page again.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* captive portal: acknowledge on Continue, not on view

iOS fetches the portal page in the background before opening the sheet,
then re-probes after the sheet's own navigation.  Acknowledging on view
made that re-probe return "Success" as the sheet's content.  Phones only
re-check the network (and offer "Done") after a full-page navigation, so
the welcome page now has a Continue button leading to /portal/continue,
which is the only place a client is acknowledged.  The Continue page says
to tap Done and links to WROLPi and the Controller.

Also hijack clients3.google.com (older Android probe host).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* help: bump wrolpi-help to the captive portal and Speed Test docs

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

* captive portal: comments describe the Continue design; clear acks on stop

Three comments still described acknowledging on view, which c72a7f7b
removed.  Acknowledged clients are now also cleared when the hotspot
stops, so a lease reused in a later session sees the portal page.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
lrnselfreliance 2026-09-13 20:09:48 -06:00 • committed by Roland
parent 91f92683ba
commit d701846254
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
18 changed files with 1029 additions and 19 deletions

View file

@ -8,6 +8,7 @@ import pytest
import yaml
from controller.lib.config import reload_config_from_drive
from controller.lib import captive_portal
from controller.lib.admin import (
apply_timezone_from_config,
block_bluetooth,
@ -558,6 +559,23 @@ class TestGetHotspotStatusDict:
assert result["available"] is True
assert result["enabled"] is True
def test_ip_and_portal_url_when_connected(self, reset_runtime_config):
with mock.patch("controller.lib.admin.get_hotspot_status", return_value=HotspotStatus.connected), \
mock.patch("controller.lib.captive_portal.get_hotspot_ip", return_value='10.42.0.1'), \
mock.patch("controller.lib.captive_portal.is_docker_mode", return_value=False):
result = get_hotspot_status_dict()
assert result["ip"] == '10.42.0.1'
assert result["captive_portal"] is True
assert result["portal_url"] == 'http://10.42.0.1/portal'
def test_no_ip_when_off(self, reset_runtime_config):
with mock.patch("controller.lib.admin.get_hotspot_status", return_value=HotspotStatus.off), \
mock.patch("controller.lib.captive_portal.get_hotspot_ip") as get_ip:
result = get_hotspot_status_dict()
assert result["ip"] is None
assert result["portal_url"] is None
get_ip.assert_not_called()
class TestHotspotSettingsMigration:
"""Legacy hotspot settings in wrolpi.yaml are copied into controller.yaml on startup."""
@ -654,6 +672,28 @@ class TestUpdateHotspotSettings:
saved = yaml.safe_load(mock_config_path.read_text())
assert saved['hotspot']['protocol'] == 'wpa3'
def test_updates_captive_portal(self, mock_config_path, reset_runtime_config):
"""The captive portal toggle is saved to controller.yaml and returned."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.captive_portal.is_docker_mode", return_value=False):
result = update_hotspot_settings(captive_portal=False)
assert result["success"] is True
assert result["captive_portal"] is False
saved = yaml.safe_load(mock_config_path.read_text())
assert saved['hotspot']['captive_portal'] is False
def test_restart_required_only_while_hotspot_up(self, mock_config_path, reset_runtime_config):
"""A change applies on the next hotspot start, so say so when the hotspot is running."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.admin.get_hotspot_status", return_value=HotspotStatus.connected):
assert update_hotspot_settings(captive_portal=False)["restart_required"] is True
# Nothing changed: nothing to apply.
assert update_hotspot_settings()["restart_required"] is False
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.admin.get_hotspot_status", return_value=HotspotStatus.off):
assert update_hotspot_settings(captive_portal=True)["restart_required"] is False
def test_rejects_invalid_protocol(self, mock_config_path, reset_runtime_config):
"""Only wpa2 and wpa3 are valid protocols."""
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
@ -897,6 +937,9 @@ class TestDockerModeErrors:
assert "Docker" in error
HOTSPOT_IP_JSON = '[{"ifname": "wlan0", "addr_info": [{"family": "inet", "local": "10.42.0.1"}]}]'
class TestStartHotspot:
"""Tests for start_hotspot function."""
@ -924,8 +967,10 @@ class TestStartHotspot:
device_ready = mock.Mock(returncode=0, stdout="wlan1:disconnected\n", stderr="")
ok = mock.Mock(returncode=0, stdout="", stderr="")
# The final call reads the hotspot's address for the captive portal.
ip_addr = mock.Mock(returncode=0, stdout=HOTSPOT_IP_JSON, stderr="")
with mock.patch("subprocess.run",
side_effect=[radio_on, device_ready, ok, ok, ok]) as mock_subprocess:
side_effect=[radio_on, device_ready, ok, ok, ok, ip_addr]) as mock_subprocess:
with mock.patch("time.sleep"):
start_hotspot()
@ -938,15 +983,143 @@ class TestStartHotspot:
assert "TestSSID" in cmd_args
assert "testpassword123" in cmd_args
@staticmethod
def _start_with_nmcli(ip_json=HOTSPOT_IP_JSON):
"""Run start_hotspot with nmcli mocked; returns the subprocess mock and the include path."""
radio_on = mock.Mock(returncode=0, stdout="", stderr="")
device_ready = mock.Mock(returncode=0, stdout="wlan0:disconnected\n", stderr="")
ok = mock.Mock(returncode=0, stdout="", stderr="")
ip_addr = mock.Mock(returncode=0, stdout=ip_json, stderr="")
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.captive_portal.is_docker_mode", return_value=False), \
mock.patch("subprocess.run", side_effect=[radio_on, device_ready, ok, ok, ok, ip_addr, ok]) as run, \
mock.patch("time.sleep"):
result = start_hotspot()
return result, run
def test_writes_captive_portal_config_before_creating_hotspot(self, reset_runtime_config):
"""dnsmasq reads the include at activation, so it must exist before `nmcli ... hotspot`."""
include = captive_portal.INCLUDE_FILE
seen = {}
results = iter([
mock.Mock(returncode=0, stdout="", stderr=""), # radio on
mock.Mock(returncode=0, stdout="wlan0:disconnected\n", stderr=""), # device ready
mock.Mock(returncode=0, stdout="", stderr=""), # nmcli device wifi hotspot
mock.Mock(returncode=0, stdout="", stderr=""), # modify
mock.Mock(returncode=0, stdout="", stderr=""), # up
mock.Mock(returncode=0, stdout=HOTSPOT_IP_JSON, stderr=""), # ip addr
])
def run(cmd, **kwargs):
if 'hotspot' in cmd:
# Observe the include at the moment NetworkManager (and its dnsmasq) start.
seen['include_at_create'] = include.read_text() if include.exists() else None
return next(results)
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.captive_portal.is_docker_mode", return_value=False), \
mock.patch("subprocess.run", side_effect=run), \
mock.patch("time.sleep"):
result = start_hotspot()
assert result["success"] is True
assert seen['include_at_create'] is not None
assert 'address=/captive.apple.com/10.42.0.1' in seen['include_at_create']
def test_disabled_removes_captive_portal_config(self, reset_runtime_config):
include = captive_portal.INCLUDE_FILE
include.write_text('address=/captive.apple.com/10.42.0.1\n')
with mock.patch("controller.lib.captive_portal.get_config_value", return_value=False):
result, run = self._start_with_nmcli()
assert result["success"] is True
assert not include.exists()
# No `ip` read and no extra re-activation when the portal is off.
assert not [c for c in run.call_args_list if c[0][0][0] == 'ip']
def test_rewrites_config_when_networkmanager_picked_another_subnet(self, reset_runtime_config):
"""10.42.1.1 is used when another shared connection holds 10.42.0.1."""
other = '[{"ifname": "wlan0", "addr_info": [{"family": "inet", "local": "10.42.1.1"}]}]'
result, run = self._start_with_nmcli(ip_json=other)
assert result["success"] is True
assert 'address=/captive.apple.com/10.42.1.1' in captive_portal.INCLUDE_FILE.read_text()
# Re-activated once more so dnsmasq re-reads the corrected include.
ups = [c for c in run.call_args_list if c[0][0][:3] == ['nmcli', 'connection', 'up']]
assert len(ups) == 2
def test_reactivation_failure_is_logged(self, reset_runtime_config, caplog):
"""dnsmasq keeps the old address if the corrective `up` fails; say so."""
other = '[{"ifname": "wlan0", "addr_info": [{"family": "inet", "local": "10.42.1.1"}]}]'
ok = mock.Mock(returncode=0, stdout="", stderr="")
device_ready = mock.Mock(returncode=0, stdout="wlan0:disconnected\n", stderr="")
ip_addr = mock.Mock(returncode=0, stdout=other, stderr="")
failed_up = mock.Mock(returncode=4, stdout="", stderr="Error: Connection activation failed")
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.captive_portal.is_docker_mode", return_value=False), \
mock.patch("subprocess.run", side_effect=[ok, device_ready, ok, ok, ok, ip_addr, failed_up]), \
mock.patch("time.sleep"):
result = start_hotspot()
assert result["success"] is True
assert "Could not re-activate hotspot for captive portal" in caplog.text
assert "Connection activation failed" in caplog.text
def test_wpa3_reverted_hotspot_still_gets_captive_portal_ip(self, reset_runtime_config):
"""A WPA3 failure that reverts to WPA2 leaves the hotspot up; it still needs the right address."""
other = '[{"ifname": "wlan0", "addr_info": [{"family": "inet", "local": "10.42.1.1"}]}]'
ok = mock.Mock(returncode=0, stdout="", stderr="")
device_ready = mock.Mock(returncode=0, stdout="wlan0:disconnected\n", stderr="")
sae_failed = mock.Mock(returncode=1, stdout="", stderr="Error: sae unsupported")
ip_addr = mock.Mock(returncode=0, stdout=other, stderr="")
def mock_get_config(key, default=None):
return {'hotspot.protocol': 'wpa3'}.get(key, default)
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("controller.lib.captive_portal.is_docker_mode", return_value=False), \
mock.patch("controller.lib.admin.get_config_value", side_effect=mock_get_config), \
mock.patch("subprocess.run", side_effect=[
ok, device_ready, ok, # radio, ready, hotspot
sae_failed, # modify to sae fails
ok, ok, # revert modify, revert up
ip_addr, ok, # captive portal: read address, re-activate
]) as run, \
mock.patch("time.sleep"):
result = start_hotspot()
assert result["success"] is False
assert "reverted to WPA2" in result["error"]
assert 'address=/captive.apple.com/10.42.1.1' in captive_portal.INCLUDE_FILE.read_text()
assert run.call_args_list[-1][0][0] == ["nmcli", "connection", "up", "Hotspot"]
def test_stop_forgets_acknowledged_clients(self):
"""A later joiner reusing the lease must see the portal page, not a silent success."""
captive_portal.acknowledge_client('10.42.0.210')
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False), \
mock.patch("subprocess.run", return_value=mock.Mock(returncode=0, stdout="", stderr="")):
assert stop_hotspot()["success"] is True
assert not captive_portal.is_client_acknowledged('10.42.0.210')
def test_start_forgets_acknowledged_clients(self, reset_runtime_config):
"""A new hotspot session shows every device the portal page again."""
captive_portal.acknowledge_client('10.42.0.210')
result, _ = self._start_with_nmcli()
assert result["success"] is True
assert not captive_portal.is_client_acknowledged('10.42.0.210')
def test_no_reactivation_when_ip_matches(self, reset_runtime_config):
result, run = self._start_with_nmcli()
ups = [c for c in run.call_args_list if c[0][0][:3] == ['nmcli', 'connection', 'up']]
assert len(ups) == 1
@staticmethod
def _run_enable(protocol: str, results: list) -> tuple:
"""Run start_hotspot() with the given hotspot.protocol and subprocess results."""
def mock_get_config(key, default=None):
return {'hotspot.protocol': protocol}.get(key, default)
# After a successful start the hotspot's address is read once for the captive portal.
ip_addr = mock.Mock(returncode=0, stdout=HOTSPOT_IP_JSON, stderr="")
with mock.patch("controller.lib.admin.is_docker_mode", return_value=False):
with mock.patch("controller.lib.admin.get_config_value", side_effect=mock_get_config):
with mock.patch("subprocess.run", side_effect=results) as mock_subprocess:
with mock.patch("subprocess.run", side_effect=results + [ip_addr]) as mock_subprocess:
with mock.patch("time.sleep"):
result = start_hotspot()
return result, mock_subprocess.call_args_list
@ -1028,6 +1201,7 @@ class TestStartHotspot:
hotspot_result, # nmcli device wifi hotspot
hotspot_result, # nmcli connection modify Hotspot
hotspot_result, # nmcli connection up Hotspot
mock.Mock(returncode=0, stdout=HOTSPOT_IP_JSON, stderr=""), # ip -4 -j addr show
]):
with mock.patch("time.sleep"): # Don't actually sleep in tests
result = start_hotspot()