-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #54 from Ehesp/ehesp/rework
Added type safety, feature toggles and shared RPC
- Loading branch information
Showing
22 changed files
with
2,228 additions
and
1,822 deletions.
There are no files selected for viewing
This file contains 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,95 @@ | ||
| import { HandlerConfig } from "../handler"; | ||
| import { DataSource } from "../types"; | ||
| import { StarbaseDBConfiguration } from "../handler"; | ||
| import { DataSource, QueryResult } from "../types"; | ||
|
|
||
| const parser = new (require('node-sql-parser').Parser)(); | ||
| const parser = new (require("node-sql-parser").Parser)(); | ||
|
|
||
| let allowlist: string[] | null = null; | ||
| let normalizedAllowlist: any[] | null = null; | ||
|
|
||
| function normalizeSQL(sql: string) { | ||
| // Remove trailing semicolon. This allows a user to send a SQL statement that has | ||
| // a semicolon where the allow list might not include it but both statements can | ||
| // equate to being the same. AST seems to have an issue with matching the difference | ||
| // when included in one query vs another. | ||
| return sql.trim().replace(/;\s*$/, ''); | ||
| // Remove trailing semicolon. This allows a user to send a SQL statement that has | ||
| // a semicolon where the allow list might not include it but both statements can | ||
| // equate to being the same. AST seems to have an issue with matching the difference | ||
| // when included in one query vs another. | ||
| return sql.trim().replace(/;\s*$/, ""); | ||
| } | ||
|
|
||
| async function loadAllowlist(dataSource?: DataSource): Promise<string[]> { | ||
| try { | ||
| const statement = 'SELECT sql_statement FROM tmp_allowlist_queries' | ||
| const result = await dataSource?.internalConnection?.durableObject.executeQuery(statement, [], false) as any[]; | ||
| return result.map((row: any) => row.sql_statement); | ||
| } catch (error) { | ||
| console.error('Error loading allowlist:', error); | ||
| return []; | ||
| } | ||
| async function loadAllowlist(dataSource: DataSource): Promise<string[]> { | ||
| try { | ||
| const statement = "SELECT sql_statement FROM tmp_allowlist_queries"; | ||
| const result = await dataSource.rpc.executeQuery({ sql: statement }) as QueryResult[] | ||
| return result.map((row) => String(row.sql_statement)); | ||
| } catch (error) { | ||
| console.error("Error loading allowlist:", error); | ||
| return []; | ||
| } | ||
| } | ||
|
|
||
| export async function isQueryAllowed(sql: string, isEnabled: boolean, dataSource?: DataSource, config?: HandlerConfig): Promise<boolean | Error> { | ||
| // If the feature is not turned on then by default the query is allowed | ||
| if (!isEnabled) return true; | ||
| export async function isQueryAllowed(opts: { | ||
| sql: string; | ||
| isEnabled: boolean; | ||
| dataSource: DataSource; | ||
| config: StarbaseDBConfiguration; | ||
| }): Promise<boolean | Error> { | ||
| const { sql, isEnabled, dataSource, config } = opts; | ||
|
|
||
| // If the feature is not turned on then by default the query is allowed | ||
| if (!isEnabled) return true; | ||
|
|
||
| // If we are using the administrative AUTHORIZATION token value, this request is allowed. | ||
| // We want database UI's to be able to have more free reign to run queries so we can load | ||
| // tables, run queries, and more. If you want to block queries with the allowlist then we | ||
| // advise you to do so by implementing user authentication with JWT. | ||
| if (config.role === "admin") { | ||
| return true; | ||
| } | ||
|
|
||
| // If we are using the administrative AUTHORIZATION token value, this request is allowed. | ||
| // We want database UI's to be able to have more free reign to run queries so we can load | ||
| // tables, run queries, and more. If you want to block queries with the allowlist then we | ||
| // advise you to do so by implementing user authentication with JWT. | ||
| if (dataSource?.request.headers.get('Authorization') === `Bearer ${config?.adminAuthorizationToken}`) { | ||
| return true; | ||
| allowlist = await loadAllowlist(dataSource); | ||
| normalizedAllowlist = allowlist.map((query) => | ||
| parser.astify(normalizeSQL(query)) | ||
| ); | ||
|
|
||
| try { | ||
| if (!sql) { | ||
| return Error("No SQL provided for allowlist check"); | ||
| } | ||
|
|
||
| allowlist = await loadAllowlist(dataSource); | ||
| normalizedAllowlist = allowlist.map(query => parser.astify(normalizeSQL(query))); | ||
|
|
||
| try { | ||
| if (!sql) { | ||
| return Error('No SQL provided for allowlist check') | ||
| } | ||
| const normalizedQuery = parser.astify(normalizeSQL(sql)); | ||
|
|
||
| // Compare ASTs while ignoring specific values | ||
| const isCurrentAllowed = normalizedAllowlist?.some((allowedQuery) => { | ||
| // Create deep copies to avoid modifying original ASTs | ||
| const allowedAst = JSON.parse(JSON.stringify(allowedQuery)); | ||
| const queryAst = JSON.parse(JSON.stringify(normalizedQuery)); | ||
|
|
||
| const normalizedQuery = parser.astify(normalizeSQL(sql)); | ||
|
|
||
| // Compare ASTs while ignoring specific values | ||
| const isCurrentAllowed = normalizedAllowlist?.some(allowedQuery => { | ||
| // Create deep copies to avoid modifying original ASTs | ||
| const allowedAst = JSON.parse(JSON.stringify(allowedQuery)); | ||
| const queryAst = JSON.parse(JSON.stringify(normalizedQuery)); | ||
|
|
||
| // Remove or normalize value fields from both ASTs | ||
| const normalizeAst = (ast: any) => { | ||
| if (Array.isArray(ast)) { | ||
| ast.forEach(normalizeAst); | ||
| } else if (ast && typeof ast === 'object') { | ||
| // Remove or normalize fields that contain specific values | ||
| if ('value' in ast) { | ||
| ast.value = '?'; | ||
| } | ||
|
|
||
| Object.values(ast).forEach(normalizeAst); | ||
| } | ||
|
|
||
| return ast; | ||
| }; | ||
|
|
||
| normalizeAst(allowedAst); | ||
| normalizeAst(queryAst); | ||
|
|
||
| return JSON.stringify(allowedAst) === JSON.stringify(queryAst); | ||
| }); | ||
|
|
||
| if (!isCurrentAllowed) { | ||
| throw new Error("Query not allowed"); | ||
| // Remove or normalize value fields from both ASTs | ||
| const normalizeAst = (ast: any) => { | ||
| if (Array.isArray(ast)) { | ||
| ast.forEach(normalizeAst); | ||
| } else if (ast && typeof ast === "object") { | ||
| // Remove or normalize fields that contain specific values | ||
| if ("value" in ast) { | ||
| ast.value = "?"; | ||
| } | ||
|
|
||
| Object.values(ast).forEach(normalizeAst); | ||
| } | ||
|
|
||
| return true; | ||
| } catch (error: any) { | ||
| throw new Error(error?.message ?? 'Error'); | ||
| return ast; | ||
| }; | ||
|
|
||
| normalizeAst(allowedAst); | ||
| normalizeAst(queryAst); | ||
|
|
||
| return JSON.stringify(allowedAst) === JSON.stringify(queryAst); | ||
| }); | ||
|
|
||
| if (!isCurrentAllowed) { | ||
| throw new Error("Query not allowed"); | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } catch (error: any) { | ||
| throw new Error(error?.message ?? "Error"); | ||
| } | ||
| } |
This file contains 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
Oops, something went wrong.