mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-21 02:19:07 +00:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fb0e869bf6 |
Binary file not shown.
|
Before Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 128 KiB |
+10
-3
@@ -1419,9 +1419,16 @@ $ACTUAL_USER ALL=(ALL) NOPASSWD: $BASH_PATH $PROJECT_ROOT_DIR/scripts/fix_perms/
|
|||||||
EOF
|
EOF
|
||||||
if [ -n "$JOURNALCTL_PATH" ]; then
|
if [ -n "$JOURNALCTL_PATH" ]; then
|
||||||
cat >> /tmp/ledmatrix_web_sudoers << EOF
|
cat >> /tmp/ledmatrix_web_sudoers << EOF
|
||||||
$ACTUAL_USER ALL=(ALL) NOPASSWD: $JOURNALCTL_PATH -u ledmatrix.service *
|
# NOEXEC, because these rules end in a wildcard and journalctl starts a pager
|
||||||
$ACTUAL_USER ALL=(ALL) NOPASSWD: $JOURNALCTL_PATH -u ledmatrix *
|
# when its output is a terminal. From that pager (less) a "!sh" is a root
|
||||||
$ACTUAL_USER ALL=(ALL) NOPASSWD: $JOURNALCTL_PATH -t ledmatrix *
|
# shell -- the standard journalctl escalation. The web interface always passes
|
||||||
|
# --no-pager, so nothing here needs it, but the rule cannot require a flag that
|
||||||
|
# sits in the middle of the command line. NOEXEC stops the command executing
|
||||||
|
# another program at all, which closes the hole without depending on wildcard
|
||||||
|
# matching subtleties.
|
||||||
|
$ACTUAL_USER ALL=(ALL) NOPASSWD:NOEXEC: $JOURNALCTL_PATH -u ledmatrix.service *
|
||||||
|
$ACTUAL_USER ALL=(ALL) NOPASSWD:NOEXEC: $JOURNALCTL_PATH -u ledmatrix *
|
||||||
|
$ACTUAL_USER ALL=(ALL) NOPASSWD:NOEXEC: $JOURNALCTL_PATH -t ledmatrix *
|
||||||
EOF
|
EOF
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
@@ -328,11 +328,7 @@ class ScrollHelper:
|
|||||||
elapsed_time = current_time - (self.scroll_start_time or current_time)
|
elapsed_time = current_time - (self.scroll_start_time or current_time)
|
||||||
# The image already includes display_width padding, so we only need total_scroll_width
|
# The image already includes display_width padding, so we only need total_scroll_width
|
||||||
required_total_distance = self.total_scroll_width
|
required_total_distance = self.total_scroll_width
|
||||||
# Progress telemetry, emitted every few seconds for the whole of
|
self.logger.info(
|
||||||
# every scroll. It says how far along a marquee is, which is what
|
|
||||||
# you turn debug on to watch and not something an operator needs
|
|
||||||
# in the journal on a device that scrolls all day.
|
|
||||||
self.logger.debug(
|
|
||||||
"Scroll progress: elapsed=%.2fs, target=%.2fs, total_scrolled=%.0f/%d px (%.1f%%)",
|
"Scroll progress: elapsed=%.2fs, target=%.2fs, total_scrolled=%.0f/%d px (%.1f%%)",
|
||||||
elapsed_time,
|
elapsed_time,
|
||||||
self.calculated_duration,
|
self.calculated_duration,
|
||||||
|
|||||||
@@ -31,14 +31,6 @@ if TYPE_CHECKING:
|
|||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
#: A frame rate this close to target is not news; below it is.
|
|
||||||
_FPS_HEALTHY_FRACTION = 0.9
|
|
||||||
|
|
||||||
#: A healthy marquee still reports this often, so silence means stopped
|
|
||||||
#: rather than fine.
|
|
||||||
_FPS_HEARTBEAT_INTERVAL = 300.0
|
|
||||||
|
|
||||||
|
|
||||||
def _percentile(ordered: List[float], fraction: float) -> float:
|
def _percentile(ordered: List[float], fraction: float) -> float:
|
||||||
"""Nearest-rank percentile of an already-sorted list.
|
"""Nearest-rank percentile of an already-sorted list.
|
||||||
|
|
||||||
@@ -403,9 +395,7 @@ class VegasModeCoordinator:
|
|||||||
duration = self.render_pipeline.get_dynamic_duration()
|
duration = self.render_pipeline.get_dynamic_duration()
|
||||||
start_time = time.time()
|
start_time = time.time()
|
||||||
frame_count = 0
|
frame_count = 0
|
||||||
fps_log_interval = 5.0 # Sample FPS every 5 seconds
|
fps_log_interval = 5.0 # Log FPS every 5 seconds
|
||||||
last_fps_health_log = 0.0 # last INFO-level report
|
|
||||||
was_degraded = False # so the recovery is reported too
|
|
||||||
last_fps_log_time = start_time
|
last_fps_log_time = start_time
|
||||||
fps_frame_count = 0
|
fps_frame_count = 0
|
||||||
# A mean hides stutter completely. At 120fps a five-second window is
|
# A mean hides stutter completely. At 120fps a five-second window is
|
||||||
@@ -458,36 +448,16 @@ class VegasModeCoordinator:
|
|||||||
frame_count += 1
|
frame_count += 1
|
||||||
fps_frame_count += 1
|
fps_frame_count += 1
|
||||||
|
|
||||||
# Periodic FPS logging. Reported at INFO only when the frame rate
|
# Periodic FPS logging
|
||||||
# is actually worth an operator's attention -- a shortfall against
|
|
||||||
# target, or the recovery from one -- with a slow heartbeat so a
|
|
||||||
# healthy marquee still shows a pulse.
|
|
||||||
#
|
|
||||||
# Measured over two hours on a running rig: 1410 samples, 98.5%
|
|
||||||
# of them within 10% of target. The 1.5% that were not included a
|
|
||||||
# reading of 8.6fps against a target of 60 -- a real stall, and
|
|
||||||
# completely invisible inside 1389 lines reading "59.6".
|
|
||||||
current_time = time.time()
|
current_time = time.time()
|
||||||
if current_time - last_fps_log_time >= fps_log_interval:
|
if current_time - last_fps_log_time >= fps_log_interval:
|
||||||
fps = fps_frame_count / (current_time - last_fps_log_time)
|
fps = fps_frame_count / (current_time - last_fps_log_time)
|
||||||
p99 = _percentile(sorted(frame_times), 0.99)
|
p99 = _percentile(sorted(frame_times), 0.99)
|
||||||
target = self.vegas_config.target_fps
|
logger.info(
|
||||||
degraded = target > 0 and fps < target * _FPS_HEALTHY_FRACTION
|
"Vegas FPS: %.1f (target: %d, frames: %d) p99 %.1fms worst %.1fms",
|
||||||
due = current_time - last_fps_health_log >= _FPS_HEARTBEAT_INTERVAL
|
fps, self.vegas_config.target_fps, fps_frame_count,
|
||||||
if degraded or was_degraded or due:
|
p99 * 1000.0, frame_worst * 1000.0
|
||||||
logger.info(
|
)
|
||||||
"Vegas FPS: %.1f (target: %d, frames: %d) p99 %.1fms worst %.1fms",
|
|
||||||
fps, target, fps_frame_count,
|
|
||||||
p99 * 1000.0, frame_worst * 1000.0
|
|
||||||
)
|
|
||||||
last_fps_health_log = current_time
|
|
||||||
else:
|
|
||||||
logger.debug(
|
|
||||||
"Vegas FPS: %.1f (target: %d, frames: %d) p99 %.1fms worst %.1fms",
|
|
||||||
fps, target, fps_frame_count,
|
|
||||||
p99 * 1000.0, frame_worst * 1000.0
|
|
||||||
)
|
|
||||||
was_degraded = degraded
|
|
||||||
last_fps_log_time = current_time
|
last_fps_log_time = current_time
|
||||||
fps_frame_count = 0
|
fps_frame_count = 0
|
||||||
frame_worst = 0.0
|
frame_worst = 0.0
|
||||||
|
|||||||
@@ -0,0 +1,87 @@
|
|||||||
|
"""Wildcard grants to commands that start a pager must carry NOEXEC.
|
||||||
|
|
||||||
|
`journalctl` runs a pager when its output is a terminal, and from `less` a
|
||||||
|
`!sh` is a shell with the privileges journalctl was given. That is the standard
|
||||||
|
journalctl privilege escalation, and the installer's rules end in a wildcard:
|
||||||
|
|
||||||
|
<user> ALL=(ALL) NOPASSWD: /usr/bin/journalctl -u ledmatrix *
|
||||||
|
|
||||||
|
The web interface always passes --no-pager -- both call sites do, in app.py and
|
||||||
|
api_v3.py -- so nothing the project runs needs the pager. But a sudoers rule
|
||||||
|
cannot require a flag that sits in the middle of the command line, and reasoning
|
||||||
|
about what a trailing `*` does or does not admit is exactly the kind of
|
||||||
|
subtlety that produces a hole.
|
||||||
|
|
||||||
|
sudo's NOEXEC tag stops the command executing another program at all, which
|
||||||
|
closes it without depending on that reasoning. It works by LD_PRELOAD, so it
|
||||||
|
applies to dynamically linked binaries; journalctl is one.
|
||||||
|
|
||||||
|
On a stock Raspberry Pi image none of this is reachable, because
|
||||||
|
/etc/sudoers.d/010_pi-nopasswd already grants the default user
|
||||||
|
`ALL=(ALL) NOPASSWD: ALL`. It matters on a hardened install, or where the
|
||||||
|
service runs as a user without that blanket rule.
|
||||||
|
"""
|
||||||
|
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 that will start another program of their own accord -- a pager, an
|
||||||
|
#: editor, a shell -- and so must not be granted the ability to do so.
|
||||||
|
SPAWNS_A_PROGRAM = ("journalctl", "systemctl", "less", "more", "man", "git")
|
||||||
|
|
||||||
|
|
||||||
|
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():
|
||||||
|
stripped = line.strip()
|
||||||
|
if "NOPASSWD" in stripped and not stripped.startswith("#"):
|
||||||
|
lines.append(stripped)
|
||||||
|
return lines
|
||||||
|
|
||||||
|
|
||||||
|
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}"
|
||||||
|
|
||||||
|
|
||||||
|
def test_wildcard_pager_grants_carry_noexec():
|
||||||
|
offenders = []
|
||||||
|
for rule in _grant_lines():
|
||||||
|
command = rule.split("NOPASSWD", 1)[1]
|
||||||
|
if not command.rstrip().endswith("*"):
|
||||||
|
continue
|
||||||
|
tool = command.replace("_PATH", "").replace("$", "").lower()
|
||||||
|
for name in SPAWNS_A_PROGRAM:
|
||||||
|
if re.search(rf"(^|/|\s){name}(\s|$)", tool):
|
||||||
|
if "NOEXEC" not in rule:
|
||||||
|
offenders.append(rule)
|
||||||
|
break
|
||||||
|
assert not offenders, (
|
||||||
|
"wildcard grant to a command that can start a pager or shell, without "
|
||||||
|
"NOEXEC:\n " + "\n ".join(offenders))
|
||||||
|
|
||||||
|
|
||||||
|
def test_journalctl_is_granted_at_all():
|
||||||
|
"""Guard against 'fixing' the above by deleting the rules."""
|
||||||
|
text = "\n".join(_grant_lines())
|
||||||
|
assert "JOURNALCTL_PATH" in text or "journalctl" in text, (
|
||||||
|
"no journalctl grant remains; the web interface reads logs through it")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("unit", ["ledmatrix.service", "ledmatrix"])
|
||||||
|
def test_each_journalctl_rule_is_tagged(unit):
|
||||||
|
matching = [r for r in _grant_lines()
|
||||||
|
if "JOURNALCTL_PATH" in r and f"-u {unit} " in r]
|
||||||
|
assert matching, f"no journalctl rule for -u {unit}"
|
||||||
|
untagged = [r for r in matching if "NOEXEC" not in r]
|
||||||
|
assert not untagged, f"untagged journalctl rule(s): {untagged}"
|
||||||
Reference in New Issue
Block a user