2007-09-22 22:32:55 -04:00
|
|
|
module ActionController #:nodoc:
|
2007-09-24 19:12:25 -04:00
|
|
|
class InvalidAuthenticityToken < ActionControllerError #:nodoc:
|
|
|
|
end
|
2007-09-22 22:32:55 -04:00
|
|
|
|
|
|
|
module RequestForgeryProtection
|
2009-05-28 12:35:36 -04:00
|
|
|
extend ActiveSupport::Concern
|
2009-05-21 05:50:34 -04:00
|
|
|
|
|
|
|
# TODO : Remove the defined? check when new base is the main base
|
2009-06-17 19:14:05 -04:00
|
|
|
include AbstractController::Helpers, Session
|
2009-05-21 05:50:34 -04:00
|
|
|
|
|
|
|
included do
|
2009-06-17 19:14:05 -04:00
|
|
|
# Sets the token parameter name for RequestForgery. Calling +protect_from_forgery+
|
|
|
|
# sets it to <tt>:authenticity_token</tt> by default.
|
|
|
|
cattr_accessor :request_forgery_protection_token
|
2009-05-21 05:50:34 -04:00
|
|
|
|
2009-06-17 19:14:05 -04:00
|
|
|
# Controls whether request forgergy protection is turned on or not. Turned off by default only in test mode.
|
|
|
|
class_inheritable_accessor :allow_forgery_protection
|
|
|
|
self.allow_forgery_protection = true
|
2009-05-21 05:50:34 -04:00
|
|
|
|
|
|
|
helper_method :form_authenticity_token
|
|
|
|
helper_method :protect_against_forgery?
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
|
|
|
|
2008-02-06 13:50:48 -05:00
|
|
|
# Protecting controller actions from CSRF attacks by ensuring that all forms are coming from the current web application, not a
|
2008-11-20 17:06:19 -05:00
|
|
|
# forged link from another site, is done by embedding a token based on a random string stored in the session (which an attacker wouldn't know) in all
|
2008-02-06 13:50:48 -05:00
|
|
|
# forms and Ajax requests generated by Rails and then verifying the authenticity of that token in the controller. Only
|
|
|
|
# HTML/JavaScript requests are checked, so this will not protect your XML API (presumably you'll have a different authentication
|
2008-07-16 08:00:36 -04:00
|
|
|
# scheme there anyway). Also, GET requests are not protected as these should be idempotent anyway.
|
2008-02-06 13:50:48 -05:00
|
|
|
#
|
|
|
|
# This is turned on with the <tt>protect_from_forgery</tt> method, which will check the token and raise an
|
|
|
|
# ActionController::InvalidAuthenticityToken if it doesn't match what was expected. You can customize the error message in
|
|
|
|
# production by editing public/422.html. A call to this method in ApplicationController is generated by default in post-Rails 2.0
|
|
|
|
# applications.
|
|
|
|
#
|
|
|
|
# The token parameter is named <tt>authenticity_token</tt> by default. If you are generating an HTML form manually (without the
|
|
|
|
# use of Rails' <tt>form_for</tt>, <tt>form_tag</tt> or other helpers), you have to include a hidden field named like that and
|
|
|
|
# set its value to what is returned by <tt>form_authenticity_token</tt>. Same applies to manually constructed Ajax requests. To
|
|
|
|
# make the token available through a global variable to scripts on a certain page, you could add something like this to a view:
|
|
|
|
#
|
|
|
|
# <%= javascript_tag "window._token = '#{form_authenticity_token}'" %>
|
|
|
|
#
|
|
|
|
# Request forgery protection is disabled by default in test environment. If you are upgrading from Rails 1.x, add this to
|
|
|
|
# config/environments/test.rb:
|
|
|
|
#
|
|
|
|
# # Disable request forgery protection in test environment
|
|
|
|
# config.action_controller.allow_forgery_protection = false
|
|
|
|
#
|
|
|
|
# == Learn more about CSRF (Cross-Site Request Forgery) attacks
|
|
|
|
#
|
|
|
|
# Here are some resources:
|
|
|
|
# * http://isc.sans.org/diary.html?storyid=1750
|
|
|
|
# * http://en.wikipedia.org/wiki/Cross-site_request_forgery
|
|
|
|
#
|
|
|
|
# Keep in mind, this is NOT a silver-bullet, plug 'n' play, warm security blanket for your rails application.
|
|
|
|
# There are a few guidelines you should follow:
|
|
|
|
#
|
|
|
|
# * Keep your GET requests safe and idempotent. More reading material:
|
|
|
|
# * http://www.xml.com/pub/a/2002/04/24/deviant.html
|
|
|
|
# * http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.1.1
|
|
|
|
# * Make sure the session cookies that Rails creates are non-persistent. Check in Firefox and look for "Expires: at end of session"
|
|
|
|
#
|
2007-09-22 22:32:55 -04:00
|
|
|
module ClassMethods
|
2008-02-06 13:50:48 -05:00
|
|
|
# Turn on request forgery protection. Bear in mind that only non-GET, HTML/JavaScript requests are checked.
|
2007-09-24 19:12:25 -04:00
|
|
|
#
|
2007-09-24 13:02:02 -04:00
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# class FooController < ApplicationController
|
|
|
|
# protect_from_forgery :except => :index
|
|
|
|
#
|
2007-09-28 11:55:45 -04:00
|
|
|
# # you can disable csrf protection on controller-by-controller basis:
|
|
|
|
# skip_before_filter :verify_authenticity_token
|
2007-09-24 13:02:02 -04:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# Valid Options:
|
|
|
|
#
|
2008-05-09 05:38:02 -04:00
|
|
|
# * <tt>:only/:except</tt> - Passed to the <tt>before_filter</tt> call. Set which actions are verified.
|
2007-09-23 14:14:44 -04:00
|
|
|
def protect_from_forgery(options = {})
|
|
|
|
self.request_forgery_protection_token ||= :authenticity_token
|
|
|
|
before_filter :verify_authenticity_token, :only => options.delete(:only), :except => options.delete(:except)
|
2008-11-20 17:06:19 -05:00
|
|
|
if options[:secret] || options[:digest]
|
|
|
|
ActiveSupport::Deprecation.warn("protect_from_forgery only takes :only and :except options now. :digest and :secret have no effect", caller)
|
|
|
|
end
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
protected
|
|
|
|
# The actual before_filter that is used. Modify this to change how you handle unverified requests.
|
2007-09-23 14:14:44 -04:00
|
|
|
def verify_authenticity_token
|
2007-09-24 19:12:25 -04:00
|
|
|
verified_request? || raise(ActionController::InvalidAuthenticityToken)
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
# Returns true or false if a request is verified. Checks:
|
|
|
|
#
|
2009-03-04 16:05:15 -05:00
|
|
|
# * is the format restricted? By default, only HTML requests are checked.
|
2007-09-22 22:32:55 -04:00
|
|
|
# * is it a GET request? Gets should be safe and idempotent
|
2008-11-20 17:06:19 -05:00
|
|
|
# * Does the form_authenticity_token match the given token value from the params?
|
2007-09-22 22:32:55 -04:00
|
|
|
def verified_request?
|
2007-09-28 11:55:45 -04:00
|
|
|
!protect_against_forgery? ||
|
|
|
|
request.method == :get ||
|
2009-03-04 16:05:15 -05:00
|
|
|
request.xhr? ||
|
2007-09-28 11:55:45 -04:00
|
|
|
!verifiable_request_format? ||
|
2007-09-23 14:14:44 -04:00
|
|
|
form_authenticity_token == params[request_forgery_protection_token]
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def verifiable_request_format?
|
2008-11-01 00:10:44 -04:00
|
|
|
!request.content_type.nil? && request.content_type.verify_request?
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
|
|
|
|
2009-07-25 11:03:58 -04:00
|
|
|
# Sets the token value for the current session.
|
2007-09-23 14:14:44 -04:00
|
|
|
def form_authenticity_token
|
2008-11-20 17:06:19 -05:00
|
|
|
session[:_csrf_token] ||= ActiveSupport::SecureRandom.base64(32)
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
2008-11-20 17:06:19 -05:00
|
|
|
|
2007-09-28 11:55:45 -04:00
|
|
|
def protect_against_forgery?
|
|
|
|
allow_forgery_protection && request_forgery_protection_token
|
|
|
|
end
|
2007-09-22 22:32:55 -04:00
|
|
|
end
|
2007-12-09 20:15:30 -05:00
|
|
|
end
|