Conversation
…uterbase#52) - Support bypassAllowlist flag in executeQuery and executeTransaction - Configure LiteREST to bypass allowlist for internal parameterized queries - Add ALLOWLIST_BYPASS_REST configuration toggle (default true) - Add comprehensive Vitest unit tests for allowlist bypass behavior
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Resolves #52.
When
ENABLE_ALLOWLIST = 1is set inwrangler.toml, accessing REST API endpoints (/rest/...) fails because the queries generated byLiteREST(internal schema introspection such asPRAGMA table_info(...)and parameterized CRUD operations) are blocked by the static SQL allowlist check.This PR provides a clean and secure resolution without introducing regex loopholes into
isQueryAllowed(which would allow arbitrary external/queryrequests to run unwhitelisted PRAGMA queries):bypassAllowlistflag: Added optionalbypassAllowlist?: booleanparameter toexecuteQueryandexecuteTransactioninsrc/operation.ts.LiteREST:LiteRESTuses this flag for its internal metadata and parameterized queries by default. Row-Level Security (RLS) and query hooks remain fully active and enforced.ALLOWLIST_BYPASS_REST = 1inwrangler.tomlandallowlistBypassRest?: booleaninStarbaseDBConfiguration.features(defaults totrue), allowing users to toggle this behavior if desired./queryor via WebSockets never setbypassAllowlistand remain strictly validated againsttmp_allowlist_queries.Tasks
bypassAllowlist?: booleaninexecuteQueryandexecuteTransactionLiteRESTto bypass allowlist for internal schema and parameterized queriesALLOWLIST_BYPASS_RESTinwrangler.tomlandStarbaseDBConfigurationsrc/operation.test.tsandsrc/literest/index.test.tsVerify
Run Vitest: