CSRF protection in Flask

Introduction

CSRF protection stops bad websites from tricking you into doing things you don't want. It keeps your web forms safe.

When you have forms that change user data, like login or signup forms.

When users submit sensitive information, like passwords or payment details.

When your site allows actions like posting comments or making purchases.

When you want to keep your users safe from hidden attacks on your site.

Syntax

Flask

from flask_wtf import FlaskForm, CSRFProtect
from flask import Flask

app = Flask(__name__)
app.config['SECRET_KEY'] = 'your-secret-key'
csrf = CSRFProtect(app)

class MyForm(FlaskForm):
    pass  # define your form fields here

You must set a SECRET_KEY in your Flask app for CSRF protection to work.

Use FlaskForm from flask_wtf to get CSRF tokens automatically in forms.

Examples

This form will have CSRF protection automatically included.

Flask

from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField

class CommentForm(FlaskForm):
    comment = StringField('Comment')
    submit = SubmitField('Post')

This enables CSRF protection for the whole Flask app.

Flask

from flask import Flask
from flask_wtf import CSRFProtect

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret123'
csrf = CSRFProtect(app)

Sample Program

This Flask app shows a simple form with CSRF protection. The hidden CSRF token is included automatically. When you submit the form, it greets you by name.

Flask

from flask import Flask, render_template_string, request
from flask_wtf import FlaskForm, CSRFProtect
from wtforms import StringField, SubmitField

app = Flask(__name__)
app.config['SECRET_KEY'] = 'mysecretkey'
csrf = CSRFProtect(app)

class NameForm(FlaskForm):
    name = StringField('Your Name')
    submit = SubmitField('Submit')

@app.route('/', methods=['GET', 'POST'])
def index():
    form = NameForm()
    if form.validate_on_submit():
        return f'Hello, {form.name.data}!'
    return render_template_string('''
        <form method="POST">
            {{ form.hidden_tag() }}
            {{ form.name.label }} {{ form.name() }}<br>
            {{ form.submit() }}
        </form>
    ''', form=form)

if __name__ == '__main__':
    app.run(debug=False)

Important Notes

Always use SECRET_KEY to keep CSRF tokens secure.

CSRF tokens are hidden fields in forms that change data.

Without CSRF protection, attackers can trick users into unwanted actions.

Summary

CSRF protection keeps your web forms safe from fake requests.

Use FlaskForm and CSRFProtect to add protection easily.

Always set a secret key in your Flask app for this to work.

Practice

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

easy

A. To prevent unauthorized commands from being transmitted from a user the website trusts

B. To speed up the loading time of web pages

C. To encrypt user passwords in the database

D. To improve the visual design of forms

Solution

1. Step 1: Understand CSRF meaning

   CSRF stands for Cross-Site Request Forgery, which tricks users into submitting unwanted actions.

2. Step 2: Identify CSRF protection goal

   Protection stops fake requests that appear to come from trusted users, preventing unauthorized actions.

3. Final Answer:

   To prevent unauthorized commands from being transmitted from a user the website trusts -> Option A

4. Quick Check:

   CSRF protection = prevent fake trusted requests [OK]

Hint: CSRF stops fake form submissions from trusted users [OK]

Common Mistakes:

• Confusing CSRF with password encryption
• Thinking CSRF improves page speed
• Believing CSRF changes form appearance

2. Which of the following is the correct way to enable CSRF protection in a Flask app?

easy

A. app = Flask(__name__)
app.secret_key = 'secret'
csrf = CSRFProtect(app)

B. app = Flask(__name__)
csrf = CSRFProtect()
app.secret_key = 'secret'

C. app = Flask(__name__)
csrf = CSRFProtect(app)
app.secret_key = None

D. app = Flask(__name__)
app.secret_key = None
csrf = CSRFProtect(app)

Solution

1. Step 1: Set secret key before CSRFProtect

   CSRF protection requires a secret key set on the Flask app for token generation.

2. Step 2: Initialize CSRFProtect with app

   Passing the app instance to CSRFProtect enables protection on the app.

3. Final Answer:

   app = Flask(__name__) app.secret_key = 'secret' csrf = CSRFProtect(app) -> Option A

4. Quick Check:

   Secret key set + CSRFProtect(app) = correct setup [OK]

Hint: Set secret_key before CSRFProtect(app) call [OK]

Common Mistakes:

• Not setting secret_key or setting it after CSRFProtect
• Passing no app to CSRFProtect
• Setting secret_key to None disables protection

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

from flask_wtf import FlaskForm
from wtforms import StringField, SubmitField

class MyForm(FlaskForm):
    name = StringField('Name')
    submit = SubmitField('Send')

medium

A. The form submission is accepted without any error

B. The form automatically regenerates a new CSRF token and retries

C. A CSRFError is raised and the request is rejected

D. The form data is saved but a warning is logged

Solution

1. Step 1: Understand FlaskForm CSRF behavior

   FlaskForm automatically checks for a valid CSRF token on submission.

2. Step 2: Effect of missing/invalid token

   If the token is missing or wrong, Flask-WTF raises a CSRFError and rejects the request.

3. Final Answer:

   A CSRFError is raised and the request is rejected -> Option C

4. Quick Check:

   Invalid CSRF token = CSRFError raised [OK]

Hint: Missing CSRF token causes error and blocks form [OK]

Common Mistakes:

• Assuming form submits anyway without token
• Thinking token regenerates automatically on failure
• Believing data saves with just a warning

4. You added CSRFProtect to your Flask app but still get CSRF errors on form submission. Which of these is the most likely cause?

medium

A. You called csrf = CSRFProtect(app) before creating the Flask app

B. You set app.secret_key to a strong random value

C. You used FlaskForm instead of plain WTForms Form

D. You forgot to include {{ form.csrf_token }} inside your HTML form

Solution

1. Step 1: Check CSRF token inclusion in form

   The CSRF token must be included in the HTML form using {{ form.csrf_token }} for validation.

2. Step 2: Understand error cause

   If the token is missing in the form, the server rejects the submission with a CSRF error.

3. Final Answer:

   You forgot to include {{ form.csrf_token }} inside your HTML form -> Option D

4. Quick Check:

   Missing token in form = CSRF errors [OK]

Hint: Always add {{ form.csrf_token }} inside your form tag [OK]

Common Mistakes:

• Assuming secret_key causes errors when set correctly
• Thinking FlaskForm causes errors instead of helping
• Initializing CSRFProtect before app creation causes syntax error, not CSRF error

5. You want to protect an API endpoint in Flask that accepts JSON POST requests from your frontend. Which approach correctly applies CSRF protection?

hard

A. Disable CSRF protection for JSON endpoints because tokens only work with HTML forms

B. Use CSRFProtect and require the frontend to send the CSRF token in a custom header, then validate it in Flask

C. Add {{ form.csrf_token }} in the JSON payload sent by the frontend

D. Use FlaskForm on the API endpoint without any token validation

Solution

1. Step 1: Understand CSRF with JSON APIs

   CSRF tokens can protect JSON POST requests if the token is sent in headers and validated server-side.

2. Step 2: Correct method to protect API

   Use CSRFProtect and require frontend to send token in a custom header (e.g., X-CSRFToken), then validate it in Flask.

3. Final Answer:

   Use CSRFProtect and require the frontend to send the CSRF token in a custom header, then validate it in Flask -> Option B

4. Quick Check:

   CSRF token in header + validation = secure JSON API [OK]

Hint: Send CSRF token in header for JSON API protection [OK]

Common Mistakes:

• Thinking CSRF tokens only work with HTML forms
• Putting CSRF token inside JSON body without validation
• Using FlaskForm without token validation on APIs