from __future__ import annotations
import logging
import os
import secrets
import time
from datetime import datetime, timedelta, timezone
from typing import Annotated
import jwt
from fastapi import Depends, Header, HTTPException, status
from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
from jwt.exceptions import PyJWTError as JWTError
from passlib.context import CryptContext
from sqlalchemy import delete, func, select
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import selectinload
from backend.app.core.database import async_session, get_db
from backend.app.core.permissions import Permission
from backend.app.models.api_key import APIKey
from backend.app.models.auth_ephemeral import AuthEphemeralToken, TokenType
from backend.app.models.settings import Settings
from backend.app.models.user import User
logger = logging.getLogger(__name__)
# GHSA-r2qv-8222-hqg3 (CVSS 9.9) — API key permission enforcement is allowlist-based.
#
# Until 0.2.4.x, ``_check_apikey_permissions`` only consulted the admin denylist
# below. The three documented scope flags on ``APIKey``
# (``can_read_status`` / ``can_queue`` / ``can_control_printer`` / ``can_manage_library``)
# were enforced only by ``check_permission()`` inside ``routes/webhook.py``;
# every other route used ``require_permission_if_auth_enabled`` which fell
# through to the denylist-only path, so an API key with all flags unchecked
# could still stop prints, edit queue items, and read every endpoint not in
# this set. ``require_any_permission_if_auth_enabled`` and
# ``require_ownership_permission`` did not call this helper at all, so admin
# "any-of" routes and ownership-modify routes were entirely ungated for API keys.
#
# Fix: ``_check_apikey_permissions`` now requires every requested permission to
# be present in ``_APIKEY_SCOPE_BY_PERMISSION`` (allowlist), and gates on the
# corresponding scope flag on the API key. Unmapped permissions = 403. This
# means a Permission added to ``core/permissions.py`` without a matching entry
# in ``_APIKEY_SCOPE_BY_PERMISSION`` is automatically denied for API keys —
# the previous denylist shape allowed every new Permission to silently widen
# the API-key surface.
#
# The denylist is retained for documentation / drift-detection only — its
# entries also satisfy "not in the allowlist", so they fail closed regardless.
#
# #1894 follow-on: the allowlist is a ceiling, not a grant. A key is also
# narrowed to what its owner may do, so a user who can create keys cannot mint
# themselves authority they do not have, and deactivating a user disables their
# keys. Legacy ownerless keys (``user_id IS NULL``) have no owner to narrow
# against and remain governed by the scope flags alone.
#
# Mapping rationale (see wiki/features/api-keys.md):
# can_read_status → every ``*_READ`` + camera + stats + system + websocket
# + the slim id/username user listing (NOT ``users:read``)
# can_queue → queue write ops + archive reprint
# can_control_printer → physical printer + smart-plug control
# can_manage_library → library upload/own + MakerWorld import (separate
# trust level from queue management, hence its own flag)
# can_manage_inventory → spool/catalog/forecast writes + SpoolBuddy kiosk writes
# can_manage_maintenance→ per-printer maintenance log/reset + type-catalog CRUD
# admin-only → unmapped (default-deny); covers all create/update/
# delete of admin resources, settings writes, user/
# group/api-key/backup admin ops, discovery scan,
# cloud auth, library ALL-ownership perms, purges
#
# A value may be a tuple of scope flags, in which case ALL of them must be True
# on the key. That is for the rare permission whose route spans two trust
# dimensions the operator toggles separately — see ``PIPELINES_RUN`` below.
# Prefer a single flag; a tuple is a statement that neither flag alone
# authorises what the route does.
_APIKEY_SCOPE_BY_PERMISSION: dict[Permission, str | tuple[str, ...]] = {
# can_read_status — read-only access to status, history, and configuration
Permission.PRINTERS_READ: "can_read_status",
# Legacy flat permissions retained for back-compat with custom API keys —
# the role bootstraps no longer use these, but custom keys may still
# carry can_read_status scope mapping. New endpoints gate on the
# ARCHIVES_READ_OWN / _ALL split (maziggy/bambuddy-security #2).
Permission.ARCHIVES_READ: "can_read_status",
Permission.ARCHIVES_READ_OWN: "can_read_status",
Permission.ARCHIVES_READ_ALL: "can_read_status",
Permission.QUEUE_READ: "can_read_status",
Permission.QUEUE_READ_OWN: "can_read_status",
Permission.QUEUE_READ_ALL: "can_read_status",
Permission.LIBRARY_READ: "can_read_status",
Permission.LIBRARY_READ_OWN: "can_read_status",
Permission.LIBRARY_READ_ALL: "can_read_status",
Permission.PROJECTS_READ: "can_read_status",
Permission.FILAMENTS_READ: "can_read_status",
Permission.INVENTORY_READ: "can_read_status",
Permission.INVENTORY_VIEW_ASSIGNMENTS: "can_read_status",
Permission.INVENTORY_FORECAST_READ: "can_read_status",
Permission.SMART_PLUGS_READ: "can_read_status",
Permission.CAMERA_VIEW: "can_read_status",
Permission.MAINTENANCE_READ: "can_read_status",
Permission.KPROFILES_READ: "can_read_status",
Permission.NOTIFICATIONS_READ: "can_read_status",
Permission.NOTIFICATION_TEMPLATES_READ: "can_read_status",
Permission.EXTERNAL_LINKS_READ: "can_read_status",
Permission.FIRMWARE_READ: "can_read_status",
Permission.AMS_HISTORY_READ: "can_read_status",
Permission.PRINTER_SENSOR_HISTORY_READ: "can_read_status",
Permission.STATS_READ: "can_read_status",
Permission.STATS_FILTER_BY_USER: "can_read_status",
# USERS_READ_SLIM grants no data an API key could not already reach (#1894):
# for API-keyed requests the permission deps return None as ``current_user``,
# so ``_validate_user_filter_permission`` in routes/archives.py short-circuits
# and ``?created_by_id=N`` is already honoured for every N. Without a way to
# discover the ids, that filter is only addressable by brute force. The slim
# listing makes it usable; the full USERS_READ listing (emails, roles, group
# membership, permission sets) stays unmapped = admin-only.
Permission.USERS_READ_SLIM: "can_read_status",
Permission.SYSTEM_READ: "can_read_status",
# SETTINGS_READ stays allowed via read-status so SpoolBuddy kiosks keep
# working (they need the UI-language setting via API key).
Permission.SETTINGS_READ: "can_read_status",
Permission.MAKERWORLD_VIEW: "can_read_status",
# Pipeline definitions and run history are configuration + status: listing
# pipelines, reading a run, and the (write-free) POST check-eligibility
# pre-flight. Authoring stays admin-only under PIPELINES_WRITE.
Permission.PIPELINES_READ: "can_read_status",
Permission.WEBSOCKET_CONNECT: "can_read_status",
# can_queue — queue write ops + reprint (which enqueues an existing archive)
Permission.QUEUE_CREATE: "can_queue",
Permission.QUEUE_UPDATE_OWN: "can_queue",
Permission.QUEUE_UPDATE_ALL: "can_queue",
Permission.QUEUE_DELETE_OWN: "can_queue",
Permission.QUEUE_DELETE_ALL: "can_queue",
Permission.QUEUE_REORDER: "can_queue",
Permission.ARCHIVES_REPRINT_OWN: "can_queue",
Permission.ARCHIVES_REPRINT_ALL: "can_queue",
# can_control_printer — physical-world side effects on hardware
Permission.PRINTERS_CONTROL: "can_control_printer",
Permission.PRINTERS_FILES: "can_control_printer",
Permission.PRINTERS_AMS_RFID: "can_control_printer",
Permission.PRINTERS_CLEAR_PLATE: "can_control_printer",
Permission.SMART_PLUGS_CONTROL: "can_control_printer",
# can_manage_library — file-manager scope (upload/rename/delete library
# entries + MakerWorld import which downloads files into the library).
# OWN and ALL ownership variants map to the same scope so the
# `require_ownership_permission` checker (which gates on `all_perm`)
# passes the API key through. This matches `can_queue` and the
# archives/inventory scopes — API keys have no per-row ownership identity
# (line 1663), so splitting OWN/ALL across allowlist/denylist made the
# whole library curation surface unreachable for API keys (#1832).
# LIBRARY_PURGE stays admin-only as a genuinely destructive op that
# bypasses the soft-delete window.
Permission.LIBRARY_UPLOAD: "can_manage_library",
Permission.LIBRARY_UPDATE_OWN: "can_manage_library",
Permission.LIBRARY_UPDATE_ALL: "can_manage_library",
Permission.LIBRARY_DELETE_OWN: "can_manage_library",
Permission.LIBRARY_DELETE_ALL: "can_manage_library",
Permission.MAKERWORLD_IMPORT: "can_manage_library",
# can_manage_inventory — inventory write scope. Covers the documented
# spool/catalog/forecast write surface AND the SpoolBuddy kiosk endpoints
# (NFC scan, scale reading, system command/update) which used
# INVENTORY_UPDATE as a stand-in for "kiosk write" under the prior
# denylist model. Read-only inventory (INVENTORY_READ etc.) stays under
# can_read_status.
Permission.INVENTORY_CREATE: "can_manage_inventory",
Permission.INVENTORY_UPDATE: "can_manage_inventory",
Permission.INVENTORY_DELETE: "can_manage_inventory",
Permission.INVENTORY_FORECAST_WRITE: "can_manage_inventory",
# can_manage_maintenance — carved out of the admin denylist so HA-style
# automations can log "cleaned nozzle" / reset a maintenance counter via
# `POST /maintenance/items/{item_id}/perform` without granting broader
# printer control or settings write (#1832 follow-up). Also covers the
# per-printer maintenance CRUD (assign/remove items, edit intervals) and
# the type-catalog CRUD — the type catalog is a config surface (system
# types are auto-seeded, custom types are user-defined), so grouping it
# with the item writes matches the operator mental model of "keys that
# log maintenance can also manage what gets tracked." MAINTENANCE_READ
# stays under can_read_status.
Permission.MAINTENANCE_CREATE: "can_manage_maintenance",
Permission.MAINTENANCE_UPDATE: "can_manage_maintenance",
Permission.MAINTENANCE_DELETE: "can_manage_maintenance",
# can_manage_archives — print-history curation. Carved out of the admin
# denylist so automations can prune old prints via API key (#1888): the
# archive delete/update routes gate on
# ``require_ownership_permission(ARCHIVES_*_ALL, ARCHIVES_*_OWN)``, which
# resolves the ALL permission for API keys (no per-row ownership identity,
# same as can_queue / can_manage_library), so OWN and ALL map to the same
# scope. ARCHIVES_PURGE stays admin-only (see denylist) as a genuinely
# destructive op that drops the stats contribution, mirroring LIBRARY_PURGE.
# ARCHIVES_REPRINT_* stays under can_queue (it enqueues a print).
Permission.ARCHIVES_CREATE: "can_manage_archives",
Permission.ARCHIVES_UPDATE_OWN: "can_manage_archives",
Permission.ARCHIVES_UPDATE_ALL: "can_manage_archives",
Permission.ARCHIVES_DELETE_OWN: "can_manage_archives",
Permission.ARCHIVES_DELETE_ALL: "can_manage_archives",
# can_manage_projects — project curation. Carved out of the admin denylist
# so automations can create projects and batch-add archives via API key
# (#1893). The project mutation routes gate on plain
# ``RequirePermissionIfAuthEnabled(Permission.PROJECTS_*)`` (no OWN/ALL
# ownership split — projects have no per-row ownership permission), so the
# three CRUD permissions map directly to the one scope. Membership edits
# (e.g. add-archives-to-project) gate on PROJECTS_UPDATE, so they're covered.
# PROJECTS_READ stays under can_read_status (unchanged).
Permission.PROJECTS_CREATE: "can_manage_projects",
Permission.PROJECTS_UPDATE: "can_manage_projects",
Permission.PROJECTS_DELETE: "can_manage_projects",
# can_queue AND can_manage_library — running a pipeline does two things a
# key is separately trusted with. It slices the source into a new library
# file (``slice_and_persist``, the same write the direct
# ``POST /library/files/{id}/slice`` route gates on LIBRARY_UPLOAD →
# can_manage_library), then creates one PrintQueueItem per copy for the
# scheduler to dispatch (can_queue). Mapping it to either flag alone would
# hand that flag the other one's authority, so both are required. Cancelling
# a run is the same permission — whoever may start one may stop it. PR A
# parked all three pipeline permissions on the denylist "until the run
# dispatch lands"; it landed in PR C (#1425) and this is that follow-up.
Permission.PIPELINES_RUN: ("can_queue", "can_manage_library"),
# can_access_cloud — narrow opt-in scope, gated by the router-level
# ``_cloud_api_key_gate`` and additionally enforced here so the route-
# level ``cloud_caller(Permission.CLOUD_AUTH)`` dep also fails closed
# when the flag is off (defence-in-depth).
Permission.CLOUD_AUTH: "can_access_cloud",
# ORCA_CLOUD_AUTH folds into the same ``can_access_cloud`` scope: same
# trust dimension (third-party cloud access for profile sync), so an
# operator who already accepted "this key can talk to clouds for the
# owner" doesn't need a second toggle for Orca. Splitting later requires
# a new column + migration — easy to add if the trust dimensions diverge.
Permission.ORCA_CLOUD_AUTH: "can_access_cloud",
}
# Retained for documentation, drift-detection, and the prior "administrative
# operations" error string. Entries here are also absent from
# ``_APIKEY_SCOPE_BY_PERMISSION``, so they fail closed via the allowlist; the
# denylist is a redundant explicit "these are admin" marker, not the load-
# bearing security check.
_APIKEY_DENIED_PERMISSIONS: frozenset[Permission] = frozenset(
{
# Settings administration (cred storage; rewriting these reaches SMTP/LDAP/MQTT).
Permission.SETTINGS_UPDATE,
Permission.SETTINGS_BACKUP,
Permission.SETTINGS_RESTORE,
# User / group / API-key administration.
Permission.USERS_READ,
Permission.USERS_CREATE,
Permission.USERS_UPDATE,
Permission.USERS_DELETE,
Permission.GROUPS_READ,
Permission.GROUPS_CREATE,
Permission.GROUPS_UPDATE,
Permission.GROUPS_DELETE,
Permission.API_KEYS_CREATE,
Permission.API_KEYS_UPDATE,
Permission.API_KEYS_DELETE,
Permission.API_KEYS_READ,
# Finance / cost-center data has no dedicated API-key scope.
Permission.COST_CENTERS_READ_OWN,
Permission.COST_CENTERS_READ_ALL,
Permission.COST_CENTERS_MODIFY,
Permission.COST_CENTERS_CREATE,
# GitHub backup admin + firmware OTA.
Permission.GITHUB_BACKUP,
Permission.GITHUB_RESTORE,
Permission.FIRMWARE_UPDATE,
# Resource administration (printer/project/filament/maintenance/k-profile/etc CRUD).
# API keys with the operational scopes can read these resources via
# *_READ permissions but cannot mutate the catalog/registry itself.
Permission.PRINTERS_CREATE,
Permission.PRINTERS_UPDATE,
Permission.PRINTERS_DELETE,
# ARCHIVES_CREATE / _UPDATE_OWN / _UPDATE_ALL / _DELETE_OWN /
# _DELETE_ALL moved to the allowlist under `can_manage_archives`
# (#1888) — split between allow/deny made the whole archive-management
# surface unreachable for API keys via `require_ownership_permission`
# (same regression class as the library/maintenance carve-outs in
# #1832). ARCHIVES_PURGE stays denied as a genuinely destructive op
# that drops the print's stats contribution.
Permission.ARCHIVES_PURGE,
# LIBRARY_UPDATE_ALL / LIBRARY_DELETE_ALL moved to the allowlist
# under `can_manage_library` (#1832) — split between allow/deny made
# the whole library curation surface unreachable for API keys via
# `require_ownership_permission`. Purge stays denied as a genuinely
# destructive op.
Permission.LIBRARY_PURGE,
# PROJECTS_CREATE / _UPDATE / _DELETE moved to the allowlist under
# `can_manage_projects` (#1893) — they were denied for every API key,
# making the project-management surface (create, add-archives, delete)
# unreachable, same regression class as the archives/library carve-outs.
Permission.FILAMENTS_CREATE,
Permission.FILAMENTS_UPDATE,
Permission.FILAMENTS_DELETE,
# MAINTENANCE_CREATE / MAINTENANCE_UPDATE / MAINTENANCE_DELETE moved
# to the allowlist under `can_manage_maintenance` (#1832 follow-up).
Permission.KPROFILES_CREATE,
Permission.KPROFILES_UPDATE,
Permission.KPROFILES_DELETE,
Permission.NOTIFICATIONS_CREATE,
Permission.NOTIFICATIONS_UPDATE,
Permission.NOTIFICATIONS_DELETE,
Permission.NOTIFICATIONS_USER_EMAIL,
Permission.NOTIFICATION_TEMPLATES_UPDATE,
Permission.EXTERNAL_LINKS_CREATE,
Permission.EXTERNAL_LINKS_UPDATE,
Permission.EXTERNAL_LINKS_DELETE,
Permission.SMART_PLUGS_CREATE,
Permission.SMART_PLUGS_UPDATE,
Permission.SMART_PLUGS_DELETE,
# Network scanning — operator only (no API-key scope for this).
Permission.DISCOVERY_SCAN,
# Slicer Pipelines (#1425) — authoring only. PIPELINES_READ and
# PIPELINES_RUN moved to the allowlist once PR C landed the run
# dispatch; PIPELINES_WRITE stays denied because it creates/edits/
# deletes the pipeline definition (slicer settings, target printer,
# fanout strategy) and, via `POST /pipeline-runs/clear`, drops run
# history. That is admin authoring, matching the other resource-CRUD
# entries here — a key that may run a pipeline cannot rewrite what it
# does.
Permission.PIPELINES_WRITE,
}
)
def _required_apikey_scopes(perm_string: str) -> tuple[str, ...] | None:
"""Return every scope flag a key must hold to exercise ``perm_string``.
None when the permission is unmapped (= admin-only / not API-key-usable),
which is distinct from an empty tuple — the latter would read as "no flags
needed" and must never be produced.
"""
try:
perm = Permission(perm_string)
except ValueError:
return None
scopes = _APIKEY_SCOPE_BY_PERMISSION.get(perm)
if scopes is None:
return None
return (scopes,) if isinstance(scopes, str) else tuple(scopes)
def apikey_effective_permissions(api_key: APIKey, owner: User | None = None) -> list[str]:
"""Return the permissions ``api_key`` can actually exercise, sorted.
This is the exact set ``_check_apikey_permissions`` will let through: every
mapped permission whose scope flag is True on the key, further narrowed to
what ``owner`` may do. Unmapped permissions are administrative and never
resolve for a key, so they are absent.
``owner=None`` means a legacy ownerless key, where the scope flags are the
whole of the key's authority -- not "skip the owner check". Callers holding
an owned key must pass the owner, or ``/auth/me`` will over-report and drift
from the gate, which is the defect #1894 was about.
"""
def _granted(perm: Permission) -> bool:
scopes = _required_apikey_scopes(perm.value)
# An unmapped permission cannot occur here (we iterate the mapping
# itself), but treat it as denied rather than as "no flags to satisfy",
# which ``all(())`` would otherwise report as granted.
if not scopes:
return False
return all(getattr(api_key, flag, False) for flag in scopes)
return sorted(
perm.value
for perm in _APIKEY_SCOPE_BY_PERMISSION
if _granted(perm) and (owner is None or owner.has_permission(perm.value))
)
async def resolve_apikey_owner(db: AsyncSession, api_key: APIKey) -> User | None:
"""Load the owner of ``api_key`` for an authorization decision.
Distinct from ``_user_from_api_key``, which answers "who is this, if
anyone" and returns None for both the legacy and the broken case. Here
those two must not be conflated:
- ``user_id IS NULL`` -- a key predating per-user ownership. There is no
owner to narrow against, so the scope flags stand alone. Returns None.
- ``user_id`` set but the row is missing or deactivated -- the key's
authority came from a user who no longer has any. Raises 403 rather than
returning None, because returning None here would fail open: deactivating
a user would leave their keys working with full scope authority.
Groups are eager-loaded because ``has_permission`` walks them, and a lazy
load inside the permission check would raise MissingGreenlet.
"""
if api_key.user_id is None:
return None
result = await db.execute(select(User).where(User.id == api_key.user_id).options(selectinload(User.groups)))
owner = result.scalar_one_or_none()
if owner is None or not owner.is_active:
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="API key owner is deactivated or no longer exists",
)
return owner
async def authorize_api_key(
db: AsyncSession,
api_key: APIKey,
perm_strings: list[str],
*,
require_any: bool = False,
) -> None:
"""Resolve the key's owner and run the full permission gate. Raises 403."""
owner = await resolve_apikey_owner(db, api_key)
_check_apikey_permissions(api_key, perm_strings, owner=owner, require_any=require_any)
def _check_apikey_permissions(
api_key: APIKey,
perm_strings: list[str],
*,
owner: User | None = None,
require_any: bool = False,
) -> None:
"""Raise 403 unless ``api_key`` is allowed to use ``perm_strings``.
Allowlist semantics: every requested permission MUST be present in
``_APIKEY_SCOPE_BY_PERMISSION`` AND every scope flag it maps to must be
True on ``api_key`` (most map to one; a few require several). Unmapped
permissions = administrative = 403.
A key must not out-rank the user it belongs to, so when ``owner`` is given
the permission must additionally be one the owner holds. Scope flags are
chosen at creation time by whoever holds ``api_keys:create``; that is
admin-only in the default groups, but a custom group can grant it, and
without this check such a user could mint themselves a key with
``can_control_printer`` and act through it beyond their own permissions.
``owner=None`` is only correct for legacy ownerless keys -- see
``resolve_apikey_owner``.
By default ALL requested permissions must pass (mirrors
``require_permission`` / ``require_permission_if_auth_enabled``).
When ``require_any=True``, only one needs to pass (mirrors
``require_any_permission_if_auth_enabled``).
"""
if not perm_strings:
# Defensive: empty perm list means the dep is auth-only, not perm-gated.
# Routes never call us with [] today, but if they did, returning here
# would silently allow — instead, fail closed.
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="API keys cannot be used for unspecified permissions",
)
last_failure: HTTPException | None = None
for perm_str in perm_strings:
scopes = _required_apikey_scopes(perm_str)
missing = [flag for flag in scopes or () if not getattr(api_key, flag, False)]
if not scopes:
failure = HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="API keys cannot be used for administrative operations",
)
elif missing:
# Name every flag the key is short of, not just the first: a
# permission requiring two scopes would otherwise send the operator
# round the loop twice, ticking one box per 403.
failure = HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail=f"API key does not have {' and '.join(repr(flag) for flag in missing)} permission",
)
elif owner is not None and not owner.has_permission(perm_str):
failure = HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail=f"API key owner does not have '{perm_str}' permission",
)
else:
failure = None
if failure is None and require_any:
return # at least one passed
if failure is not None and not require_any:
raise failure
last_failure = failure
if require_any and last_failure is not None:
raise last_failure
def require_energy_cost_update():
"""Dependency for ``POST /settings/electricity-price`` (#1356).
Bypasses the ``_APIKEY_DENIED_PERMISSIONS`` ``SETTINGS_UPDATE`` block for
API keys that explicitly opt into ``can_update_energy_cost``. Full
``SETTINGS_UPDATE`` for API keys stays denied — this is a narrowly-scoped
door for the Home Assistant dynamic-tariff use case documented in
``wiki/features/energy.md``, not a general settings-write capability.
Accepts:
* Auth disabled → always allowed (matches other settings routes)
* JWT user with ``SETTINGS_UPDATE`` permission
* API key with ``can_update_energy_cost = True``
"""
async def permission_checker(
credentials: Annotated[HTTPAuthorizationCredentials | None, Depends(security)] = None,
x_api_key: Annotated[str | None, Header(alias="X-API-Key")] = None,
) -> User | None:
async with async_session() as db:
if not await is_auth_enabled(db):
return None
credentials_exception = HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Could not validate credentials",
headers={"WWW-Authenticate": "Bearer"},
)
# API key path — X-API-Key header or Bearer bb_xxx
api_key_value: str | None = None
if x_api_key:
api_key_value = x_api_key
elif credentials is not None and credentials.credentials.startswith("bb_"):
api_key_value = credentials.credentials
if api_key_value is not None:
api_key = await _validate_api_key(db, api_key_value)
if api_key is None:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid API key",
headers={"WWW-Authenticate": "Bearer"},
)
# Fails closed if the owner has been deactivated. The scope
# flag itself is not narrowed against the owner's permissions
# the way the general gate is: this door exists precisely
# because no user permission maps to it (SETTINGS_UPDATE stays
# denied for keys even when the owner is an administrator).
await resolve_apikey_owner(db, api_key)
if not api_key.can_update_energy_cost:
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="API key does not have 'update_energy_cost' permission",
)
return None
# JWT path
if credentials is None:
raise credentials_exception
try:
payload = jwt.decode(credentials.credentials, SECRET_KEY, algorithms=[ALGORITHM])
username: str = payload.get("sub")
if username is None:
raise credentials_exception
jti: str | None = payload.get("jti")
if not jti or await is_jti_revoked(jti, db):
raise credentials_exception
iat: int | float | None = payload.get("iat")
except JWTError:
raise credentials_exception
user = await get_user_by_username(db, username)
if user is None or not user.is_active:
raise credentials_exception
if not _is_token_fresh(iat, user):
raise credentials_exception
if not user.has_all_permissions(Permission.SETTINGS_UPDATE.value):
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail=f"Missing required permissions: {Permission.SETTINGS_UPDATE.value}",
)
return user
return permission_checker
# Password hashing
# Use pbkdf2_sha256 instead of bcrypt to avoid 72-byte limit and passlib initialization issues
# pbkdf2_sha256 is a secure password hashing algorithm without bcrypt's limitations
pwd_context = CryptContext(schemes=["pbkdf2_sha256"], deprecated="auto")
def _get_jwt_secret() -> str:
"""Get the JWT secret key from environment, file, or generate a new one.
Priority:
1. JWT_SECRET_KEY environment variable
2. .jwt_secret file in data directory
3. Generate new random secret and save to file
Returns:
The JWT secret key
"""
# 1. Check environment variable first
env_secret = os.environ.get("JWT_SECRET_KEY")
if env_secret:
logger.info("Using JWT secret from JWT_SECRET_KEY environment variable")
return env_secret
# 2. Check for secret file in data directory
from backend.app.core.paths import resolve_data_dir
data_dir = resolve_data_dir()
secret_file = data_dir / ".jwt_secret"
if secret_file.exists():
try:
secret = secret_file.read_text().strip()
if secret and len(secret) >= 32:
logger.info("Using JWT secret from %s", secret_file)
return secret
except OSError as e:
logger.warning("Failed to read JWT secret file: %s", e)
# 3. Generate new random secret
new_secret = secrets.token_urlsafe(64)
# Try to save it
try:
data_dir.mkdir(parents=True, exist_ok=True)
# Note: CodeQL flags this as "clear-text storage of sensitive information" but this is
# intentional and secure - JWT secrets must be readable by the app, we set 0600 permissions,
# and this is standard practice for self-hosted applications (same as .env files).
secret_file.write_text(new_secret) # nosec B105
# Restrict permissions (owner read/write only)
secret_file.chmod(0o600)
logger.info("Generated new JWT secret and saved to %s", secret_file)
except OSError as e:
logger.warning(
"Could not save JWT secret to file (%s). "
"Secret will be regenerated on restart, invalidating existing tokens. "
"Set JWT_SECRET_KEY environment variable for persistence.",
e,
)
return new_secret
# JWT settings
SECRET_KEY = _get_jwt_secret()
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 60 * 24 # 24 hours (M-2: reduced from 7 days)
# Hard ceiling for the admin-configurable session policy (#1706). 30 days
# matches the Pydantic le=720 on AppSettings.session_max_hours; defense in
# depth so a tampered settings row can't request an absurd lifetime.
SESSION_MAX_HOURS_HARD_CEILING = 720
# HTTP Bearer token
security = HTTPBearer(auto_error=False)
async def resolve_session_max_minutes(db: AsyncSession) -> int:
"""Return the session-lifetime ceiling (minutes) honoured by login routes.
Reads ``session_max_hours`` from the settings table (#1706), clamps to
[1h, 720h], and falls back to the audit-default 24h if the row is
missing, blank, or unparseable.
DB errors are NOT caught here — login is already in a DB transaction and
a broken DB must abort the login rather than silently extend or shrink
the session lifetime.
"""
default_minutes = ACCESS_TOKEN_EXPIRE_MINUTES
result = await db.execute(select(Settings).where(Settings.key == "session_max_hours"))
row = result.scalar_one_or_none()
if row is None or not row.value:
return default_minutes
try:
hours = int(row.value)
except (TypeError, ValueError):
return default_minutes
if hours < 1:
return default_minutes
if hours > SESSION_MAX_HOURS_HARD_CEILING:
hours = SESSION_MAX_HOURS_HARD_CEILING
return hours * 60
# --- Slicer download tokens ---
# Short-lived, single-use tokens for slicer protocol handlers that can't send
# auth headers. Stored in AuthEphemeralToken (token_type=TokenType.SLICER_DOWNLOAD)
# so they survive server restarts and work in multi-worker deployments (M-3).
SLICER_TOKEN_EXPIRE_MINUTES = 5
async def create_slicer_download_token(resource_type: str, resource_id: int) -> str:
"""Create a short-lived, single-use download token for slicer protocol handlers."""
now = datetime.now(timezone.utc)
expires_at = now + timedelta(minutes=SLICER_TOKEN_EXPIRE_MINUTES)
token = secrets.token_urlsafe(24)
resource_key = f"{resource_type}:{resource_id}"
async with async_session() as db:
# Prune expired tokens opportunistically
await db.execute(
delete(AuthEphemeralToken).where(
AuthEphemeralToken.token_type == TokenType.SLICER_DOWNLOAD,
AuthEphemeralToken.expires_at < now,
)
)
db.add(
AuthEphemeralToken(
token=token,
token_type=TokenType.SLICER_DOWNLOAD,
nonce=resource_key,
expires_at=expires_at,
)
)
await db.commit()
return token
async def verify_slicer_download_token(token: str, resource_type: str, resource_id: int) -> bool:
"""Verify and atomically consume a slicer download token.
Returns True only if the token is valid, unexpired, and bound to the given resource.
DELETE...RETURNING ensures the token is single-use even under concurrent requests.
M-NEW-1 fix: nonce (resource key) is included in the WHERE clause so the DELETE
only succeeds when the token is presented to the *correct* resource endpoint.
Previously the token was consumed (committed) even when stored_key != expected_key,
permanently invalidating it while returning False to the caller.
"""
expected_key = f"{resource_type}:{resource_id}"
now = datetime.now(timezone.utc)
async with async_session() as db:
result = await db.execute(
delete(AuthEphemeralToken)
.where(
AuthEphemeralToken.token == token,
AuthEphemeralToken.token_type == TokenType.SLICER_DOWNLOAD,
AuthEphemeralToken.nonce == expected_key,
AuthEphemeralToken.expires_at > now,
)
.returning(AuthEphemeralToken.id)
)
if result.one_or_none() is None:
return False
await db.commit()
return True
# --- Camera stream tokens ---
# Reusable tokens for camera stream/snapshot endpoints loaded via
/