wrolpi/controller/api/captive_portal.py
Roland 6bea09600e
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>
2026-09-13 19:09:12 -06:00

55 lines
1.9 KiB
Python

"""
Captive portal routes: the landing page hotspot clients see, and the OS connectivity probes
which are redirected to it.
These live at bare paths (not under /api/) because phones request fixed URLs such as
`http://captive.apple.com/hotspot-detect.html`; the hotspot's DNS points those hostnames here.
"""
import logging
from pathlib import Path
from fastapi import APIRouter, HTTPException, Request
from fastapi.responses import RedirectResponse
from fastapi.templating import Jinja2Templates
from controller.lib.admin import get_hotspot_device, get_hotspot_ssid
from controller.lib.captive_portal import (
PORTAL_PATH,
PROBE_PATHS,
get_hotspot_ip,
is_captive_portal_enabled,
)
from controller.lib.config import is_docker_mode
logger = logging.getLogger(__name__)
router = APIRouter()
templates = Jinja2Templates(directory=str(Path(__file__).parent.parent / "templates"))
# Phones must re-probe every time; a cached redirect would show a stale portal.
NO_STORE = {"Cache-Control": "no-store"}
@router.get(PORTAL_PATH, include_in_schema=False)
async def portal(request: Request):
"""The landing page: this WROLPi's address and links to WROLPi and the Controller."""
if is_docker_mode():
raise HTTPException(status_code=404)
ip = get_hotspot_ip(get_hotspot_device())
if not ip:
# Hotspot is down; a page with the wrong address is worse than none.
raise HTTPException(status_code=404)
context = {"ip": ip, "ssid": get_hotspot_ssid()}
return templates.TemplateResponse(request, "portal.html", context, headers=NO_STORE)
async def probe():
"""A connectivity probe. Anything but the expected reply makes the phone show the portal."""
if not is_captive_portal_enabled():
raise HTTPException(status_code=404)
return RedirectResponse(url=PORTAL_PATH, status_code=302, headers=NO_STORE)
for _path in PROBE_PATHS:
router.add_api_route(_path, probe, methods=["GET", "HEAD"], include_in_schema=False)