goosebit 0.2.8__tar.gz → 0.2.9__tar.gz

{goosebit-0.2.8 → goosebit-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: goosebit
-Version: 0.2.8
+Version: 0.2.9
 Summary: A simplistic, opinionated remote update server implementing hawkBit™'s DDI API
 Author: Brett Rowan
 Author-email: 121075405+b-rowan@users.noreply.github.com
@@ -25,10 +25,12 @@ Requires-Dist: opentelemetry-distro (>=0.57b0,<0.58)
 Requires-Dist: opentelemetry-exporter-prometheus (>=0.57b0,<0.58)
 Requires-Dist: opentelemetry-instrumentation-fastapi (>=0.57b0,<0.58)
 Requires-Dist: pydantic-settings[yaml] (>=2.10.1,<3.0.0)
+Requires-Dist: pysquashfsimage (>=0.9.0,<1.0.0)
 Requires-Dist: python-multipart (>=0.0.20,<0.0.21)
 Requires-Dist: semver (>=3.0.4,<4.0.0)
 Requires-Dist: tortoise-orm (>=0.25.1,<0.26.0)
 Requires-Dist: uvicorn (>=0.35.0,<0.36.0)
+Requires-Dist: zstandard (>=0.24.0,<0.25.0)
 Description-Content-Type: text/markdown
 
 # gooseBit
@@ -96,7 +98,10 @@ The software packages managed by gooseBit are either stored on the local filesys
 
 ## Assumptions
 
-- Devices use [SWUpdate](https://swupdate.org) for managing software updates.
+- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://github.com/rauc/rauc) + [RAUC hawkBit Updater](https://github.com/rauc/rauc-hawkbit-updater) for managing software updates.
+- Devices send certain attributes (`sw_version`, `hw_model`, `hw_revision`).
+- Semantic versions are used.
+- With RAUC and multiple hardware revisions, `compatible` in `manifest.raucm` is set to something like `my-board-rev4.2` or `Some Board 2b`.
 
 ## Features
 
@@ -111,7 +116,7 @@ The registry tracks each device's status, including the last online timestamp, i
 
 ### Software Repository
 
-Software packages (`*.swu` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
+Software packages (`*.swu`/`*.raucb` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
 
 ### Device Update Modes
 
@@ -268,7 +273,7 @@ The structure of gooseBit is as follows:
   - `templates`: Jinja2 formatted templates.
   - `nav`: Navbar handler.
 - `updater`: DDI API handler and device update manager.
-- `updates`: SWUpdate file parsing.
+- `updates`: SWUpdate/RAUC file parsing.
 - `auth`: Authentication functions and permission handling.
 - `models`: Database models.
 - `db`: Database config and initialization.

{goosebit-0.2.8 → goosebit-0.2.9}/README.md

@@ -63,7 +63,10 @@ The software packages managed by gooseBit are either stored on the local filesys
 
 ## Assumptions
 
-- Devices use [SWUpdate](https://swupdate.org) for managing software updates.
+- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://github.com/rauc/rauc) + [RAUC hawkBit Updater](https://github.com/rauc/rauc-hawkbit-updater) for managing software updates.
+- Devices send certain attributes (`sw_version`, `hw_model`, `hw_revision`).
+- Semantic versions are used.
+- With RAUC and multiple hardware revisions, `compatible` in `manifest.raucm` is set to something like `my-board-rev4.2` or `Some Board 2b`.
 
 ## Features
 
@@ -78,7 +81,7 @@ The registry tracks each device's status, including the last online timestamp, i
 
 ### Software Repository
 
-Software packages (`*.swu` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
+Software packages (`*.swu`/`*.raucb` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions.
 
 ### Device Update Modes
 
@@ -235,7 +238,7 @@ The structure of gooseBit is as follows:
   - `templates`: Jinja2 formatted templates.
   - `nav`: Navbar handler.
 - `updater`: DDI API handler and device update manager.
-- `updates`: SWUpdate file parsing.
+- `updates`: SWUpdate/RAUC file parsing.
 - `auth`: Authentication functions and permission handling.
 - `models`: Database models.
 - `db`: Database config and initialization.

goosebit-0.2.9/goosebit/db/migrations/models/6_20250904081506_add_image_format.py

@@ -0,0 +1,11 @@
+from tortoise import BaseDBAsyncClient
+
+
+async def upgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "software" ADD "image_format" SMALLINT NOT NULL  DEFAULT 0 /* SWU: 0\nRAUC: 1 */;"""
+
+
+async def downgrade(db: BaseDBAsyncClient) -> str:
+    return """
+        ALTER TABLE "software" DROP COLUMN "image_format";"""

{goosebit-0.2.8 → goosebit-0.2.9}/goosebit/db/models.py

@@ -123,12 +123,28 @@ class Hardware(Model):
     revision = fields.CharField(max_length=255)
 
 
+class SoftwareImageFormat(IntEnum):
+    SWU = 0
+    RAUC = 1
+
+    def __str__(self):
+        return self.name.upper()
+
+    @classmethod
+    def from_str(cls, name):
+        try:
+            return cls[name.upper()]
+        except KeyError:
+            return cls.SWU
+
+
 class Software(Model):
     id = fields.IntField(primary_key=True)
     uri = fields.CharField(max_length=255)
     size = fields.BigIntField()
     hash = fields.CharField(max_length=255)
     version = fields.CharField(max_length=255)
+    image_format = fields.IntEnumField(SoftwareImageFormat, default=SoftwareImageFormat.SWU)
     compatibility = fields.ManyToManyField(
         "models.Hardware",
         related_name="softwares",

{goosebit-0.2.8 → goosebit-0.2.9}/goosebit/ui/templates/software.html.jinja

@@ -42,7 +42,7 @@
                                         <div class="col">
                                             <input class="form-control"
                                                    type="file"
-                                                   accept=".swu"
+                                                   accept=".swu,.raucb"
                                                    id="file-upload"
                                                    name="file" />
                                         </div>

{goosebit-0.2.8 → goosebit-0.2.9}/goosebit/updates/__init__.py

@@ -19,25 +19,25 @@ from . import swdesc
 async def create_software_update(uri: str, temp_file: Path | None) -> Software:
     parsed_uri = urlparse(uri)
 
-    # parse swu header into update_info
+    # parse image header into update_info
     if parsed_uri.scheme == "file":
         if temp_file is None:
             raise HTTPException(500, "Temporary file missing, cannot parse file information")
         try:
             update_info = await swdesc.parse_file(temp_file)
         except Exception:
-            raise HTTPException(422, "Software swu header cannot be parsed")
+            raise HTTPException(422, "Software image header cannot be parsed")
 
     elif parsed_uri.scheme.startswith("http"):
         try:
             update_info = await swdesc.parse_remote(uri)
         except Exception:
-            raise HTTPException(422, "Software swu header cannot be parsed")
+            raise HTTPException(422, "Software image header cannot be parsed")
     else:
         raise HTTPException(422, "Software URI protocol unknown")
 
     if update_info is None:
-        raise HTTPException(422, "Software swu header contains invalid data")
+        raise HTTPException(422, "Software image header contains invalid data")
 
     # check for collisions
     is_colliding = await _is_software_colliding(update_info)
@@ -59,6 +59,7 @@ async def create_software_update(uri: str, temp_file: Path | None) -> Software:
         version=str(update_info["version"]),
         size=update_info["size"],
         hash=update_info["hash"],
+        image_format=update_info["image_format"],
     )
 
     # create compatibility information

goosebit-0.2.9/goosebit/updates/swdesc/__init__.py

@@ -0,0 +1,45 @@
+import logging
+import random
+import string
+
+import httpx
+from anyio import Path, open_file
+
+from goosebit.db.models import SoftwareImageFormat
+from goosebit.storage import storage
+
+from . import rauc, swu
+
+logger = logging.getLogger(__name__)
+
+
+async def parse_remote(url: str):
+    async with httpx.AsyncClient() as c:
+        file = await c.get(url)
+        temp_dir = Path(storage.get_temp_dir())
+        tmp_file_path = temp_dir.joinpath("".join(random.choices(string.ascii_lowercase, k=12)) + ".tmp")
+        try:
+            async with await open_file(tmp_file_path, "w+b") as f:
+                await f.write(file.content)
+            file_data = await parse_file(tmp_file_path)  # Use anyio.Path for parse_file
+        except Exception:
+            raise
+        finally:
+            await tmp_file_path.unlink(missing_ok=True)
+        return file_data
+
+
+async def parse_file(file: Path):
+    async with await open_file(file, "r+b") as f:
+        magic = await f.read(4)
+    if magic == swu.MAGIC:
+        image_format = SoftwareImageFormat.SWU
+        attributes = await swu.parse_file(file)
+    elif magic == rauc.MAGIC:
+        image_format = SoftwareImageFormat.RAUC
+        attributes = await rauc.parse_file(file)
+    else:
+        logger.warning(f"Unknown file format, magic={magic}")
+        raise ValueError(f"Unknown file format, magic={magic}")
+    attributes["image_format"] = image_format
+    return attributes

goosebit-0.2.9/goosebit/updates/swdesc/func.py

@@ -0,0 +1,19 @@
+import hashlib
+
+from anyio import AsyncFile
+
+
+async def sha1_hash_file(fileobj: AsyncFile):
+    last = await fileobj.tell()
+    await fileobj.seek(0)
+    sha1_hash = hashlib.sha1()
+    buf = bytearray(2**18)
+    view = memoryview(buf)
+    while True:
+        size = await fileobj.readinto(buf)
+        if size == 0:
+            break
+        sha1_hash.update(view[:size])
+
+    await fileobj.seek(last)
+    return sha1_hash.hexdigest()

goosebit-0.2.9/goosebit/updates/swdesc/rauc.py

@@ -0,0 +1,49 @@
+import configparser
+import logging
+import re
+
+import semver
+from anyio import Path, open_file
+from PySquashfsImage import SquashFsImage
+
+from .func import sha1_hash_file
+
+MAGIC = b"hsqs"
+
+logger = logging.getLogger(__name__)
+
+
+async def parse_file(file: Path):
+    async with await open_file(file, "r+b") as f:
+        image_data = await f.read()
+
+        image = SquashFsImage.from_bytes(image_data)
+        manifest = image.select("manifest.raucm")
+        manifest_str = manifest.read_bytes().decode("utf-8")
+        config = configparser.ConfigParser()
+        config.read_string(manifest_str)
+        swdesc_attrs = parse_descriptor(config)
+
+        stat = await file.stat()
+        swdesc_attrs["size"] = stat.st_size
+        swdesc_attrs["hash"] = await sha1_hash_file(f)
+    return swdesc_attrs
+
+
+def parse_descriptor(manifest: configparser.ConfigParser):
+    swdesc_attrs = {}
+    try:
+        swdesc_attrs["version"] = semver.Version.parse(manifest["update"].get("version"))
+        pattern = re.compile(r"^(?P<hw_model>.+?)[- ]?(?P<hw_revision>\w*[\d.]+\w*)?$")
+        hw_model = "default"
+        hw_revision = "default"
+        m = pattern.match(manifest["update"]["compatible"])
+        if m:
+            hw_model = m.group("hw_model")
+            hw_revision = m.group("hw_revision") or "default"
+        swdesc_attrs["compatibility"] = [{"hw_model": hw_model, "hw_revision": hw_revision}]
+    except KeyError as e:
+        logger.warning(f"Parsing RAUC descriptor failed, error={e}")
+        raise ValueError("Parsing RAUC descriptor failed", e)
+
+    return swdesc_attrs

goosebit-0.2.8/goosebit/updates/swdesc.py → goosebit-0.2.9/goosebit/updates/swdesc/swu.py

@@ -1,18 +1,17 @@
-import hashlib
 import logging
-import random
-import string
 from typing import Any
 
-import httpx
 import libconf
-from anyio import AsyncFile, Path, open_file
+from anyio import Path, open_file
 
-from goosebit.storage import storage
 from goosebit.util.version import Version
 
+from .func import sha1_hash_file
+
 logger = logging.getLogger(__name__)
 
+MAGIC = b"0707"
+
 
 def _append_compatibility(boardname, value, compatibility):
     if not isinstance(value, dict):
@@ -43,7 +42,7 @@ def parse_descriptor(swdesc: libconf.AttrDict[Any, Any | None]):
 
         swdesc_attrs["compatibility"] = compatibility
     except KeyError as e:
-        logging.warning(f"Parsing swu descriptor failed, error={e}")
+        logger.warning(f"Parsing swu descriptor failed, error={e}")
         raise ValueError("Parsing swu descriptor failed", e)
 
     return swdesc_attrs
@@ -70,37 +69,6 @@ async def parse_file(file: Path):
         swdesc_attrs = parse_descriptor(swdesc)
         stat = await file.stat()
         swdesc_attrs["size"] = stat.st_size
-        swdesc_attrs["hash"] = await _sha1_hash_file(f)
-        return swdesc_attrs
+        swdesc_attrs["hash"] = await sha1_hash_file(f)
 
-
-async def parse_remote(url: str):
-    async with httpx.AsyncClient() as c:
-        file = await c.get(url)
-        temp_dir = Path(storage.get_temp_dir())
-        tmp_file_path = temp_dir.joinpath("".join(random.choices(string.ascii_lowercase, k=12)) + ".tmp")
-        try:
-            async with await open_file(tmp_file_path, "w+b") as f:
-                await f.write(file.content)
-            file_data = await parse_file(tmp_file_path)  # Use anyio.Path for parse_file
-        except Exception:
-            raise
-        finally:
-            await tmp_file_path.unlink(missing_ok=True)
-        return file_data
-
-
-async def _sha1_hash_file(fileobj: AsyncFile):
-    last = await fileobj.tell()
-    await fileobj.seek(0)
-    sha1_hash = hashlib.sha1()
-    buf = bytearray(2**18)
-    view = memoryview(buf)
-    while True:
-        size = await fileobj.readinto(buf)
-        if size == 0:
-            break
-        sha1_hash.update(view[:size])
-
-    await fileobj.seek(last)
-    return sha1_hash.hexdigest()
+        return swdesc_attrs

{goosebit-0.2.8 → goosebit-0.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "goosebit"
-version = "0.2.8"
+version = "0.2.9"
 description = "A simplistic, opinionated remote update server implementing hawkBit™'s DDI API"
 authors = [
     {name = "Brett Rowan", email = "121075405+b-rowan@users.noreply.github.com"}
@@ -25,7 +25,9 @@ dependencies = [
     "httpx (>=0.28.1,<0.29.0)",
     "pydantic-settings[yaml] (>=2.10.1,<3.0.0)",
     "uvicorn (>=0.35.0,<0.36.0)",
-    "boto3 (>=1.40.8,<2.0.0)"
+    "boto3 (>=1.40.8,<2.0.0)",
+    "pysquashfsimage (>=0.9.0,<1.0.0)",
+    "zstandard (>=0.24.0,<0.25.0)"
 ]
 
 [project.optional-dependencies]