boneio 1.6.0.dev3__tar.gz → 1.6.0.dev4__tar.gz

{boneio-1.6.0.dev3/boneio.egg-info → boneio-1.6.0.dev4}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: boneio
-Version: 1.6.0.dev3
+Version: 1.6.0.dev4
 Summary: Python App for BoneIO
 Author-email: Paweł Szafer <pszafer@gmail.com>
 License: GNU General Public License v3.0
 Project-URL: Homepage, https://boneio.eu
-Project-URL: Repository, https://github.com/boneIO-eu/app_bbb
+Project-URL: Repository, https://github.com/boneIO-eu/app_black
 Project-URL: Documentation, https://boneio.eu/docs/intro/
-Project-URL: Changelog, https://github.com/boneIO-eu/app_bbb/releases
+Project-URL: Changelog, https://github.com/boneIO-eu/app_black/releases
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE

boneio-1.6.0.dev4/boneio/core/config/provenance.py

@@ -0,0 +1,114 @@
+"""Tell a freshly flashed controller from one that has been in service.
+
+The first-run wizard has two steps that are only appropriate on a blank
+device. The import step offers to restore a configuration, which on a device
+that already has one reads as "yours is gone". The devices step is worse than
+misleading: it replaces the whole ``event`` section, so a controller with fifty
+configured inputs loses them to a wizard its owner opened only to create an
+account.
+
+So the question has to be answered before those steps are offered, and the two
+ways of getting it wrong are not equally bad:
+
+  * Treating an upgraded device as fresh costs the owner their configuration.
+  * Treating a fresh device as upgraded costs them a step in a wizard; they
+    can still import and bind inputs from the normal interface afterwards.
+
+This module is therefore written to answer "is it fresh" and to say no when it
+cannot tell. Freshness has to be demonstrated, not assumed.
+
+The demonstration is that the configuration is still the factory one. The image
+copies a variant out of ``~/.cache/boneio_configs/<variant>/`` verbatim, and
+per-device work touches only ``mqtt.yaml`` (the broker password), so a
+controller nobody has configured yet still has a ``config.yaml`` byte-identical
+to its template.
+"""
+
+from __future__ import annotations
+
+import logging
+import os
+from pathlib import Path
+
+_LOGGER = logging.getLogger(__name__)
+
+#: Where the image leaves the per-variant templates it seeded the device from.
+FACTORY_TEMPLATE_DIR = Path.home() / ".cache" / "boneio_configs"
+
+
+def _digest(path: Path) -> bytes | None:
+    """Read a file for comparison.
+
+    Args:
+        path: File to read.
+
+    Returns:
+        Its contents, or None when it cannot be read.
+    """
+    try:
+        return path.read_bytes()
+    except OSError:
+        return None
+
+
+def looks_factory_fresh(
+    config_path: str | os.PathLike[str],
+    template_dir: str | os.PathLike[str] | None = None,
+) -> bool:
+    """Whether this device still carries an untouched factory configuration.
+
+    Args:
+        config_path: The device's ``config.yaml``.
+        template_dir: Where the per-variant templates live. Defaults to
+            :data:`FACTORY_TEMPLATE_DIR`.
+
+    Returns:
+        True only when freshness can be positively shown: there is no
+        configuration at all, or the configuration is identical to one of the
+        templates the image ships. False whenever the answer is not certain.
+    """
+    config = Path(config_path)
+    current = _digest(config)
+    if current is None:
+        # Nothing to lose, and nothing that an import could overwrite.
+        _LOGGER.debug("No configuration at %s — treating the device as fresh", config)
+        return True
+
+    root = Path(template_dir) if template_dir is not None else FACTORY_TEMPLATE_DIR
+    try:
+        variants = sorted(p for p in root.iterdir() if p.is_dir())
+    except OSError:
+        # No templates to compare against: the honest answer is "cannot tell",
+        # and the safe reading of that is "assume it has been configured".
+        _LOGGER.debug("No factory templates under %s — assuming configured", root)
+        return False
+
+    for variant in variants:
+        if current == _digest(variant / "config.yaml"):
+            _LOGGER.debug("Configuration matches the %s template", variant.name)
+            return True
+
+    return False
+
+
+def was_configured_before(
+    config_path: str | os.PathLike[str],
+    had_legacy_auth: bool = False,
+    template_dir: str | os.PathLike[str] | None = None,
+) -> bool:
+    """Whether the wizard should skip the steps that assume a blank device.
+
+    Args:
+        config_path: The device's ``config.yaml``.
+        had_legacy_auth: Whether a pre-1.6 ``web.auth`` block was found. It
+            proves the device is not fresh, but its absence proves nothing —
+            most 1.5.x controllers never had web authentication at all, which
+            is exactly the case this used to get wrong.
+        template_dir: Passed through to :func:`looks_factory_fresh`.
+
+    Returns:
+        True when the device already has a configuration of its own.
+    """
+    if had_legacy_auth:
+        return True
+    return not looks_factory_fresh(config_path, template_dir)

{boneio-1.6.0.dev3 → boneio-1.6.0.dev4}/boneio/migrations/assets/MANIFEST.sha256

@@ -12,6 +12,7 @@ e08f0e81a507e625398f87cad7b922c9af00cba2bda53280697178cbbf9eea86  helpers/boneio
 dff0cd02daad2cbd525a0535f8f3562bb742e7e737b24c69e5afa986415e67e4  helpers/boneio-helpers-heal
 643cfaea029d9b1a9ce6c7f12d1d6b63e8374cb4038a89b8fa48df9848f3af77  helpers/boneio-migrate-v2
 9f9675297a2de2c708bb7cf72d96ecd18e58f97a9dc3eec3e2069bf1659f3fa5  helpers/boneio-system
+485d37182fe6a1261b472cbc6b6e922d30e690333c27672497a7b13dc775499c  issue.d/10-boneio.issue
 e6013f4fbf11693f39123b1e6159c7d7224a7c832e994722120980f64039c17e  journald/journald.conf
 d28f2e9336b881b102c42f4278ec9ddf046c83dab4469dc5be7326768e074cb6  kernel/postinst-boneio-overlay
 9681710e1a38b8ea7ba5558839e4ef8b5f01a75722dbf403913bad76437449ec  migrations-recovery.pem

boneio-1.6.0.dev4/boneio/migrations/assets/issue.d/10-boneio.issue

@@ -0,0 +1 @@
+boneIO  eth0 \4{eth0}   (blank? press Enter to redraw)

boneio-1.6.0.dev4/boneio/migrations/plans/1.6.12.json

@@ -0,0 +1 @@
+[{"action":"install_file","dst":"/etc/issue.d/10-boneio.issue","expected_sha256":"485d37182fe6a1261b472cbc6b6e922d30e690333c27672497a7b13dc775499c","group":"root","mode":420,"owner":"root","src":"issue.d/10-boneio.issue","template_vars":{}}]

boneio-1.6.0.dev4/boneio/migrations/plans/1.6.12.sig

@@ -0,0 +1,2 @@
+Qd
+��M)��!���4z!=�Uj�G���=�eGʤ��\�y� ��5Ҭ�O�bK8�)��/

{boneio-1.6.0.dev3 → boneio-1.6.0.dev4}/boneio/migrations/plans/manifest.json

@@ -1 +1 @@
-{"plans":{"1.3.0":"28f5b17fc82667ddfda08d567195b10466e673b8a62f72a1b07bb52581095629","1.3.1":"580381a4f6f40fc1bd4e903e591ad0d5c1db27daaccafc6f79dabf8c3b84259a","1.3.2":"7a69ffaf0c41438be25a656dcdc87783daac0eae79218d023648ef9d708e373f","1.4.0":"c50ba85a587c756f69ec4b3ee3ae4b5729281208c68ed138f4bd996d5dddc82f","1.4.3":"a8cfbabff09d21944a822c4a70f23a7ee14960c4054de151c9fbc7cdb29adff5","1.4.4":"a2089ad8d97d2de58a520fe633f519c8872b3052b911f040ce4957a308c6ccaa","1.5.0":"52d9d118da099abda0e0153cd16892e201681f6e4d3c6e5790284d1ac469a407","1.5.1":"d283cb8c01024338fb614ae2199744d883379f59579423e4eb9234f5c59ebdd8","1.5.10":"889e2f12614e6e67d342571c1c3bab8940659bfbbf43fa30a6847e73decb85d1","1.5.11":"4906e4de2b3a9c2f0b0181817c9dc168cb910ba6941691d4e86b8387802b624a","1.5.12":"c0a0dc085bb33d9718e869ed5effc2c1581deffd7ed0d5adc119b94312181625","1.5.13":"bfe58c8756f9b5f5e55d5acbb6f7cfc469d201004d312c14e022eb7c52369b7d","1.5.14":"a0464f11e05128cba8881e6295e591fce1ed1e8d43ab0e16710effb8e543d810","1.5.15":"0687a735cb4aaf8f8f74ad6e228ca1b14e045cba8821991c7d19fc9beaeac766","1.5.16":"3544ac754f39d56ecf2b06300b7cca1b6f8723f99885cd11bd690f1a704d3728","1.5.17":"cf1e9e0ff6812cb7092a82dd588392d625decbe3680fe003dfc554f9045809d3","1.5.18":"1fd873effa66b632217d674745722f712a48b36bb79957fefae722757a74bc30","1.5.2":"39fccb7582e13e7e3436861fde7b83ddb8057788cbde792f2f0cf7003f068850","1.5.3":"39fccb7582e13e7e3436861fde7b83ddb8057788cbde792f2f0cf7003f068850","1.5.4":"e86174ba5aff6f257f8a3f4721c7942885cd203469a9d8ddc15dbe6c704e0f45","1.5.5":"f93ed2d4342e447eb9900a0150331113918f2a8b3baeeb795c07231d80f0337c","1.5.6":"e3d90e6ceb20d760f1e9fa63224c5a070a16b3ca6e7dc4cc2c594138e929cce8","1.5.7":"a0464f11e05128cba8881e6295e591fce1ed1e8d43ab0e16710effb8e543d810","1.5.8":"f075b84fb04f4043658a28402d963494dd58481f164c0b371cec94322fe6d131","1.5.9":"ac170fc924019fc2acd69a90a82ba5c2552dce7a2c01a05e5407443e7a9e5af7","1.6.0":"c8286514d1a4f1805e727e13d3c350bb390378c6f31ad6920030412d61ec9b3f","1.6.1":"aa1d3934091853fc21208993930c1bf92e17136428d1d0baaefabfa65d13e7fa","1.6.10":"41c3a16e7819857a4b826e944fcfb4f79c58e7192cb151b106a3acd7487d5771","1.6.11":"d136203e08e3b052254403815d4ccedb555b0a297686fe97952d275eb1f322eb","1.6.2":"6ef96b5e00a04a929d16f0e4a136bfcc5b8132a466d6907a99b2c8516a8952d5","1.6.3":"5c10db827bcb92b9322d4aa5751076b825da87c6d18d6953847ba72317cca862","1.6.4":"258b3fd6a5ba62067ee6743051b66686bb7640ccbad52de45d898034c3d65e67","1.6.5":"92417668ba1c0e9ddd2482fa9513b980dea8e92130a6b849c58ccda4956a8a1a","1.6.6":"535bb041b99d5ac1bc9028ea88bc2fbf3dbadc80ea8dea236cc219123c194114","1.6.7":"d59af413e270e6f34b1b9a1c8c4acef35328f00e26fad447cfe214545af78d8f","1.6.8":"7175f827b99c602df80436db588c87277ce50f2734051a444163b048f5d0b23e","1.6.9":"732d5a9bcd2e496a260263a643c78a6346e9f3cef5b48fe59ac6b120bd03ba4e"},"release":"1.6.0.dev3"}
+{"plans":{"1.3.0":"28f5b17fc82667ddfda08d567195b10466e673b8a62f72a1b07bb52581095629","1.3.1":"580381a4f6f40fc1bd4e903e591ad0d5c1db27daaccafc6f79dabf8c3b84259a","1.3.2":"7a69ffaf0c41438be25a656dcdc87783daac0eae79218d023648ef9d708e373f","1.4.0":"c50ba85a587c756f69ec4b3ee3ae4b5729281208c68ed138f4bd996d5dddc82f","1.4.3":"a8cfbabff09d21944a822c4a70f23a7ee14960c4054de151c9fbc7cdb29adff5","1.4.4":"a2089ad8d97d2de58a520fe633f519c8872b3052b911f040ce4957a308c6ccaa","1.5.0":"52d9d118da099abda0e0153cd16892e201681f6e4d3c6e5790284d1ac469a407","1.5.1":"d283cb8c01024338fb614ae2199744d883379f59579423e4eb9234f5c59ebdd8","1.5.10":"889e2f12614e6e67d342571c1c3bab8940659bfbbf43fa30a6847e73decb85d1","1.5.11":"4906e4de2b3a9c2f0b0181817c9dc168cb910ba6941691d4e86b8387802b624a","1.5.12":"c0a0dc085bb33d9718e869ed5effc2c1581deffd7ed0d5adc119b94312181625","1.5.13":"bfe58c8756f9b5f5e55d5acbb6f7cfc469d201004d312c14e022eb7c52369b7d","1.5.14":"a0464f11e05128cba8881e6295e591fce1ed1e8d43ab0e16710effb8e543d810","1.5.15":"0687a735cb4aaf8f8f74ad6e228ca1b14e045cba8821991c7d19fc9beaeac766","1.5.16":"3544ac754f39d56ecf2b06300b7cca1b6f8723f99885cd11bd690f1a704d3728","1.5.17":"cf1e9e0ff6812cb7092a82dd588392d625decbe3680fe003dfc554f9045809d3","1.5.18":"1fd873effa66b632217d674745722f712a48b36bb79957fefae722757a74bc30","1.5.2":"39fccb7582e13e7e3436861fde7b83ddb8057788cbde792f2f0cf7003f068850","1.5.3":"39fccb7582e13e7e3436861fde7b83ddb8057788cbde792f2f0cf7003f068850","1.5.4":"e86174ba5aff6f257f8a3f4721c7942885cd203469a9d8ddc15dbe6c704e0f45","1.5.5":"f93ed2d4342e447eb9900a0150331113918f2a8b3baeeb795c07231d80f0337c","1.5.6":"e3d90e6ceb20d760f1e9fa63224c5a070a16b3ca6e7dc4cc2c594138e929cce8","1.5.7":"a0464f11e05128cba8881e6295e591fce1ed1e8d43ab0e16710effb8e543d810","1.5.8":"f075b84fb04f4043658a28402d963494dd58481f164c0b371cec94322fe6d131","1.5.9":"ac170fc924019fc2acd69a90a82ba5c2552dce7a2c01a05e5407443e7a9e5af7","1.6.0":"c8286514d1a4f1805e727e13d3c350bb390378c6f31ad6920030412d61ec9b3f","1.6.1":"aa1d3934091853fc21208993930c1bf92e17136428d1d0baaefabfa65d13e7fa","1.6.10":"41c3a16e7819857a4b826e944fcfb4f79c58e7192cb151b106a3acd7487d5771","1.6.11":"d136203e08e3b052254403815d4ccedb555b0a297686fe97952d275eb1f322eb","1.6.12":"fe4426b91a10a01fa2ebba9c818bf3ccb64103fbc6183f712507c38929645857","1.6.2":"6ef96b5e00a04a929d16f0e4a136bfcc5b8132a466d6907a99b2c8516a8952d5","1.6.3":"5c10db827bcb92b9322d4aa5751076b825da87c6d18d6953847ba72317cca862","1.6.4":"258b3fd6a5ba62067ee6743051b66686bb7640ccbad52de45d898034c3d65e67","1.6.5":"92417668ba1c0e9ddd2482fa9513b980dea8e92130a6b849c58ccda4956a8a1a","1.6.6":"535bb041b99d5ac1bc9028ea88bc2fbf3dbadc80ea8dea236cc219123c194114","1.6.7":"d59af413e270e6f34b1b9a1c8c4acef35328f00e26fad447cfe214545af78d8f","1.6.8":"7175f827b99c602df80436db588c87277ce50f2734051a444163b048f5d0b23e","1.6.9":"732d5a9bcd2e496a260263a643c78a6346e9f3cef5b48fe59ac6b120bd03ba4e"},"release":"1.6.0.dev4"}

boneio-1.6.0.dev4/boneio/migrations/versions/v1_6_12_console_shows_ip.py

@@ -0,0 +1,58 @@
+"""Show the device's address on the serial console login prompt.
+
+A controller in a cabinet is reached over the network, and the first thing
+anybody attaching a serial cable wants to know is which address it ended up
+with. Until now the console said only the hostname, so the answer meant logging
+in and running ``ip addr`` — on a device that, after the 1.6 hardening, an
+installer may not have an account on.
+
+``agetty`` expands the escape when it draws the prompt, not when it starts, so
+the address is current rather than whatever DHCP had managed by the time the
+getty came up. If the lease had not arrived yet the field is simply blank, and
+pressing Enter redraws the prompt with the address filled in — which is what
+the hint on the line is for.
+
+The interface is named explicitly. A bare ``\\4`` means "the first fully
+configured interface", and this device has ``docker0`` and a compose bridge
+holding 172.17/172.18 addresses that are of no use to anybody standing at the
+cabinet.
+
+It goes in ``/etc/issue.d`` rather than into ``/etc/issue``, which belongs to
+``base-files`` and already carries text the board vendor put there.
+
+The line carries the address and nothing else — deliberately. A URL would have
+to name a port, and the panel's port is ``web.port`` from the operator's
+``config.yaml``, defaulting to 8090 but not fixed at it; there is also a TLS
+front on 8443 that some deployments use instead. A signed plan is frozen at
+release time and this file is static, so any port written here is a guess that
+cannot be corrected on the device that proves it wrong. The address is the
+thing somebody at the cabinet does not already know.
+
+To retry on a device, delete ``/var/lib/boneio/migrations.d/1.6.12.applied``
+and restart boneIO.
+"""
+
+from __future__ import annotations
+
+from boneio.migrations.actions import InstallFile, MigrationAction
+
+VERSION = "1.6.12"
+DESCRIPTION = "Show the IP address on the serial console"
+REQUIRES_ROOT = True
+
+
+def plan() -> list[MigrationAction]:
+    """Return the ordered list of migration actions.
+
+    Returns:
+        List of :class:`MigrationAction` to apply in order.
+    """
+    return [
+        InstallFile(
+            src="issue.d/10-boneio.issue",
+            dst="/etc/issue.d/10-boneio.issue",
+            mode=0o644,
+            owner="root",
+            group="root",
+        )
+    ]

boneio-1.6.0.dev4/boneio/version.py

@@ -0,0 +1,2 @@
+# flake8: noqa
+__version__ = "1.6.0.dev4"

{boneio-1.6.0.dev3 → boneio-1.6.0.dev4}/boneio/webui/app.py

@@ -24,6 +24,7 @@ from boneio.const import COVER, NONE
 from boneio.core.auth.migration import migrate_legacy_auth
 from boneio.core.auth.store import UserStore, UserStoreError
 from boneio.core.config import ConfigHelper
+from boneio.core.config.provenance import was_configured_before
 from boneio.core.events import GracefulExit
 from boneio.core.manager import Manager
 from boneio.models import (
@@ -785,14 +786,22 @@ def init_app(
                 "username": migration.username,
                 "used_secret_file": migration.used_secret_file,
             }
-        # A web.auth block means this device was configured under a pre-1.6
-        # release, whether or not the credentials in it were usable. The
-        # factory config ships web: with ports and no auth, so its presence is
-        # what separates an upgraded controller from a fresh one — and the
-        # first-run wizard must not offer to import a configuration, or to
-        # generate input bindings, on a device that already has both.
+        # Whether the first-run wizard may offer the steps that assume a blank
+        # device — the import, and the one that replaces the whole event
+        # section.
+        #
+        # This used to be read off the web.auth block alone, which was wrong in
+        # the direction that costs the owner their configuration: most 1.5.x
+        # controllers never had web authentication, so an upgraded device with
+        # a full config.yaml looked exactly like a fresh one. Freshness is now
+        # something that has to be shown, not assumed — see
+        # boneio.core.config.provenance.
         onboarding_module.set_configured_before(
-            bool(migration) or migration.reason == "incomplete_legacy_auth"
+            was_configured_before(
+                yaml_config_file,
+                had_legacy_auth=bool(migration)
+                or migration.reason == "incomplete_legacy_auth",
+            )
         )
     except UserStoreError as err:
         # Refusing to start would brick the UI over a file the user can fix,

{boneio-1.6.0.dev3 → boneio-1.6.0.dev4/boneio.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: boneio
-Version: 1.6.0.dev3
+Version: 1.6.0.dev4
 Summary: Python App for BoneIO
 Author-email: Paweł Szafer <pszafer@gmail.com>
 License: GNU General Public License v3.0
 Project-URL: Homepage, https://boneio.eu
-Project-URL: Repository, https://github.com/boneIO-eu/app_bbb
+Project-URL: Repository, https://github.com/boneIO-eu/app_black
 Project-URL: Documentation, https://boneio.eu/docs/intro/
-Project-URL: Changelog, https://github.com/boneIO-eu/app_bbb/releases
+Project-URL: Changelog, https://github.com/boneIO-eu/app_black/releases
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE

{boneio-1.6.0.dev3 → boneio-1.6.0.dev4}/boneio.egg-info/SOURCES.txt

@@ -115,6 +115,7 @@ boneio/core/config/config_helper.py
 boneio/core/config/input_bindings.py
 boneio/core/config/package-lock.json
 boneio/core/config/package.json
+boneio/core/config/provenance.py
 boneio/core/config/schema_converter.py
 boneio/core/config/secret_masking.py
 boneio/core/config/yaml_compat.py
@@ -294,6 +295,7 @@ boneio/migrations/assets/helpers/boneio-containers
 boneio/migrations/assets/helpers/boneio-helpers-heal
 boneio/migrations/assets/helpers/boneio-migrate-v2
 boneio/migrations/assets/helpers/boneio-system
+boneio/migrations/assets/issue.d/10-boneio.issue
 boneio/migrations/assets/journald/journald.conf
 boneio/migrations/assets/kernel/postinst-boneio-overlay
 boneio/migrations/assets/modules-load.d/onewire.conf
@@ -380,6 +382,8 @@ boneio/migrations/plans/1.6.10.json
 boneio/migrations/plans/1.6.10.sig
 boneio/migrations/plans/1.6.11.json
 boneio/migrations/plans/1.6.11.sig
+boneio/migrations/plans/1.6.12.json
+boneio/migrations/plans/1.6.12.sig
 boneio/migrations/plans/1.6.2.json
 boneio/migrations/plans/1.6.2.sig
 boneio/migrations/plans/1.6.3.json
@@ -427,6 +431,7 @@ boneio/migrations/versions/v1_5_9_defer_nonessential.py
 boneio/migrations/versions/v1_6_0_nodered_admin_auth.py
 boneio/migrations/versions/v1_6_10_narrow_sudo_rules.py
 boneio/migrations/versions/v1_6_11_drop_docker_group.py
+boneio/migrations/versions/v1_6_12_console_shows_ip.py
 boneio/migrations/versions/v1_6_1_mosquitto_passwd_perms.py
 boneio/migrations/versions/v1_6_2_drop_build_sudo_rule.py
 boneio/migrations/versions/v1_6_3_firewall_rule_gaps.py

{boneio-1.6.0.dev3 → boneio-1.6.0.dev4}/pyproject.toml

@@ -38,9 +38,9 @@ license = { text = "GNU General Public License v3.0" }
 
 [project.urls]
 Homepage = "https://boneio.eu"
-Repository = "https://github.com/boneIO-eu/app_bbb"
+Repository = "https://github.com/boneIO-eu/app_black"
 Documentation = "https://boneio.eu/docs/intro/"
-Changelog = "https://github.com/boneIO-eu/app_bbb/releases"
+Changelog = "https://github.com/boneIO-eu/app_black/releases"
 
 [project.scripts]
 boneio = "boneio.bonecli:main"

boneio-1.6.0.dev3/boneio/migrations/plans/manifest.sig

@@ -1 +0,0 @@
- Y���O�h�<�u��ۡҍ�YQ0���~T�6�!gv[#w�BN�ye3����h:Z

boneio-1.6.0.dev3/boneio/version.py

@@ -1,2 +0,0 @@
-# flake8: noqa
-__version__ = "1.6.0.dev3"