XSS prevention in templates in Django - Mini Project: Build & Apply

XSS Prevention in Django Templates

📖 Scenario: You are building a simple Django web page that displays user comments. To keep your site safe, you need to prevent Cross-Site Scripting (XSS) attacks by properly handling user input in your templates.

🎯 Goal: Create a Django template that safely displays user comments by preventing XSS attacks using Django's built-in template escaping features.

📋 What You'll Learn

Create a Python dictionary called comments with exact keys and values.

Add a configuration variable safe_comment to mark a comment as safe.

Use Django template syntax to loop over comments and display each comment safely.

Use the safe filter only on the safe_comment variable to allow HTML rendering.

💡 Why This Matters

🌍 Real World

Web developers must prevent XSS attacks to protect users from malicious scripts embedded in user-generated content.

💼 Career

Understanding template escaping and safe rendering is essential for secure web application development in Django.

1

Create the comments dictionary

Create a Python dictionary called comments with these exact entries: "user1": "Hello, world!", "user2": "", and "user3": "Welcome to Django!".

Django

# Create the comments dictionary with exact entries
# Your code here

Hint

Use curly braces to create a dictionary and include the exact keys and values as strings.

2

Add a safe comment variable

Add a variable called safe_comment and set it to the value of comments["user3"].

Django

comments = {
    "user1": "Hello, world!",
    "user2": "alert('XSS')",
    "user3": "Welcome to Django!"
}
# Add the safe_comment variable here
# Your code here

Hint

Assign the value of the key "user3" from the comments dictionary to safe_comment.

3

Write the Django template loop

Write a Django template loop using {% for user, comment in comments.items %} to iterate over comments and display each comment inside a <p> tag. Use the default escaping to prevent XSS.

Django

comments = {
    "user1": "Hello, world!",
    "user2": "alert('XSS')",
    "user3": "Welcome to Django!"
}
safe_comment = comments["user3"]

# Write the Django template loop below
# Your code here

Hint

Use Django template tags {% for %} and {% endfor %} with {{ comment }} inside a paragraph tag.

4

Render the safe comment with the safe filter

Add a line in the Django template to display the safe_comment variable inside a <p> tag using the safe filter: {{ safe_comment|safe }}.

Django

comments = {
    "user1": "Hello, world!",
    "user2": "alert('XSS')",
    "user3": "Welcome to Django!"
}
safe_comment = comments["user3"]

"""
{% for user, comment in comments.items %}
  {{ comment }}
{% endfor %}

# Add the safe_comment display with safe filter below
# Your code here

Hint

Use the safe filter to allow HTML in safe_comment but keep escaping for others.

Practice

1. What does Django do by default to protect against XSS attacks when rendering variables in templates?

easy

A. It disables rendering of any user input.

B. It automatically escapes variables to prevent malicious code execution.

C. It requires manual escaping of variables in every template.

D. It converts all variables to uppercase before rendering.

Solution

1. Step 1: Understand Django's default template behavior

   Django templates automatically escape variables to prevent malicious scripts from running in the browser.

2. Step 2: Compare options with this behavior

   Only It automatically escapes variables to prevent malicious code execution. correctly states this automatic escaping feature, while others describe incorrect or unrelated behaviors.

3. Final Answer:

   It automatically escapes variables to prevent malicious code execution. -> Option B

4. Quick Check:

   Default escaping = It automatically escapes variables to prevent malicious code execution. [OK]

Hint: Remember: Django escapes variables automatically unless told otherwise [OK]

Common Mistakes:

• Thinking you must manually escape variables always
• Believing Django disables user input rendering
• Assuming variables are transformed instead of escaped

2. Which of the following is the correct way to mark a variable as safe (not escaped) in a Django template?

easy

A. {{ variable|escape }}

B. {{ variable|strip }}

C. {{ variable|safe }}

D. {{ variable|clean }}

Solution

1. Step 1: Identify the filter that marks content safe

   The safe filter tells Django not to escape the variable, rendering HTML as-is.

2. Step 2: Check other filters

   escape escapes content, strip and clean are not standard Django filters for safety.

3. Final Answer:

   {{ variable|safe }} -> Option C

4. Quick Check:

   Use safe filter to disable escaping = {{ variable|safe }} [OK]

Hint: Use '|safe' to show trusted HTML without escaping [OK]

Common Mistakes:

• Using '|escape' which does the opposite
• Confusing '|strip' or '|clean' as safety filters
• Forgetting to mark trusted content safe explicitly

3. Given the template code:

{{ user_input }}

and the user input is <script>alert('XSS')</script>, what will be rendered in the browser?

medium

A. <script>alert('XSS')</script> shown as text

B. executed as script

C. An error message about unsafe content

D. Nothing will be shown

Solution

1. Step 1: Understand default escaping of variables

   Django escapes user input by default, so HTML tags are shown as text, not executed.

2. Step 2: Apply this to the given input

   The script tags will be converted to safe text entities and displayed literally.

3. Final Answer:

   <script>alert('XSS')</script> shown as text -> Option A

4. Quick Check:

   Escaped input shows tags as text = <script>alert('XSS')</script> shown as text [OK]

Hint: Default escape shows tags as text, not scripts [OK]

Common Mistakes:

• Thinking the script runs automatically
• Expecting an error instead of safe output
• Assuming nothing is shown for unsafe input

4. You see this template code:

{{ comment|safe }}

but users report XSS attacks. What is the likely problem?

medium

A. The template engine is disabled.

B. The escape filter is missing.

C. The template variable is not wrapped in quotes.

D. The safe filter is used on untrusted user input.

Solution

1. Step 1: Analyze the use of the safe filter

   Using safe on user input disables escaping, allowing scripts to run if input is malicious.

2. Step 2: Identify the cause of XSS

   Applying safe to untrusted input is unsafe and causes XSS vulnerabilities.

3. Final Answer:

   The safe filter is used on untrusted user input. -> Option D

4. Quick Check:

   Unsafe use of safe filter = The safe filter is used on untrusted user input. [OK]

Hint: Never use '|safe' on untrusted user input [OK]

Common Mistakes:

• Assuming escape filter fixes safe misuse
• Thinking quotes affect XSS protection
• Believing template engine disables XSS automatically

5. You want to display user comments that may contain safe HTML tags like <b> and <i>, but prevent scripts. Which approach best prevents XSS while allowing these tags?

hard

A. Sanitize the comment in the backend to allow only safe tags, then use {{ comment|safe }}.

B. Use {{ comment|safe }} directly in the template.

C. Escape the comment with {{ comment|escape }} and then use |safe.

D. Store comments as plain text and never allow any HTML tags.

Solution

1. Step 1: Understand the need to allow some HTML safely

   Allowing safe tags requires cleaning input to remove dangerous scripts but keep allowed tags.

2. Step 2: Choose the correct method

   Sanitizing backend input to whitelist safe tags then marking safe in template is the secure way.

3. Step 3: Evaluate other options

   Using {{ comment|safe }} directly risks XSS by trusting raw input; combining |escape and |safe misuses filters; disallowing all HTML prevents desired formatting.

4. Final Answer:

   Sanitize the comment in the backend to allow only safe tags, then use {{ comment|safe }}. -> Option A

5. Quick Check:

   Backend sanitize + safe filter = Sanitize the comment in the backend to allow only safe tags, then use {{ comment|safe }}. [OK]

Hint: Clean input backend, then mark safe in template [OK]

Common Mistakes:

• Trusting raw user input with safe filter
• Misusing escape and safe filters together
• Disallowing all HTML when some is needed