fasthtml-auth 0.3.0

Complete authentication system for FastHTML applications with beautiful UI, role-based access control, and session management

FastHTML-Auth

Complete authentication system for FastHTML applications with built-in admin interface

Drop-in authentication with beautiful UI, role-based access control, and a powerful admin dashboard for user management. No configuration required – just install and go!

pip install fasthtml-auth

---

⭐ Key Features

• 🔐 Complete Authentication - Login, logout, registration with secure bcrypt hashing
• 👑 Built-in Admin Interface - Full user management dashboard
• 🌐 Google OAuth - Allow users to sign in with their Google account
• 🎨 Beautiful UI - Responsive MonsterUI components, zero custom CSS needed
• 🛡️ Role-Based Access - User, Manager, Admin roles with decorators
• 📱 Mobile Ready - Works perfectly on all devices
• ⚡ Zero Config - Works out of the box, customize as needed

---

🚀 Quick Start

Basic Authentication

from fasthtml.common import *
from monsterui.all import *
from fasthtml_auth import AuthManager

# Initialize auth system
auth = AuthManager(db_path="data/app.db")
db = auth.initialize()
beforeware = auth.create_beforeware()

# Create app
app = FastHTML(before=beforeware, hdrs=Theme.blue.headers())
auth.register_routes(app)

@app.route("/")
def dashboard(req):
    user = req.scope['user']  # Automatically available
    return H1(f"Welcome, {user.username}!")

@app.route("/admin")
@auth.require_admin()
def admin_only(req):
    return H1("Admin Area")

serve()

That's it! Your app now has:

• Login/logout at /auth/login and /auth/logout
• User registration at /auth/register
• Profile management at /auth/profile
• Role-based access control
• Default admin account: admin / admin123

---

👑 Built-in Admin Interface

Enable powerful user management with one parameter:

# Add this one parameter to get a complete admin dashboard
auth.register_routes(app, include_admin=True)

Instantly adds:

Feature	Route	Description
📊 Admin Dashboard	/auth/admin	User statistics and quick actions
👥 User Management	/auth/admin/users	List, search, filter all users
➕ Create Users	/auth/admin/users/create	Add users with role assignment
✏️ Edit Users	/auth/admin/users/edit?id={id}	Modify details, roles, status
🗑️ Delete Users	/auth/admin/users/delete?id={id}	Remove users (with protection)

Admin Interface Features

• 🔍 Search & Filter - Find users by username, email, role, or status
• 📄 Pagination - Handle thousands of users efficiently
• 🛡️ Safety Features - Prevent self-deletion and last admin removal
• 📊 Statistics Dashboard - User counts by role and status
• 🎨 Beautiful UI - Consistent MonsterUI design throughout

---

📖 Real-World Example

See FastHTML-Auth in action with a complete todo application:

📝 FastHTML Todo App

This real-world example shows:

• User authentication and registration
• Role-based task management
• Admin interface for user management
• Database integration patterns
• Production deployment setup

---

⚙️ Configuration

config = {
    'allow_registration': True,              # Enable user registration
    'public_paths': ['/about', '/api'],      # Routes that skip authentication  
    'login_path': '/auth/login',             # Custom login URL
    'oauth_redirect_url': 'https://yourdomain.com/auth/google/callback',  # Google OAuth callback URL
}

auth = AuthManager(db_path="data/app.db", config=config)

🌐 Google OAuth

FastHTML-Auth supports Google OAuth as an alternative login method. When enabled, a "Sign in with Google" button appears automatically on the login form.

Setup

1. Create OAuth credentials in Google Cloud Console:

   • Go to APIs & Services → Credentials → Create Credentials → OAuth 2.0 Client ID
   • Add your callback URL as an authorised redirect URI: https://yourdomain.com/auth/google/callback

2. Add credentials to your .env file:

GOOGLE_CLIENT_ID=your-client-id
GOOGLE_CLIENT_SECRET=your-client-secret
OAUTH_REDIRECT_URL=https://yourdomain.com/auth/google/callback

3. Call setup_oauth() before register_routes():

auth = AuthManager(db_path="data/app.db", config={
    ...
    'oauth_redirect_url': os.getenv('OAUTH_REDIRECT_URL')
})
db = auth.initialize()
auth.setup_oauth()                  # Load credentials and enable OAuth
beforeware = auth.create_beforeware()
app = FastHTML(before=beforeware, ...)
auth.register_routes(app)

OAuth users are stored in the same users table with auth_provider='google' and no password. They are automatically created on first login with basic user role.

---

🔐 Role-Based Access Control

Built-in Roles

• user - Basic authenticated access
• manager - Manager privileges + user access
• admin - Full system access + admin interface

Route Protection

# Require specific roles
@app.route("/manager-area")
@auth.require_role('manager', 'admin')
def manager_view(req):
    return H1("Manager+ Only")

# Admin only (shortcut)
@app.route("/admin")
@auth.require_admin()
def admin_panel(req):
    return H1("Admin Only")

# Check roles in templates
@app.route("/dashboard")
def dashboard(req):
    user = req.scope['user']
    
    admin_link = A("Admin Panel", href="/auth/admin") if user.role == 'admin' else None
    return Div(admin_link)

📊 User Object

In protected routes, access user data via req.scope['user']:

user.id             # Unique user ID  
user.username       # Username
user.email          # Email address
user.role           # 'user', 'manager', or 'admin'
user.active         # Boolean - account status
user.created_at     # Account creation timestamp
user.last_login     # Last login timestamp
user.auth_provider  # 'local' for password login, 'google' for OAuth

🎨 Styling & Themes

FastHTML-Auth uses MonsterUI for beautiful, responsive components:

# Choose your theme
app = FastHTML(
    before=beforeware,
    hdrs=Theme.blue.headers()    # or red, green, slate, etc.
)

All forms include professional styling, validation, error handling, and mobile optimization.

🛠️ API Reference

AuthManager

auth = AuthManager(db_path="data/app.db", config={})
auth.initialize()                                    # Set up database
auth.setup_oauth()                                   # Enable Google OAuth (optional)
auth.register_routes(app, include_admin=True)        # Add all routes
auth.create_beforeware()                             # Create middleware

@auth.require_admin()                                # Admin-only decorator
@auth.require_role('manager', 'admin')               # Role-based decorator

Available Routes

Authentication Routes:

• GET/POST /auth/login - User login
• GET /auth/logout - Logout and redirect
• GET/POST /auth/register - User registration
• GET/POST /auth/profile - Profile management

Admin Routes (when include_admin=True):

• GET /auth/admin - Admin dashboard
• GET /auth/admin/users - User management
• GET/POST /auth/admin/users/create - Create user
• GET/POST /auth/admin/users/edit?id={id} - Edit user
• GET/POST /auth/admin/users/delete?id={id} - Delete user

OAuth Routes (when setup_oauth() is called):

• GET /auth/google/login - Redirect to Google sign-in
• GET /auth/google/callback - Handle Google OAuth callback

📁 Examples

For complete examples, see the /examples directory:

• basic_app.py - Simple authentication setup
• example_with_admin.py - Full admin interface demo
• FastHTML Todo App - Real-world application

🔒 Security Features

• Bcrypt password hashing - Industry standard security
• Google OAuth - Secure third-party authentication via Google
• Session management - Secure session handling with FastHTML
• Remember me functionality - Optional persistent sessions
• Role-based protection - Automatic route access control
• Admin safety - Prevent self-deletion and last admin removal
• Input validation - Server-side validation for all forms

📦 Installation & Dependencies

pip install fasthtml-auth

Dependencies:

• python-fasthtml>=0.12.0 - Web framework
• monsterui>=1.0.20 - UI components
• fastlite>=0.2.0 - Database ORM
• bcrypt>=4.0.0 - Password hashing
• python-dotenv>=1.0.0 - Environment variable management (required for OAuth)

🤝 Contributing

We welcome contributions! Areas for contribution:

• Password reset functionality
• Two-factor authentication
• Additional OAuth providers (GitHub, Microsoft, etc.)
• Email verification
• Bulk user operations
• Custom user fields

📄 License

MIT License - see LICENSE file for details.

📝 Changelog

v0.3.0 (Current Release)

• ✅ Google OAuth integration
• ✅ auth_provider field to distinguish login method
• ✅ OAuth routes automatically added to public paths
• ✅ Login form automatically shows Google button when OAuth is enabled

v0.2.0

• ✅ Built-in admin interface for user management
• ✅ User CRUD operations with beautiful UI
• ✅ Dashboard with user statistics
• ✅ Search, filter, and pagination
• ✅ Safety features for admin operations

v0.1.2

• ✅ "Remember me" functionality
• ✅ Terms acceptance validation
• ✅ Improved form styling

v0.1.0

• ✅ Initial release with core authentication
• ✅ Role-based access control
• ✅ MonsterUI integration

---

FastHTML-Auth - Authentication made simple for FastHTML applications.

For questions and support: GitHub Issues