Test parameter escaping #46
Merged
Conversation
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
susodapop
requested review from
arikfr,
moderakh and
yunbodeng-db
as code owners
moderakh
approved these changes
Sep 1, 2022
There was a problem hiding this comment.
Thanks @susodapop LGTM.
I added a few non-blocking comments for adding more tests.
mcannamela
reviewed
Sep 26, 2022
tests/unit/test_param_escaper.py
Outdated
| assert pe.escape_string("golly bob howdy") == "'golly bob howdy'" | ||
|
|
||
| def test_escape_string_that_includes_quotes(self): | ||
| # Databricks queries support just one special character: a single quote mark |
There was a problem hiding this comment.
i don't understand this comment, per the spark docs backslash is used for escaping (so it too is a special character)
you might also try this query in Databricks SQL:
select 'cat\'s meow'
union all
select 'cat\\\'s meow'
union all
select '\U0001F44D \u3042'
see also #51
There was a problem hiding this comment.
Good callout. Removing this comment in dd25478
added 2 commits
October 3, 2022 11:24
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
susodapop
force-pushed
the
test-param-escaping
branch
from
67a3841 to
bce1598
Compare
added 8 commits
October 10, 2022 14:55
escaping a single quote with a second single quote. Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
…provided Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
This was originally written in such a way that it always passed. Signed-off-by: Jesse Whitehouse <[email protected]>
ueshin
added a commit
to databricks/dbt-databricks
that referenced
this pull request
Jan 12, 2023
### Description Upgrades `databricks-sql-connector` to `2.2.2`. It includes: - Add tests for parameter sanitisation / escaping (databricks/databricks-sql-python#46) for the fix for #249 - Support Python 3.11 (databricks/databricks-sql-python#60)
ueshin
added a commit
to databricks/dbt-databricks
that referenced
this pull request
Jan 12, 2023
### Description Upgrades `databricks-sql-connector` to `2.2.2`. It includes: - Add tests for parameter sanitisation / escaping (databricks/databricks-sql-python#46) for the fix for #249 - Support Python 3.11 (databricks/databricks-sql-python#60)
ueshin
added a commit
to databricks/dbt-databricks
that referenced
this pull request
Jan 12, 2023
### Description Upgrades `databricks-sql-connector` to `2.2.2`. It includes: - Add tests for parameter sanitisation / escaping (databricks/databricks-sql-python#46) for the fix for #249 - Support Python 3.11 (databricks/databricks-sql-python#60)
ueshin
added a commit
to databricks/dbt-databricks
that referenced
this pull request
Jan 12, 2023
### Description Upgrades `databricks-sql-connector` to `2.2.2`. It includes: - Add tests for parameter sanitisation / escaping (databricks/databricks-sql-python#46) for the fix for #249 - Support Python 3.11 (databricks/databricks-sql-python#60)
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.
Background
databricks-sql-connectoradheres to PEP-249 which defines a parameter binding API. For supported databases, parameter binding avoids SQL-injection vulnerabilities because parameter values are always escaped at runtime. The hive thrift server doesn't support safe parameter binding (yet!). This means that all queries are passed as strings and are therefore vulnerable to SQL-injection. It's the client's responsibility to safely handle parameterised input before callingcursor.execute(<some query text>).databricks-sql-connectorautomatically sanitises inputs that follow the PEP-249 calling convention. This pull request adds unit tests to demonstrate the sanitisation behaviour. It also sets a baseline we can use for testing server-side parameter binding once it's supported by the Databricks runtime.In a follow-up PR, I will add examples that use the PEP-249 parameter binding interface. Once Databricks runtime supports proper server-side binding, users of
databricks-sql-connectorwill benefit from its enhanced safety "for free", without needing to rewrite their client code.