Compare commits

...

8 commits

Author SHA1 Message Date
Simon Willison
481df7ff6d Shorten link text in changelog 2026-07-14 09:31:28 -07:00
Simon Willison
2ffd8a860e Release 1.0a37
Refs #2831, #2832, #2841, #2842, #2843, #2846
2026-07-14 09:28:29 -07:00
Simon Willison
8b7c942d5e Major performance boost for SQL permissions, closes #2832 2026-07-14 09:18:51 -07:00
TowyTowy
591b909a4d
Escape table names with [square] brackets, refs #2431 (#2846)
Several internal helpers quoted table names using SQLite [bracket]
identifiers built with an f-string, e.g. PRAGMA foreign_key_list([{table}]).
Bracket quoting cannot escape a "]" character, so any table whose name
contains "]" (for example "[foo]" or "foo]") produced
"sqlite3.OperationalError: unrecognized token" - crashing schema
introspection at startup and 500-ing the table page.

Switch these call sites to the existing escape_sqlite() helper, which uses
"double quote" quoting with correct "" escaping (the same approach already
used elsewhere in the codebase and in the test suite):

- utils/internal_db.py: PRAGMA foreign_key_list / index_list
- utils/__init__.py: get_outbound_foreign_keys
- database.py: table_counts count query
- facets.py: default "select * from" SQL

Added a regression test covering table names with "]" characters.

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-14 08:53:45 -07:00
Simon Willison
9cfc252394
Make internal catalog refresh atomic
Refs #2831
2026-07-14 08:41:27 -07:00
Simon Willison
7f0a8b38ae
Better permission debug tools and documentation
Closes #2841
2026-07-14 08:40:07 -07:00
Simon Willison
10088dfa1d
execute_write(transaction=False) parameter, plus fix for errors inside tasks
Ensure a write inside a failing Datasette task never becomes visible. Refs #2831
2026-07-13 22:42:44 -07:00
Simon Willison
ccace40e5a
/-/plugins.json is now an array of objects again (#2843)
Reverts the object envelope introduced in 1.0a36 for this endpoint -
it once again returns a top-level JSON array of plugin objects.

Closes #2842


Claude-Session: https://claude.ai/code/session_012TYc1NTBK4zEjabB3u2zqu

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-13 21:19:04 -07:00
27 changed files with 1202 additions and 476 deletions

View file

@ -753,19 +753,7 @@ class Datasette:
# Compare schema versions to see if we should skip it # Compare schema versions to see if we should skip it
if schema_version == current_schema_versions.get(database_name): if schema_version == current_schema_versions.get(database_name):
continue continue
placeholders = "(?, ?, ?, ?)" await populate_schema_tables(internal_db, db, schema_version)
values = [database_name, str(db.path), db.is_memory, schema_version]
if db.path is None:
placeholders = "(?, null, ?, ?)"
values = [database_name, db.is_memory, schema_version]
await internal_db.execute_write(
"""
INSERT OR REPLACE INTO catalog_databases (database_name, path, is_memory, schema_version)
VALUES {}
""".format(placeholders),
values,
)
await populate_schema_tables(internal_db, db)
@property @property
def urls(self): def urls(self):
@ -2575,7 +2563,7 @@ class Datasette:
JsonDataView.as_view( JsonDataView.as_view(
self, self,
"plugins.json", "plugins.json",
lambda request: {"plugins": self._plugins(request)}, self._plugins,
needs_request=True, needs_request=True,
), ),
r"/-/plugins(\.(?P<format>json))?$", r"/-/plugins(\.(?P<format>json))?$",

View file

@ -17,6 +17,7 @@ from .utils import (
detect_fts, detect_fts,
detect_primary_keys, detect_primary_keys,
detect_spatialite, detect_spatialite,
escape_sqlite,
get_all_foreign_keys, get_all_foreign_keys,
get_outbound_foreign_keys, get_outbound_foreign_keys,
md5_not_usedforsecurity, md5_not_usedforsecurity,
@ -246,6 +247,7 @@ class Database:
request=None, request=None,
return_all=False, return_all=False,
returning_limit=EXECUTE_WRITE_RETURNING_LIMIT, returning_limit=EXECUTE_WRITE_RETURNING_LIMIT,
transaction=True,
): ):
self._check_not_closed() self._check_not_closed()
if returning_limit < 0: if returning_limit < 0:
@ -258,7 +260,9 @@ class Database:
) )
with trace("sql", database=self.name, sql=sql.strip(), params=params): with trace("sql", database=self.name, sql=sql.strip(), params=params):
results = await self.execute_write_fn(_inner, block=block, request=request) results = await self.execute_write_fn(
_inner, block=block, request=request, transaction=transaction
)
return results return results
async def execute_write_script(self, sql, block=True, request=None): async def execute_write_script(self, sql, block=True, request=None):
@ -348,6 +352,7 @@ class Database:
self.ds._prepare_connection(self._write_connection, self.name) self.ds._prepare_connection(self._write_connection, self.name)
if transaction: if transaction:
with self._write_connection: with self._write_connection:
self._write_connection.execute("BEGIN IMMEDIATE")
result = fn(self._write_connection) result = fn(self._write_connection)
else: else:
result = fn(self._write_connection) result = fn(self._write_connection)
@ -477,6 +482,7 @@ class Database:
try: try:
if task.transaction: if task.transaction:
with conn: with conn:
conn.execute("BEGIN IMMEDIATE")
result = task.fn(conn) result = task.fn(conn)
else: else:
result = task.fn(conn) result = task.fn(conn)
@ -603,7 +609,7 @@ class Database:
try: try:
table_count = ( table_count = (
await self.execute( await self.execute(
f"select count(*) from (select * from [{table}] limit {self.count_limit + 1})", f"select count(*) from (select * from {escape_sqlite(table)} limit {self.count_limit + 1})",
custom_time_limit=limit, custom_time_limit=limit,
) )
).rows[0][0] ).rows[0][0]

View file

@ -96,6 +96,10 @@ class ConfigPermissionProcessor:
"""Evaluate an allow block against the current actor.""" """Evaluate an allow block against the current actor."""
if allow_block is None: if allow_block is None:
return None return None
# Values passed using ``-s permissions.* 1`` or ``0`` are parsed as
# integers, but should retain the CLI's boolean 1/0 behavior.
if isinstance(allow_block, int) and allow_block in (0, 1):
return bool(allow_block)
return actor_matches_allow(self.actor, allow_block) return actor_matches_allow(self.actor, allow_block)
def is_in_restriction_allowlist( def is_in_restriction_allowlist(

View file

@ -85,7 +85,7 @@ class Facet:
self.database = database self.database = database
# For foreign key expansion. Can be None for e.g. stored SQL queries: # For foreign key expansion. Can be None for e.g. stored SQL queries:
self.table = table self.table = table
self.sql = sql or f"select * from [{table}]" self.sql = sql or f"select * from {escape_sqlite(table)}"
self.params = params or [] self.params = params or []
self.table_config = table_config self.table_config = table_config
# row_count can be None, in which case we calculate it ourselves: # row_count can be None, in which case we calculate it ourselves:

View file

@ -6,8 +6,20 @@
padding: 1.5em; padding: 1.5em;
margin-bottom: 2em; margin-bottom: 2em;
} }
.permission-form form {
max-width: 60rem;
}
.permission-form-grid {
display: grid;
gap: 1.5rem;
grid-template-columns: repeat(2, minmax(0, 1fr));
}
.permission-form-result {
margin-top: 1rem;
max-width: 60rem;
}
.form-section { .form-section {
margin-bottom: 1em; margin-bottom: 1.25em;
} }
.form-section label { .form-section label {
display: block; display: block;
@ -15,22 +27,51 @@
font-weight: bold; font-weight: bold;
} }
.form-section input[type="text"], .form-section input[type="text"],
.form-section select { .form-section input[type="number"],
width: 100%; .form-section select,
max-width: 500px; .permission-textarea {
padding: 0.5em; background-color: #fff;
border: 1px solid #aaa;
border-radius: 4px;
box-sizing: border-box; box-sizing: border-box;
border: 1px solid #ccc; box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.08);
border-radius: 3px; color: #222;
font-family: inherit;
font-size: 1rem;
line-height: 1.4;
max-width: none;
width: 100%;
}
.form-section input[type="text"] {
height: 3rem;
padding: 0.6rem 0.75rem;
}
.form-section input[type="number"] {
height: 3rem;
max-width: 7rem;
padding: 0.6rem 0.75rem;
}
.form-section select {
height: 3rem;
padding: 0.6rem 0.75rem;
}
.permission-textarea {
font-family: monospace;
min-height: 12rem;
padding: 0.75rem;
resize: vertical;
} }
.form-section input[type="text"]:focus, .form-section input[type="text"]:focus,
.form-section select:focus { .form-section input[type="number"]:focus,
outline: 2px solid #0066cc; .form-section select:focus,
.permission-textarea:focus {
border-color: #0066cc; border-color: #0066cc;
box-shadow: 0 0 0 3px rgba(0, 102, 204, 0.18);
outline: none;
} }
.form-section small { .form-section small {
display: block; display: block;
margin-top: 0.3em; margin-top: 0.45em;
color: #666; color: #666;
} }
.form-actions { .form-actions {
@ -142,4 +183,9 @@
text-align: center; text-align: center;
color: #666; color: #666;
} }
@media only screen and (max-width: 576px) {
.permission-form-grid {
grid-template-columns: minmax(0, 1fr);
}
}
</style> </style>

View file

@ -44,10 +44,10 @@
</style> </style>
<nav class="permissions-debug-tabs"> <nav class="permissions-debug-tabs">
<a href="{{ urls.path('-/permissions') }}" {% if current_tab == "permissions" %}class="active"{% endif %}>Playground</a> <a href="{{ urls.path('-/check') }}{{ query_string }}" {% if current_tab == "check" %}class="active"{% endif %}>Explain</a>
<a href="{{ urls.path('-/check') }}{{ query_string }}" {% if current_tab == "check" %}class="active"{% endif %}>Check</a> <a href="{{ urls.path('-/allowed') }}{{ query_string }}" {% if current_tab == "allowed" %}class="active"{% endif %}>Access map</a>
<a href="{{ urls.path('-/allowed') }}{{ query_string }}" {% if current_tab == "allowed" %}class="active"{% endif %}>Allowed</a> <a href="{{ urls.path('-/rules') }}{{ query_string }}" {% if current_tab == "rules" %}class="active"{% endif %}>Rule explorer</a>
<a href="{{ urls.path('-/rules') }}{{ query_string }}" {% if current_tab == "rules" %}class="active"{% endif %}>Rules</a> <a href="{{ urls.path('-/permissions') }}" {% if current_tab == "permissions" %}class="active"{% endif %}>Activity</a>
<a href="{{ urls.path('-/actions') }}" {% if current_tab == "actions" %}class="active"{% endif %}>Actions</a> <a href="{{ urls.path('-/actions') }}" {% if current_tab == "actions" %}class="active"{% endif %}>Actions</a>
<a href="{{ urls.path('-/allow-debug') }}" {% if current_tab == "allow_debug" %}class="active"{% endif %}>Allow debug</a> <a href="{{ urls.path('-/allow-debug') }}" {% if current_tab == "allow_debug" %}class="active"{% endif %}>Allow debug</a>
</nav> </nav>

View file

@ -3,29 +3,11 @@
{% block title %}Debug allow rules{% endblock %} {% block title %}Debug allow rules{% endblock %}
{% block extra_head %} {% block extra_head %}
{% include "_permission_ui_styles.html" %}
<style> <style>
textarea {
height: 10em;
width: 95%;
box-sizing: border-box;
padding: 0.5em;
border: 2px dotted black;
}
.two-col {
display: inline-block;
width: 48%;
}
.two-col label {
width: 48%;
}
p.message-warning { p.message-warning {
white-space: pre-wrap; white-space: pre-wrap;
} }
@media only screen and (max-width: 576px) {
.two-col {
width: 100%;
}
}
</style> </style>
{% endblock %} {% endblock %}
@ -38,24 +20,28 @@ p.message-warning {
<p>Use this tool to try out different actor and allow combinations. See <a href="https://docs.datasette.io/en/stable/authentication.html#defining-permissions-with-allow-blocks">Defining permissions with "allow" blocks</a> for documentation.</p> <p>Use this tool to try out different actor and allow combinations. See <a href="https://docs.datasette.io/en/stable/authentication.html#defining-permissions-with-allow-blocks">Defining permissions with "allow" blocks</a> for documentation.</p>
<form class="core" action="{{ urls.path('-/allow-debug') }}" method="get" style="margin-bottom: 1em"> <div class="permission-form">
<div class="two-col"> <form class="core" action="{{ urls.path('-/allow-debug') }}" method="get">
<p><label>Allow block</label></p> <div class="permission-form-grid">
<textarea name="allow">{{ allow_input }}</textarea> <div class="form-section">
</div> <label for="allow-block">Allow block</label>
<div class="two-col"> <textarea class="permission-textarea" id="allow-block" name="allow">{{ allow_input }}</textarea>
<p><label>Actor</label></p> </div>
<textarea name="actor">{{ actor_input }}</textarea> <div class="form-section">
</div> <label for="allow-actor">Actor</label>
<div style="margin-top: 1em;"> <textarea class="permission-textarea" id="allow-actor" name="actor">{{ actor_input }}</textarea>
<input type="submit" value="Apply allow block to actor"> </div>
</div> </div>
</form> <div class="form-actions">
<button type="submit" class="submit-btn">Apply allow block to actor</button>
</div>
</form>
{% if error %}<p class="message-warning">{{ error }}</p>{% endif %} {% if error %}<p class="message-warning permission-form-result">{{ error }}</p>{% endif %}
{% if result == "True" %}<p class="message-info">Result: allow</p>{% endif %} {% if result == "True" %}<p class="message-info permission-form-result">Result: allow</p>{% endif %}
{% if result == "False" %}<p class="message-error">Result: deny</p>{% endif %} {% if result == "False" %}<p class="message-error permission-form-result">Result: deny</p>{% endif %}
</div>
{% endblock %} {% endblock %}

View file

@ -49,7 +49,7 @@
<div class="form-section"> <div class="form-section">
<label for="page_size">Page size:</label> <label for="page_size">Page size:</label>
<input type="number" id="page_size" name="_size" value="50" min="1" max="200" style="max-width: 100px;"> <input type="number" id="page_size" name="_size" value="50" min="1" max="200">
<small>Number of results per page (max 200)</small> <small>Number of results per page (max 200)</small>
</div> </div>

View file

@ -1,6 +1,6 @@
{% extends "base.html" %} {% extends "base.html" %}
{% block title %}Permission Check{% endblock %} {% block title %}Explain a permission decision{% endblock %}
{% block extra_head %} {% block extra_head %}
<script src="{{ static('json-format-highlight-1.0.1.js') }}"></script> <script src="{{ static('json-format-highlight-1.0.1.js') }}"></script>
@ -13,29 +13,35 @@
border-radius: 5px; border-radius: 5px;
} }
#output.allowed { #output.allowed {
background-color: #e8f5e9; background-color: #f3fbf4;
border: 2px solid #4caf50; border: 2px solid #4caf50;
} }
#output.denied { #output.denied {
background-color: #ffebee; background-color: #fff7f7;
border: 2px solid #f44336; border: 2px solid #f44336;
} }
#output h2 { #output h2 {
margin-top: 0; margin-top: 0;
} }
#output .result-badge { #output h3 {
margin-bottom: 0.5em;
}
#output .result-badge,
.effect-badge,
.rule-status {
display: inline-block; display: inline-block;
padding: 0.3em 0.8em; padding: 0.2em 0.5em;
border-radius: 3px; border-radius: 3px;
font-weight: bold; font-weight: bold;
font-size: 1.1em;
} }
#output .allowed-badge { #output .allowed-badge,
background-color: #4caf50; .effect-allow {
background-color: #2e7d32;
color: white; color: white;
} }
#output .denied-badge { #output .denied-badge,
background-color: #f44336; .effect-deny {
background-color: #c62828;
color: white; color: white;
} }
.details-section { .details-section {
@ -48,70 +54,130 @@
.details-section dd { .details-section dd {
margin-left: 1em; margin-left: 1em;
} }
.explanation-section {
background: rgba(255, 255, 255, 0.75);
border: 1px solid #ddd;
border-radius: 4px;
margin-top: 1em;
padding: 0 1em 1em;
}
.rules-table {
border-collapse: collapse;
width: 100%;
}
.rules-table th,
.rules-table td {
border-bottom: 1px solid #ddd;
padding: 0.5em;
text-align: left;
vertical-align: top;
}
.rule-status {
background: #e8f5e9;
color: #1b5e20;
}
.rule-ignored {
background: #eee;
color: #555;
font-weight: normal;
}
.requirement-allowed {
color: #1b5e20;
}
.requirement-denied {
color: #b71c1c;
}
@media only screen and (max-width: 576px) {
.rules-table,
.rules-table tbody,
.rules-table tr,
.rules-table td {
display: block;
}
.rules-table thead {
display: none;
}
.rules-table td::before {
content: attr(data-label) ": ";
font-weight: bold;
}
}
</style> </style>
{% endblock %} {% endblock %}
{% block content %} {% block content %}
<h1>Permission check</h1> <h1>Explain a permission decision</h1>
{% set current_tab = "check" %} {% set current_tab = "check" %}
{% include "_permissions_debug_tabs.html" %} {% include "_permissions_debug_tabs.html" %}
<p>Use this tool to test permission checks for the current actor. It queries the <code>/-/check.json</code> API endpoint.</p> <p>Test an actor, action and resource. The result explains which rules matched, which specificity level won, and whether actor restrictions or required actions changed the verdict.</p>
{% if request.actor %}
<p>Current actor: <strong>{{ request.actor.get("id", "anonymous") }}</strong></p>
{% else %}
<p>Current actor: <strong>anonymous (not logged in)</strong></p>
{% endif %}
<div class="permission-form"> <div class="permission-form">
<form id="check-form" method="get" action="{{ urls.path("-/check") }}"> <form id="check-form" method="get" action="{{ urls.path('-/check') }}">
<div class="form-section"> <div class="form-section">
<label for="action">Action (permission name):</label> <label for="actor">Actor JSON:</label>
<textarea class="permission-textarea" id="actor" name="actor">{{ actor_json }}</textarea>
<small>Use <code>null</code> for an anonymous actor. This actor is simulated; it does not change who you are signed in as.</small>
</div>
<div class="form-section">
<label for="action">Action:</label>
<select id="action" name="action" required> <select id="action" name="action" required>
<option value="">Select an action...</option> <option value="">Select an action...</option>
{% for action_name in sorted_actions %} {% for action in actions %}
<option value="{{ action_name }}">{{ action_name }}</option> <option value="{{ action.name }}">{{ action.name }}{% if action.description %} — {{ action.description }}{% endif %}</option>
{% endfor %} {% endfor %}
</select> </select>
<small>The permission action to check</small> <small id="action-help">The operation to evaluate</small>
</div> </div>
<div class="form-section"> <div class="form-section" id="parent-section">
<label for="parent">Parent resource (optional):</label> <label for="parent">Parent resource:</label>
<input type="text" id="parent" name="parent" placeholder="e.g., database name"> <input type="text" id="parent" name="parent" placeholder="e.g., database name">
<small>For database-level permissions, specify the database name</small> <small>The database or other parent resource</small>
</div> </div>
<div class="form-section"> <div class="form-section" id="child-section">
<label for="child">Child resource (optional):</label> <label for="child">Child resource:</label>
<input type="text" id="child" name="child" placeholder="e.g., table name"> <input type="text" id="child" name="child" placeholder="e.g., table or query name">
<small>For table-level permissions, specify the table name (requires parent)</small> <small>The table, query or other child resource</small>
</div> </div>
<div class="form-actions"> <div class="form-actions">
<button type="submit" class="submit-btn" id="submit-btn">Check Permission</button> <button type="submit" class="submit-btn" id="submit-btn">Explain decision</button>
</div> </div>
</form> </form>
</div> </div>
<div id="output" style="display: none;"> <div id="output" style="display: none;">
<h2>Result: <span class="result-badge" id="result-badge"></span></h2> <h2>Result: <span class="result-badge" id="result-badge"></span></h2>
<p id="result-summary"></p>
<dl class="details-section"> <dl class="details-section">
<dt>Actor:</dt>
<dd><code id="result-actor"></code></dd>
<dt>Action:</dt> <dt>Action:</dt>
<dd id="result-action"></dd> <dd><code id="result-action"></code></dd>
<dt>Resource:</dt>
<dt>Resource Path:</dt> <dd><code id="result-resource"></code></dd>
<dd id="result-resource"></dd>
<dt>Actor ID:</dt>
<dd id="result-actor"></dd>
<div id="additional-details"></div>
</dl> </dl>
<section class="explanation-section">
<h3>Matching rules</h3>
<div id="matching-rules"></div>
</section>
<section class="explanation-section" id="restrictions-section">
<h3>Actor restrictions</h3>
<div id="restriction-results"></div>
</section>
<section class="explanation-section" id="requirements-section">
<h3>Required actions</h3>
<div id="requirement-results"></div>
</section>
<details style="margin-top: 1em;"> <details style="margin-top: 1em;">
<summary style="cursor: pointer; font-weight: bold;">Raw JSON response</summary> <summary style="cursor: pointer; font-weight: bold;">Raw JSON response</summary>
<pre id="raw-json" style="margin-top: 1em; padding: 1em; background-color: #f5f5f5; border: 1px solid #ddd; border-radius: 3px; overflow-x: auto;"></pre> <pre id="raw-json" style="margin-top: 1em; padding: 1em; background-color: #f5f5f5; border: 1px solid #ddd; border-radius: 3px; overflow-x: auto;"></pre>
@ -119,152 +185,134 @@
</div> </div>
<script> <script>
const actions = Object.fromEntries({{ actions|tojson }}.map(action => [action.name, action]));
const form = document.getElementById('check-form'); const form = document.getElementById('check-form');
const output = document.getElementById('output'); const output = document.getElementById('output');
const submitBtn = document.getElementById('submit-btn'); const submitBtn = document.getElementById('submit-btn');
const actionSelect = document.getElementById('action');
function updateResourceFields() {
const action = actions[actionSelect.value];
document.getElementById('parent-section').style.display = action && action.takes_parent ? 'block' : 'none';
document.getElementById('child-section').style.display = action && action.takes_child ? 'block' : 'none';
let help = action && action.description ? action.description : 'The operation to evaluate';
if (action && action.also_requires) {
help += `; also requires ${action.also_requires}`;
}
document.getElementById('action-help').textContent = help;
}
async function performCheck() { async function performCheck() {
submitBtn.disabled = true; submitBtn.disabled = true;
submitBtn.textContent = 'Checking...'; submitBtn.textContent = 'Explaining...';
const params = new URLSearchParams(new FormData(form));
const formData = new FormData(form);
const params = new URLSearchParams();
for (const [key, value] of formData.entries()) {
if (value) {
params.append(key, value);
}
}
try { try {
const response = await fetch('{{ urls.path("-/check.json") }}?' + params.toString(), { const response = await fetch('{{ urls.path("-/check.json") }}?' + params.toString(), {
method: 'GET', headers: {'Accept': 'application/json'}
headers: {
'Accept': 'application/json',
}
}); });
const data = await response.json(); const data = await response.json();
if (response.ok) { if (response.ok) {
displayResult(data); displayResult(data);
} else { } else {
displayError(data); displayError(data);
} }
} catch (error) { } catch (error) {
alert('Error: ' + error.message); displayError({error: error.message});
} finally { } finally {
submitBtn.disabled = false; submitBtn.disabled = false;
submitBtn.textContent = 'Check Permission'; submitBtn.textContent = 'Explain decision';
} }
} }
// Populate form on initial load
(function() {
const params = populateFormFromURL();
const action = params.get('action');
if (action) {
performCheck();
}
})();
function displayResult(data) { function displayResult(data) {
output.style.display = 'block'; output.style.display = 'block';
// Set badge and styling
const resultBadge = document.getElementById('result-badge'); const resultBadge = document.getElementById('result-badge');
if (data.allowed) { output.className = data.allowed ? 'allowed' : 'denied';
output.className = 'allowed'; resultBadge.className = `result-badge ${data.allowed ? 'allowed-badge' : 'denied-badge'}`;
resultBadge.className = 'result-badge allowed-badge'; resultBadge.textContent = data.allowed ? 'ALLOWED ✓' : 'DENIED ✗';
resultBadge.textContent = 'ALLOWED ✓'; document.getElementById('result-summary').textContent = data.explanation.summary;
} else { document.getElementById('result-actor').textContent = data.actor === null ? 'anonymous' : JSON.stringify(data.actor);
output.className = 'denied'; document.getElementById('result-action').textContent = data.action;
resultBadge.className = 'result-badge denied-badge'; document.getElementById('result-resource').textContent = data.resource.path;
resultBadge.textContent = 'DENIED ✗'; displayRules(data.explanation);
} displayRestrictions(data.explanation.restrictions);
displayRequirements(data.explanation.required_actions);
// Basic details
document.getElementById('result-action').textContent = data.action || 'N/A';
document.getElementById('result-resource').textContent = data.resource?.path || '/';
document.getElementById('result-actor').textContent = data.actor_id || 'anonymous';
// Additional details
const additionalDetails = document.getElementById('additional-details');
additionalDetails.innerHTML = '';
if (data.reason !== undefined) {
const dt = document.createElement('dt');
dt.textContent = 'Reason:';
const dd = document.createElement('dd');
dd.textContent = data.reason || 'N/A';
additionalDetails.appendChild(dt);
additionalDetails.appendChild(dd);
}
if (data.source_plugin !== undefined) {
const dt = document.createElement('dt');
dt.textContent = 'Source Plugin:';
const dd = document.createElement('dd');
dd.textContent = data.source_plugin || 'N/A';
additionalDetails.appendChild(dt);
additionalDetails.appendChild(dd);
}
if (data.used_default !== undefined) {
const dt = document.createElement('dt');
dt.textContent = 'Used Default:';
const dd = document.createElement('dd');
dd.textContent = data.used_default ? 'Yes' : 'No';
additionalDetails.appendChild(dt);
additionalDetails.appendChild(dd);
}
if (data.depth !== undefined) {
const dt = document.createElement('dt');
dt.textContent = 'Depth:';
const dd = document.createElement('dd');
dd.textContent = data.depth;
additionalDetails.appendChild(dt);
additionalDetails.appendChild(dd);
}
// Raw JSON
document.getElementById('raw-json').innerHTML = jsonFormatHighlight(data); document.getElementById('raw-json').innerHTML = jsonFormatHighlight(data);
}
// Scroll to output function displayRules(explanation) {
output.scrollIntoView({ behavior: 'smooth', block: 'nearest' }); const container = document.getElementById('matching-rules');
if (!explanation.matched_rules.length) {
container.innerHTML = '<p>No rules matched. Datasette denies access when there is no matching rule.</p>';
return;
}
let html = '<table class="rules-table"><thead><tr><th>Effect</th><th>Scope</th><th>Source</th><th>Reason</th><th>Role in decision</th></tr></thead><tbody>';
for (const rule of explanation.matched_rules) {
const status = rule.decisive
? '<span class="rule-status">Decisive</span>'
: `<span class="rule-status rule-ignored">${escapeHtml(rule.ignored_because)}</span>`;
html += '<tr>';
html += `<td data-label="Effect"><span class="effect-badge effect-${rule.effect}">${rule.effect.toUpperCase()}</span></td>`;
html += `<td data-label="Scope">${escapeHtml(rule.scope)}</td>`;
html += `<td data-label="Source"><code>${escapeHtml(rule.source || 'unknown')}</code></td>`;
html += `<td data-label="Reason">${escapeHtml(rule.reason || 'No reason supplied')}</td>`;
html += `<td data-label="Role in decision">${status}</td>`;
html += '</tr>';
}
container.innerHTML = html + '</tbody></table>';
}
function displayRestrictions(restrictions) {
const section = document.getElementById('restrictions-section');
const container = document.getElementById('restriction-results');
section.style.display = restrictions.length ? 'block' : 'none';
container.innerHTML = restrictions.map(restriction => {
const className = restriction.allowed ? 'requirement-allowed' : 'requirement-denied';
const verdict = restriction.allowed ? 'INCLUDED ✓' : 'EXCLUDED ✗';
return `<p class="${className}"><strong>${verdict}</strong> by <code>${escapeHtml(restriction.source || 'unknown')}</code>: ${escapeHtml(restriction.reason)}</p>`;
}).join('');
}
function displayRequirements(requirements) {
const section = document.getElementById('requirements-section');
const container = document.getElementById('requirement-results');
section.style.display = requirements.length ? 'block' : 'none';
container.innerHTML = requirements.map(requirement => {
const className = requirement.allowed ? 'requirement-allowed' : 'requirement-denied';
const verdict = requirement.allowed ? 'ALLOWED ✓' : 'DENIED ✗';
return `<p class="${className}"><strong>${escapeHtml(requirement.action)}: ${verdict}</strong> — ${escapeHtml(requirement.summary)}</p>`;
}).join('');
} }
function displayError(data) { function displayError(data) {
output.style.display = 'block'; output.style.display = 'block';
output.className = 'denied'; output.className = 'denied';
const resultBadge = document.getElementById('result-badge'); const resultBadge = document.getElementById('result-badge');
resultBadge.className = 'result-badge denied-badge'; resultBadge.className = 'result-badge denied-badge';
resultBadge.textContent = 'ERROR'; resultBadge.textContent = 'ERROR';
document.getElementById('result-summary').textContent = data.error || 'Unknown error';
document.getElementById('result-action').textContent = 'N/A'; document.getElementById('result-actor').textContent = '—';
document.getElementById('result-resource').textContent = 'N/A'; document.getElementById('result-action').textContent = '—';
document.getElementById('result-actor').textContent = 'N/A'; document.getElementById('result-resource').textContent = '—';
document.getElementById('matching-rules').innerHTML = '';
const additionalDetails = document.getElementById('additional-details'); document.getElementById('restrictions-section').style.display = 'none';
additionalDetails.innerHTML = '<dt>Error:</dt><dd>' + (data.error || 'Unknown error') + '</dd>'; document.getElementById('requirements-section').style.display = 'none';
document.getElementById('raw-json').innerHTML = jsonFormatHighlight(data); document.getElementById('raw-json').innerHTML = jsonFormatHighlight(data);
output.scrollIntoView({ behavior: 'smooth', block: 'nearest' });
} }
// Disable child input if parent is empty form.addEventListener('submit', event => {
const parentInput = document.getElementById('parent'); event.preventDefault();
const childInput = document.getElementById('child'); performCheck();
childInput.addEventListener('focus', () => {
if (!parentInput.value) {
alert('Please specify a parent resource first before adding a child resource.');
parentInput.focus();
}
}); });
</script> actionSelect.addEventListener('change', updateResourceFields);
(function initializeFromUrl() {
const params = populateFormFromURL();
updateResourceFields();
if (params.get('action')) {
performCheck();
}
})();
</script>
{% endblock %} {% endblock %}

View file

@ -1,6 +1,6 @@
{% extends "base.html" %} {% extends "base.html" %}
{% block title %}Debug permissions{% endblock %} {% block title %}Permission activity{% endblock %}
{% block extra_head %} {% block extra_head %}
{% include "_permission_ui_styles.html" %} {% include "_permission_ui_styles.html" %}
@ -20,60 +20,45 @@
.check-action, .check-when, .check-result { .check-action, .check-when, .check-result {
font-size: 1.3em; font-size: 1.3em;
} }
textarea {
height: 10em;
width: 95%;
box-sizing: border-box;
padding: 0.5em;
border: 2px dotted black;
}
.two-col {
display: inline-block;
width: 48%;
}
.two-col label {
width: 48%;
}
@media only screen and (max-width: 576px) {
.two-col {
width: 100%;
}
}
</style> </style>
{% endblock %} {% endblock %}
{% block content %} {% block content %}
<h1>Permission playground</h1> <h1>Permission activity</h1>
{% set current_tab = "permissions" %} {% set current_tab = "permissions" %}
{% include "_permissions_debug_tabs.html" %} {% include "_permissions_debug_tabs.html" %}
<p>This tool lets you simulate an actor and a permission check for that actor.</p> <h2>Raw simulator</h2>
<p>This form runs a hypothetical permission check and returns its raw explanation JSON. Use the <a href="{{ urls.path('-/check') }}">Explain tool</a> for a visual explanation of the same decision.</p>
<div class="permission-form"> <div class="permission-form">
<form action="{{ urls.path('-/permissions') }}" id="debug-post" method="post"> <form action="{{ urls.path('-/permissions') }}" id="debug-post" method="post">
<div class="two-col"> <div class="permission-form-grid">
<div class="form-section"> <div>
<label>Actor</label> <div class="form-section">
<textarea name="actor">{% if actor_input %}{{ actor_input }}{% else %}{"id": "root"}{% endif %}</textarea> <label for="activity-actor">Actor</label>
<textarea class="permission-textarea" id="activity-actor" name="actor">{% if actor_input %}{{ actor_input }}{% else %}{"id": "root"}{% endif %}</textarea>
</div>
</div> </div>
</div> <div>
<div class="two-col" style="vertical-align: top"> <div class="form-section">
<div class="form-section"> <label for="permission">Action</label>
<label for="permission">Action</label> <select name="permission" id="permission">
<select name="permission" id="permission"> {% for permission in permissions %}
{% for permission in permissions %} <option value="{{ permission.name }}">{{ permission.name }}</option>
<option value="{{ permission.name }}">{{ permission.name }}</option> {% endfor %}
{% endfor %} </select>
</select> </div>
</div> <div class="form-section">
<div class="form-section"> <label for="resource_1">Parent</label>
<label for="resource_1">Parent</label> <input type="text" id="resource_1" name="resource_1" placeholder="e.g., database name">
<input type="text" id="resource_1" name="resource_1" placeholder="e.g., database name"> </div>
</div> <div class="form-section">
<div class="form-section"> <label for="resource_2">Child</label>
<label for="resource_2">Child</label> <input type="text" id="resource_2" name="resource_2" placeholder="e.g., table name">
<input type="text" id="resource_2" name="resource_2" placeholder="e.g., table name"> </div>
</div> </div>
</div> </div>
<div class="form-actions"> <div class="form-actions">
@ -125,7 +110,7 @@ debugPost.addEventListener('submit', function(ev) {
}); });
</script> </script>
<h1>Recent permissions checks</h1> <h2>Recent permission checks</h2>
<p> <p>
{% if filter != "all" %}<a href="?filter=all">All</a>{% else %}<strong>All</strong>{% endif %}, {% if filter != "all" %}<a href="?filter=all">All</a>{% else %}<strong>All</strong>{% endif %},

View file

@ -37,7 +37,7 @@
<div class="form-section"> <div class="form-section">
<label for="page_size">Page size:</label> <label for="page_size">Page size:</label>
<input type="number" id="page_size" name="_size" value="50" min="1" max="200" style="max-width: 100px;"> <input type="number" id="page_size" name="_size" value="50" min="1" max="200">
<small>Number of results per page (max 200)</small> <small>Number of results per page (max 200)</small>
</div> </div>

View file

@ -636,7 +636,7 @@ def detect_primary_keys(conn, table):
def get_outbound_foreign_keys(conn, table): def get_outbound_foreign_keys(conn, table):
infos = conn.execute(f"PRAGMA foreign_key_list([{table}])").fetchall() infos = conn.execute(f"PRAGMA foreign_key_list({escape_sqlite(table)})").fetchall()
fks = [] fks = []
for info in infos: for info in infos:
if info is not None: if info is not None:

View file

@ -252,88 +252,62 @@ async def _build_single_action_sql(
] ]
) )
# Continue with the cascading logic # Continue with the cascading logic.
query_parts.extend( # Aggregate the RULES by cascade level (small), rather than grouping
[ # base x rules (which scales with the number of resources).
"child_lvl AS (", def _agg(select_key, where, group_by):
" SELECT b.parent, b.child,", parts = [
" MAX(CASE WHEN ar.allow = 0 THEN 1 ELSE 0 END) AS any_deny,", f" SELECT {select_key}",
" MAX(CASE WHEN ar.allow = 1 THEN 1 ELSE 0 END) AS any_allow,", " MAX(CASE WHEN allow = 0 THEN 1 ELSE 0 END) AS any_deny,",
" json_group_array(CASE WHEN ar.allow = 0 THEN ar.source_plugin || ': ' || ar.reason END) AS deny_reasons,", " MAX(CASE WHEN allow = 1 THEN 1 ELSE 0 END) AS any_allow,",
" json_group_array(CASE WHEN ar.allow = 1 THEN ar.source_plugin || ': ' || ar.reason END) AS allow_reasons", " json_group_array(CASE WHEN allow = 0 THEN source_plugin || ': ' || reason END) AS deny_reasons,",
" FROM base b", " json_group_array(CASE WHEN allow = 1 THEN source_plugin || ': ' || reason END) AS allow_reasons",
" LEFT JOIN all_rules ar ON ar.parent = b.parent AND ar.child = b.child", f" FROM all_rules WHERE {where}",
" GROUP BY b.parent, b.child",
"),",
"parent_lvl AS (",
" SELECT b.parent, b.child,",
" MAX(CASE WHEN ar.allow = 0 THEN 1 ELSE 0 END) AS any_deny,",
" MAX(CASE WHEN ar.allow = 1 THEN 1 ELSE 0 END) AS any_allow,",
" json_group_array(CASE WHEN ar.allow = 0 THEN ar.source_plugin || ': ' || ar.reason END) AS deny_reasons,",
" json_group_array(CASE WHEN ar.allow = 1 THEN ar.source_plugin || ': ' || ar.reason END) AS allow_reasons",
" FROM base b",
" LEFT JOIN all_rules ar ON ar.parent = b.parent AND ar.child IS NULL",
" GROUP BY b.parent, b.child",
"),",
"global_lvl AS (",
" SELECT b.parent, b.child,",
" MAX(CASE WHEN ar.allow = 0 THEN 1 ELSE 0 END) AS any_deny,",
" MAX(CASE WHEN ar.allow = 1 THEN 1 ELSE 0 END) AS any_allow,",
" json_group_array(CASE WHEN ar.allow = 0 THEN ar.source_plugin || ': ' || ar.reason END) AS deny_reasons,",
" json_group_array(CASE WHEN ar.allow = 1 THEN ar.source_plugin || ': ' || ar.reason END) AS allow_reasons",
" FROM base b",
" LEFT JOIN all_rules ar ON ar.parent IS NULL AND ar.child IS NULL",
" GROUP BY b.parent, b.child",
"),",
] ]
if group_by:
parts.append(f" GROUP BY {group_by}")
return parts
query_parts.extend(
["child_agg AS ("]
+ _agg(
"parent, child,",
"parent IS NOT NULL AND child IS NOT NULL",
"parent, child",
)
+ ["),", "parent_agg AS ("]
+ _agg("parent,", "parent IS NOT NULL AND child IS NULL", "parent")
+ ["),", "global_agg AS ("]
+ _agg("", "parent IS NULL AND child IS NULL", None)
+ ["),"]
) )
# Add anonymous decision logic if needed # Add anonymous decision logic if needed
if include_is_private: if include_is_private:
query_parts.extend(
[ def _anon_agg(select_key, where, group_by):
"anon_child_lvl AS (", parts = [
" SELECT b.parent, b.child,", f" SELECT {select_key}",
" MAX(CASE WHEN ar.allow = 0 THEN 1 ELSE 0 END) AS any_deny,", " MAX(CASE WHEN allow = 0 THEN 1 ELSE 0 END) AS any_deny,",
" MAX(CASE WHEN ar.allow = 1 THEN 1 ELSE 0 END) AS any_allow", " MAX(CASE WHEN allow = 1 THEN 1 ELSE 0 END) AS any_allow",
" FROM base b", f" FROM anon_rules WHERE {where}",
" LEFT JOIN anon_rules ar ON ar.parent = b.parent AND ar.child = b.child",
" GROUP BY b.parent, b.child",
"),",
"anon_parent_lvl AS (",
" SELECT b.parent, b.child,",
" MAX(CASE WHEN ar.allow = 0 THEN 1 ELSE 0 END) AS any_deny,",
" MAX(CASE WHEN ar.allow = 1 THEN 1 ELSE 0 END) AS any_allow",
" FROM base b",
" LEFT JOIN anon_rules ar ON ar.parent = b.parent AND ar.child IS NULL",
" GROUP BY b.parent, b.child",
"),",
"anon_global_lvl AS (",
" SELECT b.parent, b.child,",
" MAX(CASE WHEN ar.allow = 0 THEN 1 ELSE 0 END) AS any_deny,",
" MAX(CASE WHEN ar.allow = 1 THEN 1 ELSE 0 END) AS any_allow",
" FROM base b",
" LEFT JOIN anon_rules ar ON ar.parent IS NULL AND ar.child IS NULL",
" GROUP BY b.parent, b.child",
"),",
"anon_decisions AS (",
" SELECT",
" b.parent, b.child,",
" CASE",
" WHEN acl.any_deny = 1 THEN 0",
" WHEN acl.any_allow = 1 THEN 1",
" WHEN apl.any_deny = 1 THEN 0",
" WHEN apl.any_allow = 1 THEN 1",
" WHEN agl.any_deny = 1 THEN 0",
" WHEN agl.any_allow = 1 THEN 1",
" ELSE 0",
" END AS anon_is_allowed",
" FROM base b",
" JOIN anon_child_lvl acl ON b.parent = acl.parent AND (b.child = acl.child OR (b.child IS NULL AND acl.child IS NULL))",
" JOIN anon_parent_lvl apl ON b.parent = apl.parent AND (b.child = apl.child OR (b.child IS NULL AND apl.child IS NULL))",
" JOIN anon_global_lvl agl ON b.parent = agl.parent AND (b.child = agl.child OR (b.child IS NULL AND agl.child IS NULL))",
"),",
] ]
if group_by:
parts.append(f" GROUP BY {group_by}")
return parts
query_parts.extend(
["anon_child_agg AS ("]
+ _anon_agg(
"parent, child,",
"parent IS NOT NULL AND child IS NOT NULL",
"parent, child",
)
+ ["),", "anon_parent_agg AS ("]
+ _anon_agg("parent,", "parent IS NOT NULL AND child IS NULL", "parent")
+ ["),", "anon_global_agg AS ("]
+ _anon_agg("", "parent IS NULL AND child IS NULL", None)
+ ["),"]
) )
# Final decisions # Final decisions
@ -342,31 +316,28 @@ async def _build_single_action_sql(
"decisions AS (", "decisions AS (",
" SELECT", " SELECT",
" b.parent, b.child,", " b.parent, b.child,",
" -- Cascading permission logic: child → parent → global, DENY beats ALLOW at each level", " -- Cascading permission logic: child -> parent -> global, DENY beats ALLOW at each level",
" -- Priority order:", " -- Priority order:",
" -- 1. Child-level deny (most specific, blocks access)", " -- 1. Child-level deny 2. Child-level allow",
" -- 2. Child-level allow (most specific, grants access)", " -- 3. Parent-level deny 4. Parent-level allow",
" -- 3. Parent-level deny (intermediate, blocks access)", " -- 5. Global-level deny 6. Global-level allow",
" -- 4. Parent-level allow (intermediate, grants access)",
" -- 5. Global-level deny (least specific, blocks access)",
" -- 6. Global-level allow (least specific, grants access)",
" -- 7. Default deny (no rules match)", " -- 7. Default deny (no rules match)",
" CASE", " CASE",
" WHEN cl.any_deny = 1 THEN 0", " WHEN ca.any_deny = 1 THEN 0",
" WHEN cl.any_allow = 1 THEN 1", " WHEN ca.any_allow = 1 THEN 1",
" WHEN pl.any_deny = 1 THEN 0", " WHEN pa.any_deny = 1 THEN 0",
" WHEN pl.any_allow = 1 THEN 1", " WHEN pa.any_allow = 1 THEN 1",
" WHEN gl.any_deny = 1 THEN 0", " WHEN ga.any_deny = 1 THEN 0",
" WHEN gl.any_allow = 1 THEN 1", " WHEN ga.any_allow = 1 THEN 1",
" ELSE 0", " ELSE 0",
" END AS is_allowed,", " END AS is_allowed,",
" CASE", " CASE",
" WHEN cl.any_deny = 1 THEN cl.deny_reasons", " WHEN ca.any_deny = 1 THEN ca.deny_reasons",
" WHEN cl.any_allow = 1 THEN cl.allow_reasons", " WHEN ca.any_allow = 1 THEN ca.allow_reasons",
" WHEN pl.any_deny = 1 THEN pl.deny_reasons", " WHEN pa.any_deny = 1 THEN pa.deny_reasons",
" WHEN pl.any_allow = 1 THEN pl.allow_reasons", " WHEN pa.any_allow = 1 THEN pa.allow_reasons",
" WHEN gl.any_deny = 1 THEN gl.deny_reasons", " WHEN ga.any_deny = 1 THEN ga.deny_reasons",
" WHEN gl.any_allow = 1 THEN gl.allow_reasons", " WHEN ga.any_allow = 1 THEN ga.allow_reasons",
" ELSE '[]'", " ELSE '[]'",
" END AS reason", " END AS reason",
] ]
@ -374,21 +345,34 @@ async def _build_single_action_sql(
if include_is_private: if include_is_private:
query_parts.append( query_parts.append(
" , CASE WHEN ad.anon_is_allowed = 0 THEN 1 ELSE 0 END AS is_private" " , CASE WHEN ("
"CASE"
" WHEN aca.any_deny = 1 THEN 0"
" WHEN aca.any_allow = 1 THEN 1"
" WHEN apa.any_deny = 1 THEN 0"
" WHEN apa.any_allow = 1 THEN 1"
" WHEN aga.any_deny = 1 THEN 0"
" WHEN aga.any_allow = 1 THEN 1"
" ELSE 0 END"
") = 0 THEN 1 ELSE 0 END AS is_private"
) )
query_parts.extend( query_parts.extend(
[ [
" FROM base b", " FROM base b",
" JOIN child_lvl cl ON b.parent = cl.parent AND (b.child = cl.child OR (b.child IS NULL AND cl.child IS NULL))", " LEFT JOIN child_agg ca ON ca.parent = b.parent AND ca.child = b.child",
" JOIN parent_lvl pl ON b.parent = pl.parent AND (b.child = pl.child OR (b.child IS NULL AND pl.child IS NULL))", " LEFT JOIN parent_agg pa ON pa.parent = b.parent",
" JOIN global_lvl gl ON b.parent = gl.parent AND (b.child = gl.child OR (b.child IS NULL AND gl.child IS NULL))", " CROSS JOIN global_agg ga",
] ]
) )
if include_is_private: if include_is_private:
query_parts.append( query_parts.extend(
" JOIN anon_decisions ad ON b.parent = ad.parent AND (b.child = ad.child OR (b.child IS NULL AND ad.child IS NULL))" [
" LEFT JOIN anon_child_agg aca ON aca.parent = b.parent AND aca.child = b.child",
" LEFT JOIN anon_parent_agg apa ON apa.parent = b.parent",
" CROSS JOIN anon_global_agg aga",
]
) )
query_parts.append(")") query_parts.append(")")
@ -400,8 +384,28 @@ async def _build_single_action_sql(
restriction_intersect = "\nINTERSECT\n".join( restriction_intersect = "\nINTERSECT\n".join(
f"SELECT * FROM ({sql})" for sql in restriction_sqls f"SELECT * FROM ({sql})" for sql in restriction_sqls
) )
# Decompose by NULL-pattern so the final filter can use pure-equality
# EXISTS lookups (satisfiable via automatic indexes) instead of a
# correlated OR-scan over the whole list.
query_parts.extend( query_parts.extend(
[",", "restriction_list AS (", f" {restriction_intersect}", ")"] [
",",
"restriction_list AS (",
f" {restriction_intersect}",
"),",
"restriction_exact AS (",
" SELECT parent, child FROM restriction_list WHERE parent IS NOT NULL AND child IS NOT NULL",
"),",
"restriction_parent_any AS (",
" SELECT DISTINCT parent FROM restriction_list WHERE parent IS NOT NULL AND child IS NULL",
"),",
"restriction_child_any AS (",
" SELECT DISTINCT child FROM restriction_list WHERE parent IS NULL AND child IS NOT NULL",
"),",
"restriction_all AS (",
" SELECT 1 AS matched FROM restriction_list WHERE parent IS NULL AND child IS NULL LIMIT 1",
")",
]
) )
# Final SELECT # Final SELECT
@ -416,10 +420,11 @@ async def _build_single_action_sql(
# Add restriction filter if there are restrictions # Add restriction filter if there are restrictions
if restriction_sqls: if restriction_sqls:
query_parts.append(""" query_parts.append("""
AND EXISTS ( AND (
SELECT 1 FROM restriction_list r EXISTS (SELECT 1 FROM restriction_all)
WHERE (r.parent = decisions.parent OR r.parent IS NULL) OR EXISTS (SELECT 1 FROM restriction_parent_any r WHERE r.parent = decisions.parent)
AND (r.child = decisions.child OR r.child IS NULL) OR EXISTS (SELECT 1 FROM restriction_child_any r WHERE r.child = decisions.child)
OR EXISTS (SELECT 1 FROM restriction_exact r WHERE r.parent = decisions.parent AND r.child = decisions.child)
)""") )""")
# Add parent filter if specified # Add parent filter if specified
@ -673,3 +678,239 @@ async def check_permission_for_resource(
child=child, child=child,
) )
return results[action] return results[action]
async def explain_permission_for_resource(
*,
datasette: "Datasette",
actor: dict | None,
action: str,
parent: str | None,
child: str | None,
) -> dict:
"""Explain a permission decision for one action and resource.
This is intended for Datasette's permission debugging tools. It uses the
same ``permission_resources_sql`` hook results and the same resolution
rules as :func:`check_permissions_for_actions`, but also returns the
matching rules, actor restriction results and ``also_requires`` chain.
The returned dictionary is part of Datasette's unstable debugging API.
"""
action_obj = datasette.actions.get(action)
if action_obj is None:
raise ValueError(f"Unknown action: {action}")
explanation = await _explain_single_action(
datasette=datasette,
actor=actor,
action=action,
parent=parent,
child=child,
)
required_actions = []
if action_obj.also_requires:
required = await explain_permission_for_resource(
datasette=datasette,
actor=actor,
action=action_obj.also_requires,
parent=parent,
child=child,
)
required_actions.append(required)
explanation["required_actions"] = required_actions
explanation["allowed"] = bool(
explanation["rule_allowed"]
and explanation["restriction_allowed"]
and all(required["allowed"] for required in required_actions)
)
explanation["summary"] = _permission_explanation_summary(explanation)
return explanation
async def _explain_single_action(
*,
datasette: "Datasette",
actor: dict | None,
action: str,
parent: str | None,
child: str | None,
) -> dict:
"""Return matching rules and restrictions for a single action."""
from datasette.utils.permissions import SKIP_PERMISSION_CHECKS
permission_sqls = await gather_permission_sql_from_hooks(
datasette=datasette,
actor=actor,
action=action,
)
if permission_sqls is SKIP_PERMISSION_CHECKS:
return {
"action": action,
"rule_allowed": True,
"restriction_allowed": True,
"winning_scope": "global",
"matched_rules": [
{
"scope": "global",
"effect": "allow",
"source": "skip_permission_checks",
"reason": "Permission checks were explicitly skipped",
"decisive": True,
"ignored_because": None,
}
],
"restrictions": [],
}
db = datasette.get_internal_database()
matched_rules = []
restrictions = []
for permission_sql in permission_sqls:
params = dict(permission_sql.params or {})
parent_param = _unused_parameter_name(params, "_explain_parent")
params[parent_param] = parent
child_param = _unused_parameter_name(params, "_explain_child")
params[child_param] = child
if permission_sql.sql:
rows = await db.execute(
f"""
SELECT parent, child, allow, reason
FROM ({permission_sql.sql}) AS permission_rules
WHERE (parent IS NULL OR parent = :{parent_param})
AND (child IS NULL OR child = :{child_param})
""",
params,
)
for row in rows:
specificity = (
2
if row["child"] is not None
else 1 if row["parent"] is not None else 0
)
matched_rules.append(
{
"scope": ("resource", "parent", "global")[2 - specificity],
"effect": "allow" if row["allow"] else "deny",
"source": permission_sql.source,
"reason": row["reason"],
"_specificity": specificity,
}
)
if permission_sql.restriction_sql:
restriction_row = (
await db.execute(
f"""
SELECT EXISTS(
SELECT 1 FROM ({permission_sql.restriction_sql}) AS restriction_rules
WHERE (parent IS NULL OR parent = :{parent_param})
AND (child IS NULL OR child = :{child_param})
) AS resource_is_in_allowlist
""",
params,
)
).first()
restriction_allowed = bool(restriction_row[0])
restrictions.append(
{
"source": permission_sql.source,
"allowed": restriction_allowed,
"reason": params.get("deny")
or (
"Resource is included in this restriction allowlist"
if restriction_allowed
else "Resource is not included in this restriction allowlist"
),
}
)
matched_rules.sort(
key=lambda rule: (
-rule["_specificity"],
0 if rule["effect"] == "deny" else 1,
rule["source"] or "",
rule["reason"] or "",
)
)
if matched_rules:
winning_specificity = matched_rules[0]["_specificity"]
winning_rules = [
rule
for rule in matched_rules
if rule["_specificity"] == winning_specificity
]
rule_allowed = not any(rule["effect"] == "deny" for rule in winning_rules)
winning_scope = winning_rules[0]["scope"]
else:
winning_specificity = None
rule_allowed = False
winning_scope = None
for rule in matched_rules:
specificity = rule.pop("_specificity")
if specificity != winning_specificity:
rule["decisive"] = False
rule["ignored_because"] = "A more specific rule matched"
elif not rule_allowed and rule["effect"] == "allow":
rule["decisive"] = False
rule["ignored_because"] = "A deny rule matched at the same scope"
else:
rule["decisive"] = True
rule["ignored_because"] = None
return {
"action": action,
"rule_allowed": rule_allowed,
"restriction_allowed": all(
restriction["allowed"] for restriction in restrictions
),
"winning_scope": winning_scope,
"matched_rules": matched_rules,
"restrictions": restrictions,
}
def _unused_parameter_name(params: dict, preferred: str) -> str:
"""Return a SQL parameter name that is not already in ``params``."""
candidate = preferred
suffix = 2
while candidate in params:
candidate = f"{preferred}_{suffix}"
suffix += 1
return candidate
def _permission_explanation_summary(explanation: dict) -> str:
denied_requirement = next(
(
required
for required in explanation["required_actions"]
if not required["allowed"]
),
None,
)
if denied_requirement:
return (
f"Denied because {explanation['action']} also requires "
f"{denied_requirement['action']}, which was denied."
)
if not explanation["matched_rules"]:
return "Denied because no permission rule matched this actor and resource."
if not explanation["rule_allowed"]:
return (
f"Denied by a {explanation['winning_scope']}-level rule. "
"Deny rules take precedence over allow rules at the same scope."
)
if not explanation["restriction_allowed"]:
return (
"Denied because the resource is not included in the actor's restrictions."
)
return f"Allowed by the matching {explanation['winning_scope']}-level rule."

View file

@ -3,7 +3,7 @@ import textwrap
from sqlite_utils import Database as SQLiteUtilsDatabase from sqlite_utils import Database as SQLiteUtilsDatabase
from sqlite_utils import Migrations from sqlite_utils import Migrations
from datasette.utils import table_column_details from datasette.utils import escape_sqlite, table_column_details
INTERNAL_DB_SCHEMA_TABLES = { INTERNAL_DB_SCHEMA_TABLES = {
"catalog_databases", "catalog_databases",
@ -180,29 +180,9 @@ async def init_internal_db(db):
await db.execute_write_fn(apply_migrations, transaction=False) await db.execute_write_fn(apply_migrations, transaction=False)
async def populate_schema_tables(internal_db, db): async def populate_schema_tables(internal_db, db, schema_version):
database_name = db.name database_name = db.name
def delete_everything(conn):
conn.execute(
"DELETE FROM catalog_tables WHERE database_name = ?", [database_name]
)
conn.execute(
"DELETE FROM catalog_views WHERE database_name = ?", [database_name]
)
conn.execute(
"DELETE FROM catalog_columns WHERE database_name = ?", [database_name]
)
conn.execute(
"DELETE FROM catalog_foreign_keys WHERE database_name = ?",
[database_name],
)
conn.execute(
"DELETE FROM catalog_indexes WHERE database_name = ?", [database_name]
)
await internal_db.execute_write_fn(delete_everything)
tables = (await db.execute("select * from sqlite_master WHERE type = 'table'")).rows tables = (await db.execute("select * from sqlite_master WHERE type = 'table'")).rows
views = (await db.execute("select * from sqlite_master WHERE type = 'view'")).rows views = (await db.execute("select * from sqlite_master WHERE type = 'view'")).rows
@ -233,7 +213,7 @@ async def populate_schema_tables(internal_db, db):
for column in columns for column in columns
) )
foreign_keys = conn.execute( foreign_keys = conn.execute(
f"PRAGMA foreign_key_list([{table_name}])" f"PRAGMA foreign_key_list({escape_sqlite(table_name)})"
).fetchall() ).fetchall()
foreign_keys_to_insert.extend( foreign_keys_to_insert.extend(
{ {
@ -242,7 +222,9 @@ async def populate_schema_tables(internal_db, db):
} }
for foreign_key in foreign_keys for foreign_key in foreign_keys
) )
indexes = conn.execute(f"PRAGMA index_list([{table_name}])").fetchall() indexes = conn.execute(
f"PRAGMA index_list({escape_sqlite(table_name)})"
).fetchall()
indexes_to_insert.extend( indexes_to_insert.extend(
{ {
**{"database_name": database_name, "table_name": table_name}, **{"database_name": database_name, "table_name": table_name},
@ -266,47 +248,76 @@ async def populate_schema_tables(internal_db, db):
indexes_to_insert, indexes_to_insert,
) = await db.execute_fn(collect_info) ) = await db.execute_fn(collect_info)
await internal_db.execute_write_many( def replace_catalog(conn):
""" # Delete child rows before their catalog_tables parents so this also
INSERT INTO catalog_tables (database_name, table_name, rootpage, sql) # works if a prepare_connection plugin enables foreign key enforcement.
values (?, ?, ?, ?) for table in (
""", "catalog_columns",
tables_to_insert, "catalog_foreign_keys",
) "catalog_indexes",
await internal_db.execute_write_many( "catalog_views",
""" "catalog_tables",
INSERT INTO catalog_views (database_name, view_name, rootpage, sql) ):
values (?, ?, ?, ?) conn.execute(
""", "DELETE FROM {} WHERE database_name = ?".format(table),
views_to_insert, [database_name],
) )
await internal_db.execute_write_many( conn.execute(
""" """
INSERT INTO catalog_columns ( INSERT OR REPLACE INTO catalog_databases (
database_name, table_name, cid, name, type, "notnull", default_value, is_pk, hidden database_name, path, is_memory, schema_version
) VALUES ( ) VALUES (?, ?, ?, ?)
:database_name, :table_name, :cid, :name, :type, :notnull, :default_value, :is_pk, :hidden """,
[
database_name,
str(db.path) if db.path is not None else None,
db.is_memory,
schema_version,
],
) )
""", conn.executemany(
columns_to_insert, """
) INSERT INTO catalog_tables (database_name, table_name, rootpage, sql)
await internal_db.execute_write_many( values (?, ?, ?, ?)
""" """,
INSERT INTO catalog_foreign_keys ( tables_to_insert,
database_name, table_name, "id", seq, "table", "from", "to", on_update, on_delete, match
) VALUES (
:database_name, :table_name, :id, :seq, :table, :from, :to, :on_update, :on_delete, :match
) )
""", conn.executemany(
foreign_keys_to_insert, """
) INSERT INTO catalog_views (database_name, view_name, rootpage, sql)
await internal_db.execute_write_many( values (?, ?, ?, ?)
""" """,
INSERT INTO catalog_indexes ( views_to_insert,
database_name, table_name, seq, name, "unique", origin, partial
) VALUES (
:database_name, :table_name, :seq, :name, :unique, :origin, :partial
) )
""", conn.executemany(
indexes_to_insert, """
) INSERT INTO catalog_columns (
database_name, table_name, cid, name, type, "notnull", default_value, is_pk, hidden
) VALUES (
:database_name, :table_name, :cid, :name, :type, :notnull, :default_value, :is_pk, :hidden
)
""",
columns_to_insert,
)
conn.executemany(
"""
INSERT INTO catalog_foreign_keys (
database_name, table_name, "id", seq, "table", "from", "to", on_update, on_delete, match
) VALUES (
:database_name, :table_name, :id, :seq, :table, :from, :to, :on_update, :on_delete, :match
)
""",
foreign_keys_to_insert,
)
conn.executemany(
"""
INSERT INTO catalog_indexes (
database_name, table_name, seq, name, "unique", origin, partial
) VALUES (
:database_name, :table_name, :seq, :name, :unique, :origin, :partial
)
""",
indexes_to_insert,
)
await internal_db.execute_write_fn(replace_catalog)

View file

@ -1,2 +1,2 @@
__version__ = "1.0a36" __version__ = "1.0a37"
__version_info__ = tuple(__version__.split(".")) __version_info__ = tuple(__version__.split("."))

View file

@ -643,8 +643,15 @@ class QueryView(View):
ok = None ok = None
redirect_url = None redirect_url = None
try: try:
execute_write_kwargs = {"request": request}
if stored_query.is_trusted:
analysis = await db.analyze_sql(stored_query.sql, params_for_query)
if any(
operation.operation == "vacuum" for operation in analysis.operations
):
execute_write_kwargs["transaction"] = False
cursor = await db.execute_write( cursor = await db.execute_write(
stored_query.sql, params_for_query, request=request stored_query.sql, params_for_query, **execute_write_kwargs
) )
# success message can come from on_success_message or on_success_message_sql # success message can come from on_success_message or on_success_message_sql
message = None message = None

View file

@ -600,7 +600,7 @@ class PermissionRulesView(BaseView):
async def _check_permission_for_actor(ds, action, parent, child, actor): async def _check_permission_for_actor(ds, action, parent, child, actor):
"""Shared logic for checking permissions. Returns a dict with check results.""" """Shared logic for checking and explaining a permission decision."""
if action not in ds.actions: if action not in ds.actions:
return error_body(f"Unknown action: {action}", 404), 404 return error_body(f"Unknown action: {action}", 404), 404
@ -629,15 +629,28 @@ async def _check_permission_for_actor(ds, action, parent, child, actor):
allowed = await ds.allowed(action=action, resource=resource_obj, actor=actor) allowed = await ds.allowed(action=action, resource=resource_obj, actor=actor)
from datasette.utils.actions_sql import explain_permission_for_resource
explanation = await explain_permission_for_resource(
datasette=ds,
actor=actor,
action=action,
parent=parent,
child=child,
)
response = { response = {
"ok": True, "ok": True,
"unstable": UNSTABLE_API_MESSAGE,
"action": action, "action": action,
"allowed": bool(allowed), "allowed": bool(allowed),
"actor": actor,
"resource": { "resource": {
"parent": parent, "parent": parent,
"child": child, "child": child,
"path": _resource_path(parent, child), "path": _resource_path(parent, child),
}, },
"explanation": explanation,
} }
if actor and "id" in actor: if actor and "id" in actor:
@ -655,11 +668,25 @@ class PermissionCheckView(BaseView):
as_format = request.url_vars.get("format") as_format = request.url_vars.get("format")
if not as_format: if not as_format:
actions = [
{
"name": action.name,
"description": action.description,
"takes_parent": action.takes_parent,
"takes_child": action.takes_child,
"also_requires": action.also_requires,
}
for action in sorted(
self.ds.actions.values(), key=lambda action: action.name
)
]
return await self.render( return await self.render(
["debug_check.html"], ["debug_check.html"],
request, request,
{ {
"sorted_actions": sorted(self.ds.actions.keys()), "actions": actions,
"actor_json": request.args.get("actor")
or json.dumps(request.actor, indent=2),
"has_debug_permission": True, "has_debug_permission": True,
}, },
) )
@ -671,9 +698,18 @@ class PermissionCheckView(BaseView):
parent = request.args.get("parent") parent = request.args.get("parent")
child = request.args.get("child") child = request.args.get("child")
actor = request.actor
actor_json = request.args.get("actor")
if actor_json is not None:
try:
actor = json.loads(actor_json)
except json.JSONDecodeError as ex:
return Response.error(f"Invalid actor JSON: {ex}", 400)
if actor is not None and not isinstance(actor, dict):
return Response.error("actor must be a JSON object or null", 400)
response, status = await _check_permission_for_actor( response, status = await _check_permission_for_actor(
self.ds, action, parent, child, request.actor self.ds, action, parent, child, actor
) )
return Response.json(response, status=status) return Response.json(response, status=status)

View file

@ -45,7 +45,7 @@ Using the "root" actor
Datasette currently leaves almost all forms of authentication to plugins - `datasette-auth-github <https://github.com/simonw/datasette-auth-github>`__ for example. Datasette currently leaves almost all forms of authentication to plugins - `datasette-auth-github <https://github.com/simonw/datasette-auth-github>`__ for example.
The one exception is the "root" account, which you can sign into while using Datasette on your local machine. The root user has **all permissions** - they can perform any action regardless of other permission rules. The one exception is the "root" account, which you can sign into while using Datasette on your local machine. The root user starts with **all permissions**: Datasette contributes a global allow rule for every action. More specific deny rules can still override that global rule.
The ``--root`` flag is designed for local development and testing. When you start Datasette with ``--root``, the root user automatically receives every permission, including: The ``--root`` flag is designed for local development and testing. When you start Datasette with ``--root``, the root user automatically receives every permission, including:
@ -84,12 +84,12 @@ Click on that link and then visit ``http://127.0.0.1:8001/-/actor`` to confirm t
Permissions Permissions
=========== ===========
Datasette's permissions system is built around SQL queries. Datasette and its plugins construct SQL queries to resolve the list of resources that an actor cas access.
The key question the permissions system answers is this: The key question the permissions system answers is this:
Is this **actor** allowed to perform this **action**, optionally against this particular **resource**? Is this **actor** allowed to perform this **action**, optionally against this particular **resource**?
Every permission decision can be understood in terms of those three values. Datasette implements the decisions using SQL, but you do not need to understand the generated SQL to configure or debug permissions.
**Actors** are :ref:`described above <authentication_actor>`. **Actors** are :ref:`described above <authentication_actor>`.
An **action** is a string describing the action the actor would like to perform. A full list is :ref:`provided below <actions>` - examples include ``view-table`` and ``execute-sql``. An **action** is a string describing the action the actor would like to perform. A full list is :ref:`provided below <actions>` - examples include ``view-table`` and ``execute-sql``.
@ -138,7 +138,51 @@ This configuration will deny access to everyone except the user with ``id`` of `
How permissions are resolved How permissions are resolved
---------------------------- ----------------------------
Datasette performs permission checks using the internal :ref:`datasette_allowed`, method which accepts keyword arguments for ``action``, ``resource`` and an optional ``actor``. Permission rules describe an effect (``allow`` or ``deny``) at one of three levels:
``resource``
A specific child resource, such as the ``analytics/sales`` table.
``parent``
A parent resource, such as the ``analytics`` database. A parent rule also applies to its child resources.
``global``
Every resource for that action.
Datasette resolves matching rules from most specific to least specific:
#. Resource rules take precedence over parent and global rules.
#. Parent rules take precedence over global rules.
#. If both allow and deny rules match at the same level, deny takes precedence.
#. If no rule matches, access is denied.
This means a resource-level allow can provide an exception to a parent-level deny. It also means that two plugins which disagree at the same level resolve to deny.
.. list-table:: Permission rule examples
:header-rows: 1
* - Matching rules
- Result
- Explanation
* - Global allow
- Allow
- The global rule is the most specific matching rule.
* - Global allow, parent deny
- Deny
- The parent rule is more specific.
* - Parent deny, resource allow
- Allow
- The resource rule is more specific.
* - Resource allow and resource deny
- Deny
- Deny takes precedence at the same level.
* - No matching rules
- Deny
- Permissions default to deny when no rule applies.
The built-in public defaults are global allow rules for actions such as ``view-instance``, ``view-database`` and ``view-table``. They follow the same precedence rules as configuration and plugin rules. The ``--default-deny`` option prevents Datasette from contributing those default allow rules.
Datasette performs checks using :ref:`datasette_allowed`, which accepts keyword arguments for ``action``, ``resource`` and an optional ``actor``.
``resource`` should be an instance of the appropriate ``Resource`` subclass from :mod:`datasette.resources`—for example ``InstanceResource()``, ``DatabaseResource(database="...``)`` or ``TableResource(database="...", table="...")``. This defaults to ``InstanceResource()`` if not specified. ``resource`` should be an instance of the appropriate ``Resource`` subclass from :mod:`datasette.resources`—for example ``InstanceResource()``, ``DatabaseResource(database="...``)`` or ``TableResource(database="...", table="...")``. This defaults to ``InstanceResource()`` if not specified.
@ -149,12 +193,12 @@ resources were allowed or denied. The combined sources are:
* ``allow`` blocks configured in :ref:`datasette.yaml <authentication_permissions_config>`. * ``allow`` blocks configured in :ref:`datasette.yaml <authentication_permissions_config>`.
* :ref:`Actor restrictions <authentication_cli_create_token_restrict>` encoded into the actor dictionary or API token. * :ref:`Actor restrictions <authentication_cli_create_token_restrict>` encoded into the actor dictionary or API token.
* The "root" user shortcut when ``--root`` (or :attr:`Datasette.root_enabled <datasette.app.Datasette.root_enabled>`) is active, replying ``True`` to all permission chucks unless configuration rules deny them at a more specific level. * The "root" user rule when ``--root`` (or :attr:`Datasette.root_enabled <datasette.app.Datasette.root_enabled>`) is active. This is a global allow rule, so a more specific configuration deny can override it.
* Any additional SQL provided by plugins implementing :ref:`plugin_hook_permission_resources_sql`. * Any additional SQL provided by plugins implementing :ref:`plugin_hook_permission_resources_sql`.
Datasette evaluates the SQL to determine if the requested ``resource`` is Actor restrictions are applied after the allow/deny rules. They act as an additional allowlist: a restriction can remove access but cannot grant access that the actor did not already have. See :ref:`authentication_cli_create_token_restrict`.
included. Explicit deny rules returned by configuration or plugins will block
access even if other rules allowed it. Some actions have dependencies on other actions. These are evaluated as an ``AND`` condition. For example, ``execute-sql`` also requires ``view-database``: both decisions must be allowed for the final result to be allowed.
.. _authentication_permissions_allow: .. _authentication_permissions_allow:
@ -1145,11 +1189,21 @@ The debug tool at ``/-/permissions`` is available to any actor with the ``permis
datasette -s permissions.permissions-debug true data.db datasette -s permissions.permissions-debug true data.db
The page shows the permission checks that have been carried out by the Datasette instance. The permission debug tools answer four different questions:
It also provides an interface for running hypothetical permission checks against a hypothetical actor. This is a useful way of confirming that your configured permissions work in the way you expect. Why was this decision allowed or denied?
Use :ref:`PermissionCheckView`. It shows every matching rule, identifies the winning specificity level, applies actor restrictions and evaluates any required actions.
This is designed to help administrators and plugin authors understand exactly how permission checks are being carried out, in order to effectively configure Datasette's permission system. Which resources can the current actor access?
Use :ref:`AllowedResourcesView` to view an access map for a selected action.
Which raw rules did Datasette and its plugins contribute?
Use :ref:`PermissionRulesView` to inspect the rules before they are resolved into decisions.
Which checks has this Datasette instance performed recently?
Use ``/-/permissions`` to view recent permission activity.
These tools are designed to help administrators and plugin authors understand and confirm the effective permissions configuration.
These debug endpoints are exempt from the :ref:`JSON API stability promise <json_api_stability>` - their JSON shapes may change in future releases. These debug endpoints are exempt from the :ref:`JSON API stability promise <json_api_stability>` - their JSON shapes may change in future releases.
@ -1184,11 +1238,20 @@ This endpoint requires the ``permissions-debug`` permission.
Permission check view Permission check view
--------------------- ---------------------
The ``/-/check`` endpoint evaluates a single action/resource pair and returns information indicating whether the access was allowed along with diagnostic information. The ``/-/check`` endpoint evaluates and explains a single actor, action and resource decision. The explanation includes:
* Every matching allow and deny rule, with its source and reason.
* The winning resource, parent or global scope.
* Rules ignored because a more specific rule matched, or because a deny won at the same scope.
* Actor restriction allowlists that included or excluded the resource.
* Additional actions required by the requested action.
* An explicit default-deny explanation when no rule matched.
This endpoint provides an interactive HTML form interface. Add ``.json`` to the URL path (e.g. ``/-/check.json?action=view-instance``) to get the raw JSON response instead. This endpoint provides an interactive HTML form interface. Add ``.json`` to the URL path (e.g. ``/-/check.json?action=view-instance``) to get the raw JSON response instead.
Pass ``?action=`` to specify the action to check, and optional ``?parent=`` and ``?child=`` parameters to specify the resource. Pass ``?action=`` to specify the action to check, and optional ``?parent=`` and ``?child=`` parameters to specify the resource. The interactive form also accepts actor JSON, allowing a hypothetical actor to be tested without signing in as that actor. The JSON endpoint accepts the same value using the ``actor`` query string parameter. Use ``actor=null`` to represent an anonymous actor.
This endpoint requires the ``permissions-debug`` permission. The hypothetical actor is used only for the decision being explained; access to the debug tool is checked against the actor who is actually signed in.
.. _authentication_ds_actor: .. _authentication_ds_actor:

View file

@ -4,6 +4,20 @@
Changelog Changelog
========= =========
.. _v1_0_a37:
1.0a37 (2026-07-14)
-------------------
Performance improvement for SQL-backed permission checks, plus an improved permission debugging interface.
- SQL used to resolve permission checks now aggregates permission rules before joining them to resources, improving performance on instances with large schemas. (:issue:`2832`)
- The :ref:`PermissionCheckView` permission debugger now explains why a decision was allowed or denied, including the matching rules. The interactive form can also test a hypothetical actor supplied as JSON, and the :ref:`permissions documentation <authentication_permissions_explained>` now describes resolution rules in more detail. (:issue:`2841`)
- :ref:`db.execute_write(sql, ..., transaction=True) <database_execute_write>` has a new ``transaction=`` parameter, which can be set to ``False`` for statements such as ``VACUUM`` that cannot run inside a transaction. Write tasks now start their transactions using ``BEGIN IMMEDIATE``, which also ensures that writes are rolled back if the task fails. (:issue:`2831`)
- Refreshing a database's schema in Datasette's internal catalog is now performed as a single atomic operation. (:issue:`2831`)
- Fixed schema introspection, table pages, facets and table counts for tables with names containing a ``]`` character. Thanks, `TowyTowy <https://github.com/TowyTowy>`__. (:issue:`2431`, :pr:`2846`)
- ``/-/plugins.json`` once again returns a top-level JSON array of plugin objects, reverting the object envelope introduced in 1.0a36. This should fix a large number of trivial test failures in existing plugins. (:issue:`2842`, :pr:`2843`)
.. _v1_0_a36: .. _v1_0_a36:
1.0a36 (2026-07-07) 1.0a36 (2026-07-07)

View file

@ -2023,8 +2023,8 @@ Example usage:
.. _database_execute_write: .. _database_execute_write:
await db.execute_write(sql, params=None, block=True, request=None, return_all=False, returning_limit=10) await db.execute_write(sql, params=None, block=True, request=None, return_all=False, returning_limit=10, transaction=True)
-------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------------------
SQLite only allows one database connection to write at a time. Datasette handles this for you by maintaining a queue of writes to be executed against a given database. Plugins can submit write operations to this queue and they will be executed in the order in which they are received. SQLite only allows one database connection to write at a time. Datasette handles this for you by maintaining a queue of writes to be executed against a given database. Plugins can submit write operations to this queue and they will be executed in the order in which they are received.
@ -2059,7 +2059,9 @@ If you need to retrieve every row returned by a statement, pass ``return_all=Tru
If you pass ``block=False`` this behavior changes to "fire and forget" - queries will be added to the write queue and executed in a separate thread while your code can continue to do other things. The method will return a UUID representing the queued task. If you pass ``block=False`` this behavior changes to "fire and forget" - queries will be added to the write queue and executed in a separate thread while your code can continue to do other things. The method will return a UUID representing the queued task.
Each call to ``execute_write()`` will be executed inside a transaction. Each call to ``execute_write()`` will be executed inside a transaction. Pass
``transaction=False`` for statements such as ``VACUUM`` that cannot run inside
a transaction.
.. _database_execute_write_script: .. _database_execute_write_script:

View file

@ -80,18 +80,15 @@ Shows a list of currently installed plugins and their versions. `Plugins example
.. code-block:: json .. code-block:: json
{ [
"ok": true, {
"plugins": [ "name": "datasette_cluster_map",
{ "static": true,
"name": "datasette_cluster_map", "templates": false,
"static": true, "version": "0.10",
"templates": false, "hooks": ["extra_css_urls", "extra_js_urls", "extra_body_script"]
"version": "0.10", }
"hooks": ["extra_css_urls", "extra_js_urls", "extra_body_script"] ]
}
]
}
Add ``?all=1`` to include details of the default plugins baked into Datasette. Add ``?all=1`` to include details of the default plugins baked into Datasette.

View file

@ -1,6 +1,6 @@
from datasette.app import Datasette from datasette.app import Datasette
from datasette.plugins import DEFAULT_PLUGINS from datasette.plugins import DEFAULT_PLUGINS
from datasette.utils import UNSTABLE_API_MESSAGE from datasette.utils import UNSTABLE_API_MESSAGE, escape_sqlite, tilde_encode
from datasette.utils.sqlite import sqlite_version from datasette.utils.sqlite import sqlite_version
from datasette.version import __version__ from datasette.version import __version__
from .fixtures import make_app_client, EXPECTED_PLUGINS from .fixtures import make_app_client, EXPECTED_PLUGINS
@ -614,13 +614,13 @@ async def test_plugins_json(ds_client):
response = await ds_client.get("/-/plugins.json") response = await ds_client.get("/-/plugins.json")
# Filter out TrackEventPlugin # Filter out TrackEventPlugin
actual_plugins = sorted( actual_plugins = sorted(
[p for p in response.json()["plugins"] if p["name"] != "TrackEventPlugin"], [p for p in response.json() if p["name"] != "TrackEventPlugin"],
key=lambda p: p["name"], key=lambda p: p["name"],
) )
assert EXPECTED_PLUGINS == actual_plugins assert EXPECTED_PLUGINS == actual_plugins
# Try with ?all=1 # Try with ?all=1
response = await ds_client.get("/-/plugins.json?all=1") response = await ds_client.get("/-/plugins.json?all=1")
names = {p["name"] for p in response.json()["plugins"]} names = {p["name"] for p in response.json()}
assert names.issuperset(p["name"] for p in EXPECTED_PLUGINS) assert names.issuperset(p["name"] for p in EXPECTED_PLUGINS)
assert names.issuperset(DEFAULT_PLUGINS) assert names.issuperset(DEFAULT_PLUGINS)
@ -930,6 +930,37 @@ async def test_tilde_encoded_database_names(db_name):
assert response2.status_code == 200 assert response2.status_code == 200
@pytest.mark.asyncio
@pytest.mark.parametrize("table_name", ("[foo]", "foo]", "[foo]/bar"))
async def test_table_with_reserved_characters_in_name(table_name):
# Table names containing characters such as "]" that cannot be escaped
# using SQLite [bracket] quoting used to break schema introspection and
# the table page - https://github.com/simonw/datasette/issues/2431
ds = Datasette()
db = ds.add_memory_database("test_reserved_table_names")
await db.execute_write(
"create table {} (id integer primary key, name text)".format(
escape_sqlite(table_name)
)
)
await db.execute_write(
"insert into {} (id, name) values (1, 'one')".format(escape_sqlite(table_name))
)
# Schema introspection (populate_schema_tables) must not crash:
db_response = await ds.client.get("/test_reserved_table_names.json")
assert db_response.status_code == 200
tables = {t["name"]: t for t in db_response.json()["tables"]}
assert tables[table_name]["count"] == 1
# And the table page itself must load and return the row:
table_response = await ds.client.get(
"/test_reserved_table_names/{}.json?_shape=array".format(
tilde_encode(table_name)
)
)
assert table_response.status_code == 200
assert table_response.json() == [{"id": 1, "name": "one"}]
@pytest.mark.asyncio @pytest.mark.asyncio
@pytest.mark.parametrize( @pytest.mark.parametrize(
"config,expected", "config,expected",

View file

@ -109,7 +109,7 @@ def test_settings(config_dir_client):
def test_plugins(config_dir_client): def test_plugins(config_dir_client):
response = config_dir_client.get("/-/plugins.json") response = config_dir_client.get("/-/plugins.json")
assert 200 == response.status assert 200 == response.status
plugins = response.json["plugins"] plugins = response.json
assert "hooray.py" in {p["name"] for p in plugins} assert "hooray.py" in {p["name"] for p in plugins}
assert "non_py_file.txt" not in {p["name"] for p in plugins} assert "non_py_file.txt" not in {p["name"] for p in plugins}
assert "mypy_cache" not in {p["name"] for p in plugins} assert "mypy_cache" not in {p["name"] for p in plugins}

View file

@ -11,6 +11,7 @@ from datasette.database import _deliver_write_result
from datasette.utils.sqlite import sqlite3, supports_returning from datasette.utils.sqlite import sqlite3, supports_returning
from datasette.utils import Column from datasette.utils import Column
import pytest import pytest
import sqlite_utils
import time import time
import uuid import uuid
@ -718,6 +719,41 @@ async def test_execute_write_fn_exception(db):
await db.execute_write_fn(write_fn) await db.execute_write_fn(write_fn)
@pytest.mark.asyncio
@pytest.mark.parametrize("num_sql_threads", (0, 1))
async def test_execute_write_fn_sqlite_utils_transaction(tmp_path, num_sql_threads):
# A write inside a failing Datasette task must never become visible or
# survive the rollback. Exercise both the synchronous and writer-thread
# paths against a file-backed database so a second connection can observe
# committed state independently.
db_path = tmp_path / "test.db"
sqlite3.connect(db_path).close()
ds = Datasette([str(db_path)], settings={"num_sql_threads": num_sql_threads})
db = ds.get_database("test")
await db.execute_write("create table items (id integer primary key)")
# This reader is used inside the write callback, which may run on another
# thread, but it is never accessed concurrently.
reader = sqlite3.connect(db_path, check_same_thread=False)
def insert_then_fail(conn):
# Datasette must open the outer transaction before sqlite-utils writes.
assert conn.in_transaction
sqlite_utils.Database(conn)["items"].insert({"id": 1})
# If sqlite-utils committed its own transaction, this would return 1.
assert reader.execute("select count(*) from items").fetchone()[0] == 0
# Simulate a later step failing after the sqlite-utils write succeeded.
raise ValueError("deliberate")
try:
with pytest.raises(ValueError, match="deliberate"):
await db.execute_write_fn(insert_then_fail)
# The outer transaction must roll back the sqlite-utils write as well.
assert reader.execute("select count(*) from items").fetchone()[0] == 0
finally:
reader.close()
db.close()
@pytest.mark.asyncio @pytest.mark.asyncio
@pytest.mark.parametrize("param_name", ["conn", "connection", "db", "c"]) @pytest.mark.parametrize("param_name", ["conn", "connection", "db", "c"])
async def test_execute_write_fn_accepts_any_single_param_name(db, param_name): async def test_execute_write_fn_accepts_any_single_param_name(db, param_name):

View file

@ -457,6 +457,20 @@ async def test_permissions_debug(ds_client, filter_):
assert checks == expected_checks assert checks == expected_checks
@pytest.mark.asyncio
@pytest.mark.parametrize(
"permissions_debug,expected_status",
(
(1, 200),
(0, 403),
),
)
async def test_permissions_debug_numeric_boolean(permissions_debug, expected_status):
ds = Datasette(config={"permissions": {"permissions-debug": permissions_debug}})
response = await ds.client.get("/-/permissions")
assert response.status_code == expected_status
@pytest.mark.asyncio @pytest.mark.asyncio
@pytest.mark.parametrize( @pytest.mark.parametrize(
"actor,allow,expected_fragment", "actor,allow,expected_fragment",
@ -748,7 +762,12 @@ async def test_actor_restricted_permissions(
} }
if actor.get("id"): if actor.get("id"):
expected["actor_id"] = actor["id"] expected["actor_id"] = actor["id"]
assert response.json() == expected data = response.json()
for key, value in expected.items():
assert data[key] == value
assert data["actor"] == actor
assert data["explanation"]["allowed"] is expected_result
assert data["explanation"]["summary"]
PermConfigTestCase = collections.namedtuple( PermConfigTestCase = collections.namedtuple(
@ -1734,6 +1753,8 @@ async def test_permission_check_view_requires_debug_permission():
data = response.json() data = response.json()
assert data["action"] == "view-instance" assert data["action"] == "view-instance"
assert data["allowed"] is True assert data["allowed"] is True
assert data["explanation"]["allowed"] is True
assert data["explanation"]["summary"]
@pytest.mark.asyncio @pytest.mark.asyncio
@ -1759,6 +1780,211 @@ async def test_permission_check_view_query_actions(action):
} }
@pytest.mark.asyncio
async def test_permission_check_explains_specificity_for_hypothetical_actor():
ds = Datasette(
config={
"permissions": {"view-table": {"id": "alice"}},
"databases": {
"analytics": {
"permissions": {"view-table": False},
"tables": {
"public": {"permissions": {"view-table": {"id": "alice"}}}
},
}
},
}
)
ds.root_enabled = True
await ds.invoke_startup()
def path_for(child):
return "/-/check.json?" + urllib.parse.urlencode(
{
"action": "view-table",
"parent": "analytics",
"child": child,
"actor": json.dumps({"id": "alice"}),
}
)
public_response = await ds.client.get(path_for("public"), actor={"id": "root"})
assert public_response.status_code == 200
public = public_response.json()
assert public["actor"] == {"id": "alice"}
assert public["allowed"] is True
assert public["explanation"]["allowed"] is True
assert public["explanation"]["winning_scope"] == "resource"
public_rules = public["explanation"]["matched_rules"]
assert any(
rule["scope"] == "resource" and rule["effect"] == "allow" and rule["decisive"]
for rule in public_rules
)
assert any(
rule["scope"] == "parent"
and rule["effect"] == "deny"
and rule["ignored_because"] == "A more specific rule matched"
for rule in public_rules
)
private_response = await ds.client.get(path_for("private"), actor={"id": "root"})
assert private_response.status_code == 200
private = private_response.json()
assert private["allowed"] is False
assert private["explanation"]["allowed"] is False
assert private["explanation"]["winning_scope"] == "parent"
assert private["explanation"]["summary"].startswith("Denied by a parent-level rule")
@pytest.mark.asyncio
async def test_permission_check_explains_deny_wins_at_same_scope():
ds = Datasette(config={"permissions": {"view-table": {"id": "someone-else"}}})
ds.root_enabled = True
await ds.invoke_startup()
path = "/-/check.json?" + urllib.parse.urlencode(
{
"action": "view-table",
"parent": "analytics",
"child": "users",
"actor": json.dumps({"id": "alice"}),
}
)
response = await ds.client.get(path, actor={"id": "root"})
assert response.status_code == 200
data = response.json()
assert data["allowed"] is False
assert data["explanation"]["winning_scope"] == "global"
rules = data["explanation"]["matched_rules"]
assert any(rule["effect"] == "deny" and rule["decisive"] for rule in rules)
assert any(
rule["effect"] == "allow"
and rule["ignored_because"] == "A deny rule matched at the same scope"
for rule in rules
)
@pytest.mark.asyncio
async def test_permission_check_explains_default_deny():
ds = Datasette()
ds.root_enabled = True
await ds.invoke_startup()
path = "/-/check.json?" + urllib.parse.urlencode(
{
"action": "insert-row",
"parent": "analytics",
"child": "users",
"actor": json.dumps({"id": "alice"}),
}
)
response = await ds.client.get(path, actor={"id": "root"})
assert response.status_code == 200
data = response.json()
assert data["allowed"] is False
explanation = data["explanation"]
assert explanation["allowed"] is False
assert explanation["matched_rules"] == []
assert explanation["winning_scope"] is None
assert explanation["summary"] == (
"Denied because no permission rule matched this actor and resource."
)
@pytest.mark.asyncio
async def test_permission_check_explains_actor_restrictions():
ds = Datasette()
ds.root_enabled = True
await ds.invoke_startup()
restricted_actor = {
"id": "alice",
"_r": {"r": {"analytics": {"public": ["vt"]}}},
}
path = "/-/check.json?" + urllib.parse.urlencode(
{
"action": "view-table",
"parent": "analytics",
"child": "private",
"actor": json.dumps(restricted_actor),
}
)
response = await ds.client.get(path, actor={"id": "root"})
assert response.status_code == 200
data = response.json()
assert data["allowed"] is False
explanation = data["explanation"]
assert explanation["rule_allowed"] is True
assert explanation["restriction_allowed"] is False
assert explanation["allowed"] is False
assert explanation["restrictions"]
assert any(
restriction["allowed"] is False for restriction in explanation["restrictions"]
)
assert "actor's restrictions" in explanation["summary"]
@pytest.mark.asyncio
async def test_permission_check_explains_required_actions():
from datasette import hookimpl
from datasette.permissions import PermissionSQL
class StoreQueryPermissions:
@hookimpl
def permission_resources_sql(self, actor, action):
if not actor or actor.get("id") != "alice":
return None
if action == "store-query":
return PermissionSQL(
sql="SELECT 'analytics' AS parent, NULL AS child, 1 AS allow, 'alice can store queries' AS reason"
)
if action == "execute-sql":
return PermissionSQL(
sql="SELECT 'analytics' AS parent, NULL AS child, 0 AS allow, 'alice cannot execute SQL' AS reason"
)
ds = Datasette()
ds.root_enabled = True
await ds.invoke_startup()
ds.pm.register(StoreQueryPermissions(), name="store-query-test")
path = "/-/check.json?" + urllib.parse.urlencode(
{
"action": "store-query",
"parent": "analytics",
"actor": json.dumps({"id": "alice"}),
}
)
response = await ds.client.get(path, actor={"id": "root"})
assert response.status_code == 200
data = response.json()
assert data["allowed"] is False
explanation = data["explanation"]
assert explanation["rule_allowed"] is True
assert explanation["required_actions"][0]["action"] == "execute-sql"
assert explanation["required_actions"][0]["allowed"] is False
assert explanation["summary"] == (
"Denied because store-query also requires execute-sql, which was denied."
)
@pytest.mark.asyncio
async def test_permission_check_hypothetical_actor_validation():
ds = Datasette()
ds.root_enabled = True
await ds.invoke_startup()
response = await ds.client.get(
"/-/check.json?action=view-instance&actor=not-json",
actor={"id": "root"},
)
assert response.status_code == 400
assert response.json()["error"].startswith("Invalid actor JSON:")
response = await ds.client.get(
"/-/check.json?action=view-instance&actor=%5B%5D",
actor={"id": "root"},
)
assert response.status_code == 400
assert response.json()["error"] == "actor must be a JSON object or null"
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_root_allow_block_with_table_restricted_actor(): async def test_root_allow_block_with_table_restricted_actor():
""" """

View file

@ -1482,7 +1482,7 @@ async def test_plugin_is_installed():
datasette.pm.register(DummyPlugin(), name="DummyPlugin") datasette.pm.register(DummyPlugin(), name="DummyPlugin")
response = await datasette.client.get("/-/plugins.json") response = await datasette.client.get("/-/plugins.json")
assert response.status_code == 200 assert response.status_code == 200
installed_plugins = {p["name"] for p in response.json()["plugins"]} installed_plugins = {p["name"] for p in response.json()}
assert "DummyPlugin" in installed_plugins assert "DummyPlugin" in installed_plugins
finally: finally:

View file

@ -2,8 +2,8 @@
Tests for the canonical JSON success envelope. Tests for the canonical JSON success envelope.
Every JSON object returned by a Datasette endpoint on success should include Every JSON object returned by a Datasette endpoint on success should include
"ok": true. (Endpoints that return a top-level array are being converted to "ok": true. /-/plugins intentionally returns a top-level array instead, while
objects separately - see /-/plugins, /-/databases, /-/actions.) /-/databases and /-/actions use the object envelope.
""" """
import pytest import pytest
@ -79,17 +79,16 @@ async def test_permissions_post_success_has_ok_true(ds_envelope):
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_plugins_json_is_object(ds_client): async def test_plugins_json_is_array(ds_client):
response = await ds_client.get("/-/plugins.json") response = await ds_client.get("/-/plugins.json")
assert response.status_code == 200 assert response.status_code == 200
data = response.json() data = response.json()
assert set(data.keys()) == {"ok", "plugins"} assert isinstance(data, list)
assert data["ok"] is True assert all(isinstance(plugin, dict) for plugin in data)
assert isinstance(data["plugins"], list)
# ?all=1 should include Datasette's default plugins in the same shape # ?all=1 should include Datasette's default plugins in the same shape
response_all = await ds_client.get("/-/plugins.json?all=1") response_all = await ds_client.get("/-/plugins.json?all=1")
all_plugins = response_all.json()["plugins"] all_plugins = response_all.json()
assert len(all_plugins) > len(data["plugins"]) assert len(all_plugins) > len(data)
@pytest.mark.asyncio @pytest.mark.asyncio