feat: Add --allow-function-prefix flag for restricted mode#154
Open
willfrey wants to merge 1 commit intocrystaldba:mainfrom
Open
feat: Add --allow-function-prefix flag for restricted mode#154willfrey wants to merge 1 commit intocrystaldba:mainfrom
willfrey wants to merge 1 commit intocrystaldba:mainfrom
Conversation
Allow specific function prefixes (e.g. st_ for PostGIS) to bypass the hardcoded ALLOWED_FUNCTIONS allowlist in restricted mode. The flag is repeatable and case-insensitive.
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.
Summary
--allow-function-prefixCLI flag that lets operators whitelist function prefixes (e.g.st_for PostGIS) in restricted mode, without opening up all functionsALLOWED_FUNCTIONSset is permittedMotivation
In restricted mode the SQL validator blocks any function not in the built-in allowlist. This makes it impossible to use extensions like PostGIS whose functions (
ST_Intersects,ST_DWithin, etc.) are safe read-only calls. Rather than hard-coding every extension's functions, this flag lets operators opt-in by prefix:Changes
server.py— new--allow-function-prefixargument (repeatable viaaction="append"), threaded through toSafeSqlDriversafe_sql.py—SafeSqlDriver.__init__acceptsallowed_function_prefixes; validation checks prefixes after the existing allowlist lookuptests/unit/sql/test_safe_sql.py— three new tests covering prefix-allowed, prefix-not-set-blocks, and case-insensitive matchingTest plan