Built-in middleware overview in Django - Mini Project: Build & Apply

Built-in Middleware Overview in Django

📖 Scenario: You are building a simple Django project to understand how built-in middleware works. Middleware helps process requests and responses in a Django app, like a helpful assistant checking or modifying data as it passes through.

🎯 Goal: Create a Django settings file snippet that sets up a list of built-in middleware classes. Then add a custom setting to control middleware behavior, apply the middleware list in the settings, and finally complete the settings with the required Django configuration.

📋 What You'll Learn

Create a list variable called MIDDLEWARE with specific built-in middleware classes

Add a boolean variable called USE_SECURITY_MIDDLEWARE set to True

Use an if statement to conditionally add 'django.middleware.security.SecurityMiddleware' to MIDDLEWARE

Complete the settings by adding ROOT_URLCONF with value 'myproject.urls'

💡 Why This Matters

🌍 Real World

Middleware is used in real Django projects to handle security, sessions, CSRF protection, and more automatically for every web request.

💼 Career

Understanding middleware setup is essential for Django developers to configure and customize request processing pipelines in professional web applications.

1

Create the initial middleware list

Create a list called MIDDLEWARE with these exact strings in order: 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware'

Django

# Create the MIDDLEWARE list with three built-in middleware classes
# Your code here

Hint

Use square brackets [] to create a list and put each middleware string inside quotes separated by commas.

2

Add a configuration variable

Add a boolean variable called USE_SECURITY_MIDDLEWARE and set it to True

Django

MIDDLEWARE = [
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
# Add USE_SECURITY_MIDDLEWARE variable below
# Your code here

Hint

Write the variable name exactly as USE_SECURITY_MIDDLEWARE and assign it the value True.

3

Conditionally add SecurityMiddleware

Write an if statement that checks if USE_SECURITY_MIDDLEWARE is True. Inside it, add 'django.middleware.security.SecurityMiddleware' to the start of the MIDDLEWARE list using insert(0, ...)

Django

MIDDLEWARE = [
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

USE_SECURITY_MIDDLEWARE = True
# Add if statement to insert SecurityMiddleware
# Your code here

Hint

Use if USE_SECURITY_MIDDLEWARE: and then call MIDDLEWARE.insert(0, 'django.middleware.security.SecurityMiddleware') inside the block.

4

Complete settings with ROOT_URLCONF

Add a variable called ROOT_URLCONF and set it to the string 'myproject.urls'

Django

MIDDLEWARE = [
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

USE_SECURITY_MIDDLEWARE = True

if USE_SECURITY_MIDDLEWARE:
    MIDDLEWARE.insert(0, 'django.middleware.security.SecurityMiddleware')
# Add ROOT_URLCONF variable below
# Your code here

Hint

Write ROOT_URLCONF = 'myproject.urls' exactly as shown.

Practice

1. Which of the following is a primary purpose of Django's built-in middleware?

easy

A. To automatically process requests and responses

B. To create database models

C. To write HTML templates

D. To manage static files

Solution

1. Step 1: Understand middleware role

   Django middleware acts as a layer that processes requests before views and responses after views.

2. Step 2: Identify correct purpose

   Creating models, writing templates, and managing static files are handled by other parts of Django, not middleware.

3. Final Answer:

   To automatically process requests and responses -> Option A

4. Quick Check:

   Middleware = process requests/responses [OK]

Hint: Middleware handles request/response flow automatically [OK]

Common Mistakes:

• Confusing middleware with models or templates
• Thinking middleware manages static files
• Assuming middleware writes HTML

2. Which of the following is the correct way to add built-in middleware in Django's settings.py?

easy

A. MIDDLEWARE = django.middleware.security.SecurityMiddleware

B. MIDDLEWARE = {'django.middleware.security.SecurityMiddleware'}

C. MIDDLEWARE = ('django.middleware.security.SecurityMiddleware')

D. MIDDLEWARE = ['django.middleware.security.SecurityMiddleware']

Solution

1. Step 1: Check correct data type for MIDDLEWARE

   Django expects MIDDLEWARE to be a list of strings representing middleware classes.

2. Step 2: Identify correct syntax

   MIDDLEWARE = ['django.middleware.security.SecurityMiddleware'] uses a list with one string, which is correct. Options B uses a set, C is a string without list, and D is invalid syntax.

3. Final Answer:

   MIDDLEWARE = ['django.middleware.security.SecurityMiddleware'] -> Option D

4. Quick Check:

   Middleware list syntax = MIDDLEWARE = ['django.middleware.security.SecurityMiddleware'] [OK]

Hint: Middleware must be a list of strings in settings.py [OK]

Common Mistakes:

• Using sets or tuples instead of lists
• Omitting quotes around middleware path
• Assigning middleware without brackets

3. Given this middleware order in settings.py:
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
]
What happens if a request triggers a CSRF failure?

medium

A. The request passes through all middleware without blocking

B. The session middleware blocks the request before CSRF check

C. The CSRF middleware blocks the request before reaching the view

D. The security middleware blocks the request after CSRF check

Solution

1. Step 1: Understand middleware order and function

   Middleware runs in order on request. CSRF middleware checks tokens and blocks if invalid.

2. Step 2: Identify which middleware blocks on CSRF failure

   CSRF middleware is responsible for blocking bad requests before views. Session middleware runs earlier but doesn't block CSRF. Security middleware runs first but does not handle CSRF.

3. Final Answer:

   The CSRF middleware blocks the request before reaching the view -> Option C

4. Quick Check:

   CSRF middleware blocks bad requests [OK]

Hint: CSRF middleware blocks invalid tokens before views [OK]

Common Mistakes:

• Thinking session middleware blocks CSRF errors
• Assuming security middleware handles CSRF
• Believing request always passes through

4. You added 'django.middleware.csrf.CsrfViewMiddleware' after 'django.middleware.security.SecurityMiddleware' but get CSRF errors on valid requests. What is the likely problem?

medium

A. Security middleware must be removed to fix CSRF errors

B. Middleware order is incorrect; CSRF middleware should come after session middleware

C. CSRF middleware requires no session middleware to work

D. CSRF middleware should be first in the list

Solution

1. Step 1: Recall middleware order importance

   CSRF middleware depends on session middleware to access session data for tokens.

2. Step 2: Identify correct order

   Session middleware must come before CSRF middleware. If CSRF middleware is before session, it can't validate tokens properly, causing errors.

3. Final Answer:

   Middleware order is incorrect; CSRF middleware should come after session middleware -> Option B

4. Quick Check:

   Session before CSRF middleware fixes errors [OK]

Hint: Session middleware must precede CSRF middleware [OK]

Common Mistakes:

• Removing security middleware unnecessarily
• Placing CSRF middleware first
• Ignoring middleware order dependencies

5. You want to add a custom middleware that logs request info and must run after security checks but before session handling. Given the default order:
[
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
]
Where should you insert your custom middleware?

hard

A. Between SecurityMiddleware and SessionMiddleware

B. Before SecurityMiddleware

C. After SessionMiddleware

D. At the end of the list

Solution

1. Step 1: Understand middleware order effect

   Middleware runs top to bottom on request. To run after security but before session, place custom middleware between them.

2. Step 2: Identify correct insertion point

   SecurityMiddleware is first, SessionMiddleware second. Insert custom middleware as second item to run after security and before session.

3. Final Answer:

   Between SecurityMiddleware and SessionMiddleware -> Option A

4. Quick Check:

   Insert custom middleware between security and session [OK]

Hint: Middleware order controls execution sequence [OK]

Common Mistakes:

• Placing custom middleware before security
• Putting it after session middleware
• Adding it at the end ignoring order