test_auth_apikey_rbac.py 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735
  1. """Integration tests for API key RBAC enforcement (security fix C1)."""
  2. import pytest
  3. from httpx import AsyncClient
  4. @pytest.fixture
  5. async def api_key_data(async_client: AsyncClient, db_session):
  6. """Create an API key and return its full key value."""
  7. from backend.app.core.auth import generate_api_key
  8. from backend.app.models.api_key import APIKey
  9. full_key, key_hash, key_prefix = generate_api_key()
  10. api_key = APIKey(
  11. name="test-key",
  12. key_hash=key_hash,
  13. key_prefix=key_prefix,
  14. can_queue=True,
  15. can_control_printer=True,
  16. can_read_status=True,
  17. enabled=True,
  18. )
  19. db_session.add(api_key)
  20. await db_session.commit()
  21. return full_key
  22. @pytest.fixture
  23. async def spoolman_settings(db_session):
  24. from backend.app.models.settings import Settings
  25. db_session.add(Settings(key="spoolman_enabled", value="true"))
  26. db_session.add(Settings(key="spoolman_url", value="http://localhost:7912"))
  27. await db_session.commit()
  28. class TestApiKeyRbacDenied:
  29. """API keys must be refused for admin-only endpoints."""
  30. @pytest.mark.asyncio
  31. @pytest.mark.integration
  32. async def test_api_key_cannot_access_settings_update_endpoint(
  33. self, async_client: AsyncClient, db_session, api_key_data
  34. ):
  35. """API key must not be usable for settings:update endpoints (C1)."""
  36. from backend.app.models.settings import Settings
  37. db_session.add(Settings(key="auth_enabled", value="true"))
  38. await db_session.commit()
  39. resp = await async_client.put(
  40. "/api/v1/settings/",
  41. json={},
  42. headers={"X-API-Key": api_key_data},
  43. )
  44. assert resp.status_code == 403
  45. assert "administrative operations" in resp.json()["detail"]
  46. @pytest.mark.asyncio
  47. @pytest.mark.integration
  48. async def test_api_key_bearer_cannot_access_settings_update(
  49. self, async_client: AsyncClient, db_session, api_key_data
  50. ):
  51. """Bearer bb_ API key must also be refused for settings:update (C1)."""
  52. from backend.app.models.settings import Settings
  53. db_session.add(Settings(key="auth_enabled", value="true"))
  54. await db_session.commit()
  55. resp = await async_client.put(
  56. "/api/v1/settings/",
  57. json={},
  58. headers={"Authorization": f"Bearer {api_key_data}"},
  59. )
  60. assert resp.status_code == 403
  61. assert "administrative operations" in resp.json()["detail"]
  62. class TestApiKeyRbacAllowed:
  63. """API keys must still work for non-admin endpoints."""
  64. @pytest.mark.asyncio
  65. @pytest.mark.integration
  66. async def test_api_key_can_access_inventory_read(
  67. self, async_client: AsyncClient, db_session, api_key_data, spoolman_settings
  68. ):
  69. """API key must be accepted for inventory:read endpoints (C1)."""
  70. from unittest.mock import AsyncMock, MagicMock, patch
  71. from backend.app.models.settings import Settings
  72. db_session.add(Settings(key="auth_enabled", value="true"))
  73. await db_session.commit()
  74. mock_client = MagicMock()
  75. mock_client.base_url = "http://localhost:7912"
  76. mock_client.health_check = AsyncMock(return_value=True)
  77. mock_client.get_all_spools = AsyncMock(return_value=[])
  78. mock_client.get_distinct_locations = AsyncMock(return_value=[])
  79. with patch(
  80. "backend.app.api.routes.spoolman_inventory._get_client",
  81. AsyncMock(return_value=mock_client),
  82. ):
  83. resp = await async_client.get(
  84. "/api/v1/spoolman/inventory/spools",
  85. headers={"X-API-Key": api_key_data},
  86. )
  87. assert resp.status_code == 200
  88. class TestApiKeyDenylistIntegrity:
  89. """Drift-detection: assert that admin-tier permissions remain in the denylist."""
  90. def test_admin_permissions_are_denied_for_api_keys(self):
  91. """All known admin-tier permissions must be in _APIKEY_DENIED_PERMISSIONS (H1 guard)."""
  92. from backend.app.core.auth import _APIKEY_DENIED_PERMISSIONS
  93. from backend.app.core.permissions import Permission
  94. expected_denied = {
  95. # SETTINGS_READ is intentionally NOT denied — SpoolBuddy kiosk reads
  96. # settings via API key (e.g. to sync the UI language).
  97. Permission.SETTINGS_UPDATE,
  98. Permission.SETTINGS_BACKUP,
  99. Permission.SETTINGS_RESTORE,
  100. Permission.USERS_READ,
  101. Permission.USERS_CREATE,
  102. Permission.USERS_UPDATE,
  103. Permission.USERS_DELETE,
  104. Permission.GROUPS_READ,
  105. Permission.GROUPS_CREATE,
  106. Permission.GROUPS_UPDATE,
  107. Permission.GROUPS_DELETE,
  108. Permission.API_KEYS_READ,
  109. Permission.API_KEYS_CREATE,
  110. Permission.API_KEYS_UPDATE,
  111. Permission.API_KEYS_DELETE,
  112. Permission.COST_CENTERS_READ_OWN,
  113. Permission.COST_CENTERS_READ_ALL,
  114. Permission.COST_CENTERS_MODIFY,
  115. Permission.COST_CENTERS_CREATE,
  116. Permission.GITHUB_BACKUP,
  117. Permission.GITHUB_RESTORE,
  118. Permission.FIRMWARE_UPDATE,
  119. }
  120. missing = expected_denied - _APIKEY_DENIED_PERMISSIONS
  121. assert not missing, (
  122. f"Admin-tier permissions not in API key denylist (add them to _APIKEY_DENIED_PERMISSIONS): {missing}"
  123. )
  124. def test_operational_permissions_are_allowed_for_api_keys(self):
  125. """Core operational permissions must NOT be in the denylist."""
  126. from backend.app.core.auth import _APIKEY_DENIED_PERMISSIONS
  127. from backend.app.core.permissions import Permission
  128. # NOTE: under the GHSA-r2qv-8222-hqg3 allowlist model, INVENTORY_CREATE
  129. # and INVENTORY_UPDATE are administrative (not in the allowlist) and
  130. # therefore denied for API keys regardless of denylist membership.
  131. # This test still guards the small denylist-redundancy set of read-y
  132. # permissions that the SpoolBuddy kiosk + status integrations rely on.
  133. expected_allowed = {
  134. Permission.INVENTORY_READ,
  135. Permission.PRINTERS_READ,
  136. Permission.PRINTERS_CONTROL,
  137. Permission.ARCHIVES_READ,
  138. # #1888: archive delete/update moved off the denylist to the
  139. # can_manage_archives allowlist scope; must not be denied.
  140. Permission.ARCHIVES_DELETE_ALL,
  141. Permission.ARCHIVES_UPDATE_ALL,
  142. # #1893: project CRUD moved off the denylist to the
  143. # can_manage_projects allowlist scope; must not be denied.
  144. Permission.PROJECTS_CREATE,
  145. Permission.PROJECTS_UPDATE,
  146. Permission.PROJECTS_DELETE,
  147. # SpoolBuddy kiosk reads settings (e.g. language) via API key — must stay allowed.
  148. Permission.SETTINGS_READ,
  149. }
  150. incorrectly_denied = expected_allowed & _APIKEY_DENIED_PERMISSIONS
  151. assert not incorrectly_denied, f"Operational permissions incorrectly in API key denylist: {incorrectly_denied}"
  152. def _flags_in_use() -> set[str]:
  153. """Every scope flag named anywhere in the allowlist.
  154. A mapping value is normally one flag but may be a tuple of flags that must
  155. all be held (PIPELINES_RUN). Reading ``.values()`` directly would put that
  156. tuple into the set and make both drift checks below wrong in opposite
  157. directions: an unknown-flag alarm for the tuple, and a false "dead flag"
  158. for whichever flags only appear inside one.
  159. """
  160. from backend.app.core.auth import _APIKEY_SCOPE_BY_PERMISSION
  161. flags: set[str] = set()
  162. for value in _APIKEY_SCOPE_BY_PERMISSION.values():
  163. flags.update((value,) if isinstance(value, str) else value)
  164. return flags
  165. class TestApiKeyScopeAllowlist:
  166. """GHSA-r2qv-8222-hqg3 (CVSS 9.9) — allowlist-based scope enforcement.
  167. Verifies that ``_check_apikey_permissions`` (and the higher-level
  168. dependencies that call it) honour the per-permission scope mapping rather
  169. than the legacy denylist-only model. Failures here would re-open the
  170. "Read Status / Manage Queue / Control Printer / Manage Library checkboxes
  171. are decorative" class of bug.
  172. """
  173. def test_every_permission_has_a_classification(self):
  174. """Structural: every Permission must be either allowlisted or admin-denied.
  175. This is the load-bearing drift-detection test for the allowlist model.
  176. A new Permission added to ``core/permissions.py`` without a matching
  177. entry in ``_APIKEY_SCOPE_BY_PERMISSION`` or ``_APIKEY_DENIED_PERMISSIONS``
  178. is functionally admin-only (allowlist failure → 403) — that's the safe
  179. default, but it should be an explicit choice rather than an oversight.
  180. """
  181. from backend.app.core.auth import (
  182. _APIKEY_DENIED_PERMISSIONS,
  183. _APIKEY_SCOPE_BY_PERMISSION,
  184. )
  185. from backend.app.core.permissions import Permission
  186. unclassified = {
  187. perm
  188. for perm in Permission
  189. if perm not in _APIKEY_SCOPE_BY_PERMISSION and perm not in _APIKEY_DENIED_PERMISSIONS
  190. }
  191. assert not unclassified, (
  192. "Every Permission must be classified for API-key access. "
  193. "Either add to _APIKEY_SCOPE_BY_PERMISSION (with scope flag) or "
  194. f"_APIKEY_DENIED_PERMISSIONS (admin-only). Unclassified: {unclassified}"
  195. )
  196. def test_allowlist_uses_only_valid_scope_flags(self):
  197. """Every value in the scope mapping must be a real bool field on APIKey."""
  198. from backend.app.core.auth import _APIKEY_SCOPE_BY_PERMISSION
  199. from backend.app.models.api_key import APIKey
  200. # can_access_cloud / can_update_energy_cost are narrow opt-in scopes;
  201. # the latter routes through its own ``require_energy_cost_update`` dep
  202. # rather than the central allowlist, so it doesn't appear here.
  203. valid_flags = {
  204. "can_read_status",
  205. "can_queue",
  206. "can_control_printer",
  207. "can_manage_library",
  208. "can_manage_inventory",
  209. "can_manage_maintenance",
  210. "can_manage_archives",
  211. "can_manage_projects",
  212. "can_access_cloud",
  213. }
  214. used_flags = _flags_in_use()
  215. assert used_flags <= valid_flags, f"Unknown scope flags in mapping: {used_flags - valid_flags}"
  216. # And every flag must actually exist on the model.
  217. for flag in valid_flags:
  218. assert hasattr(APIKey, flag), f"APIKey model missing column referenced by allowlist: {flag}"
  219. def test_allowlist_and_denylist_are_disjoint(self):
  220. """A permission classified as allowlisted must not also be in the denylist (and v/v)."""
  221. from backend.app.core.auth import (
  222. _APIKEY_DENIED_PERMISSIONS,
  223. _APIKEY_SCOPE_BY_PERMISSION,
  224. )
  225. overlap = set(_APIKEY_SCOPE_BY_PERMISSION) & _APIKEY_DENIED_PERMISSIONS
  226. assert not overlap, f"Permissions in both allowlist and denylist: {overlap}"
  227. @pytest.mark.parametrize(
  228. "scope_flag",
  229. [
  230. "can_read_status",
  231. "can_queue",
  232. "can_control_printer",
  233. "can_manage_library",
  234. "can_manage_inventory",
  235. "can_manage_maintenance",
  236. "can_manage_archives",
  237. "can_manage_projects",
  238. "can_access_cloud",
  239. ],
  240. )
  241. def test_each_scope_flag_has_at_least_one_permission(self, scope_flag):
  242. """If a scope flag has no permissions, it's dead code — fail loudly."""
  243. assert scope_flag in _flags_in_use(), (
  244. f"No permission maps to {scope_flag} — either remove the flag or classify a permission under it."
  245. )
  246. class _FakeApiKey:
  247. """Bool-attribute stand-in for APIKey used by the scope matrix tests.
  248. The ``_check_apikey_permissions`` function only inspects the four scope
  249. booleans, so a lightweight stub is enough; instantiating the real model
  250. requires a DB session which is overkill for pure-logic verification.
  251. """
  252. def __init__(
  253. self,
  254. can_read_status=False,
  255. can_queue=False,
  256. can_control_printer=False,
  257. can_manage_library=False,
  258. can_manage_inventory=False,
  259. can_manage_maintenance=False,
  260. can_manage_archives=False,
  261. can_manage_projects=False,
  262. ):
  263. self.can_read_status = can_read_status
  264. self.can_queue = can_queue
  265. self.can_control_printer = can_control_printer
  266. self.can_manage_library = can_manage_library
  267. self.can_manage_inventory = can_manage_inventory
  268. self.can_manage_maintenance = can_manage_maintenance
  269. self.can_manage_archives = can_manage_archives
  270. self.can_manage_projects = can_manage_projects
  271. class TestCheckApiKeyPermissionsMatrix:
  272. """Pure-logic matrix: every (scope flag combo × representative permission) outcome.
  273. These are the tests that would have caught GHSA-r2qv-8222-hqg3 — they prove
  274. the actual gate function honours the scope flags, not just that some
  275. helper called by webhook.py does.
  276. """
  277. # (Permission, expected scope flag attribute, category description)
  278. _SCOPE_CASES = [
  279. # can_read_status
  280. ("PRINTERS_READ", "can_read_status", "read printer status"),
  281. ("ARCHIVES_READ", "can_read_status", "read archives"),
  282. ("QUEUE_READ", "can_read_status", "read queue"),
  283. ("SETTINGS_READ", "can_read_status", "SpoolBuddy kiosk settings read"),
  284. ("WEBSOCKET_CONNECT", "can_read_status", "websocket subscribe"),
  285. # can_queue
  286. ("QUEUE_CREATE", "can_queue", "add queue item"),
  287. ("QUEUE_DELETE_ALL", "can_queue", "delete any queue item"),
  288. ("ARCHIVES_REPRINT_ALL", "can_queue", "reprint an archive"),
  289. # can_control_printer
  290. ("PRINTERS_CONTROL", "can_control_printer", "start/stop print"),
  291. ("PRINTERS_FILES", "can_control_printer", "send file to printer"),
  292. ("SMART_PLUGS_CONTROL", "can_control_printer", "smart plug on/off"),
  293. # can_manage_library — OWN and ALL ownership variants both fold into
  294. # the same scope (#1832): API keys have no per-row ownership identity,
  295. # so splitting OWN/ALL across allowlist/denylist made the curation
  296. # surface unreachable. PURGE stays admin-only.
  297. ("LIBRARY_UPLOAD", "can_manage_library", "upload library file"),
  298. ("LIBRARY_UPDATE_OWN", "can_manage_library", "rename own library file"),
  299. ("LIBRARY_UPDATE_ALL", "can_manage_library", "rename any library file"),
  300. ("LIBRARY_DELETE_OWN", "can_manage_library", "delete own library file"),
  301. ("LIBRARY_DELETE_ALL", "can_manage_library", "delete any library file"),
  302. ("MAKERWORLD_IMPORT", "can_manage_library", "import from MakerWorld"),
  303. # can_manage_inventory
  304. ("INVENTORY_CREATE", "can_manage_inventory", "create spool record"),
  305. ("INVENTORY_UPDATE", "can_manage_inventory", "update spool / SpoolBuddy kiosk write"),
  306. ("INVENTORY_DELETE", "can_manage_inventory", "delete spool record"),
  307. ("INVENTORY_FORECAST_WRITE", "can_manage_inventory", "update forecast SKU settings"),
  308. # can_manage_maintenance (#1832 follow-up) — HA "cleaned nozzle" / reset counter
  309. # is the load-bearing use case; MAINTENANCE_UPDATE gates POST /maintenance/items/{id}/perform.
  310. ("MAINTENANCE_CREATE", "can_manage_maintenance", "assign maintenance type to printer"),
  311. ("MAINTENANCE_UPDATE", "can_manage_maintenance", "log maintenance / edit interval"),
  312. ("MAINTENANCE_DELETE", "can_manage_maintenance", "remove custom maintenance item"),
  313. # can_manage_archives (#1888) — prune print history via API key. OWN and
  314. # ALL ownership variants both fold into the same scope (API keys have no
  315. # per-row ownership identity), matching the can_manage_library shape.
  316. # ARCHIVES_PURGE stays admin-only (see _ADMIN_CASES).
  317. ("ARCHIVES_CREATE", "can_manage_archives", "create an archive"),
  318. ("ARCHIVES_UPDATE_OWN", "can_manage_archives", "edit own archive"),
  319. ("ARCHIVES_UPDATE_ALL", "can_manage_archives", "edit any archive"),
  320. ("ARCHIVES_DELETE_OWN", "can_manage_archives", "delete own archive"),
  321. ("ARCHIVES_DELETE_ALL", "can_manage_archives", "delete any archive"),
  322. # can_manage_projects (#1893) — project CRUD + membership via API key.
  323. # Projects gate on plain PROJECTS_* (no OWN/ALL split), so the three
  324. # permissions map directly to the one scope. PROJECTS_READ stays under
  325. # can_read_status. Membership edits (add-archives) gate on PROJECTS_UPDATE.
  326. ("PROJECTS_CREATE", "can_manage_projects", "create a project"),
  327. ("PROJECTS_UPDATE", "can_manage_projects", "update a project / add archives"),
  328. ("PROJECTS_DELETE", "can_manage_projects", "delete a project"),
  329. # Pipeline definitions and run history read as status/config, so they
  330. # ride can_read_status. PIPELINES_RUN needs two flags and has its own
  331. # class below; PIPELINES_WRITE stays admin-only (see _ADMIN_CASES).
  332. ("PIPELINES_READ", "can_read_status", "list pipelines / read run history"),
  333. ]
  334. _ADMIN_CASES = [
  335. # Documented denylist
  336. "SETTINGS_UPDATE",
  337. "USERS_CREATE",
  338. "GROUPS_DELETE",
  339. "API_KEYS_CREATE",
  340. "GITHUB_BACKUP",
  341. "FIRMWARE_UPDATE",
  342. # Unmapped administrative (allowlist fail-closed catches these too)
  343. "PRINTERS_CREATE",
  344. # LIBRARY_DELETE_ALL / LIBRARY_UPDATE_ALL moved to can_manage_library
  345. # under #1832 — covered by the _SCOPE_CASES matrix above.
  346. "LIBRARY_PURGE",
  347. # ARCHIVES_PURGE stays admin-only even though the rest of archive
  348. # management moved to can_manage_archives under #1888 — it drops the
  349. # print's stats contribution, mirroring LIBRARY_PURGE.
  350. "ARCHIVES_PURGE",
  351. "DISCOVERY_SCAN",
  352. # PIPELINES_READ / PIPELINES_RUN became key-usable once PR C landed the
  353. # run dispatch (#1425). Authoring did not: PIPELINES_WRITE rewrites the
  354. # slicer settings and target printer a run then acts on, and clears run
  355. # history.
  356. "PIPELINES_WRITE",
  357. ]
  358. @pytest.mark.parametrize("perm_name,required_flag,_descr", _SCOPE_CASES)
  359. def test_permission_allowed_only_when_scope_flag_is_set(self, perm_name, required_flag, _descr):
  360. """For each (Permission, scope) case, true→allow and false→403."""
  361. from fastapi import HTTPException
  362. from backend.app.core.auth import _check_apikey_permissions
  363. from backend.app.core.permissions import Permission
  364. perm = Permission[perm_name].value
  365. # Flag set → passes
  366. _check_apikey_permissions(_FakeApiKey(**{required_flag: True}), [perm])
  367. # All flags off → 403
  368. with pytest.raises(HTTPException) as exc:
  369. _check_apikey_permissions(_FakeApiKey(), [perm])
  370. assert exc.value.status_code == 403
  371. # Wrong flag set, required flag off → 403 (no cross-scope leakage)
  372. other_flags = {
  373. f
  374. for f in (
  375. "can_read_status",
  376. "can_queue",
  377. "can_control_printer",
  378. "can_manage_library",
  379. "can_manage_inventory",
  380. "can_manage_maintenance",
  381. "can_manage_archives",
  382. "can_manage_projects",
  383. )
  384. if f != required_flag
  385. }
  386. for other in other_flags:
  387. with pytest.raises(HTTPException) as exc:
  388. _check_apikey_permissions(_FakeApiKey(**{other: True}), [perm])
  389. assert exc.value.status_code == 403
  390. @pytest.mark.parametrize("perm_name", _ADMIN_CASES)
  391. def test_admin_permissions_are_403_regardless_of_flags(self, perm_name):
  392. """A fully-flagged API key still cannot use administrative permissions."""
  393. from fastapi import HTTPException
  394. from backend.app.core.auth import _check_apikey_permissions
  395. from backend.app.core.permissions import Permission
  396. perm = Permission[perm_name].value
  397. all_flags = _FakeApiKey(can_read_status=True, can_queue=True, can_control_printer=True, can_manage_library=True)
  398. with pytest.raises(HTTPException) as exc:
  399. _check_apikey_permissions(all_flags, [perm])
  400. assert exc.value.status_code == 403
  401. assert "administrative" in exc.value.detail.lower() or "does not have" in exc.value.detail.lower()
  402. def test_unknown_permission_string_is_admin_denied(self):
  403. """An unrecognised permission string must fail closed, not silently pass."""
  404. from fastapi import HTTPException
  405. from backend.app.core.auth import _check_apikey_permissions
  406. all_flags = _FakeApiKey(can_read_status=True, can_queue=True, can_control_printer=True, can_manage_library=True)
  407. with pytest.raises(HTTPException) as exc:
  408. _check_apikey_permissions(all_flags, ["bogus:nonexistent"])
  409. assert exc.value.status_code == 403
  410. def test_empty_perm_list_is_403(self):
  411. """Defence-in-depth: an empty perm list must not silently allow."""
  412. from fastapi import HTTPException
  413. from backend.app.core.auth import _check_apikey_permissions
  414. all_flags = _FakeApiKey(can_read_status=True, can_queue=True, can_control_printer=True, can_manage_library=True)
  415. with pytest.raises(HTTPException) as exc:
  416. _check_apikey_permissions(all_flags, [])
  417. assert exc.value.status_code == 403
  418. def test_require_any_at_least_one_must_pass(self):
  419. """``require_any=True`` matches any-of semantics, but still respects scopes."""
  420. from fastapi import HTTPException
  421. from backend.app.core.auth import _check_apikey_permissions
  422. from backend.app.core.permissions import Permission
  423. # can_read_status only: any-of (PRINTERS_READ, QUEUE_CREATE) passes because the read flag is set.
  424. _check_apikey_permissions(
  425. _FakeApiKey(can_read_status=True),
  426. [Permission.PRINTERS_READ.value, Permission.QUEUE_CREATE.value],
  427. require_any=True,
  428. )
  429. # No flags: any-of fails.
  430. with pytest.raises(HTTPException):
  431. _check_apikey_permissions(
  432. _FakeApiKey(),
  433. [Permission.PRINTERS_READ.value, Permission.QUEUE_CREATE.value],
  434. require_any=True,
  435. )
  436. # All admin perms: any-of fails even with every flag set.
  437. with pytest.raises(HTTPException):
  438. _check_apikey_permissions(
  439. _FakeApiKey(can_read_status=True, can_queue=True, can_control_printer=True, can_manage_library=True),
  440. [Permission.USERS_CREATE.value, Permission.GROUPS_DELETE.value],
  441. require_any=True,
  442. )
  443. def test_require_all_every_perm_must_pass(self):
  444. """Default ``require_any=False``: every permission must pass — single failure → 403."""
  445. from fastapi import HTTPException
  446. from backend.app.core.auth import _check_apikey_permissions
  447. from backend.app.core.permissions import Permission
  448. # Read+queue set, queue+control required → fails because control flag is off.
  449. with pytest.raises(HTTPException) as exc:
  450. _check_apikey_permissions(
  451. _FakeApiKey(can_read_status=True, can_queue=True),
  452. [Permission.QUEUE_CREATE.value, Permission.PRINTERS_CONTROL.value],
  453. )
  454. assert exc.value.status_code == 403
  455. class TestMultiScopePermissions:
  456. """A permission may require several scope flags at once (#1425 follow-up).
  457. Running a slicer pipeline slices the source into a new library file and
  458. then queues one print per copy. Those are two things an operator ticks
  459. separately when minting a key, so PIPELINES_RUN maps to both
  460. ``can_queue`` and ``can_manage_library`` — mapping it to either alone
  461. would quietly hand that flag the other one's authority.
  462. """
  463. def _run_perm(self):
  464. from backend.app.core.permissions import Permission
  465. return Permission.PIPELINES_RUN.value
  466. def test_both_flags_pass(self):
  467. from backend.app.core.auth import _check_apikey_permissions
  468. _check_apikey_permissions(_FakeApiKey(can_queue=True, can_manage_library=True), [self._run_perm()])
  469. @pytest.mark.parametrize(
  470. "flags",
  471. [
  472. {},
  473. {"can_queue": True},
  474. {"can_manage_library": True},
  475. # Neither of the two required flags, however generous the rest.
  476. {"can_read_status": True, "can_control_printer": True, "can_manage_projects": True},
  477. ],
  478. )
  479. def test_a_partial_key_is_refused(self, flags):
  480. """Half the authority is not authority. A queue-only key must not be
  481. able to write into the library through a pipeline, and a library-only
  482. key must not be able to spend filament through one."""
  483. from fastapi import HTTPException
  484. from backend.app.core.auth import _check_apikey_permissions
  485. with pytest.raises(HTTPException) as exc:
  486. _check_apikey_permissions(_FakeApiKey(**flags), [self._run_perm()])
  487. assert exc.value.status_code == 403
  488. def test_the_403_names_every_missing_flag(self):
  489. """Reporting only the first would send the operator round the loop
  490. twice, ticking one box per refusal with no hint a second is needed."""
  491. from fastapi import HTTPException
  492. from backend.app.core.auth import _check_apikey_permissions
  493. with pytest.raises(HTTPException) as exc:
  494. _check_apikey_permissions(_FakeApiKey(), [self._run_perm()])
  495. assert "can_queue" in exc.value.detail
  496. assert "can_manage_library" in exc.value.detail
  497. with pytest.raises(HTTPException) as exc:
  498. _check_apikey_permissions(_FakeApiKey(can_queue=True), [self._run_perm()])
  499. assert "can_manage_library" in exc.value.detail
  500. assert "can_queue" not in exc.value.detail
  501. def test_single_scope_message_is_unchanged(self):
  502. """Existing keys' 403 text is documented in the wiki and matched by
  503. other tests; multi-scope support must not reword the common case."""
  504. from fastapi import HTTPException
  505. from backend.app.core.auth import _check_apikey_permissions
  506. from backend.app.core.permissions import Permission
  507. with pytest.raises(HTTPException) as exc:
  508. _check_apikey_permissions(_FakeApiKey(), [Permission.QUEUE_CREATE.value])
  509. assert exc.value.detail == "API key does not have 'can_queue' permission"
  510. def test_require_any_still_passes_on_a_different_permission(self):
  511. """An any-of route must not be blocked by the multi-scope member when
  512. the key satisfies one of the others."""
  513. from backend.app.core.auth import _check_apikey_permissions
  514. from backend.app.core.permissions import Permission
  515. _check_apikey_permissions(
  516. _FakeApiKey(can_read_status=True),
  517. [self._run_perm(), Permission.PRINTERS_READ.value],
  518. require_any=True,
  519. )
  520. def test_effective_permissions_agree_with_the_gate(self):
  521. """``/auth/me`` reports what a key can do by walking the same mapping.
  522. If it ignored the second flag it would advertise pipelines:run to a
  523. key the gate then refuses — the drift #1894 was about."""
  524. from backend.app.core.auth import apikey_effective_permissions
  525. assert self._run_perm() not in apikey_effective_permissions(_FakeApiKey(can_queue=True))
  526. assert self._run_perm() not in apikey_effective_permissions(_FakeApiKey(can_manage_library=True))
  527. assert self._run_perm() in apikey_effective_permissions(_FakeApiKey(can_queue=True, can_manage_library=True))
  528. def test_effective_permissions_still_narrow_to_the_owner(self):
  529. """A multi-scope permission is no exception to owner narrowing: both
  530. flags set is still capped by what the key's owner may do."""
  531. class _Owner:
  532. def __init__(self, holds):
  533. self._holds = holds
  534. def has_permission(self, perm):
  535. return perm in self._holds
  536. from backend.app.core.auth import apikey_effective_permissions
  537. key = _FakeApiKey(can_queue=True, can_manage_library=True)
  538. assert self._run_perm() not in apikey_effective_permissions(key, _Owner(set()))
  539. assert self._run_perm() in apikey_effective_permissions(key, _Owner({self._run_perm()}))
  540. class TestPipelineRoutesAcceptApiKeys:
  541. """End-to-end: the routes themselves, not just the mapping.
  542. Before this fix every pipeline endpoint answered 403 "API keys cannot be
  543. used for administrative operations", because PR A parked all three
  544. permissions on the denylist until the run dispatch landed. It landed in
  545. PR C.
  546. """
  547. @pytest.fixture
  548. async def auth_on(self, db_session):
  549. from backend.app.models.settings import Settings
  550. db_session.add(Settings(key="auth_enabled", value="true"))
  551. await db_session.commit()
  552. async def _key(self, db_session, **flags):
  553. from backend.app.core.auth import generate_api_key
  554. from backend.app.models.api_key import APIKey
  555. full_key, key_hash, key_prefix = generate_api_key()
  556. db_session.add(
  557. APIKey(
  558. name="pipeline-key",
  559. key_hash=key_hash,
  560. key_prefix=key_prefix,
  561. enabled=True,
  562. **{"can_read_status": False, "can_queue": False, "can_manage_library": False, **flags},
  563. )
  564. )
  565. await db_session.commit()
  566. return full_key
  567. @pytest.mark.asyncio
  568. @pytest.mark.integration
  569. async def test_a_read_key_can_list_pipelines(self, async_client: AsyncClient, db_session, auth_on):
  570. key = await self._key(db_session, can_read_status=True)
  571. resp = await async_client.get("/api/v1/slicer-pipelines/", headers={"X-API-Key": key})
  572. assert resp.status_code == 200
  573. @pytest.mark.asyncio
  574. @pytest.mark.integration
  575. async def test_a_read_key_can_list_runs(self, async_client: AsyncClient, db_session, auth_on):
  576. key = await self._key(db_session, can_read_status=True)
  577. resp = await async_client.get("/api/v1/pipeline-runs", headers={"X-API-Key": key})
  578. assert resp.status_code == 200
  579. @pytest.mark.asyncio
  580. @pytest.mark.integration
  581. async def test_a_read_key_cannot_author_a_pipeline(self, async_client: AsyncClient, db_session, auth_on):
  582. """PIPELINES_WRITE stays admin-only — reading pipelines must not imply
  583. rewriting the slicer settings a run will act on."""
  584. key = await self._key(db_session, can_read_status=True, can_queue=True, can_manage_library=True)
  585. resp = await async_client.post(
  586. "/api/v1/slicer-pipelines/",
  587. json={"name": "x"},
  588. headers={"X-API-Key": key},
  589. )
  590. assert resp.status_code == 403
  591. assert "administrative operations" in resp.json()["detail"]
  592. @pytest.mark.asyncio
  593. @pytest.mark.integration
  594. async def test_a_queue_only_key_cannot_run_a_pipeline(self, async_client: AsyncClient, db_session, auth_on):
  595. key = await self._key(db_session, can_read_status=True, can_queue=True)
  596. resp = await async_client.post(
  597. "/api/v1/slicer-pipelines/1/run",
  598. json={"source_library_file_id": 1},
  599. headers={"X-API-Key": key},
  600. )
  601. assert resp.status_code == 403
  602. assert "can_manage_library" in resp.json()["detail"]
  603. @pytest.mark.asyncio
  604. @pytest.mark.integration
  605. async def test_a_fully_scoped_key_gets_past_the_gate(self, async_client: AsyncClient, db_session, auth_on):
  606. """404 for the missing pipeline, not 403 — the permission check is
  607. what this asserts, and only a request that cleared it reaches the
  608. lookup."""
  609. key = await self._key(db_session, can_read_status=True, can_queue=True, can_manage_library=True)
  610. resp = await async_client.post(
  611. "/api/v1/slicer-pipelines/999999/run",
  612. json={"source_library_file_id": 1},
  613. headers={"X-API-Key": key},
  614. )
  615. assert resp.status_code == 404