I've read about this for some time now on various SO threads, guides, etc... but all the answers are conflicting and contradictory.
It seems there's many similar methods, and a lot of the answers say to use a different one.
sanitize
sanitize_conditions
sanitize_sql
sanitize_sql_array
sanitize_sql_for_assignment
sanitize_sql_for_conditions
sanitize_sql_hash
sanitize_sql_hash_for_assignment
sanitize_sql_hash_for_conditions
sanitize_sql_like
I'm trying to write a 'raw query' adapter that lets me run raw Postgres queries, but allowing me to insert my own parameters that come from dangerous user input.
I can't use AR in these few instances because I'm doing complex lat/long calculations, aggregate functions, complex subqueries, etc.
So far I have tried 2 approaches:
Method 1
For this method, I don't know if sanitize
is the best option of the above, or if it will work in 100% of cases... (I'm using Postgres only)
class RawQuery
def exec(prepared, *params)
prepared = query.dup
params.flatten.each_with_index do |p, i|
prepared.gsub!("$#{i + 1}", ActiveRecord::Base.sanitize(p))
end
ActiveRecord::Base.connection.exec_query(prepared)
end
end
Trivial usage example (normally it wouldn't be this simple of course, or I would just use AR):
RawQuery.new.exec('SELECT * FROM users WHERE name = $1', params[:name])
Furthermore it seems that sanitize
delegates to quote
. But according to this SO post it says simply wrapping things with single quotes isn't secure... so I have no idea.
Method 2
I'm not sure if this is just as secure, but it seems to use an actual PG prepared function (which I assume is 100% secure). The only problem is rails doesn't print it out to the console, nor include the SQL execution time (which breaks my profiling tools).
class RawQuery
def prepare(query, *params)
name = "raw_query_#{SecureRandom.uuid.gsub('-', '')}"
connection = ActiveRecord::Base.connection.raw_connection
connection.prepare(name, query)
connection.exec_prepared(name, params)
end
end
Used the same way:
RawQuery.new.prepare('SELECT * FROM users WHERE name = $1', params[:name])
Is one method more secure over another? Are both 100% secure?
My apps always extend far outside of what Rails is capable of SQL-wise and I need a good lib I can include on all my projects which I know is completely safe.
Using quote
is safe. I read the answers on the page you linked to, and I don't see anyone saying that quote
is insecure. I see your question about using "quotes". Yes, if you just put quotes around a string, that is insecure, e.g.:
q = "SELECT * FROM users where email = '#{params[:email]}'"
But using quote
(the method) is fine:
q = "SELECT * FROM users where email = #{connection.quote(params[:email])}"
You could play around in the console and try your best to break it, but I don't think you'll be able to:
2.3.3 :003 > ActiveRecord::Base.connection.quote("f''oo")
=> "'f''''oo'"
If you succeed, I'm sure the Rails team would like to know (privately)! But as you can see, the quote
method does more than stick a quote at the beginning and end.
Also, since you say you are looking for an authoritative citation, the comments in the source code itself suggest that quoting user inputs is the intended purpose of these functions:
https://github.com/rails/rails/blob/2471e6391dfe71cfbb8621bdf573729d961d3209/activerecord/lib/active_record/connection_adapters/abstract/quoting.rb#L6-L13
# Quotes the column value to help prevent
# {SQL injection attacks}[http://en.wikipedia.org/wiki/SQL_injection].
def quote(value)
https://github.com/rails/rails/blob/0f1d0b1b5254e3678abaabbebb3362a100c10262/activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb#L17-L20
# Quotes strings for use in SQL input.
def quote_string(s) #:nodoc:
(Note I am showing quote_string
for the comment, but you should probably use quote
, which tries to figure out the data type and do something appropriate.)
By the way, here is a similar question to yours, with an answer from me in 2014, and some alternatives too: How to execute a raw update sql with dynamic binding in rails
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With