JWT token creation in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does JWT stand for and what is its main purpose?

JWT stands for JSON Web Token. It is used to securely transmit information between parties as a JSON object, often for user authentication.

beginner

In FastAPI, which Python library is commonly used to create and verify JWT tokens?

The PyJWT library is commonly used in FastAPI to create and verify JWT tokens.

beginner

What are the three parts of a JWT token?

A JWT token has three parts separated by dots: header, payload, and signature.

intermediate

Why do we include an expiration time in a JWT token?

Expiration time limits how long the token is valid, improving security by reducing the risk of token misuse if stolen.

intermediate

In FastAPI, what is the purpose of the SECRET_KEY when creating a JWT token?

The SECRET_KEY is used to sign the JWT token's signature, ensuring the token's integrity and that it was issued by a trusted source.

Which part of a JWT contains the user data like user ID or roles?

A Header

B Signature

C Payload

D Secret Key

The payload contains the user data or claims inside the JWT.

What is the role of the signature in a JWT token?

A Verifies token integrity

B Defines token expiration

C Stores user information

D Specifies token type

The signature verifies that the token has not been tampered with.

Which FastAPI library is typically used to encode and decode JWT tokens?

A SQLAlchemy

B PyJWT

C Pydantic

D Requests

PyJWT is the common library for JWT handling in FastAPI.

What should you keep secret to ensure JWT tokens remain secure?

A Secret Key

B Payload

C Header

D Expiration time

The secret key is used to sign tokens and must be kept private.

Why is it important to set an expiration time on JWT tokens?

A To increase token size

B To encrypt the token

C To store user roles

D To limit token validity

Expiration limits how long a token can be used, improving security.

Explain the process of creating a JWT token in FastAPI including key components needed.

Think about what data you include and how you protect the token.

Describe why JWT tokens are useful for authentication in web applications.

Consider how tokens help servers know who the user is without storing session data.

Practice

1. What is the main purpose of creating a JWT token in FastAPI?

easy

A. To style the user interface

B. To send emails automatically

C. To connect to a database

D. To securely store user information for authentication

Solution

1. Step 1: Understand JWT token purpose

   JWT tokens are used to safely carry user data for authentication.

2. Step 2: Identify correct use in FastAPI

   FastAPI uses JWT tokens to verify user identity securely.

3. Final Answer:

   To securely store user information for authentication -> Option D

4. Quick Check:

   JWT purpose = secure user info [OK]

Hint: JWT tokens are for secure user identity, not UI or DB [OK]

Common Mistakes:

• Confusing JWT with UI styling or database connection
• Thinking JWT sends emails
• Assuming JWT stores passwords directly

2. Which of the following is the correct way to import the function to create JWT tokens in FastAPI using PyJWT?

easy

A. import jwt.encode

B. from fastapi import jwt_encode

C. from jwt import encode

D. from fastapi.security import create_jwt

Solution

1. Step 1: Identify the JWT library used

   PyJWT is commonly used and provides an encode function imported as 'from jwt import encode'.

2. Step 2: Check FastAPI imports

   FastAPI itself does not provide jwt_encode or create_jwt functions directly.

3. Final Answer:

   from jwt import encode -> Option C

4. Quick Check:

   PyJWT encode import = from jwt import encode [OK]

Hint: PyJWT encode is imported from jwt, not fastapi [OK]

Common Mistakes:

• Trying to import JWT functions directly from FastAPI
• Using incorrect import syntax
• Confusing module names

3. Given this code snippet, what will be the output of the print(token) statement?

from jwt import encode

payload = {"user_id": 123}
secret = "mysecret"
algorithm = "HS256"
token = encode(payload, secret, algorithm=algorithm)
print(token)

medium

A. A JWT token string encoded with user_id 123

B. An error because algorithm parameter is missing

C. The original payload dictionary printed

D. None, because encode returns nothing

Solution

1. Step 1: Understand encode function behavior

   The encode function creates a JWT token string from the payload using the secret and algorithm.

2. Step 2: Analyze the code snippet

   Payload and secret are provided correctly, algorithm is set to HS256, so encode returns a JWT token string.

3. Final Answer:

   A JWT token string encoded with user_id 123 -> Option A

4. Quick Check:

   encode returns JWT string [OK]

Hint: encode returns a token string, not the original data [OK]

Common Mistakes:

• Expecting encode to print the payload
• Missing algorithm causes error (not true here)
• Thinking encode returns None

4. Identify the error in this JWT token creation code snippet:

from jwt import encode

payload = {"user_id": 42}
secret = "secretkey"
token = encode(payload, secret)
print(token)

medium

A. Missing algorithm parameter causes an error

B. No error; code runs correctly

C. Secret key should be bytes, not string

D. Payload must be a string, not a dictionary

Solution

1. Step 1: Check encode function requirements

   PyJWT's encode has a default algorithm='HS256', so it is not strictly required.

2. Step 2: Analyze the code snippet

   The code calls encode with payload and secret; algorithm defaults to HS256, so it runs correctly and produces a token.

3. Final Answer:

   No error; code runs correctly -> Option B

4. Quick Check:

   Algorithm defaults to HS256 = no error [OK]

Hint: PyJWT encode defaults to HS256 algorithm [OK]

Common Mistakes:

• Assuming algorithm defaults to HS256
• Thinking payload must be string
• Believing secret must be bytes

5. You want to create a JWT token in FastAPI that expires in 30 minutes. Which code snippet correctly adds the expiration time to the payload before encoding?

hard

A. payload = {"user_id": 1, "exp": datetime.utcnow() + timedelta(minutes=30)}

B. payload = {"user_id": 1, "exp": str(datetime.utcnow() + timedelta(minutes=30))}

C. payload = {"user_id": 1, "exp": time.time() + 1800}

D. payload = {"user_id": 1, "exp": datetime.now() + timedelta(minutes=30)}

Solution

1. Step 1: Understand JWT expiration format

   The 'exp' claim must be a UTC datetime or a timestamp representing expiration time.

2. Step 2: Evaluate each option

   payload = {"user_id": 1, "exp": datetime.utcnow() + timedelta(minutes=30)} uses datetime.utcnow() + timedelta for 30 minutes, which is correct. payload = {"user_id": 1, "exp": str(datetime.utcnow() + timedelta(minutes=30))} converts datetime to string, which is invalid. payload = {"user_id": 1, "exp": time.time() + 1800} uses time.time() but JWT expects datetime or timestamp as int, so this may cause issues. payload = {"user_id": 1, "exp": datetime.now() + timedelta(minutes=30)} uses datetime.now() which is local time, not UTC, causing potential errors.

3. Final Answer:

   payload = {"user_id": 1, "exp": datetime.utcnow() + timedelta(minutes=30)} -> Option A

4. Quick Check:

   Use UTC datetime for 'exp' claim [OK]

Hint: Use datetime.utcnow() + timedelta for expiration [OK]

Common Mistakes:

• Using local time instead of UTC
• Converting datetime to string for 'exp'
• Using wrong time functions like time.time() without conversion