mirror of
https://github.com/simonw/datasette.git
synced 2025-12-10 16:51:24 +01:00
Implement resource-based permission system with SQL-driven access control
This introduces a new hierarchical permission system that uses SQL queries
for efficient permission checking across resources. The system replaces the
older permission_allowed() pattern with a more flexible resource-based
approach.
Core changes:
- New Resource ABC and Action dataclass in datasette/permissions.py
* Resources represent hierarchical entities (instance, database, table)
* Each resource type implements resources_sql() to list all instances
* Actions define operations on resources with cascading rules
- New plugin hook: register_actions(datasette)
* Plugins register actions with their associated resource types
* Replaces register_permissions() and register_resource_types()
* See docs/plugin_hooks.rst for full documentation
- Three new Datasette methods for permission checks:
* allowed_resources(action, actor) - returns list[Resource]
* allowed_resources_with_reasons(action, actor) - for debugging
* allowed(action, resource, actor) - checks single resource
* All use SQL for filtering, never Python iteration
- New /-/tables endpoint (TablesView)
* Returns JSON list of tables user can view
* Supports ?q= parameter for regex filtering
* Format: {"matches": [{"name": "db/table", "url": "/db/table"}]}
* Respects all permission rules from configuration and plugins
- SQL-based permission evaluation (datasette/utils/actions_sql.py)
* Cascading rules: child-level → parent-level → global-level
* DENY beats ALLOW at same specificity
* Uses CTEs for efficient SQL-only filtering
* Combines permission_resources_sql() hook results
- Default actions in datasette/default_actions.py
* InstanceResource, DatabaseResource, TableResource, QueryResource
* Core actions: view-instance, view-database, view-table, etc.
- Fixed default_permissions.py to handle database-level allow blocks
* Now creates parent-level rules for view-table action
* Fixes: datasette ... -s databases.fixtures.allow.id root
Documentation:
- Comprehensive register_actions() hook documentation
- Detailed resources_sql() method explanation
- /-/tables endpoint documentation in docs/introspection.rst
- Deprecated register_permissions() with migration guide
Tests:
- tests/test_actions_sql.py: 7 tests for core permission API
- tests/test_tables_endpoint.py: 13 tests for /-/tables endpoint
- All 118 documentation tests pass
- Tests verify SQL does filtering (not Python)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
e951f7e81f
commit
2b879e462f
14 changed files with 2185 additions and 2 deletions
317
tests/test_actions_sql.py
Normal file
317
tests/test_actions_sql.py
Normal file
|
|
@ -0,0 +1,317 @@
|
|||
"""
|
||||
Tests for the new Resource-based permission system.
|
||||
|
||||
These tests verify:
|
||||
1. The new Datasette.allowed_resources() method
|
||||
2. The new Datasette.allowed() method
|
||||
3. The new Datasette.allowed_resources_with_reasons() method
|
||||
4. That SQL does the heavy lifting (no Python filtering)
|
||||
"""
|
||||
|
||||
import pytest
|
||||
import pytest_asyncio
|
||||
from datasette.app import Datasette
|
||||
from datasette.plugins import pm
|
||||
from datasette.utils.permissions import PluginSQL
|
||||
from datasette.default_actions import TableResource
|
||||
from datasette import hookimpl
|
||||
|
||||
|
||||
# Test plugin that provides permission rules
|
||||
class PermissionRulesPlugin:
|
||||
def __init__(self, rules_callback):
|
||||
self.rules_callback = rules_callback
|
||||
|
||||
@hookimpl
|
||||
def permission_resources_sql(self, datasette, actor, action):
|
||||
"""Return permission rules based on the callback"""
|
||||
return self.rules_callback(datasette, actor, action)
|
||||
|
||||
|
||||
@pytest_asyncio.fixture
|
||||
async def test_ds():
|
||||
"""Create a test Datasette instance with sample data"""
|
||||
ds = Datasette()
|
||||
await ds.invoke_startup()
|
||||
|
||||
# Add test databases with some tables
|
||||
db = ds.add_memory_database("analytics")
|
||||
await db.execute_write("CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY)")
|
||||
await db.execute_write("CREATE TABLE IF NOT EXISTS events (id INTEGER PRIMARY KEY)")
|
||||
await db.execute_write(
|
||||
"CREATE TABLE IF NOT EXISTS sensitive (id INTEGER PRIMARY KEY)"
|
||||
)
|
||||
|
||||
db2 = ds.add_memory_database("production")
|
||||
await db2.execute_write(
|
||||
"CREATE TABLE IF NOT EXISTS customers (id INTEGER PRIMARY KEY)"
|
||||
)
|
||||
await db2.execute_write(
|
||||
"CREATE TABLE IF NOT EXISTS orders (id INTEGER PRIMARY KEY)"
|
||||
)
|
||||
|
||||
# Refresh schemas to populate catalog_tables in internal database
|
||||
await ds._refresh_schemas()
|
||||
|
||||
return ds
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_allowed_resources_global_allow(test_ds):
|
||||
"""Test allowed_resources() with a global allow rule"""
|
||||
|
||||
def rules_callback(datasette, actor, action):
|
||||
if actor and actor.get("id") == "alice":
|
||||
sql = "SELECT NULL AS parent, NULL AS child, 1 AS allow, 'global: alice has access' AS reason"
|
||||
return PluginSQL(source="test", sql=sql, params={})
|
||||
return None
|
||||
|
||||
plugin = PermissionRulesPlugin(rules_callback)
|
||||
pm.register(plugin, name="test_plugin")
|
||||
|
||||
try:
|
||||
# Use the new allowed_resources() method
|
||||
tables = await test_ds.allowed_resources("view-table", {"id": "alice"})
|
||||
|
||||
# Alice should see all tables
|
||||
assert len(tables) == 5
|
||||
assert all(isinstance(t, TableResource) for t in tables)
|
||||
|
||||
# Check specific tables are present
|
||||
table_set = set((t.parent, t.child) for t in tables)
|
||||
assert ("analytics", "events") in table_set
|
||||
assert ("analytics", "users") in table_set
|
||||
assert ("analytics", "sensitive") in table_set
|
||||
assert ("production", "customers") in table_set
|
||||
assert ("production", "orders") in table_set
|
||||
|
||||
finally:
|
||||
pm.unregister(plugin, name="test_plugin")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_allowed_specific_resource(test_ds):
|
||||
"""Test allowed() method checks specific resource efficiently"""
|
||||
|
||||
def rules_callback(datasette, actor, action):
|
||||
if actor and actor.get("role") == "analyst":
|
||||
# Allow analytics database, deny everything else (global deny)
|
||||
sql = """
|
||||
SELECT NULL AS parent, NULL AS child, 0 AS allow, 'global deny' AS reason
|
||||
UNION ALL
|
||||
SELECT 'analytics' AS parent, NULL AS child, 1 AS allow, 'analyst access' AS reason
|
||||
"""
|
||||
return PluginSQL(source="test", sql=sql, params={})
|
||||
return None
|
||||
|
||||
plugin = PermissionRulesPlugin(rules_callback)
|
||||
pm.register(plugin, name="test_plugin")
|
||||
|
||||
try:
|
||||
actor = {"id": "bob", "role": "analyst"}
|
||||
|
||||
# Check specific resources using allowed()
|
||||
# This should use SQL WHERE clause, not fetch all resources
|
||||
assert await test_ds.allowed(
|
||||
"view-table", TableResource("analytics", "users"), actor
|
||||
)
|
||||
assert await test_ds.allowed(
|
||||
"view-table", TableResource("analytics", "events"), actor
|
||||
)
|
||||
assert not await test_ds.allowed(
|
||||
"view-table", TableResource("production", "orders"), actor
|
||||
)
|
||||
|
||||
finally:
|
||||
pm.unregister(plugin, name="test_plugin")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_allowed_resources_with_reasons(test_ds):
|
||||
"""Test allowed_resources_with_reasons() exposes debugging info"""
|
||||
|
||||
def rules_callback(datasette, actor, action):
|
||||
if actor and actor.get("role") == "analyst":
|
||||
sql = """
|
||||
SELECT 'analytics' AS parent, NULL AS child, 1 AS allow,
|
||||
'parent: analyst access to analytics' AS reason
|
||||
UNION ALL
|
||||
SELECT 'analytics' AS parent, 'sensitive' AS child, 0 AS allow,
|
||||
'child: sensitive data denied' AS reason
|
||||
"""
|
||||
return PluginSQL(source="test", sql=sql, params={})
|
||||
return None
|
||||
|
||||
plugin = PermissionRulesPlugin(rules_callback)
|
||||
pm.register(plugin, name="test_plugin")
|
||||
|
||||
try:
|
||||
# Use allowed_resources_with_reasons to get debugging info
|
||||
allowed = await test_ds.allowed_resources_with_reasons(
|
||||
"view-table", {"id": "bob", "role": "analyst"}
|
||||
)
|
||||
|
||||
# Should get analytics tables except sensitive
|
||||
assert len(allowed) >= 2 # At least users and events
|
||||
|
||||
# Check we can access both resource and reason
|
||||
for item in allowed:
|
||||
assert isinstance(item.resource, TableResource)
|
||||
assert isinstance(item.reason, str)
|
||||
if item.resource.parent == "analytics":
|
||||
# Should mention parent-level reason
|
||||
assert "analyst access" in item.reason.lower()
|
||||
|
||||
finally:
|
||||
pm.unregister(plugin, name="test_plugin")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_child_deny_overrides_parent_allow(test_ds):
|
||||
"""Test that child-level DENY beats parent-level ALLOW"""
|
||||
|
||||
def rules_callback(datasette, actor, action):
|
||||
if actor and actor.get("role") == "analyst":
|
||||
sql = """
|
||||
SELECT 'analytics' AS parent, NULL AS child, 1 AS allow,
|
||||
'parent: allow analytics' AS reason
|
||||
UNION ALL
|
||||
SELECT 'analytics' AS parent, 'sensitive' AS child, 0 AS allow,
|
||||
'child: deny sensitive' AS reason
|
||||
"""
|
||||
return PluginSQL(source="test", sql=sql, params={})
|
||||
return None
|
||||
|
||||
plugin = PermissionRulesPlugin(rules_callback)
|
||||
pm.register(plugin, name="test_plugin")
|
||||
|
||||
try:
|
||||
actor = {"id": "bob", "role": "analyst"}
|
||||
tables = await test_ds.allowed_resources("view-table", actor)
|
||||
|
||||
# Should see analytics tables except sensitive
|
||||
analytics_tables = [t for t in tables if t.parent == "analytics"]
|
||||
assert len(analytics_tables) >= 2
|
||||
|
||||
table_names = {t.child for t in analytics_tables}
|
||||
assert "users" in table_names
|
||||
assert "events" in table_names
|
||||
assert "sensitive" not in table_names
|
||||
|
||||
# Verify with allowed() method
|
||||
assert await test_ds.allowed(
|
||||
"view-table", TableResource("analytics", "users"), actor
|
||||
)
|
||||
assert not await test_ds.allowed(
|
||||
"view-table", TableResource("analytics", "sensitive"), actor
|
||||
)
|
||||
|
||||
finally:
|
||||
pm.unregister(plugin, name="test_plugin")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_child_allow_overrides_parent_deny(test_ds):
|
||||
"""Test that child-level ALLOW beats parent-level DENY"""
|
||||
|
||||
def rules_callback(datasette, actor, action):
|
||||
if actor and actor.get("id") == "carol":
|
||||
sql = """
|
||||
SELECT 'production' AS parent, NULL AS child, 0 AS allow,
|
||||
'parent: deny production' AS reason
|
||||
UNION ALL
|
||||
SELECT 'production' AS parent, 'orders' AS child, 1 AS allow,
|
||||
'child: carol can see orders' AS reason
|
||||
"""
|
||||
return PluginSQL(source="test", sql=sql, params={})
|
||||
return None
|
||||
|
||||
plugin = PermissionRulesPlugin(rules_callback)
|
||||
pm.register(plugin, name="test_plugin")
|
||||
|
||||
try:
|
||||
actor = {"id": "carol"}
|
||||
tables = await test_ds.allowed_resources("view-table", actor)
|
||||
|
||||
# Should only see production.orders
|
||||
production_tables = [t for t in tables if t.parent == "production"]
|
||||
assert len(production_tables) == 1
|
||||
assert production_tables[0].child == "orders"
|
||||
|
||||
# Verify with allowed() method
|
||||
assert await test_ds.allowed(
|
||||
"view-table", TableResource("production", "orders"), actor
|
||||
)
|
||||
assert not await test_ds.allowed(
|
||||
"view-table", TableResource("production", "customers"), actor
|
||||
)
|
||||
|
||||
finally:
|
||||
pm.unregister(plugin, name="test_plugin")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_resource_equality_and_hashing(test_ds):
|
||||
"""Test that Resource instances support equality and hashing"""
|
||||
|
||||
# Create some resources
|
||||
r1 = TableResource("analytics", "users")
|
||||
r2 = TableResource("analytics", "users")
|
||||
r3 = TableResource("analytics", "events")
|
||||
|
||||
# Test equality
|
||||
assert r1 == r2
|
||||
assert r1 != r3
|
||||
|
||||
# Test they can be used in sets
|
||||
resource_set = {r1, r2, r3}
|
||||
assert len(resource_set) == 2 # r1 and r2 are the same
|
||||
|
||||
# Test they can be used as dict keys
|
||||
resource_dict = {r1: "data1", r3: "data2"}
|
||||
assert resource_dict[r2] == "data1" # r2 same as r1
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sql_does_filtering_not_python(test_ds):
|
||||
"""
|
||||
Verify that allowed() uses SQL WHERE clause, not Python filtering.
|
||||
|
||||
This test doesn't actually verify the SQL itself (that would require
|
||||
query introspection), but it demonstrates the API contract.
|
||||
"""
|
||||
|
||||
def rules_callback(datasette, actor, action):
|
||||
# Deny everything by default, allow only analytics.users specifically
|
||||
sql = """
|
||||
SELECT NULL AS parent, NULL AS child, 0 AS allow,
|
||||
'global deny' AS reason
|
||||
UNION ALL
|
||||
SELECT 'analytics' AS parent, 'users' AS child, 1 AS allow,
|
||||
'specific allow' AS reason
|
||||
"""
|
||||
return PluginSQL(source="test", sql=sql, params={})
|
||||
|
||||
plugin = PermissionRulesPlugin(rules_callback)
|
||||
pm.register(plugin, name="test_plugin")
|
||||
|
||||
try:
|
||||
actor = {"id": "dave"}
|
||||
|
||||
# allowed() should execute a targeted SQL query
|
||||
# NOT fetch all resources and filter in Python
|
||||
assert await test_ds.allowed(
|
||||
"view-table", TableResource("analytics", "users"), actor
|
||||
)
|
||||
assert not await test_ds.allowed(
|
||||
"view-table", TableResource("analytics", "events"), actor
|
||||
)
|
||||
|
||||
# allowed_resources() should also use SQL filtering
|
||||
tables = await test_ds.allowed_resources("view-table", actor)
|
||||
assert len(tables) == 1
|
||||
assert tables[0].parent == "analytics"
|
||||
assert tables[0].child == "users"
|
||||
|
||||
finally:
|
||||
pm.unregister(plugin, name="test_plugin")
|
||||
Loading…
Add table
Add a link
Reference in a new issue