OPNsense-Plugin os-mdns-bridge #23

Merged
jochen merged 2 commits from feat/opnsense-plugin into master 2026-11-10 21:12:18 +00:00
Collaborator

Refs #14 · GUI aus Branch gui, an den aktuellen Daemon und das Paket angepasst.

Aufbau

  • opnsense/net/mdns-bridge/ im Layout von opnsense/plugins (Makefile, pkg-descr, src/)
  • opnsense/build-plugin.sh baut os-mdns-bridge-<version>.pkg und macht dabei, was Mk/plugins.mk tut (Dateien nach /usr/local, nach Installation Migrationen, Template-Reload, configd-Neustart). Abhängigkeit auf das mdns-bridged-Paket desselben Builds mit exakter Version, damit pkg add ./os-mdns-bridge-*.pkg es aus demselben Verzeichnis mitinstalliert.
  • Nicht übernommen: Port net/mdns-bridged (ersetzt durch packaging/freebsd), eigenes rc-Script mdnsbridge

Änderungen gegenüber der alten GUI

  • Dienst: nutzt das rc-Script mdns_bridged des Daemon-Pakets (/etc/rc.conf.d/mdns_bridged, pidfile und Socket in /var/run/mdns-bridged/). Kein @sample-Konflikt mehr.
  • Modell 1.1.0 + Migration M1_1_0:
    • neu: Listen-Adresse, zusätzliche erlaubte Peers, PSK
    • entfernt: status_socket, resync_interval_secs, always_forward_address_records, multicast_ttl (alter Default 1 verstieß gegen RFC 6762)
  • PSK: landet in /usr/local/etc/mdns-bridge.psk. setup.sh setzt vor jedem (Re)Start Config und Key auf 0640 root:mdnsbridge und prüft die erzeugte Config mit --check-config. Eine abgelehnte Config wird geloggt und in der GUI als Dialog angezeigt; der laufende Daemon bleibt unangetastet.
  • Status-Tab: Config-Prüfung, Zähler/Peers, Record-Tabelle. Dazu eine eigene Logdatei (Services: mDNS Bridge: Log File), Dashboard-Dienst und HA-Sync.
  • Hilfetexte überarbeitet, seltene Optionen als „advanced“

Daemon

Neu: mdns-bridged --check-config prüft Syntax, unbekannte Keys (hier ein Fehler, im Daemon nur eine Warnung) und den PSK. Exit-Code 0 oder 1.

Tests / CI

  • opnsense/tests/render_templates.py rendert die configd-Templates wie OPNsense (Jinja2, helpers, Interface-Macro als Stub) für 4 Konfigurationen und prüft jede mit --check-config, dazu Key-Datei und rc.conf.d. Gegenprobe: ein eingeschleuster veralteter Key lässt den Test scheitern.
  • ci: PHP-, XML- und Shell-Syntax sowie der Template-Test
  • build-freebsd: baut auch das Plugin-Paket, prüft ABI, Eigentümer und die Abhängigkeit; läuft auch bei Änderungen unter opnsense/
  • Lokal: alle obigen Prüfungen grün, Manifest und Dateiliste per pkg-Stub kontrolliert

Bitte auf OPNsense testen

Das ließ sich hier nicht testen, weil kein OPNsense-Core verfügbar ist.

  1. Reste der alten Script-Installation entfernen (siehe opnsense/README.md, Upgrading)
  2. Beide .pkg aus dem Artefakt dieses PR-Laufs in ein Verzeichnis legen, pkg add ./os-mdns-bridge-*.pkg
  3. Prüfen: Menüeintrag, Migration der alten Einstellungen, Apply, Status-Tab, Log File, Dashboard-Dienst
  4. Mit PSK und einmal mit absichtlich falscher Config (z. B. nicht existierende Source-Adresse)

Danach: Branches auth und gui löschen. Der signierte Paket-Repo aus #14 bleibt offen.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Vh6img4RYU1F52VUwGJcrp

Refs #14 · GUI aus Branch `gui`, an den aktuellen Daemon und das Paket angepasst. ## Aufbau - `opnsense/net/mdns-bridge/` im Layout von opnsense/plugins (Makefile, pkg-descr, `src/`) - `opnsense/build-plugin.sh` baut `os-mdns-bridge-<version>.pkg` und macht dabei, was `Mk/plugins.mk` tut (Dateien nach `/usr/local`, nach Installation Migrationen, Template-Reload, configd-Neustart). Abhängigkeit auf das `mdns-bridged`-Paket desselben Builds mit exakter Version, damit `pkg add ./os-mdns-bridge-*.pkg` es aus demselben Verzeichnis mitinstalliert. - Nicht übernommen: Port `net/mdns-bridged` (ersetzt durch `packaging/freebsd`), eigenes rc-Script `mdnsbridge` ## Änderungen gegenüber der alten GUI - **Dienst:** nutzt das rc-Script `mdns_bridged` des Daemon-Pakets (`/etc/rc.conf.d/mdns_bridged`, pidfile und Socket in `/var/run/mdns-bridged/`). Kein `@sample`-Konflikt mehr. - **Modell 1.1.0 + Migration `M1_1_0`:** - neu: Listen-Adresse, zusätzliche erlaubte Peers, PSK - entfernt: `status_socket`, `resync_interval_secs`, `always_forward_address_records`, `multicast_ttl` (alter Default 1 verstieß gegen RFC 6762) - **PSK:** landet in `/usr/local/etc/mdns-bridge.psk`. `setup.sh` setzt vor jedem (Re)Start Config und Key auf `0640 root:mdnsbridge` und prüft die erzeugte Config mit `--check-config`. Eine abgelehnte Config wird geloggt und in der GUI als Dialog angezeigt; der laufende Daemon bleibt unangetastet. - **Status-Tab:** Config-Prüfung, Zähler/Peers, Record-Tabelle. Dazu eine eigene Logdatei (Services: mDNS Bridge: Log File), Dashboard-Dienst und HA-Sync. - Hilfetexte überarbeitet, seltene Optionen als „advanced“ ## Daemon Neu: `mdns-bridged --check-config` prüft Syntax, unbekannte Keys (hier ein Fehler, im Daemon nur eine Warnung) und den PSK. Exit-Code 0 oder 1. ## Tests / CI - `opnsense/tests/render_templates.py` rendert die configd-Templates wie OPNsense (Jinja2, `helpers`, Interface-Macro als Stub) für 4 Konfigurationen und prüft jede mit `--check-config`, dazu Key-Datei und rc.conf.d. Gegenprobe: ein eingeschleuster veralteter Key lässt den Test scheitern. - ci: PHP-, XML- und Shell-Syntax sowie der Template-Test - build-freebsd: baut auch das Plugin-Paket, prüft ABI, Eigentümer und die Abhängigkeit; läuft auch bei Änderungen unter `opnsense/` - Lokal: alle obigen Prüfungen grün, Manifest und Dateiliste per `pkg`-Stub kontrolliert ## Bitte auf OPNsense testen Das ließ sich hier nicht testen, weil kein OPNsense-Core verfügbar ist. 1. Reste der alten Script-Installation entfernen (siehe `opnsense/README.md`, *Upgrading*) 2. Beide `.pkg` aus dem Artefakt dieses PR-Laufs in ein Verzeichnis legen, `pkg add ./os-mdns-bridge-*.pkg` 3. Prüfen: Menüeintrag, Migration der alten Einstellungen, Apply, Status-Tab, Log File, Dashboard-Dienst 4. Mit PSK und einmal mit absichtlich falscher Config (z. B. nicht existierende Source-Adresse) Danach: Branches `auth` und `gui` löschen. Der signierte Paket-Repo aus #14 bleibt offen. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01Vh6img4RYU1F52VUwGJcrp
OPNsense plugin os-mdns-bridge, mdns-bridged --check-config
Some checks failed
ci / rust (push) Has been cancelled
22537d0bb5
Plugin from branch `gui`, moved to opnsense/net/mdns-bridge (layout of
opnsense/plugins) and adapted to the current daemon and package:

- uses the mdns-bridged package's rc script (mdns_bridged) instead of
  an own one; rc.conf.d/mdns_bridged, pidfile and status socket in
  /var/run/mdns-bridged/; no @sample conflict with the daemon package
- model 1.1.0 with migration M1_1_0: new listen_addr, allowed_peers,
  psk; dropped status_socket, resync_interval_secs,
  always_forward_address_records and multicast_ttl (old default 1
  violated RFC 6762; the daemon's 255 applies)
- PSK written to /usr/local/etc/mdns-bridge.psk, auth_psk_file points
  to it; setup.sh sets config and key to 0640 root:mdnsbridge before
  every (re)start and validates the rendered config with
  --check-config - a rejected config is logged, shown in the GUI, and
  the running daemon is left alone
- Status tab (config check, counters/peers, record table), own log
  file via syslog facility, dashboard service entry, HA sync
- build-plugin.sh: packages os-mdns-bridge with dependency on the
  mdns-bridged package of the same build, post-install runs
  migrations, template reload, configd restart
- tests/render_templates.py renders the templates like OPNsense
  (Jinja2, helpers, interface macro stub) for several configurations
  and validates each with --check-config

Daemon: --check-config checks syntax, unknown keys (an error there)
and the PSK, exit 0/1.

Not ported: net/mdns-bridged (FreeBSD port, superseded by
packaging/freebsd), the old rc script mdnsbridge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Vh6img4RYU1F52VUwGJcrp
Plugin: template test, CI, docs
All checks were successful
ci / rust (push) Successful in 3m11s
build-freebsd / freebsd (pull_request) Successful in 2m58s
build-freebsd / release (pull_request) Has been skipped
ci / rust (pull_request) Successful in 3m24s
aaccbabe11
- tests/render_templates.py: renders the configd templates like
  OPNsense for four configurations, validates them with
  mdns-bridged --check-config and checks key file and rc.conf.d
- ci: PHP/XML/shell syntax of the plugin and the template test
- build-freebsd: also builds os-mdns-bridge, checks ABI, owners and
  the dependency on mdns-bridged; runs on changes below opnsense/
- opnsense/README.md: install, configure, files written, upgrade from
  the script-installed first GUI version, development
- README: plugin, --check-config; daemon package message points to
  the plugin on OPNsense

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Vh6img4RYU1F52VUwGJcrp
jochen approved these changes 2026-11-10 21:12:12 +00:00
jochen merged commit c14037eb94 into master 2026-11-10 21:12:18 +00:00
jochen deleted branch feat/opnsense-plugin 2026-11-10 21:12:18 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
jochen/mdns-bridge!23
No description provided.