Skip to main content

FastAPI authentication backend for Auth Kit

Project description

Auth Kit FastAPI

FastAPI authentication backend for Auth Kit. Provides a complete authentication solution with JWT tokens, passkeys, 2FA, and more.

Installation

pip install auth-kit-fastapi

Quick Start

from fastapi import FastAPI
from auth_kit_fastapi import create_auth_app, AuthConfig

app = FastAPI()

# Configure authentication
auth_config = AuthConfig(
    database_url="postgresql://localhost/myapp",
    jwt_secret="your-secret-key",
    features={
        "passkeys": True,
        "two_factor": True,
        "email_verification": True
    }
)

# Create auth app
auth_app = create_auth_app(auth_config)

# Mount auth routes
app.mount("/api/auth", auth_app)

Features

  • 🔐 JWT-based authentication with refresh tokens
  • 🔑 WebAuthn/Passkey support
  • 🔒 Two-factor authentication (TOTP)
  • 📧 Email verification
  • 🔄 Password reset flow
  • 👤 User management
  • 🗄️ SQLAlchemy ORM support
  • 🔍 Extensible user model
  • 🛡️ Security best practices

Configuration

from auth_kit_fastapi import AuthConfig

config = AuthConfig(
    # Database
    database_url="postgresql://user:pass@localhost/db",
    
    # JWT Settings
    jwt_secret="your-secret-key",
    jwt_algorithm="HS256",
    access_token_expire_minutes=30,
    refresh_token_expire_days=7,
    
    # Passkey Settings
    passkey_rp_id="localhost",
    passkey_rp_name="My App",
    passkey_origin="http://localhost:3000",
    
    # Email Settings
    email_from="noreply@example.com",
    email_from_name="My App",
    
    # Features
    features={
        "passkeys": True,
        "two_factor": True,
        "email_verification": True,
        "social_login": ["google", "github"]
    }
)

Custom User Model

Extend the base User model with your own fields:

from auth_kit_fastapi import BaseUser
from sqlalchemy import Column, String

class User(BaseUser):
    __tablename__ = "users"
    
    # Add custom fields
    company_name = Column(String, nullable=True)
    department = Column(String, nullable=True)

API Endpoints

All endpoints are mounted under your chosen prefix (e.g., /api/auth):

Authentication

  • POST /register - Register new user
  • POST /login - Login with email/password
  • POST /logout - Logout user
  • POST /refresh - Refresh access token
  • GET /me - Get current user

Password Management

  • POST /password/change - Change password
  • POST /password/reset - Request password reset
  • POST /password/reset/confirm - Confirm password reset

Email Verification

  • GET /verify-email/{token} - Verify email
  • POST /resend-verification - Resend verification email

Passkeys

  • GET /passkeys - List user's passkeys
  • POST /passkeys/register/begin - Begin passkey registration
  • POST /passkeys/register/complete - Complete passkey registration
  • POST /passkeys/authenticate/begin - Begin passkey authentication
  • POST /passkeys/authenticate/complete - Complete passkey authentication
  • DELETE /passkeys/{id} - Delete passkey

Two-Factor Authentication

  • POST /2fa/setup/begin - Begin 2FA setup
  • POST /2fa/setup/verify - Verify and enable 2FA
  • POST /2fa/disable - Disable 2FA
  • POST /2fa/verify/login - Verify 2FA during login
  • POST /2fa/recovery-codes - Regenerate recovery codes

Middleware & Dependencies

Use the provided dependencies to protect your routes:

from fastapi import Depends
from auth_kit_fastapi import get_current_user, require_verified_user

@app.get("/protected")
async def protected_route(user = Depends(get_current_user)):
    return {"message": f"Hello {user.email}"}

@app.get("/verified-only")
async def verified_only(user = Depends(require_verified_user)):
    return {"message": "Only verified users can see this"}

Events & Hooks

Subscribe to authentication events:

from auth_kit_fastapi import auth_events

@auth_events.on("user_registered")
async def on_user_registered(user):
    # Send welcome email
    print(f"New user registered: {user.email}")

@auth_events.on("user_logged_in")
async def on_user_logged_in(user):
    # Log login event
    print(f"User logged in: {user.email}")

Changelog

Version 0.3.16 (2025-01-09)

  • Fixed: Complete passkey authentication flow with proxy/API gateway setups
    • Resolved FastAPI redirect_slashes conflicts causing redirect loops in proxy environments
    • Added duplicate routes without trailing slashes for passkey endpoints
    • Fixed authentication flow to properly handle passkey login without password fallback
    • Improved frontend integration with proper Content-Type handling for form-encoded data
    • Enhanced debug logging for troubleshooting authentication issues

Version 0.3.3 (2025-01-07)

  • Fixed: Base64url decoding for passkey challenges
    • Properly handles base64url encoded challenges (with - and _ characters)
    • Fixes 400 errors when challenges are sent in base64url format from frontend

Version 0.3.2 (2025-01-07)

  • Fixed: Passkey challenge handling for proxy/CORS scenarios
    • Challenges can now be provided in the request body as a fallback when session cookies aren't maintained
    • Fixes "Registration session expired" errors in environments with proxy setups (e.g., Next.js, Vercel)
    • Maintains backward compatibility with session-based challenge storage

Version 0.3.1

  • Initial public release with full authentication features

Troubleshooting

Passkey Authentication Issues

Redirect Loops with Proxy/API Gateway

If you're experiencing redirect loops (ERR_TOO_MANY_REDIRECTS) when using passkeys through a proxy:

Problem: FastAPI's redirect_slashes=True (default) conflicts with proxy setups, causing infinite redirects.

Solution:

app = FastAPI(redirect_slashes=False)

Frontend Integration with Next.js/Vercel

When using with Next.js or similar frameworks that proxy API requests:

  1. Preserve trailing slashes in proxy config:
// next.config.js
rewrites: async () => [
  {
    source: '/api/:path*/',
    destination: 'http://backend:8000/api/:path*/'
  },
  {
    source: '/api/:path*',
    destination: 'http://backend:8000/api/:path*'
  }
]
  1. Handle form-encoded data properly in axios:
// Don't override Content-Type for URLSearchParams
if (!(config.data instanceof FormData) && 
    !(config.data instanceof URLSearchParams)) {
  config.headers['Content-Type'] = 'application/json';
}

"Credential not found" Errors

This usually means the passkey authentication succeeded but the frontend is incorrectly trying to perform a regular login afterwards. Ensure your frontend directly fetches user data after successful passkey verification instead of calling the login endpoint.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

auth_kit_fastapi-0.3.17.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

auth_kit_fastapi-0.3.17-py3-none-any.whl (52.2 kB view details)

Uploaded Python 3

File details

Details for the file auth_kit_fastapi-0.3.17.tar.gz.

File metadata

  • Download URL: auth_kit_fastapi-0.3.17.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for auth_kit_fastapi-0.3.17.tar.gz
Algorithm Hash digest
SHA256 56333705c20ca3d98b28abe81470b801df07c4001ac30f0d7485e5448bf3c4f8
MD5 89b59cf72a6ec927e339da8a971f3489
BLAKE2b-256 77f3570633e1425510a2d5ed75cf2dc290ce2d18ab16161e1558c8c6613792c6

See more details on using hashes here.

File details

Details for the file auth_kit_fastapi-0.3.17-py3-none-any.whl.

File metadata

File hashes

Hashes for auth_kit_fastapi-0.3.17-py3-none-any.whl
Algorithm Hash digest
SHA256 d88e380217cc0a4ece442d71e941f50c2eec0236e3c2b94da253a441a1dc7016
MD5 cd2603077ad890477b203ad46b80c7c7
BLAKE2b-256 41aac78f392cca78c5024cd418fb8d8e44cf7081c895133e781fa12fb88ed362

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page