Type:
Module
Constants:
CROSS_ORIGIN_JAVASCRIPT_WARNING : "Security warning: an embedded " \ "<script> tag on another site requested protected JavaScript. " \ "If you know what you're doing, go ahead and disable forgery " \ "protection on this action to permit cross-origin JavaScript embedding."

Controller actions are protected from Cross-Site Request Forgery (CSRF) attacks by including a token in the rendered html for your application. This token is stored as a random string in the session, to which an attacker does not have access. When a request reaches your application, Rails verifies the received token with the token in the session. Only HTML and JavaScript requests are checked, so this will not protect your XML API (presumably you'll have a different authentication scheme there anyway).

GET requests are not protected since they don't have side effects like writing to the database and don't leak sensitive information. JavaScript requests are an exception: a third-party site can use a <script> tag to reference a JavaScript URL on your site. When your JavaScript response loads on their site, it executes. With carefully crafted JavaScript on their end, sensitive data in your JavaScript response may be extracted. To prevent this, only XmlHttpRequest (known as XHR or Ajax) requests are allowed to make GET requests for JavaScript responses.

It's important to remember that XML or JSON requests are also affected and if you're building an API you'll need something like:

class ApplicationController < ActionController::Base
  protect_from_forgery
  skip_before_action :verify_authenticity_token, if: :json_request?

  protected

  def json_request?
    request.format.json?
  end
end

CSRF protection is turned on with the protect_from_forgery method, which checks the token and resets the session if it doesn't match what was expected. A call to this method is generated for new Rails applications by default.

The token parameter is named authenticity_token by default. The name and value of this token must be added to every layout that renders forms by including csrf_meta_tags in the html head.

Learn more about CSRF attacks and securing your application in the Ruby on Rails Security Guide.

verified_request?

verified_request?() Instance Protected methods Returns true or false if a request

2015-06-20 00:00:00
handle_unverified_request

handle_unverified_request() Instance Protected methods

2015-06-20 00:00:00
marked_for_same_origin_verification?

marked_for_same_origin_verification?() Instance Protected methods If the `v

2015-06-20 00:00:00
protect_against_forgery?

protect_against_forgery?() Instance Protected methods Checks if the controller

2015-06-20 00:00:00
mark_for_same_origin_verification!

mark_for_same_origin_verification!() Instance Protected methods GET requests

2015-06-20 00:00:00
form_authenticity_param

form_authenticity_param() Instance Protected methods The form's authenticity

2015-06-20 00:00:00
non_xhr_javascript_response?

non_xhr_javascript_response?() Instance Protected methods Check for cross-origin

2015-06-20 00:00:00
verify_same_origin_request

verify_same_origin_request() Instance Protected methods If `verify_authenticity_token`

2015-06-20 00:00:00
verify_authenticity_token

verify_authenticity_token() Instance Protected methods The actual before_action

2015-06-20 00:00:00
form_authenticity_token

form_authenticity_token() Instance Protected methods Sets the token value for

2015-06-20 00:00:00