CSRF protection in Ruby on Rails

Introduction

CSRF protection stops bad websites from tricking you into doing things you don't want on other sites. It keeps your actions safe and private.

When you have forms that change data, like submitting a comment or updating a profile.

When your app accepts POST, PUT, PATCH, or DELETE requests from users.

When you want to make sure only your website can send important requests.

When you want to protect users from malicious attacks that use their login without permission.

Syntax

Ruby on Rails

class ApplicationController < ActionController::Base
  protect_from_forgery with: :exception
end

This line is usually in ApplicationController to protect all controllers by default.

The :exception option stops the request if the CSRF token is missing or wrong.

Examples

This option resets the session instead of raising an error, useful for APIs.

Ruby on Rails

class ApplicationController < ActionController::Base
  protect_from_forgery with: :null_session
end

Rails automatically adds a hidden CSRF token field in forms created with helpers like form_with.

Ruby on Rails

<%= form_with(model: @post) do |form| %>
  <%= form.text_field :title %>
  <%= form.submit %>
<% end %>

Use this to skip CSRF check for specific actions like webhooks that come from external services.

Ruby on Rails

skip_before_action :verify_authenticity_token, only: [:webhook]

Sample Program

This example shows a simple posts controller with CSRF protection enabled by default. The form automatically includes the CSRF token, so Rails can verify requests are safe.

Ruby on Rails

class ApplicationController < ActionController::Base
  protect_from_forgery with: :exception
end

class PostsController < ApplicationController
  def new
    @post = Post.new
  end

  def create
    @post = Post.new(post_params)
    if @post.save
      redirect_to @post
    else
      render :new
    end
  end

  private

  def post_params
    params.require(:post).permit(:title, :content)
  end
end

# In the view (new.html.erb):
# <%= form_with(model: @post) do |form| %>
#   <%= form.text_field :title %>
#   <%= form.text_area :content %>
#   <%= form.submit %>
# <% end %>

Important Notes

Always use Rails form helpers to get automatic CSRF tokens.

APIs often use :null_session or skip CSRF checks because they use other security methods.

CSRF tokens change with each session to keep protection strong.

Summary

CSRF protection stops unwanted actions from other sites.

Rails adds CSRF tokens automatically in forms created with helpers.

Use protect_from_forgery in ApplicationController to enable protection.

Practice

1. What is the main purpose of CSRF protection in a Rails application?

easy

A. To prevent unauthorized commands from being executed by malicious websites

B. To speed up database queries

C. To improve the user interface design

D. To encrypt user passwords

Solution

1. Step 1: Understand CSRF meaning

   CSRF stands for Cross-Site Request Forgery, which is an attack where unauthorized commands are sent from a user that the web application trusts.

2. Step 2: Identify CSRF protection goal

   The goal of CSRF protection is to stop these unauthorized commands from malicious websites.

3. Final Answer:

   To prevent unauthorized commands from being executed by malicious websites -> Option A

4. Quick Check:

   CSRF protection = prevent unauthorized commands [OK]

Hint: CSRF stops bad actions from other sites [OK]

Common Mistakes:

• Confusing CSRF with password encryption
• Thinking it speeds up queries
• Assuming it improves UI design

2. Which line of code correctly enables CSRF protection in a Rails controller?

easy

A. use_csrf_token()

B. enable_csrf_protection true

C. csrf_protect = true

D. protect_from_forgery with: :exception

Solution

1. Step 1: Recall Rails CSRF syntax

   Rails uses the method protect_from_forgery with options like :exception to enable CSRF protection.

2. Step 2: Match correct syntax

   Only protect_from_forgery with: :exception is valid Rails syntax to enable CSRF protection.

3. Final Answer:

   protect_from_forgery with: :exception -> Option D

4. Quick Check:

   Enable CSRF = protect_from_forgery [OK]

Hint: Use protect_from_forgery with: :exception [OK]

Common Mistakes:

• Using non-existent methods like enable_csrf_protection
• Assigning variables instead of calling method
• Calling undefined functions like use_csrf_token()

3. Given this Rails form code snippet, what happens if the CSRF token is missing or invalid?

<%= form_with url: '/posts' do |form| %>
  <%= form.text_field :title %>
  <%= form.submit 'Create' %>
<% end %>

medium

A. The form submits successfully without any error

B. Rails raises an ActionController::InvalidAuthenticityToken error

C. The form data is saved but with a warning in logs

D. The form redirects to the home page silently

Solution

1. Step 1: Understand form_with and CSRF token

   Rails automatically includes a CSRF token in forms created with helpers like form_with.

2. Step 2: Effect of missing or invalid token

   If the token is missing or invalid, Rails raises an ActionController::InvalidAuthenticityToken error to block the request.

3. Final Answer:

   Rails raises an ActionController::InvalidAuthenticityToken error -> Option B

4. Quick Check:

   Missing CSRF token = InvalidAuthenticityToken error [OK]

Hint: Missing token causes InvalidAuthenticityToken error [OK]

Common Mistakes:

• Assuming form submits without error
• Thinking data saves with warning
• Believing it redirects silently

4. You see this error in your Rails app: ActionController::InvalidAuthenticityToken. Which fix will most likely solve the problem?

medium

A. Ensure your forms include the CSRF token by using Rails form helpers

B. Remove the CSRF token from your forms

C. Add protect_from_forgery with: :exception in ApplicationController

D. Disable CSRF protection in config

Solution

1. Step 1: Identify cause of InvalidAuthenticityToken

   This error happens when the CSRF token is missing or invalid in the form submission.

2. Step 2: Choose fix to include CSRF token

   Using Rails form helpers like form_with automatically includes the CSRF token, fixing the error.

3. Final Answer:

   Ensure your forms include the CSRF token by using Rails form helpers -> Option A

4. Quick Check:

   Fix InvalidAuthenticityToken = include CSRF token [OK]

Hint: Use Rails form helpers to add CSRF token automatically [OK]

Common Mistakes:

• Adding protect_from_forgery again when already present
• Removing CSRF token which causes error
• Disabling protection instead of fixing token

5. You want to allow JSON API requests in your Rails app without CSRF errors but keep protection for HTML forms. Which is the best way to do this?

hard

A. Manually add CSRF tokens to JSON requests

B. Disable CSRF protection globally

C. Use protect_from_forgery with: :null_session and handle API authentication separately

D. Use protect_from_forgery with: :exception and skip CSRF check for JSON requests

Solution

1. Step 1: Understand CSRF and API requests

   CSRF tokens are mainly for browser forms; API JSON requests often don't use them and need different handling.

2. Step 2: Choose best Rails approach

   Using protect_from_forgery with: :null_session disables CSRF exceptions for APIs but keeps protection for forms, requiring separate API authentication.

3. Final Answer:

   Use protect_from_forgery with: :null_session and handle API authentication separately -> Option C

4. Quick Check:

   API JSON + CSRF = null_session + separate auth [OK]

Hint: Use null_session for APIs, keep exception for forms [OK]

Common Mistakes:

• Disabling CSRF protection globally
• Trying to add CSRF tokens manually to JSON
• Skipping CSRF only without alternative auth