feat: decide who may connect at all, by source address
mirror has no accounts, so on a real network the address a connection arrives
from is not a nicety — it is the entire access control. Before this change the
answer was "everyone who can open a TCP connection", which is fine for a laptop
demo and alarming for a box someone leaves running.
`mirror serve --allow-cidr 10.2.0.0/22` (or MIRROR_ALLOW_CIDRS) now restricts
pages, the JSON API and the signaling socket to the networks named, and it is
strict where it needs to be: a malformed CIDR exits 2 with one line instead of
starting a server whose list silently failed to parse, because the two
outcomes of that typo are "nobody can connect" and "everybody can connect".
Empty remains the only permissive state, on purpose.
The rules that matter live in src/mirror/access.py and are the ones that get
either outcome:
* X-Forwarded-For is believed only from MIRROR_TRUSTED_PROXIES (loopback by
default), and only its left-most value. An untrusted peer that sends the
header gets judged on its own address — there is a test for exactly that,
because it is the shape of a bypass.
* The socket is closed before it accepts, so a refused address never creates
a roster entry to clean up behind it.
* An address that cannot be parsed fails closed, and a v6 address is never
"inside" a v4 network (comparing the two raises TypeError, which would be
a 500 on a dual-stack host).
* /healthz is exempt: the container health probe comes from loopback, which
a production list otherwise excludes.
The refused client is told why, and which address it was judged as — "403" in
front of a proxy is undiagnosable otherwise. Browsers get a page, fetches get
JSON, and the page is self-contained because a refused address cannot load
/static/app.css any more than it can load a page. net.js keys its own notice on
the /api/config 403 and stops: without that the pill reads "offline,
reconnecting in 32s" forever for a decision that will never change.
The static files drop their only inline script and style attribute (the landing
page's counter is /static/home.js, its fine print is .fineprint) so the
deployment can send `script-src 'self'; style-src 'self'` with no
'unsafe-inline'. That policy was verified through a real nginx edge carrying the
exact header set — capture through SRTP to decoded, painted frames at
1280x720, eight distinct, zero securitypolicyviolation events — which also
caught the edge sending `Cache-Control: no-store, no-store` and needed
proxy_hide_header, since nginx appends rather than replaces.
24 tests added; 176 pass, 2 skipped, pyright and ruff clean.
LLM-Generated: true
This commit is contained in:
@@ -5,6 +5,7 @@ from __future__ import annotations
|
||||
import pytest
|
||||
|
||||
from mirror import __main__ as entry
|
||||
from mirror.access import ConfigError, parse_cidrs
|
||||
from mirror.config import DEFAULT_PORT, Settings, lan_addresses, parse_ice_servers
|
||||
from mirror.debug import maybe_enable_debugpy
|
||||
|
||||
@@ -30,6 +31,8 @@ class TestSettings:
|
||||
"MIRROR_ICE_SERVERS",
|
||||
"MIRROR_MAX_BITRATE",
|
||||
"MIRROR_MAX_MIRRORS",
|
||||
"MIRROR_ALLOW_CIDRS",
|
||||
"MIRROR_TRUSTED_PROXIES",
|
||||
):
|
||||
monkeypatch.delenv(name, raising=False)
|
||||
settings = Settings.from_env()
|
||||
@@ -37,6 +40,13 @@ class TestSettings:
|
||||
assert settings.host == "0.0.0.0"
|
||||
assert settings.ice_servers == []
|
||||
assert settings.max_streams == 0
|
||||
# Unrestricted until told otherwise, and only loopback may speak for a client.
|
||||
assert settings.allow_cidrs == ()
|
||||
assert [str(network) for network in settings.trusted_proxies] == [
|
||||
"127.0.0.0/8",
|
||||
"::1/128",
|
||||
]
|
||||
assert settings.gate().enabled is False
|
||||
|
||||
def test_environment_wins(self, monkeypatch):
|
||||
monkeypatch.setenv("MIRROR_HOST", "127.0.0.1")
|
||||
@@ -44,8 +54,12 @@ class TestSettings:
|
||||
monkeypatch.setenv("MIRROR_MAX_BITRATE", "250000")
|
||||
monkeypatch.setenv("MIRROR_MAX_MIRRORS", "3")
|
||||
monkeypatch.setenv("MIRROR_ICE_SERVERS", '[{"urls": "stun:box:3478"}]')
|
||||
monkeypatch.setenv("MIRROR_ALLOW_CIDRS", "10.2.0.0/22, fd00::/64")
|
||||
monkeypatch.setenv("MIRROR_TRUSTED_PROXIES", "10.1.1.27")
|
||||
settings = Settings.from_env()
|
||||
assert (settings.host, settings.port) == ("127.0.0.1", 9123)
|
||||
assert [str(network) for network in settings.allow_cidrs] == ["10.2.0.0/22", "fd00::/64"]
|
||||
assert [str(network) for network in settings.trusted_proxies] == ["10.1.1.27/32"]
|
||||
assert settings.max_bitrate_bps == 250_000
|
||||
assert settings.max_streams == 3
|
||||
assert settings.ice_servers == [{"urls": "stun:box:3478"}]
|
||||
@@ -60,6 +74,19 @@ class TestSettings:
|
||||
config = Settings.from_env().client_config()
|
||||
assert set(config) == {"iceServers", "maxBitrateBps", "pingIntervalMs"}
|
||||
|
||||
def test_a_bad_cidr_refuses_to_start_rather_than_failing_open(self, monkeypatch):
|
||||
monkeypatch.setenv("MIRROR_ALLOW_CIDRS", "office")
|
||||
with pytest.raises(ConfigError, match="MIRROR_ALLOW_CIDRS"):
|
||||
Settings.from_env()
|
||||
|
||||
def test_the_gate_carries_both_halves_of_the_setting(self):
|
||||
settings = Settings(
|
||||
allow_cidrs=parse_cidrs("10.2.0.0/22"), trusted_proxies=parse_cidrs("127.0.0.1")
|
||||
)
|
||||
gate = settings.gate()
|
||||
assert gate.enabled is True
|
||||
assert gate.check("127.0.0.1", "10.2.1.5") == (True, "10.2.1.5")
|
||||
|
||||
def test_lan_addresses_are_real_addresses(self):
|
||||
for address in lan_addresses():
|
||||
assert not address.startswith("127.")
|
||||
@@ -74,6 +101,28 @@ class TestCli:
|
||||
assert args.command == "serve"
|
||||
assert args.port == 8123
|
||||
|
||||
def test_allow_cidr_is_repeatable_and_replaces_the_environment(self, monkeypatch):
|
||||
monkeypatch.setenv("MIRROR_ALLOW_CIDRS", "192.168.0.0/16")
|
||||
args = entry.build_parser().parse_args(
|
||||
["serve", "--allow-cidr", "10.2.0.0/22", "--allow-cidr", "fd00::/64"]
|
||||
)
|
||||
assert args.allow_cidr == ["10.2.0.0/22", "fd00::/64"]
|
||||
# cmd_serve replaces rather than merges, so the environment cannot leave a
|
||||
# second, wider network open by accident.
|
||||
assert [str(network) for network in parse_cidrs(",".join(args.allow_cidr))] == [
|
||||
"10.2.0.0/22",
|
||||
"fd00::/64",
|
||||
]
|
||||
|
||||
def test_a_bad_allow_cidr_exits_with_a_message_not_a_traceback(self, capsys):
|
||||
# Config is parsed before anything binds or imports, so this cannot stall
|
||||
# on a stray DEBUGPY in the operator's shell.
|
||||
code = entry.cmd_serve(
|
||||
entry.build_parser().parse_args(["serve", "--allow-cidr", "nonsense"])
|
||||
)
|
||||
assert code == 2
|
||||
assert "--allow-cidr" in capsys.readouterr().err
|
||||
|
||||
def test_port_validation_rejects_nonsense(self):
|
||||
parser = entry.build_parser()
|
||||
with pytest.raises(SystemExit):
|
||||
|
||||
Reference in New Issue
Block a user