|
| 1 | +# Copyright 2026 Quantum Pipes Technologies, LLC |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +"""Role-Based Access Control (RBAC) for qp-vault. |
| 5 | +
|
| 6 | +Defines three roles with escalating permissions: |
| 7 | +- READER: search, get, list, verify, health, status |
| 8 | +- WRITER: all reader ops + add, update, delete, replace, transition, supersede |
| 9 | +- ADMIN: all writer ops + export, import, config, create_collection |
| 10 | +
|
| 11 | +Enforcement is at the Vault API boundary. Storage backends are not |
| 12 | +role-aware; RBAC is enforced before operations reach storage. |
| 13 | +""" |
| 14 | + |
| 15 | +from __future__ import annotations |
| 16 | + |
| 17 | +from enum import StrEnum |
| 18 | + |
| 19 | +from qp_vault.exceptions import VaultError |
| 20 | + |
| 21 | + |
| 22 | +class Role(StrEnum): |
| 23 | + """Vault access roles.""" |
| 24 | + |
| 25 | + READER = "reader" |
| 26 | + """Search, get, list, verify, health, status.""" |
| 27 | + |
| 28 | + WRITER = "writer" |
| 29 | + """All reader ops + add, update, delete, replace, transition, supersede.""" |
| 30 | + |
| 31 | + ADMIN = "admin" |
| 32 | + """All writer ops + export, import, config, create_collection.""" |
| 33 | + |
| 34 | + |
| 35 | +# Permission matrix: operation -> minimum required role |
| 36 | +PERMISSIONS: dict[str, Role] = { |
| 37 | + # Reader operations |
| 38 | + "search": Role.READER, |
| 39 | + "get": Role.READER, |
| 40 | + "get_content": Role.READER, |
| 41 | + "list": Role.READER, |
| 42 | + "verify": Role.READER, |
| 43 | + "health": Role.READER, |
| 44 | + "status": Role.READER, |
| 45 | + "get_provenance": Role.READER, |
| 46 | + "chain": Role.READER, |
| 47 | + "expiring": Role.READER, |
| 48 | + "list_collections": Role.READER, |
| 49 | + "search_with_facets": Role.READER, |
| 50 | + # Writer operations |
| 51 | + "add": Role.WRITER, |
| 52 | + "add_batch": Role.WRITER, |
| 53 | + "update": Role.WRITER, |
| 54 | + "delete": Role.WRITER, |
| 55 | + "replace": Role.WRITER, |
| 56 | + "transition": Role.WRITER, |
| 57 | + "supersede": Role.WRITER, |
| 58 | + "set_adversarial_status": Role.WRITER, |
| 59 | + # Admin operations |
| 60 | + "export_vault": Role.ADMIN, |
| 61 | + "import_vault": Role.ADMIN, |
| 62 | + "create_collection": Role.ADMIN, |
| 63 | + "export_proof": Role.ADMIN, |
| 64 | +} |
| 65 | + |
| 66 | +# Role hierarchy: higher roles include all lower permissions |
| 67 | +ROLE_HIERARCHY: dict[Role, int] = { |
| 68 | + Role.READER: 1, |
| 69 | + Role.WRITER: 2, |
| 70 | + Role.ADMIN: 3, |
| 71 | +} |
| 72 | + |
| 73 | + |
| 74 | +def check_permission(role: Role | str | None, operation: str) -> None: |
| 75 | + """Check if a role has permission for an operation. |
| 76 | +
|
| 77 | + Args: |
| 78 | + role: The caller's role. None means no RBAC (all operations allowed). |
| 79 | + operation: The operation name (e.g., "add", "search"). |
| 80 | +
|
| 81 | + Raises: |
| 82 | + VaultError: If the role lacks permission. |
| 83 | + """ |
| 84 | + if role is None: |
| 85 | + return # No RBAC configured |
| 86 | + |
| 87 | + role_enum = Role(role) if isinstance(role, str) else role |
| 88 | + required = PERMISSIONS.get(operation) |
| 89 | + |
| 90 | + if required is None: |
| 91 | + return # Unknown operation, allow by default |
| 92 | + |
| 93 | + caller_level = ROLE_HIERARCHY.get(role_enum, 0) |
| 94 | + required_level = ROLE_HIERARCHY.get(required, 0) |
| 95 | + |
| 96 | + if caller_level < required_level: |
| 97 | + raise VaultError( |
| 98 | + f"Permission denied: {operation} requires {required.value} role " |
| 99 | + f"(current: {role_enum.value})" |
| 100 | + ) |
0 commit comments