mirror of
https://github.com/MarekWo/mc-webui.git
synced 2026-10-30 23:51:57 +01:00
mc-webui has no login, which is fine on a LAN and not fine once the address is handed to testers: they assume the node is theirs and rename it, and the console is right there for anyone curious enough to type into it. MC_DEMO=true refuses everything that reconfigures the radio, destroys data, reaches other people's repeaters, rebuilds the containers, publishes to an external broker, or hands out a secret. Reading and sending messages keep working, so the instance is still worth visiting. The guard is default-deny: an api_bp.before_request hook refuses every non-GET unless it is on a short allowlist, so an endpoint added later is locked without touching this module. That mattered — six mutating endpoints already had no frontend caller and would never have made a hand-written blacklist. A small read denylist covers the GETs that leak (repeater passwords, backup download, capture download, /api/logs), which the write guard never sees. Two paths bypass the HTTP layer and are closed separately: the console is a Socket.IO event, not a route, so it is checked against a read-only command set; the log viewer is refused at the connect handshake. Access is kept two ways. MC_DEMO_TRUSTED_NETS unlocks by CIDR, and MC_DEMO_UNLOCK_CODE unlocks by a code typed once in Settings and held in an HMAC cookie for 30 days — stateless, and deliberately not Flask's session, whose SECRET_KEY is a hardcoded public constant. The trap the network list walks into: published through a tunnel, every visitor arrives from the tunnel's address, and if the tunnel runs on the LAN then trusting the LAN unlocks the instance for the whole internet. An address arriving with a proxy header is therefore not matched unless MC_TRUST_PROXY is on, and startup logs report the resulting shape. Frontend is advisory only: demo-lock.js loads from _head_i18n.html so it reaches all eight entry points including the six iframes, greys out [data-demo-lock] rather than hiding it (the instance exists to show the app off), re-applies via MutationObserver for JS-rendered buttons, and turns any 403 demo_locked into a toast. Verified on the local container: the rename, reboot, updater, vacuum, cleanup and the leaky GETs all 403; sending, read markers and ordinary reads pass; `set name` is refused over the console socket while `infos` still answers; unlock/lock round-trips. 86 new unit tests, en/pl at 100%. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
76 lines
2.8 KiB
YAML
76 lines
2.8 KiB
YAML
# mc-webui v2 — single container with direct device access
|
|
services:
|
|
mc-webui:
|
|
build: .
|
|
container_name: mc-webui
|
|
restart: unless-stopped
|
|
# MC_BIND_ADDRESS=127.0.0.1 keeps the plain-HTTP port off the network once
|
|
# HTTPS is up (docs/https-setup.md). Default 0.0.0.0 = reachable as before.
|
|
ports:
|
|
- "${MC_BIND_ADDRESS:-0.0.0.0}:${FLASK_PORT:-5000}:${FLASK_PORT:-5000}"
|
|
# Grant access to serial devices for auto-detection
|
|
# Major 188 = ttyUSB (CP2102, CH340), Major 166 = ttyACM (ESP32-S3)
|
|
device_cgroup_rules:
|
|
- 'c 188:* rmw'
|
|
- 'c 166:* rmw'
|
|
# NET_ADMIN + NET_RAW for BLE scanning (no overhead when BLE unused)
|
|
cap_add:
|
|
- NET_ADMIN
|
|
- NET_RAW
|
|
volumes:
|
|
- "${MC_CONFIG_DIR:-./data}:/data:rw"
|
|
- "/dev:/dev"
|
|
- "/var/run/dbus:/var/run/dbus" # BlueZ D-Bus (for BLE)
|
|
environment:
|
|
- MC_SERIAL_PORT=${MC_SERIAL_PORT:-auto}
|
|
- MC_DEVICE_NAME=${MC_DEVICE_NAME:-MeshCore}
|
|
- MC_CONFIG_DIR=/data
|
|
- MC_TCP_HOST=${MC_TCP_HOST:-}
|
|
- MC_TCP_PORT=${MC_TCP_PORT:-5555}
|
|
- MC_BLE_ADDRESS=${MC_BLE_ADDRESS:-}
|
|
- MC_BACKUP_ENABLED=${MC_BACKUP_ENABLED:-true}
|
|
- MC_BACKUP_HOUR=${MC_BACKUP_HOUR:-2}
|
|
- MC_BACKUP_RETENTION_DAYS=${MC_BACKUP_RETENTION_DAYS:-7}
|
|
- FLASK_HOST=${FLASK_HOST:-0.0.0.0}
|
|
- FLASK_PORT=${FLASK_PORT:-5000}
|
|
- FLASK_DEBUG=${FLASK_DEBUG:-false}
|
|
- MC_TRUST_PROXY=${MC_TRUST_PROXY:-false}
|
|
- MC_DEMO=${MC_DEMO:-false}
|
|
- MC_DEMO_TRUSTED_NETS=${MC_DEMO_TRUSTED_NETS:-}
|
|
- MC_DEMO_UNLOCK_CODE=${MC_DEMO_UNLOCK_CODE:-}
|
|
- TZ=${TZ:-UTC}
|
|
env_file:
|
|
- path: .env
|
|
required: false
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-f", "http://localhost:5000/health"]
|
|
interval: 30s
|
|
timeout: 10s
|
|
retries: 3
|
|
start_period: 15s
|
|
|
|
# Optional HTTPS front end — Nginx Proxy Manager.
|
|
# Inert unless the "https" profile is active, so existing installs are untouched.
|
|
# Enable it by putting COMPOSE_PROFILES=https in .env, then run the usual
|
|
# `docker compose up -d --build` (or mcupdate). Full guide: docs/https-setup.md
|
|
#
|
|
# Both services share this project's default network, so the proxy reaches the
|
|
# app at http://mc-webui:5000 without the app publishing any port at all.
|
|
npm:
|
|
image: ${NPM_IMAGE:-jc21/nginx-proxy-manager:latest}
|
|
container_name: mc-webui-proxy
|
|
profiles: ["https"]
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- mc-webui
|
|
ports:
|
|
- "${NPM_HTTP_PORT:-80}:80" # HTTP — also the Let's Encrypt HTTP-01 challenge
|
|
- "${NPM_HTTPS_PORT:-443}:443" # HTTPS
|
|
- "${NPM_ADMIN_PORT:-81}:81" # Proxy Manager admin UI
|
|
volumes:
|
|
- "${NPM_DATA_DIR:-./data/npm}:/data"
|
|
- "${NPM_LETSENCRYPT_DIR:-./data/letsencrypt}:/etc/letsencrypt"
|
|
environment:
|
|
- TZ=${TZ:-UTC}
|
|
- DISABLE_IPV6=${NPM_DISABLE_IPV6:-true}
|