goosebit 0.1.0__py3-none-any.whl

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/api/__init__.py

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

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/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/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/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/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/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())

goosebit/models.py

@@ -0,0 +1,21 @@
+from tortoise import Model, fields
+
+
+class Tag(Model):
+    id = fields.IntField(pk=True)
+    name = fields.CharField(max_length=255)
+
+
+class Device(Model):
+    uuid = fields.CharField(max_length=255, pk=True)
+    name = fields.CharField(max_length=255, null=True)
+    fw_file = fields.CharField(max_length=255, default="latest")
+    fw_version = fields.CharField(max_length=255, null=True)
+    last_state = fields.CharField(max_length=255, null=True)
+    last_log = fields.TextField(null=True)
+    last_seen = fields.BigIntField(null=True)
+    last_ip = fields.CharField(max_length=15, null=True)
+    last_ipv6 = fields.CharField(max_length=40, null=True)
+    tags = fields.ManyToManyField(
+        "models.Tag", related_name="devices", through="device_tags"
+    )

goosebit/permissions.py

@@ -0,0 +1,55 @@
+from enum import Enum
+
+
+class PermissionsBase(str, Enum):
+    @classmethod
+    def full(cls) -> list:
+        return [i for i in cls]
+
+    def __str__(self):
+        return self.value
+
+
+class FirmwarePermissions(PermissionsBase):
+    READ = "firmware.read"
+    WRITE = "firmware.write"
+    DELETE = "firmware.delete"
+
+
+class DevicePermissions(PermissionsBase):
+    READ = "devices.read"
+    WRITE = "devices.write"
+    DELETE = "devices.delete"
+
+
+class TunnelPermissions(PermissionsBase):
+    READ = "tunnels.read"
+    WRITE = "tunnels.write"
+    DELETE = "tunnels.delete"
+
+
+class HomePermissions(PermissionsBase):
+    READ = "home.read"
+
+
+class Permissions:
+    HOME = HomePermissions
+    FIRMWARE = FirmwarePermissions
+    DEVICE = DevicePermissions
+    TUNNEL = TunnelPermissions
+
+    @classmethod
+    def full(cls):
+        all_items = set()
+        for item in [cls.HOME, cls.FIRMWARE, cls.DEVICE, cls.TUNNEL]:
+            all_items.update(item.full())
+        return list(all_items)
+
+
+ADMIN = Permissions.full()
+MONITORING = [
+    *Permissions.HOME.full(),
+    *Permissions.FIRMWARE.full(),
+    *Permissions.DEVICE.full(),
+]
+READONLY = [Permissions.HOME.READ]

goosebit/realtime/__init__.py

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

goosebit/realtime/logs.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from fastapi import APIRouter, Security
+from fastapi.websockets import WebSocket, WebSocketDisconnect
+from pydantic import BaseModel
+from websockets.exceptions import ConnectionClosed
+
+from goosebit.auth import validate_ws_user_permissions
+from goosebit.permissions import Permissions
+from goosebit.updater.manager import get_update_manager
+
+router = APIRouter(prefix="/logs")
+
+
+class RealtimeLogModel(BaseModel):
+    log: str | None
+    clear: bool = False
+
+
+@router.websocket(
+    "/{dev_id}",
+    dependencies=[
+        Security(validate_ws_user_permissions, scopes=[Permissions.HOME.READ])
+    ],
+)
+async def device_logs(websocket: WebSocket, dev_id: str):
+    await websocket.accept()
+
+    manager = await get_update_manager(dev_id)
+
+    async def callback(log_update):
+        data = RealtimeLogModel(log=log_update)
+        if log_update is None:
+            data.clear = True
+            data.log = ""
+        await websocket.send_json(dict(data))
+
+    async with manager.subscribe_log(callback):
+        try:
+            while True:
+                await websocket.receive()
+        except (WebSocketDisconnect, ConnectionClosed, RuntimeError):
+            pass

goosebit/realtime/routes.py

@@ -0,0 +1,13 @@
+from fastapi import APIRouter, Depends
+
+from goosebit.auth import authenticate_ws_session
+
+from . import logs
+
+router = APIRouter(
+    prefix="/realtime",
+    dependencies=[Depends(authenticate_ws_session)],
+    tags=["realtime"],
+)
+
+router.include_router(logs.router)

goosebit/settings.py

@@ -0,0 +1,55 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+from passlib.context import CryptContext
+
+from goosebit import permissions
+
+POLL_SECONDS = 0
+POLL_MINUTES = 1
+POLL_HOURS = 0
+POLL_TIME = ":".join(
+    [
+        str(POLL_HOURS).rjust(2, "0"),
+        str(POLL_MINUTES).rjust(2, "0"),
+        str(POLL_SECONDS).rjust(2, "0"),
+    ]
+)
+
+BASE_DIR = Path(__file__).resolve().parent
+TOKEN_SWU_DIR = BASE_DIR.joinpath("swugen")
+SWUPDATE_FILES_DIR = BASE_DIR.joinpath("swupdate")
+UPDATES_DIR = BASE_DIR.joinpath("updates")
+DB_LOC = BASE_DIR.joinpath("db.sqlite3")
+DB_MIGRATIONS_LOC = BASE_DIR.joinpath("migrations")
+DB_URI = f"sqlite:///{DB_LOC}"
+
+SECRET = "123456789"
+PWD_CXT = CryptContext(schemes=["bcrypt"], deprecated="auto")
+
+users = {}
+
+
+@dataclass
+class User:
+    username: str
+    hashed_pwd: str
+    permissions: list
+
+    def get_json_permissions(self):
+        return [str(p) for p in self.permissions]
+
+
+def add_user(user: User):
+    users[user.username] = user
+
+
+# User configuration
+add_user(
+    User(
+        username="admin@goosebit.local",
+        hashed_pwd=PWD_CXT.hash("admin"),
+        permissions=permissions.ADMIN,
+    )
+)
+USERS = users

goosebit/ui/__init__.py

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