Repository navigation
Fix SQL injection in connector sample path and validate source queries #688
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vishwasvaidya-cloudsufi
wants to merge
1
commit into
develop
Choose a base branch
from
sql-identifier-escaping
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
48 changes: 48 additions & 0 deletions
48
...ql-plugin/src/test/java/io/cdap/plugin/cloudsql/mysql/CloudSQLMySQLConnectorUnitTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright © 2026 Cask Data, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package io.cdap.plugin.cloudsql.mysql; | ||
|
|
||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Unit tests for {@link CloudSQLMySQLConnector} | ||
| */ | ||
| public class CloudSQLMySQLConnectorUnitTest { | ||
|
|
||
| private static final CloudSQLMySQLConnector CONNECTOR = new CloudSQLMySQLConnector( | ||
| new CloudSQLMySQLConnectorConfig("user", "password", "cloudsql-mysql", "", "public", | ||
| "project:region:instance", "db", null)); | ||
|
|
||
| /** | ||
| * Unit test for getTableName() | ||
| */ | ||
| @Test | ||
| public void getTableNameTest() { | ||
| Assert.assertEquals("`db`.`table`", | ||
| CONNECTOR.getTableName("db", null, "table")); | ||
| } | ||
|
|
||
| /** | ||
| * Unit test for getTableName() with identifiers containing backticks | ||
| */ | ||
| @Test | ||
| public void getTableNameEscapesBackticksTest() { | ||
| Assert.assertEquals("`my``db`.`t``; DELETE FROM x; --`", | ||
| CONNECTOR.getTableName("my`db", null, "t`; DELETE FROM x; --")); | ||
| } | ||
| } |
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
54 changes: 54 additions & 0 deletions
54
...n/src/test/java/io/cdap/plugin/cloudsql/postgres/CloudSQLPostgreSQLConnectorUnitTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * Copyright © 2026 Cask Data, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package io.cdap.plugin.cloudsql.postgres; | ||
|
|
||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Unit tests for {@link CloudSQLPostgreSQLConnector} | ||
| */ | ||
| public class CloudSQLPostgreSQLConnectorUnitTest { | ||
|
|
||
| private static final CloudSQLPostgreSQLConnector CONNECTOR = new CloudSQLPostgreSQLConnector( | ||
| new CloudSQLPostgreSQLConnectorConfig("user", "password", "cloudsql-postgresql", "", "public", | ||
| "project:region:instance", "db", null)); | ||
|
|
||
| /** | ||
| * Unit test for getTableName() | ||
| */ | ||
| @Test | ||
| public void getTableNameTest() { | ||
| Assert.assertEquals("\"schema\".\"table\"", | ||
| CONNECTOR.getTableName("db", "schema", "table")); | ||
| } | ||
|
|
||
| /** | ||
| * Unit test for getTableName() with identifiers containing double quotes, using the payload from the | ||
| * reported sample path SQL injection | ||
| */ | ||
| @Test | ||
| public void getTableNameEscapesQuotesTest() { | ||
| String table = "pg_class\" LIMIT 0; UPDATE audit_vault.write_marker SET value='INJECTED_BY_SAMPLE_PATH' " + | ||
| "WHERE id=1; SELECT * FROM \"pg_catalog\".\"pg_class"; | ||
| Assert.assertEquals("\"pg_catalog\".\"pg_class\"\" LIMIT 0; UPDATE audit_vault.write_marker SET " + | ||
| "value='INJECTED_BY_SAMPLE_PATH' WHERE id=1; SELECT * FROM \"\"pg_catalog\"\".\"\"pg_class\"", | ||
| CONNECTOR.getTableName("db", "pg_catalog", table)); | ||
| Assert.assertEquals("\"my\"\"schema\".\"table\"", | ||
| CONNECTOR.getTableName("db", "my\"schema", "table")); | ||
| } | ||
| } |
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
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
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
133 changes: 133 additions & 0 deletions
133
database-commons/src/main/java/io/cdap/plugin/util/SelectQueryValidator.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /* | ||
| * Copyright © 2026 Cask Data, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy of | ||
| * the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations under | ||
| * the License. | ||
| */ | ||
|
|
||
| package io.cdap.plugin.util; | ||
|
|
||
| import com.google.common.util.concurrent.ThreadFactoryBuilder; | ||
| import net.sf.jsqlparser.JSQLParserException; | ||
| import net.sf.jsqlparser.parser.CCJSqlParserUtil; | ||
| import net.sf.jsqlparser.statement.Statement; | ||
| import net.sf.jsqlparser.statement.Statements; | ||
| import net.sf.jsqlparser.statement.select.ParenthesedSelect; | ||
| import net.sf.jsqlparser.statement.select.PlainSelect; | ||
| import net.sf.jsqlparser.statement.select.Select; | ||
| import net.sf.jsqlparser.statement.select.SetOperationList; | ||
| import net.sf.jsqlparser.statement.select.WithItem; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ThreadFactory; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Validates that a user provided query is a single, read-only SELECT statement before it is executed with the | ||
| * credential of a database connection. | ||
| */ | ||
| public final class SelectQueryValidator { | ||
|
|
||
| private static final long PARSE_TIMEOUT_MS = 10_000L; | ||
| // Placeholder replaced with the split condition at runtime, it is not valid SQL on its own | ||
| private static final String CONDITIONS_PLACEHOLDER = "$CONDITIONS"; | ||
| private static final ThreadFactory PARSER_THREAD_FACTORY = new ThreadFactoryBuilder() | ||
| .setDaemon(true).setNameFormat("select-query-validator-%d").build(); | ||
|
|
||
| private SelectQueryValidator() { | ||
| } | ||
|
|
||
| /** | ||
| * Validates that the given query is a single read-only SELECT statement. | ||
| * | ||
| * @param query the query to validate | ||
| * @param squareBracketQuotes whether square brackets quote identifiers, as in SQL Server | ||
| * @throws IllegalArgumentException if the query cannot be parsed or is not a single read-only SELECT statement | ||
| */ | ||
| public static void validate(String query, boolean squareBracketQuotes) { | ||
| String parsableQuery = query.replace(CONDITIONS_PLACEHOLDER, "1 = 1"); | ||
| // Databases disagree on whether a backslash escapes a quote inside a string literal. Requiring a single SELECT | ||
| // under both interpretations makes sure a crafted string literal cannot hide a second statement. | ||
| validate(parsableQuery, squareBracketQuotes, false); | ||
| validate(parsableQuery, squareBracketQuotes, true); | ||
| } | ||
|
|
||
| private static void validate(String query, boolean squareBracketQuotes, boolean backslashEscapes) { | ||
| Statements statements; | ||
| // Use our own executor so that its thread is always released, the parser does not shut down its own executor | ||
| // when parsing fails. | ||
| ExecutorService executor = Executors.newSingleThreadExecutor(PARSER_THREAD_FACTORY); | ||
| try { | ||
| statements = CCJSqlParserUtil.parseStatements(query, executor, parser -> parser | ||
| .withSquareBracketQuotation(squareBracketQuotes) | ||
| .withBackslashEscapeCharacter(backslashEscapes) | ||
| .withTimeOut(PARSE_TIMEOUT_MS)); | ||
| } catch (JSQLParserException e) { | ||
| throw new IllegalArgumentException( | ||
| "Query could not be parsed. Only a single SELECT statement is allowed. Error: " + firstLine(e), e); | ||
| } finally { | ||
| executor.shutdownNow(); | ||
| } | ||
|
|
||
| // the parser returns null for an empty query | ||
| List<Statement> nonEmptyStatements = statements == null ? Collections.emptyList() | ||
| : statements.stream().filter(Objects::nonNull).collect(Collectors.toList()); | ||
| if (nonEmptyStatements.size() != 1) { | ||
| throw new IllegalArgumentException(String.format( | ||
| "Only a single SELECT statement is allowed, but found %d statements.", nonEmptyStatements.size())); | ||
| } | ||
| Statement statement = nonEmptyStatements.get(0); | ||
| if (!(statement instanceof Select)) { | ||
| throw new IllegalArgumentException(String.format( | ||
| "Only a SELECT statement is allowed, but found a %s statement.", statement.getClass().getSimpleName())); | ||
| } | ||
| validateSelect((Select) statement); | ||
| } | ||
|
|
||
| private static void validateSelect(Select select) { | ||
| if (select.getWithItemsList() != null) { | ||
| for (WithItem withItem : select.getWithItemsList()) { | ||
| validateSelect(withItem.getSelect()); | ||
| } | ||
| } | ||
| if (select instanceof PlainSelect) { | ||
| PlainSelect plainSelect = (PlainSelect) select; | ||
| if ((plainSelect.getIntoTables() != null && !plainSelect.getIntoTables().isEmpty()) | ||
| || plainSelect.getIntoTempTable() != null) { | ||
| throw new IllegalArgumentException("SELECT ... INTO is not allowed, the query must only read data."); | ||
| } | ||
| if (plainSelect.getForMode() != null) { | ||
| throw new IllegalArgumentException(String.format( | ||
| "SELECT ... FOR %s is not allowed, the query must only read data.", plainSelect.getForMode().getValue())); | ||
| } | ||
| } else if (select instanceof SetOperationList) { | ||
| for (Select operand : ((SetOperationList) select).getSelects()) { | ||
| validateSelect(operand); | ||
| } | ||
| } else if (select instanceof ParenthesedSelect) { | ||
| validateSelect(((ParenthesedSelect) select).getSelect()); | ||
| } else { | ||
| throw new IllegalArgumentException(String.format( | ||
| "Unsupported SELECT statement of type %s.", select.getClass().getSimpleName())); | ||
| } | ||
| } | ||
|
|
||
| private static String firstLine(Exception e) { | ||
| String message = String.valueOf(e.getMessage()); | ||
| int newLine = message.indexOf('\n'); | ||
| return newLine < 0 ? message : message.substring(0, newLine); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.