OctoPrint-BitBang 0.2.7__tar.gz → 0.2.8__tar.gz

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8/OctoPrint_BitBang.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OctoPrint-BitBang
-Version: 0.2.7
+Version: 0.2.8
 Summary: Remote OctoPrint access with live H.264 video via BitBang WebRTC
 Author-email: Rich LeGrand <rich.m.legrand@gmail.com>
 License-Expression: MIT
@@ -115,12 +115,20 @@ All settings live in **Settings → BitBang**:
 | Setting | Effect |
 |---|---|
 | Enabled | Toggle BitBang remote access |
-| PIN | Optional 4+ digit PIN prompt on the remote URL |
+| PIN | **Required by default.** At least 4 characters; prompted on the remote URL. Remote access stays **off** until a PIN is set (or "Allow no PIN" is ticked). |
+| Allow no PIN | Expose remote access with no PIN (not recommended — anyone with the link can control the printer) |
 | Camera | Auto-detect, or select from dropdown list |
 | Resolution | VGA → HD (depending on what selected camera supports) |
 | Flip horizontal / vertical | Flip video if necessary |
 
-All settings take effect on OctoPrint restart. Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+Changes to the PIN and Enabled settings take effect immediately (no OctoPrint restart). Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+
+### Set a PIN (required)
+
+BitBang exposes a public link to your printer, so it is protected by a PIN. On
+first install a **setup wizard** prompts you to choose one — remote access does
+not start until you do (fail-closed). You can change it any time under
+**Settings → BitBang**.
 
 ## How it works
 

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8}/OctoPrint_BitBang.egg-info/SOURCES.txt

@@ -28,4 +28,5 @@ octoprint_bitbang/static/favicon.png
 octoprint_bitbang/static/js/bitbang.js
 octoprint_bitbang/templates/bitbang_navbar.jinja2
 octoprint_bitbang/templates/bitbang_settings.jinja2
-octoprint_bitbang/templates/bitbang_webcam.jinja2
+octoprint_bitbang/templates/bitbang_webcam.jinja2
+octoprint_bitbang/templates/bitbang_wizard.jinja2

{octoprint_bitbang-0.2.7/OctoPrint_BitBang.egg-info → octoprint_bitbang-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OctoPrint-BitBang
-Version: 0.2.7
+Version: 0.2.8
 Summary: Remote OctoPrint access with live H.264 video via BitBang WebRTC
 Author-email: Rich LeGrand <rich.m.legrand@gmail.com>
 License-Expression: MIT
@@ -115,12 +115,20 @@ All settings live in **Settings → BitBang**:
 | Setting | Effect |
 |---|---|
 | Enabled | Toggle BitBang remote access |
-| PIN | Optional 4+ digit PIN prompt on the remote URL |
+| PIN | **Required by default.** At least 4 characters; prompted on the remote URL. Remote access stays **off** until a PIN is set (or "Allow no PIN" is ticked). |
+| Allow no PIN | Expose remote access with no PIN (not recommended — anyone with the link can control the printer) |
 | Camera | Auto-detect, or select from dropdown list |
 | Resolution | VGA → HD (depending on what selected camera supports) |
 | Flip horizontal / vertical | Flip video if necessary |
 
-All settings take effect on OctoPrint restart. Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+Changes to the PIN and Enabled settings take effect immediately (no OctoPrint restart). Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+
+### Set a PIN (required)
+
+BitBang exposes a public link to your printer, so it is protected by a PIN. On
+first install a **setup wizard** prompts you to choose one — remote access does
+not start until you do (fail-closed). You can change it any time under
+**Settings → BitBang**.
 
 ## How it works
 

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8}/README.md

@@ -85,12 +85,20 @@ All settings live in **Settings → BitBang**:
 | Setting | Effect |
 |---|---|
 | Enabled | Toggle BitBang remote access |
-| PIN | Optional 4+ digit PIN prompt on the remote URL |
+| PIN | **Required by default.** At least 4 characters; prompted on the remote URL. Remote access stays **off** until a PIN is set (or "Allow no PIN" is ticked). |
+| Allow no PIN | Expose remote access with no PIN (not recommended — anyone with the link can control the printer) |
 | Camera | Auto-detect, or select from dropdown list |
 | Resolution | VGA → HD (depending on what selected camera supports) |
 | Flip horizontal / vertical | Flip video if necessary |
 
-All settings take effect on OctoPrint restart. Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+Changes to the PIN and Enabled settings take effect immediately (no OctoPrint restart). Full-screen button and brightness slider are overlaid on the video window (Control tab) and update immediately.
+
+### Set a PIN (required)
+
+BitBang exposes a public link to your printer, so it is protected by a PIN. On
+first install a **setup wizard** prompts you to choose one — remote access does
+not start until you do (fail-closed). You can change it any time under
+**Settings → BitBang**.
 
 ## How it works
 

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8}/octoprint_bitbang/_plugin.py

@@ -47,6 +47,12 @@ except ImportError as e:
     )
 
 
+# A PIN must be empty (remote access then gated/off) or at least this many
+# characters. Mirrored by the wizard/settings JS; enforced server-side in
+# on_settings_save as the authoritative backstop.
+MIN_PIN_LENGTH = 4
+
+
 class BitBangPlugin(
     octoprint.plugin.StartupPlugin,
     octoprint.plugin.ShutdownPlugin,
@@ -55,12 +61,14 @@ class BitBangPlugin(
     octoprint.plugin.AssetPlugin,
     octoprint.plugin.BlueprintPlugin,
     octoprint.plugin.WebcamProviderPlugin,
+    octoprint.plugin.WizardPlugin,
 ):
     def __init__(self):
         super().__init__()
         self._adapter = None
         self._thread = None
         self._local_pcs = set()  # track local WebRTC peer connections
+        self._running = False  # whether the remote-access proxy is live
 
     def on_shutdown(self):
         # Release the camera cleanly when OctoPrint shuts down via its own
@@ -93,8 +101,30 @@ class BitBangPlugin(
         if not self._settings.get_boolean(["enabled"]):
             self._logger.info("BitBang disabled in settings")
             return
+        if not self._remote_access_allowed():
+            self._logger.warning(
+                "BitBang: remote access NOT started — no PIN is set. Set a PIN "
+                "in the BitBang settings (or, advanced, explicitly allow running "
+                "without one) to enable remote access."
+            )
+            return
         self._start_bitbang()
 
+    def _remote_access_allowed(self):
+        """Secure-by-default gate. The public tunnel is only exposed when a
+        PIN protects it, or the user has explicitly opted into running without
+        one. An empty PIN with no opt-in means remote access stays OFF — this
+        is the enforcement behind the setup wizard (which merely prompts).
+
+        Without this, anyone holding the share URL reaches OctoPrint with no
+        BitBang-layer auth; for users who enabled OctoPrint's autologinLocal
+        that is a full remote takeover (see the X-Forwarded-For handling in
+        the Go proxy)."""
+        pin = (self._settings.get(["pin"]) or "").strip()
+        if pin:
+            return True
+        return self._settings.get_boolean(["allow_no_pin"])
+
     def _probe_picamera2_sensor(self):
         # Cache before the adapter opens the camera — picamera2 can't be
         # opened twice, so the resolutions endpoint relies on this.
@@ -209,6 +239,7 @@ class BitBangPlugin(
         # pion) owns the transport under our shared identity, and our camera
         # track is fed into a video PeerConnection over a socketpair relay.
         self._start_video_bridge()
+        self._running = True
 
     def _run_aiortc_loop(self):
         """Bare asyncio loop for aiortc. Replaces the adapter's own bitbang
@@ -334,6 +365,39 @@ class BitBangPlugin(
             time.sleep(backoff)
             backoff = min(backoff * 2, 30)
 
+    def _stop_bitbang(self):
+        """Tear down the remote-access proxy (Go subprocess supervisor +
+        aiortc loop + camera). Best-effort; each step is independently
+        guarded so a failure in one doesn't strand the others."""
+        self._running = False
+        # Tell the supervisor not to respawn, then kill the current proxy.
+        self._go_stop = True
+        proc = getattr(self, "_go_proc", None)
+        if proc is not None and proc.poll() is None:
+            try:
+                proc.terminate()
+            except Exception:
+                pass
+        # Release the camera.
+        try:
+            player = getattr(self._adapter, "player", None) if self._adapter else None
+            if player is not None:
+                player.stop()
+        except Exception as e:
+            self._logger.warning(f"BitBang: error stopping camera: {e}")
+        # Stop the aiortc event loop so its thread can exit.
+        try:
+            loop = getattr(self._adapter, "_loop", None) if self._adapter else None
+            if loop is not None and loop.is_running():
+                loop.call_soon_threadsafe(loop.stop)
+        except Exception:
+            pass
+        self._adapter = None
+        # Clear the persisted URL so the navbar doesn't show a dead link.
+        self._settings.set(["url"], "")
+        self._settings.save()
+        self._plugin_manager.send_plugin_message(self._identifier, {"url": ""})
+
     # -- Local WebRTC video signaling --
 
     @octoprint.plugin.BlueprintPlugin.route("/ice-servers", methods=["GET"])
@@ -756,6 +820,9 @@ class BitBangPlugin(
         return {
             "enabled": True,
             "pin": "",
+            # Explicit opt-in to expose remote access with NO PIN. Default
+            # False so a fresh install is gated until the wizard runs.
+            "allow_no_pin": False,
             "url": "",
             "camera_device": "",
             "camera_resolution": "640x480",
@@ -765,16 +832,99 @@ class BitBangPlugin(
             "signaling_server": "bitba.ng",
         }
 
+    def on_settings_save(self, data):
+        # Server-side PIN-policy backstop. The wizard/settings JS validates
+        # too, but this is authoritative: a non-empty PIN below the minimum
+        # length is rejected (the prior value is kept) rather than persisted.
+        if data.get("pin"):
+            pin = str(data["pin"]).strip()
+            if 0 < len(pin) < MIN_PIN_LENGTH:
+                self._logger.warning(
+                    "BitBang: rejected PIN shorter than %d characters",
+                    MIN_PIN_LENGTH,
+                )
+                data["pin"] = self._settings.get(["pin"])
+            else:
+                data["pin"] = pin
+
+        # Snapshot gate-relevant state, save, then reconcile if it changed so
+        # the wizard's "set a PIN" takes effect without an OctoPrint restart.
+        before = self._gate_state()
+        octoprint.plugin.SettingsPlugin.on_settings_save(self, data)
+        if self._gate_state() != before:
+            self._reconcile_remote_access()
+
+    def _gate_state(self):
+        """The tuple of settings that determines whether/how the proxy runs."""
+        return (
+            self._settings.get_boolean(["enabled"]),
+            (self._settings.get(["pin"]) or "").strip(),
+            self._settings.get_boolean(["allow_no_pin"]),
+        )
+
+    def _reconcile_remote_access(self):
+        """Bring the running proxy in line with current settings. Best-effort
+        and defensive: on any failure the user can still restart OctoPrint to
+        pick up the change (the prior behavior)."""
+        if _VIDEO_IMPORT_ERROR:
+            return  # video stack unavailable; nothing to start/stop
+        try:
+            should_run = self._settings.get_boolean(["enabled"]) and self._remote_access_allowed()
+            if should_run and not self._running:
+                self._logger.info("BitBang: remote access now permitted — starting")
+                self._start_bitbang()
+            elif not should_run and self._running:
+                self._logger.info("BitBang: remote access no longer permitted — stopping")
+                self._stop_bitbang()
+            elif should_run and self._running:
+                # Still running, but the PIN may have changed. The Go proxy
+                # reads -pin fresh on each spawn, so bouncing the subprocess
+                # (the supervisor respawns it) applies the new PIN.
+                self._logger.info("BitBang: PIN/config changed — restarting proxy")
+                self._restart_go_proxy()
+        except Exception as e:
+            self._logger.warning(
+                "BitBang: live reconcile failed (%s); restart OctoPrint to apply", e
+            )
+
+    def _restart_go_proxy(self):
+        """Bounce just the Go subprocess; the supervisor loop respawns it with
+        the current -pin. Falls back to a full restart if no proc is tracked."""
+        proc = getattr(self, "_go_proc", None)
+        if proc is not None and proc.poll() is None:
+            proc.terminate()
+        else:
+            self._stop_bitbang()
+            if self._settings.get_boolean(["enabled"]) and self._remote_access_allowed():
+                self._start_bitbang()
+
     def get_template_configs(self):
         return [
             {"type": "settings", "custom_bindings": True},
             {"type": "navbar", "custom_bindings": True},
+            {"type": "wizard", "name": "BitBang", "template": "bitbang_wizard.jinja2"},
             # Render the live view as a proper webcam provider template so
             # OctoPrint shows it only when "BitBang Camera" is the selected
             # webcam -- no DOM-replacing the classic webcam.
             {"type": "webcam", "name": "BitBang Camera", "template": "bitbang_webcam.jinja2"},
         ]
 
+    # -- Setup wizard (secure-by-default PIN prompt) --
+
+    def is_wizard_required(self):
+        # Show the wizard whenever remote access would be enabled but is
+        # currently ungated (no PIN, no explicit opt-out). Covers fresh
+        # installs and existing no-PIN users on upgrade.
+        return self._settings.get_boolean(["enabled"]) and not self._remote_access_allowed()
+
+    def get_wizard_version(self):
+        # Bump to re-show the wizard to users who already cleared an older
+        # version (e.g. if the PIN policy changes again).
+        return 1
+
+    def get_wizard_details(self):
+        return {"required": self.is_wizard_required()}
+
     def get_template_vars(self):
         return {"plugin_version": __plugin_version__}
 

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8}/octoprint_bitbang/static/js/bitbang.js

@@ -399,3 +399,55 @@ OCTOPRINT_VIEWMODELS.push({
     dependencies: ["settingsViewModel"],
     elements: ["#navbar_plugin_bitbang", "#settings_plugin_bitbang"]
 });
+
+/*
+ * Setup-wizard viewmodel. The wizard fields bind directly to the shared
+ * settings observables, so OctoPrint persists them on Finish (which then
+ * runs the server-side PIN-length backstop in on_settings_save). This VM
+ * only supplies live validation feedback for the PIN field.
+ */
+function BitBangWizardViewModel(parameters) {
+    var self = this;
+    self.settings = parameters[0];
+
+    function bb() {
+        var plugins = self.settings.settings.plugins;
+        return plugins && plugins.bitbang ? plugins.bitbang : null;
+    }
+
+    function pinOk() {
+        var b = bb();
+        if (!b) return true;
+        return b.allow_no_pin() || (b.pin() || "").trim().length >= 4;
+    }
+
+    self.pinTooShort = ko.pureComputed(function () {
+        var b = bb();
+        if (!b) return false;
+        var pin = (b.pin() || "").trim();
+        return pin.length > 0 && pin.length < 4;
+    });
+
+    // Set once the user tries to finish without a usable PIN. Drives the
+    // blocking message; clears reactively once they set a valid PIN or
+    // tick the no-PIN opt-out.
+    self.finishAttempted = ko.observable(false);
+    self.finishBlocked = ko.pureComputed(function () {
+        return self.finishAttempted() && !pinOk();
+    });
+
+    // Veto the wizard's Finish button unless a valid PIN is set (or the user
+    // explicitly opted out). Returning false keeps the dialog open — see
+    // OctoPrint wizard.js onBeforeWizardFinish.
+    self.onBeforeWizardFinish = function () {
+        if (pinOk()) return true;
+        self.finishAttempted(true);
+        return false;
+    };
+}
+
+OCTOPRINT_VIEWMODELS.push({
+    construct: BitBangWizardViewModel,
+    dependencies: ["settingsViewModel"],
+    elements: ["#wizard_plugin_bitbang"]
+});

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8}/octoprint_bitbang/templates/bitbang_settings.jinja2

@@ -14,8 +14,25 @@
             <div class="controls">
                 <input type="text" class="input-medium"
                        data-bind="value: settings.settings.plugins.bitbang.pin"
-                       placeholder="Empty to disable">
-                <span class="help-inline">Optional PIN to protect remote access</span>
+                       placeholder="At least 4 characters">
+                <span class="help-inline">
+                    Protects remote access. At least 4 characters. Leave empty
+                    only if you tick &ldquo;allow no PIN&rdquo; below &mdash;
+                    otherwise remote access stays disabled.
+                </span>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <div class="controls">
+                <label class="checkbox">
+                    <input type="checkbox"
+                           data-bind="checked: settings.settings.plugins.bitbang.allow_no_pin">
+                    Allow remote access without a PIN (not recommended)
+                </label>
+                <span class="help-block muted">
+                    Anyone who has the share link could control this printer.
+                </span>
             </div>
         </div>
 

octoprint_bitbang-0.2.8/octoprint_bitbang/templates/bitbang_wizard.jinja2

@@ -0,0 +1,47 @@
+<div id="wizard_plugin_bitbang">
+    <h3>Secure your BitBang remote access</h3>
+    <p>
+        BitBang gives this OctoPrint a private link you can use to reach it from
+        anywhere. Protect that link with a PIN so only you can connect &mdash; we
+        recommend at least {{ 4 }} characters.
+    </p>
+
+    <form class="form-horizontal">
+        <div class="control-group">
+            <label class="control-label">PIN</label>
+            <div class="controls">
+                <input type="text" class="input-medium"
+                       data-bind="value: settings.settings.plugins.bitbang.pin, valueUpdate: 'afterkeydown'"
+                       placeholder="At least 4 characters">
+                <span class="help-inline" style="color: #b94a48;"
+                      data-bind="visible: pinTooShort">
+                    PIN must be at least 4 characters.
+                </span>
+            </div>
+        </div>
+
+        <div class="control-group">
+            <div class="controls">
+                <label class="checkbox">
+                    <input type="checkbox"
+                           data-bind="checked: settings.settings.plugins.bitbang.allow_no_pin">
+                    Advanced: run without a PIN
+                </label>
+                <span class="help-block muted">
+                    Not recommended &mdash; anyone who has the link could control
+                    this printer.
+                </span>
+            </div>
+        </div>
+    </form>
+
+    <p class="muted">
+        Until you set a PIN (or tick the box above), BitBang remote access stays
+        disabled.
+    </p>
+
+    <div class="alert alert-error" data-bind="visible: finishBlocked" style="display: none;">
+        Set a PIN of at least 4 characters, or tick &ldquo;run without a
+        PIN&rdquo; above, before finishing.
+    </div>
+</div>

{octoprint_bitbang-0.2.7 → octoprint_bitbang-0.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OctoPrint-BitBang"
-version = "0.2.7"
+version = "0.2.8"
 description = "Remote OctoPrint access with live H.264 video via BitBang WebRTC"
 readme = "README.md"
 license = "MIT"