Password reset email pattern in Flask

Introduction

We use a password reset email pattern to help users safely change their forgotten passwords. It sends a special link to their email so only they can reset their password.

When a user forgets their password and needs to create a new one.

When you want to improve security by verifying the user's email before changing the password.

When you want to provide a smooth way for users to regain access without contacting support.

Syntax

Flask

from flask import Flask, request, url_for
from itsdangerous import URLSafeTimedSerializer

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

serializer = URLSafeTimedSerializer(app.config['SECRET_KEY'])

def generate_reset_token(email):
    return serializer.dumps(email, salt='password-reset-salt')

def verify_reset_token(token, expiration=3600):
    try:
        email = serializer.loads(token, salt='password-reset-salt', max_age=expiration)
    except Exception:
        return None
    return email

The URLSafeTimedSerializer creates a token that expires after some time.

Use the same salt value when generating and verifying tokens.

Examples

This creates a token for the email '[e-mail]'.

Flask

token = generate_reset_token('[e-mail]')
print(token)

This checks if the token is still valid and prints the email if it is.

Flask

email = verify_reset_token(token)
if email:
    print(f'Token valid for {email}')
else:
    print('Token invalid or expired')

Sample Program

This program creates a reset token for a user email, prints a reset link with the token, then simulates verifying the token when the user clicks the link.

Flask

from flask import Flask, request, url_for
from itsdangerous import URLSafeTimedSerializer

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

serializer = URLSafeTimedSerializer(app.config['SECRET_KEY'])

def generate_reset_token(email):
    return serializer.dumps(email, salt='password-reset-salt')

def verify_reset_token(token, expiration=3600):
    try:
        email = serializer.loads(token, salt='password-reset-salt', max_age=expiration)
    except Exception:
        return None
    return email

# Simulate sending reset email
user_email = '[e-mail]'
token = generate_reset_token(user_email)
print(f'Reset link: http://example.com/reset_password/{token}')

# Simulate user clicking the link later
received_token = token
verified_email = verify_reset_token(received_token)
if verified_email:
    print(f'Token valid for {verified_email}')
else:
    print('Token invalid or expired')

Important Notes

Always keep your SECRET_KEY safe and secret.

Tokens should expire to prevent misuse.

Send the reset link via email securely and avoid showing tokens in URLs publicly.

Summary

The password reset email pattern helps users safely reset forgotten passwords.

It uses a token that expires to verify the user's identity.

Flask with itsdangerous makes creating and checking tokens easy.

Practice

1. What is the main purpose of using a token in a Flask password reset email pattern?

easy

A. To securely verify the user's identity before allowing password reset

B. To store the user's new password temporarily

C. To send the user's password in plain text via email

D. To log the user out of all sessions automatically

Solution

1. Step 1: Understand the role of tokens in password reset

   Tokens are unique codes sent to users to confirm their identity securely during password reset.

2. Step 2: Identify the purpose of the token

   The token ensures only the rightful user can reset the password by verifying their identity.

3. Final Answer:

   To securely verify the user's identity before allowing password reset -> Option A

4. Quick Check:

   Token = Secure identity verification [OK]

Hint: Tokens verify identity safely before password changes [OK]

Common Mistakes:

• Thinking tokens store passwords
• Assuming tokens send passwords in email
• Believing tokens log users out

2. Which of the following is the correct way to create a timed token using Flask's itsdangerous library?

easy

A. token = URLSafeTimedSerializer.dumps(secret_key, email)

B. token = URLSafeTimedSerializer(secret_key).loads(email)

C. serializer = URLSafeTimedSerializer(); token = serializer.dumps(secret_key, email)

D. serializer = URLSafeTimedSerializer(secret_key); token = serializer.dumps(email)

Solution

1. Step 1: Recall the correct usage of URLSafeTimedSerializer

   It requires initializing with a secret key, then calling dumps() with the data to encode.

2. Step 2: Match the syntax to the correct option

   serializer = URLSafeTimedSerializer(secret_key); token = serializer.dumps(email) correctly creates the serializer and calls dumps(email) to create the token.

3. Final Answer:

   serializer = URLSafeTimedSerializer(secret_key); token = serializer.dumps(email) -> Option D

4. Quick Check:

   Serializer + dumps(data) = token [OK]

Hint: Initialize serializer with key, then dumps(data) for token [OK]

Common Mistakes:

• Calling dumps as a static method
• Passing secret key to dumps instead of constructor
• Using loads instead of dumps to create token

3. Given this Flask code snippet, what will be printed if the token is valid and not expired?

from itsdangerous import URLSafeTimedSerializer
serializer = URLSafeTimedSerializer('secret')
token = serializer.dumps('[e-mail]')

try:
    email = serializer.loads(token, max_age=3600)
    print(email)
except Exception:
    print('Invalid or expired token')

medium

A. None

B. [e-mail]

C. secret

D. Invalid or expired token

Solution

1. Step 1: Understand what serializer.dumps and loads do

   dumps creates a token from the email string; loads decodes it back if valid and within max_age.

2. Step 2: Analyze the try-except block

   If the token is valid and not expired, loads returns the original email, which is printed.

3. Final Answer:

   [e-mail] -> Option B

4. Quick Check:

   Valid token returns original email [OK]

Hint: Valid loads returns original data, else error [OK]

Common Mistakes:

• Assuming loads returns the secret key
• Confusing dumps and loads output
• Ignoring max_age expiration

4. Identify the error in this Flask password reset token verification code:

from itsdangerous import URLSafeTimedSerializer
serializer = URLSafeTimedSerializer('secret')
token = serializer.dumps('[e-mail]')

email = serializer.loads(token, max_age=3600)
print(email)

medium

A. Missing try-except block to handle expired or invalid tokens

B. Incorrect secret key used in serializer

C. Using dumps instead of loads to decode token

D. max_age parameter is not supported in loads

Solution

1. Step 1: Review the code for error handling

   The code calls loads without try-except, so expired or invalid tokens cause exceptions.

2. Step 2: Identify the missing safety measure

   Proper pattern uses try-except to catch exceptions and handle errors gracefully.

3. Final Answer:

   Missing try-except block to handle expired or invalid tokens -> Option A

4. Quick Check:

   Always catch exceptions when verifying tokens [OK]

Hint: Always wrap loads in try-except to catch errors [OK]

Common Mistakes:

• Not handling exceptions on token verification
• Confusing dumps and loads usage
• Assuming max_age is unsupported

5. You want to implement a password reset feature in Flask that sends a reset link with a token valid for 30 minutes. Which approach correctly combines token creation, expiration, and email sending?

hard

A. Store user password in token, send email with token, verify token by comparing passwords

B. Generate token with random string, send email with token, verify token by checking string length

C. Create a URLSafeTimedSerializer with secret key, generate token with dumps(user_email), send email with link containing token, verify token with loads(token, max_age=1800)

D. Create token with dumps(user_email), send email without token, verify token with loads(token, max_age=3600)

Solution

1. Step 1: Understand token creation and expiration

   Use URLSafeTimedSerializer with secret key to create a token from user email; set max_age to 1800 seconds (30 minutes) when verifying.

2. Step 2: Combine with email sending and verification

   Send the token in the reset link via email; verify token on reset page using loads with max_age to ensure expiration.

3. Final Answer:

   Create a URLSafeTimedSerializer with secret key, generate token with dumps(user_email), send email with link containing token, verify token with loads(token, max_age=1800) -> Option C

4. Quick Check:

   Serializer + dumps + max_age + email link = secure reset [OK]

Hint: Use serializer dumps and loads with max_age for timed tokens [OK]

Common Mistakes:

• Not setting max_age for token expiration
• Sending token without including it in email link
• Storing passwords in tokens