/Ruby on Rails 7.0

module ActionController::RequestForgeryProtection::ClassMethods

Public Instance Methods

protect_from_forgery(options = {}) Show source
# File actionpack/lib/action_controller/metal/request_forgery_protection.rb, line 156
def protect_from_forgery(options = {})
  options = options.reverse_merge(prepend: false)

  self.forgery_protection_strategy = protection_method_class(options[:with] || :null_session)
  self.request_forgery_protection_token ||= :authenticity_token
  before_action :verify_authenticity_token, options
  append_after_action :verify_same_origin_request

Turn on request forgery protection. Bear in mind that GET and HEAD requests are not checked.

class ApplicationController < ActionController::Base

class FooController < ApplicationController
  protect_from_forgery except: :index

You can disable forgery protection on controller by skipping the verification before_action:

skip_before_action :verify_authenticity_token

Valid Options:

  • :only/:except - Only apply forgery protection to a subset of actions. For example only: [ :create, :create_all ].

  • :if/:unless - Turn off the forgery protection entirely depending on the passed Proc or method reference.

  • :prepend - By default, the verification of the authentication token will be added at the position of the protect_from_forgery call in your application. This means any callbacks added before are run first. This is useful when you want your forgery protection to depend on other callbacks, like authentication methods (Oauth vs Cookie auth).

    If you need to add verification to the beginning of the callback chain, use prepend: true.

  • :with - Set the method to handle unverified request.

Built-in unverified request handling methods are:

  • :exception - Raises ActionController::InvalidAuthenticityToken exception.

  • :reset_session - Resets the session.

  • :null_session - Provides an empty session during request but doesn't reset it completely. Used as default if :with option is not specified.

You can also implement custom strategy classes for unverified request handling:

class CustomStrategy
  def initialize(controller)
    @controller = controller

  def handle_unverified_request
    # Custom behaviour for unverfied request

class ApplicationController < ActionController:x:Base
  protect_from_forgery with: CustomStrategy
skip_forgery_protection(options = {}) Show source
# File actionpack/lib/action_controller/metal/request_forgery_protection.rb, line 170
def skip_forgery_protection(options = {})
  skip_before_action :verify_authenticity_token, options

Turn off request forgery protection. This is a wrapper for:

skip_before_action :verify_authenticity_token

See skip_before_action for allowed options.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.