fastapi-nextauth-jwt 2.1.1

A fastapi dependency used to decode jwt tokens generated by nextauth,

fastapi-nextauth-jwt

This project provides a FastAPI dependency for decrypting and validating JWTs generated by Auth.js. It is designed to facilitate the integration of a FastAPI backend with Next.js and NextAuth/Auth.js on the frontend.

[!NOTE] Using Auth.js with frameworks other than Next.js may work but has not been tested

Features

• JWT Decryption & Validation: Seamlessly decrypt and validate JWTs generated by Auth.js
• CSRF Protection: Built-in Auth.js-compatible CSRF protection with configurable HTTP methods
• Flexible Configuration: Extensive customization options for encryption algorithms, cookie names, and security settings
• NextAuth.js v4 Compatibility: Includes a compatibility layer for NextAuth.js v4 through NextAuthJWTv4

Installation

pip install fastapi-nextauth-jwt

Basic Usage

from typing import Annotated
from fastapi import FastAPI, Depends
from fastapi_nextauth_jwt import NextAuthJWT

app = FastAPI()

JWT = NextAuthJWT(
    secret="y0uR_SuP3r_s3cr37_$3cr3t", # Leave this out to automatically read the AUTH_SECRET env var
)

@app.get("/")
async def return_jwt(jwt: Annotated[dict, Depends(JWT)]):
    return jwt

Configuration Options

Essential Settings

• secret (str): The secret key used for JWT operations. Should match AUTH_SECRET in your Next.js app. Leave this out to automatically read the AUTH_SECRET environment variable.

  JWT = NextAuthJWT(secret=os.getenv("YOUR_SECRET_ENV_VAR_NAME")))
  

Additional Options

If your auth.js settings are left at their defaults, you shouldn't need to touch these.

Security Options

• csrf_prevention_enabled (bool): Enable CSRF protection

  • Defaults to False in development (ENV=dev), True otherwise

• csrf_methods (Set[str]): HTTP methods requiring CSRF protection

  • Default: {'POST', 'PUT', 'PATCH', 'DELETE'}

Cookie Configuration

• secure_cookie (bool): Enable secure cookie attributes

  • Default: True (when AUTH_URL starts with https)

• cookie_name (str): Session token cookie name

  • Default: "__Secure-authjs.session-token" (when secure_cookie is True)
  • Default: "authjs.session-token" (when secure_cookie is False)

• csrf_cookie_name (str): CSRF token cookie name

  • Default: "__Host-authjs.csrf-token" (when secure_cookie is True)
  • Default: "authjs.csrf-token" (when secure_cookie is False)

[!TIP] If you're using the latest version of Auth.js, here's the recommended configuration:

JWT = NextAuthJWT(
    secret=os.environ["AUTH_SECRET"],
)

Advanced Options

• encryption_algorithm (str): JWT encryption algorithm

  • Supported: "A256CBC-HS512" (default), "A256GCM"

• check_expiry (bool): Enable JWT expiration validation

  • Default: True

NextAuth.js v4 Compatibility

For NextAuth.js v4 applications, use the NextAuthJWTv4 class:

from fastapi_nextauth_jwt import NextAuthJWTv4

JWT = NextAuthJWTv4(
    secret=os.getenv("AUTH_SECRET")
)

This provides compatibility with the v4 token format and default settings

Best Practices

1. Environment Variables: Always use environment variables for sensitive values:

   JWT = NextAuthJWT(
       secret=os.getenv("AUTH_SECRET"),
   )
   

2. HTTPS in Production: Ensure AUTH_URL starts with https:// in production to enable secure cookies

3. CSRF Protection: Keep CSRF protection enabled in production environments

Examples

A simple example is available in the examples folder. It demonstrates:

• Using Next.js URL rewrites to route requests to FastAPI
• Basic JWT validation setup
• CSRF protection configuration

You can also place both the backend and frontend behind a reverse proxy like nginx, as long as the auth.js cookies reach FastAPI.

Environment Variables

• AUTH_SECRET: The secret key used for JWT operations (required)
• AUTH_URL: The URL of your application (affects secure cookie settings)
• ENV: Set to "dev" to disable CSRF protection in development