mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-22 02:48:15 +00:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
29f1c68bea |
@@ -37,10 +37,6 @@ echo " systemctl: $SYSTEMCTL_PATH"
|
|||||||
echo ""
|
echo ""
|
||||||
echo "Step 1: Configuring sudo permissions for nmcli..."
|
echo "Step 1: Configuring sudo permissions for nmcli..."
|
||||||
SUDOERS_FILE="/etc/sudoers.d/ledmatrix_wifi"
|
SUDOERS_FILE="/etc/sudoers.d/ledmatrix_wifi"
|
||||||
SYSCTL_PATH=$(command -v sysctl || echo /usr/sbin/sysctl)
|
|
||||||
NFT_PATH=$(command -v nft || echo /usr/sbin/nft)
|
|
||||||
RFKILL_PATH=$(command -v rfkill || echo /usr/sbin/rfkill)
|
|
||||||
MKDIR_PATH=$(command -v mkdir || echo /usr/bin/mkdir)
|
|
||||||
|
|
||||||
# Create a temporary sudoers file using mktemp (handles permissions better)
|
# Create a temporary sudoers file using mktemp (handles permissions better)
|
||||||
TEMP_SUDOERS=$(mktemp) || {
|
TEMP_SUDOERS=$(mktemp) || {
|
||||||
@@ -66,36 +62,6 @@ $WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH start dnsmasq
|
|||||||
$WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH stop dnsmasq
|
$WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH stop dnsmasq
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH restart dnsmasq
|
$WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH restart dnsmasq
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH restart NetworkManager
|
$WEB_USER ALL=(ALL) NOPASSWD: $SYSTEMCTL_PATH restart NetworkManager
|
||||||
# The captive portal turns IP forwarding on while the access point is up and
|
|
||||||
# restores the previous value when it comes down (wifi_manager._setup_iptables_
|
|
||||||
# redirect / _teardown_iptables_redirect). Without this rule that sudo call
|
|
||||||
# needs a password, so forwarding stays off and clients associate to the AP but
|
|
||||||
# cannot route. It goes unnoticed on a stock Raspberry Pi image, where
|
|
||||||
# /etc/sudoers.d/010_pi-nopasswd grants the default user blanket NOPASSWD and
|
|
||||||
# masks every gap in this file -- it only bites once that blanket rule is
|
|
||||||
# removed.
|
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $SYSCTL_PATH -w net.ipv4.ip_forward=0
|
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $SYSCTL_PATH -w net.ipv4.ip_forward=1
|
|
||||||
# The portal's redirect lives in its own nftables table, created when the AP
|
|
||||||
# comes up and deleted when it goes down, and the radio has to be unblocked
|
|
||||||
# before the AP can start at all. Same story as the sysctl rules above: called
|
|
||||||
# with sudo, never granted here, and invisible on a stock Pi image.
|
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $NFT_PATH add table ip ledmatrix
|
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $NFT_PATH delete table ip ledmatrix
|
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $RFKILL_PATH unblock wifi
|
|
||||||
# NetworkManager's dnsmasq drop-in directory, exact path.
|
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: $MKDIR_PATH -p /etc/NetworkManager/dnsmasq-shared.d
|
|
||||||
#
|
|
||||||
# iptables is deliberately NOT granted here. Its rules are built from the live
|
|
||||||
# interface name and port, so a rule covering them needs a trailing wildcard --
|
|
||||||
# and `iptables --modprobe=/path/to/anything` runs that path as root, so
|
|
||||||
# `NOPASSWD: iptables *` is a root shell for the web user by another name. That
|
|
||||||
# is a worse outcome than the gap it would close, which today is masked anyway
|
|
||||||
# by the blanket NOPASSWD rule on stock Pi images.
|
|
||||||
#
|
|
||||||
# Closing it safely means a wrapper script that builds the rules itself and
|
|
||||||
# takes only an interface and a port, granted the way safe_plugin_rm.sh already
|
|
||||||
# is. That belongs in its own change rather than being smuggled into this one.
|
|
||||||
|
|
||||||
# Allow copying hostapd and dnsmasq config files into place
|
# Allow copying hostapd and dnsmasq config files into place
|
||||||
$WEB_USER ALL=(ALL) NOPASSWD: /usr/bin/cp /tmp/hostapd.conf /etc/hostapd/hostapd.conf
|
$WEB_USER ALL=(ALL) NOPASSWD: /usr/bin/cp /tmp/hostapd.conf /etc/hostapd/hostapd.conf
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import time
|
|||||||
import logging
|
import logging
|
||||||
import threading
|
import threading
|
||||||
from typing import Dict, Optional, Any, Callable
|
from typing import Dict, Optional, Any, Callable
|
||||||
from dataclasses import dataclass, field
|
from dataclasses import dataclass, field, fields
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import psutil
|
import psutil
|
||||||
@@ -102,6 +102,50 @@ class PluginResourceMonitor:
|
|||||||
"psutil not available - resource monitoring will be limited to execution time only"
|
"psutil not available - resource monitoring will be limited to execution time only"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def _metrics_from_cache(self, plugin_id: str, cached: Any) -> "ResourceMetrics":
|
||||||
|
"""Build metrics from a cached record, ignoring anything unrecognised.
|
||||||
|
|
||||||
|
ResourceMetrics(**cached) raises TypeError on a single unexpected key,
|
||||||
|
and that exception escapes into plugin_manager, which reports it as
|
||||||
|
"plugin <id> operation failed". Every plugin fails, and the plugin
|
||||||
|
system never finishes initialising.
|
||||||
|
|
||||||
|
Seen on a live rig: every plugin failing with
|
||||||
|
|
||||||
|
ResourceMetrics.__init__() got an unexpected keyword argument
|
||||||
|
'consecutive_failures'
|
||||||
|
|
||||||
|
which is a plugin_health field, not a metrics one. How a health-shaped
|
||||||
|
record came to sit under a plugin_metrics key on that machine is not
|
||||||
|
established -- a restored backup that mixed two machines' caches is the
|
||||||
|
likeliest explanation -- but the loader should not be brittle enough for
|
||||||
|
it to matter. plugin_health already repairs its records field by field
|
||||||
|
rather than trusting whatever is on disk; this does the same.
|
||||||
|
|
||||||
|
Unknown keys are dropped and named once, so a genuine schema change is
|
||||||
|
visible in the log instead of silently discarded.
|
||||||
|
"""
|
||||||
|
if not isinstance(cached, dict):
|
||||||
|
self.logger.warning(
|
||||||
|
"Ignoring cached metrics for %s: expected a mapping, got %s",
|
||||||
|
plugin_id, type(cached).__name__)
|
||||||
|
return ResourceMetrics()
|
||||||
|
|
||||||
|
known = {f.name for f in fields(ResourceMetrics)}
|
||||||
|
unknown = sorted(set(cached) - known)
|
||||||
|
if unknown:
|
||||||
|
self.logger.warning(
|
||||||
|
"Dropping unrecognised field(s) from cached metrics for %s: %s",
|
||||||
|
plugin_id, ", ".join(unknown))
|
||||||
|
usable = {k: v for k, v in cached.items() if k in known}
|
||||||
|
try:
|
||||||
|
return ResourceMetrics(**usable)
|
||||||
|
except (TypeError, ValueError) as e:
|
||||||
|
self.logger.warning(
|
||||||
|
"Cached metrics for %s unusable (%s); starting fresh",
|
||||||
|
plugin_id, e)
|
||||||
|
return ResourceMetrics()
|
||||||
|
|
||||||
def _get_metrics_key(self, plugin_id: str) -> str:
|
def _get_metrics_key(self, plugin_id: str) -> str:
|
||||||
"""Get cache key for plugin metrics."""
|
"""Get cache key for plugin metrics."""
|
||||||
return f"plugin_metrics:{plugin_id}"
|
return f"plugin_metrics:{plugin_id}"
|
||||||
@@ -126,7 +170,7 @@ class PluginResourceMonitor:
|
|||||||
cache_key, max_age=None, memory_ttl=0 if force_reload else None
|
cache_key, max_age=None, memory_ttl=0 if force_reload else None
|
||||||
)
|
)
|
||||||
if cached:
|
if cached:
|
||||||
metrics = ResourceMetrics(**cached)
|
metrics = self._metrics_from_cache(plugin_id, cached)
|
||||||
else:
|
else:
|
||||||
metrics = ResourceMetrics()
|
metrics = ResourceMetrics()
|
||||||
self._metrics[plugin_id] = metrics
|
self._metrics[plugin_id] = metrics
|
||||||
|
|||||||
@@ -0,0 +1,100 @@
|
|||||||
|
"""A malformed metrics cache entry must not take every plugin down with it.
|
||||||
|
|
||||||
|
`ResourceMetrics(**cached)` raises TypeError on a single unexpected key, and
|
||||||
|
that exception escapes into plugin_manager, which reports it per plugin as
|
||||||
|
"plugin <id> operation failed". Every plugin fails and the plugin system never
|
||||||
|
finishes initialising -- the health endpoint reports
|
||||||
|
`plugin_system: not_initialized` while the display itself keeps running.
|
||||||
|
|
||||||
|
Seen on a live rig, once per plugin, continuously:
|
||||||
|
|
||||||
|
ERROR - src.plugin_system.plugin_manager - plugin geochron operation failed:
|
||||||
|
ResourceMetrics.__init__() got an unexpected keyword argument
|
||||||
|
'consecutive_failures'
|
||||||
|
|
||||||
|
`consecutive_failures` belongs to plugin_health, not to metrics. How a
|
||||||
|
health-shaped record came to sit under a plugin_metrics key on that machine is
|
||||||
|
not established -- a restored backup that mixed two machines' caches is the
|
||||||
|
likeliest explanation, and the same rig had one restored onto it -- but a
|
||||||
|
loader that turns one bad cache entry into a total outage is the part worth
|
||||||
|
fixing. plugin_health already repairs its own records field by field rather
|
||||||
|
than trusting what is on disk.
|
||||||
|
"""
|
||||||
|
import logging
|
||||||
|
from dataclasses import fields
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.plugin_system.resource_monitor import PluginResourceMonitor, ResourceMetrics
|
||||||
|
|
||||||
|
|
||||||
|
class _Cache:
|
||||||
|
def __init__(self, payload=None):
|
||||||
|
self.payload = payload
|
||||||
|
|
||||||
|
def get(self, key, max_age=None, memory_ttl=None, **kwargs):
|
||||||
|
return self.payload
|
||||||
|
|
||||||
|
def set(self, key, data, ttl=None, **kwargs):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _monitor(payload):
|
||||||
|
m = PluginResourceMonitor(cache_manager=_Cache(payload))
|
||||||
|
m.logger = logging.getLogger("test")
|
||||||
|
return m
|
||||||
|
|
||||||
|
|
||||||
|
#: What the rig actually had under the metrics key.
|
||||||
|
HEALTH_SHAPED = {
|
||||||
|
"consecutive_failures": 0, "circuit_state": "closed",
|
||||||
|
"circuit_opened_time": None, "half_open_start_time": None,
|
||||||
|
"last_error": None, "last_failure_time": None,
|
||||||
|
"last_success_time": 1_700_000_000.0, "total_failures": 0,
|
||||||
|
"total_successes": 42,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_health_record_under_the_metrics_key_does_not_raise():
|
||||||
|
"""The exact failure: it must degrade, not take the plugin system down."""
|
||||||
|
monitor = _monitor(HEALTH_SHAPED)
|
||||||
|
metrics = monitor.get_metrics(" plugin-a".strip())
|
||||||
|
assert isinstance(metrics, ResourceMetrics)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recognised_fields_in_a_mixed_record_are_kept():
|
||||||
|
"""Dropping the record wholesale would lose real history unnecessarily."""
|
||||||
|
mixed = dict(HEALTH_SHAPED, call_count=7, memory_mb=12.5)
|
||||||
|
metrics = _monitor(mixed).get_metrics("plugin-b")
|
||||||
|
assert metrics.call_count == 7
|
||||||
|
assert metrics.memory_mb == 12.5
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_clean_record_still_loads_unchanged():
|
||||||
|
clean = {f.name: 3 for f in fields(ResourceMetrics)}
|
||||||
|
metrics = _monitor(clean).get_metrics("plugin-c")
|
||||||
|
for name in (f.name for f in fields(ResourceMetrics)):
|
||||||
|
assert getattr(metrics, name) == 3
|
||||||
|
|
||||||
|
|
||||||
|
def test_unknown_fields_are_named_in_the_log(caplog):
|
||||||
|
"""Silently discarding them would hide a real schema change."""
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
_monitor(HEALTH_SHAPED).get_metrics("plugin-d")
|
||||||
|
# getMessage(), not .message: the latter is only populated once a handler
|
||||||
|
# formats the record, so the obvious spelling silently never matches.
|
||||||
|
assert any("consecutive_failures" in r.getMessage() for r in caplog.records), \
|
||||||
|
caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("payload", ["a string", 42, ["a", "list"]])
|
||||||
|
def test_a_non_mapping_cache_entry_does_not_raise(payload):
|
||||||
|
metrics = _monitor(payload).get_metrics("plugin-e")
|
||||||
|
assert isinstance(metrics, ResourceMetrics)
|
||||||
|
|
||||||
|
|
||||||
|
def test_values_of_the_wrong_type_do_not_raise():
|
||||||
|
"""A dataclass will accept these, but a later float() on them would not."""
|
||||||
|
metrics = _monitor({"call_count": "not a number"}).get_metrics("plugin-f")
|
||||||
|
assert isinstance(metrics, ResourceMetrics)
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
"""The captive portal's fixed-argument sudo calls must be granted.
|
|
||||||
|
|
||||||
The installers write two allow-lists, /etc/sudoers.d/ledmatrix_web and
|
|
||||||
ledmatrix_wifi. A sudo call absent from both needs a password, which a service
|
|
||||||
cannot supply, so it fails.
|
|
||||||
|
|
||||||
Four such calls were ungranted, all of them captive-portal teardown/setup:
|
|
||||||
|
|
||||||
sysctl -w net.ipv4.ip_forward=0|1 wifi_manager.py:788, 883
|
|
||||||
nft add|delete table ip ledmatrix wifi_manager.py:835, 895
|
|
||||||
rfkill unblock wifi wifi_manager.py:1811
|
|
||||||
mkdir -p .../dnsmasq-shared.d wifi_manager.py:922
|
|
||||||
|
|
||||||
It goes unnoticed because a stock Raspberry Pi image ships
|
|
||||||
/etc/sudoers.d/010_pi-nopasswd granting the default user
|
|
||||||
`ALL=(ALL) NOPASSWD: ALL`, which satisfies every gap in both files. It only
|
|
||||||
bites once that blanket rule is removed or the service runs as another user.
|
|
||||||
|
|
||||||
Scope, deliberately narrow: this pins the four commands above, each of which
|
|
||||||
can be written out literally. The portal makes further sudo calls whose
|
|
||||||
arguments are built at runtime -- iptables and nft rules carrying an interface
|
|
||||||
name and a port, `ip addr`, `ip link` -- and those cannot be granted safely
|
|
||||||
here. A rule covering them needs a trailing wildcard, and
|
|
||||||
`iptables --modprobe=/path/to/anything` runs that path as root, so
|
|
||||||
`NOPASSWD: iptables *` is a root shell for the web user by another name.
|
|
||||||
Closing that half needs a privileged helper that builds the rules itself and
|
|
||||||
takes only an interface and a port, granted the way safe_plugin_rm.sh already
|
|
||||||
is. That is a design decision, not a one-line grant, and belongs in its own
|
|
||||||
change.
|
|
||||||
"""
|
|
||||||
import re
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
ROOT = Path(__file__).resolve().parent.parent
|
|
||||||
INSTALLERS = (
|
|
||||||
ROOT / "first_time_install.sh",
|
|
||||||
ROOT / "scripts" / "install" / "configure_wifi_permissions.sh",
|
|
||||||
)
|
|
||||||
|
|
||||||
#: Commands this change grants, each fully literal in the source.
|
|
||||||
REQUIRED = (
|
|
||||||
("sysctl", "-w", "net.ipv4.ip_forward=0"),
|
|
||||||
("sysctl", "-w", "net.ipv4.ip_forward=1"),
|
|
||||||
("nft", "add", "table", "ip", "ledmatrix"),
|
|
||||||
("nft", "delete", "table", "ip", "ledmatrix"),
|
|
||||||
("rfkill", "unblock", "wifi"),
|
|
||||||
("mkdir", "-p", "/etc/NetworkManager/dnsmasq-shared.d"),
|
|
||||||
)
|
|
||||||
|
|
||||||
#: Tools with an option that executes a program of the caller's choosing.
|
|
||||||
#: A trailing wildcard on any of these is a privilege escalation.
|
|
||||||
EXEC_CAPABLE = ("iptables", "ip6tables", "nft", "tcpdump", "find", "awk",
|
|
||||||
"sed", "perl", "python", "python3", "env")
|
|
||||||
|
|
||||||
|
|
||||||
def _grant_lines():
|
|
||||||
lines = []
|
|
||||||
for installer in INSTALLERS:
|
|
||||||
if not installer.is_file():
|
|
||||||
continue
|
|
||||||
for line in installer.read_text(encoding="utf-8", errors="replace").splitlines():
|
|
||||||
if "NOPASSWD:" in line:
|
|
||||||
lines.append(line.split("NOPASSWD:", 1)[1])
|
|
||||||
return lines
|
|
||||||
|
|
||||||
|
|
||||||
def _normalised_grants():
|
|
||||||
"""Grants with binary-path variables reduced to tool names.
|
|
||||||
|
|
||||||
Rules are written as `$SYSCTL_PATH -w ...`, so matching the literal
|
|
||||||
"sysctl" finds nothing and every rule looks absent -- which is exactly how
|
|
||||||
an earlier version of this test reported six gaps that did not exist.
|
|
||||||
Only NOPASSWD lines are considered, because taking the whole script let a
|
|
||||||
variable definition such as NFT_PATH=$(command -v nft) satisfy the check on
|
|
||||||
its own while the grant itself had been deleted.
|
|
||||||
"""
|
|
||||||
text = "\n".join(_grant_lines())
|
|
||||||
text = re.sub(r"\$\{?([A-Z][A-Z0-9_]*)_PATH\}?", lambda m: m.group(1).lower(), text)
|
|
||||||
return re.sub(r"/usr/(?:s?bin)/", "", text)
|
|
||||||
|
|
||||||
|
|
||||||
def test_the_installers_are_present():
|
|
||||||
missing = [str(p.relative_to(ROOT)) for p in INSTALLERS if not p.is_file()]
|
|
||||||
assert not missing, f"installer(s) missing: {missing}"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("command", REQUIRED, ids=lambda c: " ".join(c))
|
|
||||||
def test_the_command_is_granted(command):
|
|
||||||
"""Whole command, not just the binary.
|
|
||||||
|
|
||||||
Checking only the binary made this far weaker than it looked: with
|
|
||||||
`sysctl` present anywhere, deleting the ip_forward=0 grant still passed,
|
|
||||||
and the portal would then be unable to restore forwarding on teardown.
|
|
||||||
"""
|
|
||||||
pattern = r"\s+".join(re.escape(word) for word in command)
|
|
||||||
assert re.search(pattern, _normalised_grants()), (
|
|
||||||
f"no installer grants `{' '.join(command)}`")
|
|
||||||
|
|
||||||
|
|
||||||
def test_no_wildcard_on_a_tool_that_can_exec():
|
|
||||||
"""`NOPASSWD: iptables *` hands the web user root.
|
|
||||||
|
|
||||||
iptables --modprobe=/path runs that path as root. This caught a grant added
|
|
||||||
in this very change, which is why it is here.
|
|
||||||
"""
|
|
||||||
offenders = []
|
|
||||||
for rule in _grant_lines():
|
|
||||||
rule = rule.strip()
|
|
||||||
if not rule.endswith("*"):
|
|
||||||
continue
|
|
||||||
haystack = rule.replace("_PATH", "").lower()
|
|
||||||
for tool in EXEC_CAPABLE:
|
|
||||||
if re.search(rf"(^|/|\s|\$){tool}(\s|$)", haystack):
|
|
||||||
offenders.append(rule)
|
|
||||||
break
|
|
||||||
assert not offenders, (
|
|
||||||
"wildcard grant on a tool that can execute another program:\n "
|
|
||||||
+ "\n ".join(offenders))
|
|
||||||
Reference in New Issue
Block a user