Build SQL expressions with Arel instead of string interpolation #2418
Conversation
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
nickcharlton
approved these changes
Dec 12, 2023
| @@ -0,0 +1,5 @@ | |||
| RSpec::Matchers.define :to_sql do |sql| | |||
| match do |actual| | |||
| actual.to_sql == sql | |||
In Administrate::Order, there are several places where we are building
SQL expressions using string interpolation, e.g. order =
"#{relation.table_name}.#{attribute} #{direction}". Doing this can be
dangerous, because it's easy to introduce a SQL injection vulnerability.
Thankfully, it seems like this class is carefully designed in a way that
prevents such a vulnerability. Nevertheless, it feels precarious; if
someone makes changes, they have to be very careful to keep the code
safe.
This change replaces all string-interpolated SQL expressions with Arel
expressions. The database adapter will then automatically quote &
sanitize the components of these expressions.
nickcharlton
force-pushed
the
replace-raw-sql-with-arel
branch
from
e2e2b8f to
b215833
Compare
|
I just rebased (only actual change I made was to add the contents of your PR description to the commit itself) and I'll merge this in a bit. |
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.
There, but for the grace of
column_exist?, go we.In
Administrate::Order, there are several places where we are building SQL expressions using string interpolation, e.g.order = "#{relation.table_name}.#{attribute} #{direction}". Doing this can be dangerous, because it's easy to introduce a SQL injection vulnerability. Thankfully, it seems like this class is carefully designed in a way that prevents such a vulnerability. Nevertheless, it feels precarious; if someone makes changes, they have to be very careful to keep the code safe.This change replaces all string-interpolated SQL expressions with Arel expressions. The database adapter will then automatically quote & sanitize the components of these expressions.