AuthenticationX 💫

authx

Ready-to-use and customizable Authentications and Oauth2 management for FastAPI ⚡

Source Code: https://github.com/yezz123/AuthX

Documentation: https://authx.yezz.me/

Add a Fully registration and authentication or authorization system to your FastAPI project. AuthX is designed to be as customizable and adaptable as possible.

Features 🔧

[x] Support Python 3.9+.
[x] Extensible base user model.
[x] Ready-to-use register, login, reset password and verify e-mail routes.
[x] Ready-to-use Social login and Oauth2 routes.
- [x] Full Configuration and customization.
- [x] Ready-to-use social OAuth2 login flow.
[x] Middleware Support for Oauth2 using Authlib and Starlette.
[x] Dependency callable to inject current user in route.
[x] Pluggable password validation
- [x] Using Captcha Service.
- [x] Implements the HMAC algorithm And Hashlib library.
[x] Using Email Service. (SMTP)
[x] Extensible Error Handling
[x] High level API to manage users, roles and permissions
[x] Using Redis as a session store & cache.
[x] Support HTTPCache.
[x] Customizable database backend:
- [x] MongoDB async backend included thanks to mongodb/motor
- [x] SQLAlchemy backend included thanks to Encode/Databases
[x] Multiple customizable authentication backend:
- [x] JWT authentication backend included
- [x] Cookie authentication backend included
[x] Full OpenAPI schema support, even with several authentication backend.
[x] Provide a Docstring for each class and function.
[x] Support Sessions and Pre-built CRUD functions and Instance to launch Redis.
[x] Support SocketIO.
[x] Support Middleware of pyinstrument to check your service performance.
[x] Support Middleware for collecting and exposing Prometheus metrics.

Note: Check Release Notes.

Note: Check Examples.

Project using 🚀

from fastapi import APIRouter, Depends, FastAPI
from authx import Authentication, User, BaseDBBackend, RedisBackend

app = FastAPI()
auth = Authentication(database_backend=BaseDBBackend())
router = APIRouter()

# Set up Pre-configured Routes
app.include_router(auth.auth_router, prefix="/api/users")
app.include_router(auth.social_router, prefix="/auth")
app.include_router(auth.password_router, prefix="/api/users")
app.include_router(auth.admin_router, prefix="/api/users")
app.include_router(auth.search_router, prefix="/api/users")

# Set Redis Cache
auth.set_cache(RedisBackend)

# Set Anonymous User
@router.get("/anonym")
def anonym_test(user: User = Depends(auth.get_user)):
    pass


# Set Authenticated User
@router.get("/user")
def user_test(user: User = Depends(auth.get_authenticated_user)):
    pass


# Set Admin User
@router.get("/admin", dependencies=[Depends(auth.admin_required)])
def admin_test():
    pass

Contributors and sponsors ✨☕️

Thanks goes to these wonderful people (emoji key):

_{Yasser Tahiri} 💻 📖 🚧 🚇	_{Abderrahim SOUBAI-ELIDRISI} 👀 📖	_{Ismail Ghallou} 💻 🛡️	_{talentuno LLC} 💵	_{Cactus LLC} 💵	_MojixCoder 💻 🐛	_{Stéphane Raimbault} 💻 🔌
_theoohoho 📖	_{Yogesh Upadhyay} 🐛	_Roman 🐛