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}")

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.2.3.tar.gz (38.2 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.2.3-py3-none-any.whl (49.3 kB view details)

Uploaded Python 3

File details

Details for the file auth-kit-fastapi-0.2.3.tar.gz.

File metadata

  • Download URL: auth-kit-fastapi-0.2.3.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.7

File hashes

Hashes for auth-kit-fastapi-0.2.3.tar.gz
Algorithm Hash digest
SHA256 25a56e15cdbb9ef230be572425550009a15e2ffcac946fdf1ac02d64a1a1748d
MD5 fcbeae351f98a7b469b86fa51f8f584d
BLAKE2b-256 210fba72f489491bbf7abed8197527f80cb6c88c300d6eb2bcde1a227e018784

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for auth_kit_fastapi-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b5329b5c305b93260933d3560ea65ed21f51105b2f045c590b24c758d00fb3d0
MD5 e7db084927f5b61c9e5f9ac903d9ee77
BLAKE2b-256 4724416a2a0163f505396202c887b2cd28f2e7843735d3b535ffd724704f3f51

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