goosebit 0.1.0__tar.gz

goosebit-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

goosebit-0.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.1
+Name: goosebit
+Version: 0.1.0
+Summary: 
+Author: Upstream Data
+Author-email: brett@upstreamdata.ca
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: aerich (>=0.7.2,<0.8.0)
+Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
+Requires-Dist: fastapi[uvicorn] (>=0.111.0,<0.112.0)
+Requires-Dist: itsdangerous (>=2.2.0,<3.0.0)
+Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
+Requires-Dist: passlib[bcrypt] (>=1.7.4,<2.0.0)
+Requires-Dist: python-jose (>=3.3.0,<4.0.0)
+Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
+Requires-Dist: tortoise-orm (>=0.21.4,<0.22.0)
+Requires-Dist: websockets (>=12.0,<13.0)
+Description-Content-Type: text/markdown
+
+# goosebit
+<img src="docs/img/goosebit-logo.png?raw=true" style="width: 100px; height: 100px; display: block;">
+
+---
+
+A simplistic remote update server.
+
+
+## Setup
+
+To set up, install the dependencies in `pyproject.toml` with `poetry install`.  Then you can run GooseBit by running `main.py`.
+
+## Initial Startup
+
+The first time you start GooseBit, you should change the default username and password inside `goosebit/settings.py`, as well as generate a new secret key.
+The default login credentials for testing are `admin@goosebit.local`, `admin`.

goosebit-0.1.0/README.md

@@ -0,0 +1,16 @@
+# goosebit
+<img src="docs/img/goosebit-logo.png?raw=true" style="width: 100px; height: 100px; display: block;">
+
+---
+
+A simplistic remote update server.
+
+
+## Setup
+
+To set up, install the dependencies in `pyproject.toml` with `poetry install`.  Then you can run GooseBit by running `main.py`.
+
+## Initial Startup
+
+The first time you start GooseBit, you should change the default username and password inside `goosebit/settings.py`, as well as generate a new secret key.
+The default login credentials for testing are `admin@goosebit.local`, `admin`.

goosebit-0.1.0/goosebit/__init__.py

@@ -0,0 +1,62 @@
+from contextlib import asynccontextmanager
+from typing import Annotated
+
+from fastapi import Depends, FastAPI
+from fastapi.requests import Request
+from fastapi.responses import RedirectResponse
+from fastapi.security import OAuth2PasswordRequestForm
+
+from goosebit import api, db, realtime, ui, updater
+from goosebit.auth import (
+    authenticate_user,
+    auto_redirect,
+    create_session,
+    get_current_user,
+)
+from goosebit.ui.static import static
+from goosebit.ui.templates import templates
+
+
+@asynccontextmanager
+async def lifespan(_: FastAPI):
+    await db.init()
+    yield
+    await db.close()
+
+
+app = FastAPI(lifespan=lifespan)
+app.include_router(updater.router)
+app.include_router(ui.router)
+app.include_router(api.router)
+app.include_router(realtime.router)
+app.mount("/static", static, name="static")
+
+
+@app.middleware("http")
+async def attach_user(request: Request, call_next):
+    request.scope["user"] = get_current_user(request)
+    return await call_next(request)
+
+
+@app.get("/", include_in_schema=False)
+def root_redirect(request: Request):
+    return RedirectResponse(request.url_for("ui_root"))
+
+
+@app.get("/login", dependencies=[Depends(auto_redirect)], include_in_schema=False)
+async def login_ui(request: Request):
+    return templates.TemplateResponse("login.html", context={"request": request})
+
+
+@app.post("/login", include_in_schema=False, dependencies=[Depends(authenticate_user)])
+async def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]):
+    resp = RedirectResponse("/ui/home", status_code=302)
+    resp.set_cookie(key="session_id", value=create_session(form_data.username))
+    return resp
+
+
+@app.get("/logout", include_in_schema=False)
+async def logout(request: Request):
+    resp = RedirectResponse("/login", status_code=302)
+    resp.delete_cookie(key="session_id")
+    return resp

goosebit-0.1.0/goosebit/api/__init__.py

@@ -0,0 +1 @@
+from .routes import router

goosebit-0.1.0/goosebit/api/devices.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+import asyncio
+import time
+
+from fastapi import APIRouter, Security
+from fastapi.requests import Request
+from pydantic import BaseModel
+
+from goosebit.auth import validate_user_permissions
+from goosebit.models import Device
+from goosebit.permissions import Permissions
+from goosebit.updater.manager import delete_device, get_update_manager
+from goosebit.updater.misc import get_device_by_uuid
+
+router = APIRouter(prefix="/devices")
+
+
+@router.get(
+    "/all",
+    dependencies=[Security(validate_user_permissions, scopes=[Permissions.HOME.READ])],
+)
+async def devices_get_all() -> list[dict]:
+    devices = await Device.all()
+
+    async def parse(device: Device) -> dict:
+        manager = await get_update_manager(device.uuid)
+        last_seen = device.last_seen
+        if last_seen is not None:
+            last_seen = round(time.time() - device.last_seen)
+        return {
+            "uuid": device.uuid,
+            "web_pwd": device.web_pwd,
+            "name": device.name,
+            "fw": device.fw_version,
+            "fw_file": device.fw_file,
+            "state": device.last_state,
+            "force_update": manager.force_update,
+            "last_ip": device.last_ip,
+            "last_seen": last_seen,
+            "online": last_seen < 120 if last_seen is not None else None,
+        }
+
+    return list(await asyncio.gather(*[parse(d) for d in devices]))
+
+
+class UpdateDevicesModel(BaseModel):
+    devices: list[str]
+    firmware: str | None = None
+    name: str | None = None
+
+
+@router.post(
+    "/update",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.DEVICE.WRITE])
+    ],
+)
+async def devices_update(request: Request, config: UpdateDevicesModel) -> dict:
+    for uuid in config.devices:
+        updater = await get_update_manager(uuid)
+        device = await updater.get_device()
+        if config.firmware is not None:
+            device.fw_file = config.firmware
+        if config.name is not None:
+            device.name = config.name
+        await updater.save()
+    return {"success": True}
+
+
+class ForceUpdateModel(BaseModel):
+    devices: list[str]
+
+
+@router.post(
+    "/force_update",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.DEVICE.WRITE])
+    ],
+)
+async def devices_force_update(request: Request, config: ForceUpdateModel) -> dict:
+    for uuid in config.devices:
+        updater = await get_update_manager(uuid)
+        updater.force_update = True
+    return {"success": True}
+
+
+@router.get(
+    "/logs/{dev_id}",
+    dependencies=[Security(validate_user_permissions, scopes=[Permissions.HOME.READ])],
+)
+async def device_logs(request: Request, dev_id: str) -> str:
+    device = await get_device_by_uuid(dev_id)
+    if device.last_log is not None:
+        return device.last_log
+    return "No logs found."
+
+
+class DeleteModel(BaseModel):
+    devices: list[str]
+
+
+@router.post(
+    "/delete",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.DEVICE.DELETE])
+    ],
+)
+async def devices_delete(request: Request, config: DeleteModel) -> dict:
+    for uuid in config.devices:
+        await delete_device(uuid)
+    return {"success": True}

goosebit-0.1.0/goosebit/api/download.py

@@ -0,0 +1,20 @@
+from fastapi import APIRouter, Security
+from fastapi.requests import Request
+from fastapi.responses import FileResponse
+
+from goosebit.auth import validate_user_permissions
+from goosebit.permissions import Permissions
+from goosebit.settings import UPDATES_DIR
+
+router = APIRouter(prefix="/download")
+
+
+@router.get(
+    "/{file}",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.FIRMWARE.READ])
+    ],
+)
+async def download_file(request: Request, file: str):
+    filename = UPDATES_DIR.joinpath(file)
+    return FileResponse(filename, media_type="application/octet-stream")

goosebit-0.1.0/goosebit/api/firmware.py

@@ -0,0 +1,64 @@
+from fastapi import APIRouter, Body, Security
+from fastapi.requests import Request
+
+from goosebit.auth import validate_user_permissions
+from goosebit.permissions import Permissions
+from goosebit.settings import UPDATES_DIR
+from goosebit.updater.misc import fw_sort_key, get_newest_fw
+from goosebit.updater.updates import FirmwareArtifact
+
+router = APIRouter(prefix="/firmware")
+
+
+@router.get(
+    "/all",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.FIRMWARE.READ])
+    ],
+)
+async def firmware_get_all() -> list[dict]:
+    UPDATES_DIR.mkdir(parents=True, exist_ok=True)
+
+    firmware = []
+    for file in sorted(
+        [f for f in UPDATES_DIR.iterdir() if f.suffix == ".swu"],
+        key=lambda x: fw_sort_key(x),
+        reverse=True,
+    ):
+        artifact = FirmwareArtifact(file.name)
+        firmware.append(
+            {
+                "name": file.name,
+                "size": artifact.path.stat().st_size,
+                "version": artifact.version,
+            }
+        )
+
+    return firmware
+
+
+@router.get(
+    "/latest",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.FIRMWARE.READ])
+    ],
+)
+async def firmware_get_latest() -> dict:
+    UPDATES_DIR.mkdir(parents=True, exist_ok=True)
+
+    file_data = UPDATES_DIR.joinpath(get_newest_fw())
+    return {"name": file_data.name, "size": file_data.stat().st_size}
+
+
+@router.post(
+    "/delete",
+    dependencies=[
+        Security(validate_user_permissions, scopes=[Permissions.FIRMWARE.DELETE])
+    ],
+)
+async def firmware_delete(request: Request, file: str = Body()) -> dict:
+    file_path = UPDATES_DIR.joinpath(file)
+    if file_path.exists():
+        file_path.unlink()
+        return {"success": True}
+    return {"success": False}

goosebit-0.1.0/goosebit/api/routes.py

@@ -0,0 +1,11 @@
+from fastapi import APIRouter, Depends
+
+from goosebit.api import devices, download, firmware
+from goosebit.auth import authenticate_api_session
+
+router = APIRouter(
+    prefix="/api", dependencies=[Depends(authenticate_api_session)], tags=["api"]
+)
+router.include_router(firmware.router)
+router.include_router(devices.router)
+router.include_router(download.router)

goosebit-0.1.0/goosebit/auth/__init__.py

@@ -0,0 +1,123 @@
+from __future__ import annotations
+
+from fastapi import Depends, HTTPException
+from fastapi.requests import Request
+from fastapi.security import SecurityScopes
+from fastapi.websockets import WebSocket
+from jose import jwt
+
+from goosebit.settings import PWD_CXT, SECRET, USERS
+
+
+async def authenticate_user(request: Request):
+    form_data = await request.form()
+    username = form_data.get("username")
+    password = form_data.get("password")
+    user = USERS.get(username)
+    if user is None:
+        raise HTTPException(
+            status_code=302,
+            headers={"location": str(request.url_for("login"))},
+            detail="Invalid credentials",
+        )
+    if not PWD_CXT.verify(password, user.hashed_pwd):
+        raise HTTPException(
+            status_code=302,
+            headers={"location": str(request.url_for("login"))},
+            detail="Invalid credentials",
+        )
+    return user
+
+
+sessions = {}
+
+
+def create_session(email: str) -> str:
+    token = jwt.encode({"email": email}, SECRET)
+    sessions[token] = email
+    return token
+
+
+def authenticate_session(request: Request):
+    session_id = request.cookies.get("session_id")
+    if session_id is None or session_id not in sessions:
+        raise HTTPException(
+            status_code=302,
+            headers={"location": str(request.url_for("login"))},
+            detail="Invalid session ID",
+        )
+    user = get_user_from_session(session_id)
+    return user
+
+
+def authenticate_api_session(request: Request):
+    session_id = request.cookies.get("session_id")
+    if session_id is None or session_id not in sessions:
+        raise HTTPException(status_code=401, detail="Not logged in")
+    user = get_user_from_session(session_id)
+    return user
+
+
+def authenticate_ws_session(websocket: WebSocket):
+    session_id = websocket.cookies.get("session_id")
+    if session_id is None or session_id not in sessions:
+        raise HTTPException(status_code=401, detail="Not logged in")
+    user = get_user_from_session(session_id)
+    return user
+
+
+def auto_redirect(request: Request):
+    session_id = request.cookies.get("session_id")
+    if session_id is None or session_id not in sessions:
+        return request
+    raise HTTPException(
+        status_code=302,
+        headers={"location": str(request.url_for("ui_root"))},
+        detail="Already logged in",
+    )
+
+
+def get_user_from_session(session_id: str):
+    for username in USERS:
+        if username == sessions.get(session_id):
+            return username
+
+
+def get_current_user(request: Request):
+    session_id = request.cookies.get("session_id")
+    if session_id is None or session_id not in sessions:
+        return None
+    user = get_user_from_session(session_id)
+    return USERS[user]
+
+
+def validate_user_permissions(
+    request: Request,
+    security: SecurityScopes,
+    username: str = Depends(authenticate_session),
+) -> Request:
+    user = USERS[username]
+    if security.scopes is None:
+        return request
+    for scope in security.scopes:
+        if scope not in user.permissions:
+            raise HTTPException(
+                status_code=403,
+                detail="Not enough permissions",
+            )
+
+
+def validate_ws_user_permissions(
+    websocket: WebSocket,
+    security: SecurityScopes,
+    username: str = Depends(authenticate_ws_session),
+) -> WebSocket:
+    user = USERS[username]
+    if security.scopes is None:
+        return websocket
+    for scope in security.scopes:
+        if scope not in user.permissions:
+            raise HTTPException(
+                status_code=403,
+                detail="Not enough permissions",
+            )

goosebit-0.1.0/goosebit/db.py

@@ -0,0 +1,32 @@
+from aerich import Command
+from tortoise import Tortoise, run_async
+
+from goosebit.settings import DB_MIGRATIONS_LOC, DB_URI
+
+TORTOISE_CONF = {
+    "connections": {"default": DB_URI},
+    "apps": {
+        "models": {
+            "models": ["goosebit.models", "aerich.models"],
+        },
+    },
+}
+
+
+async def init():
+    command = Command(tortoise_config=TORTOISE_CONF, location=DB_MIGRATIONS_LOC)
+    await Tortoise.init(config=TORTOISE_CONF)
+    if not DB_MIGRATIONS_LOC.exists():
+        await command.init_db(safe=True)
+    await command.init()
+    await command.migrate()
+    await command.upgrade(run_in_transaction=True)
+    await Tortoise.generate_schemas(safe=True)
+
+
+async def close():
+    await Tortoise.close_connections()
+
+
+if __name__ == "__main__":
+    run_async(init())