mirror of
https://github.com/maziggy/bambuddy.git
synced 2026-10-03 04:31:28 +02:00
maziggy
006c3113a0
Carve MAINTENANCE_CREATE/UPDATE/DELETE out of the admin denylist so HA automations can log "cleaned nozzle" / reset a counter via API key without granting broader printer control. Follows the same shape as can_manage_library and can_manage_inventory: new column, allowlist entry, UI checkbox, wiki row, RBAC test coverage. Distinct backfill: these perms were EXPLICITLY denied for every API key before this change (no existing integration relies on them), so existing rows migrate to FALSE — no silent scope widening on upgrade. New keys default to TRUE, matching the safe-on-by-default pattern. Bundled SpoolBuddy kiosk key gets False explicitly (kiosk doesn't need it).
56 lines
2.7 KiB
Python
56 lines
2.7 KiB
Python
from datetime import datetime
|
|
|
|
from sqlalchemy import JSON, Boolean, DateTime, ForeignKey, Integer, String, func
|
|
from sqlalchemy.orm import Mapped, mapped_column
|
|
|
|
from backend.app.core.database import Base
|
|
|
|
|
|
class APIKey(Base):
|
|
"""API key for external webhook access."""
|
|
|
|
__tablename__ = "api_keys"
|
|
|
|
id: Mapped[int] = mapped_column(primary_key=True)
|
|
name: Mapped[str] = mapped_column(String(100)) # User-friendly name
|
|
key_hash: Mapped[str] = mapped_column(String(255)) # bcrypt hash of the key
|
|
key_prefix: Mapped[str] = mapped_column(String(20)) # First 8 chars + "..." for display
|
|
|
|
# Owner — required for new keys, NULL only on legacy rows that predate per-user
|
|
# ownership. Cloud routes reject calls from keys without an owner so callers are
|
|
# forced to recreate them. CASCADE so deleting a user removes their keys.
|
|
user_id: Mapped[int | None] = mapped_column(
|
|
Integer,
|
|
ForeignKey("users.id", ondelete="CASCADE"),
|
|
nullable=True,
|
|
index=True,
|
|
)
|
|
|
|
# Permissions
|
|
can_queue: Mapped[bool] = mapped_column(Boolean, default=True) # Add to queue
|
|
can_control_printer: Mapped[bool] = mapped_column(Boolean, default=False) # Start/stop/cancel
|
|
can_read_status: Mapped[bool] = mapped_column(Boolean, default=True) # Query status
|
|
can_manage_library: Mapped[bool] = mapped_column(
|
|
Boolean, default=True
|
|
) # Upload/rename/delete own library files + MakerWorld import
|
|
can_manage_inventory: Mapped[bool] = mapped_column(
|
|
Boolean, default=True
|
|
) # Inventory write ops (incl. SpoolBuddy kiosk NFC/scale/system)
|
|
can_manage_maintenance: Mapped[bool] = mapped_column(
|
|
Boolean, default=True
|
|
) # Log/reset per-printer maintenance, edit intervals, manage the type catalog (#1832 follow-up)
|
|
can_access_cloud: Mapped[bool] = mapped_column(Boolean, default=False) # Read /cloud/* on the owner's behalf
|
|
# Narrowly-scoped settings write: only POST /settings/electricity-price.
|
|
# Lets HA/Tibber-style automations push dynamic tariff updates without
|
|
# granting full SETTINGS_UPDATE (which is denied for API keys because it
|
|
# could rewrite SMTP/LDAP/MQTT credentials).
|
|
can_update_energy_cost: Mapped[bool] = mapped_column(Boolean, default=False)
|
|
|
|
# Optional scope limits
|
|
printer_ids: Mapped[list | None] = mapped_column(JSON, nullable=True) # null = all printers
|
|
|
|
enabled: Mapped[bool] = mapped_column(Boolean, default=True)
|
|
last_used: Mapped[datetime | None] = mapped_column(DateTime, nullable=True)
|
|
created_at: Mapped[datetime] = mapped_column(DateTime, server_default=func.now())
|
|
expires_at: Mapped[datetime | None] = mapped_column(DateTime, nullable=True) # Optional expiry
|