Authx

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

Project	Status
CI
Meta

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.8+ & Pydantic 2.0+.
[x] Multiple customizable authentication backend:
- [x] JWT authentication backend included
- [x] JWT encoding/decoding for application authentication
- [x] Automatic detection of JWTs in requests:
  - [x] JWTs in headers
  - [x] JWTs in cookies
  - [x] JWTs in query parameters
  - [x] JWTs in request bodies
- [x] Cookie authentication backend included
[x] Middleware for authentication and authorization through JWT.
[x] Extensible Error Handling System.

Extra Features

AuthX is designed to be as customizable and adaptable as possible.

So you need to install authx-extra to get extra features.

[x] Using Redis as a session store & cache.
[x] Support HTTPCache.
[x] Support Sessions and Pre-built CRUD functions and Instance to launch Redis.
[x] Support Middleware of pyinstrument to check your service performance.
[x] Support Middleware for collecting and exposing Prometheus metrics.

Note: Check Release Notes.

Project using

Here is a simple way to kickstart your project with AuthX:

from fastapi import FastAPI, Depends, HTTPException
from authx import AuthX, AuthXConfig, RequestToken

app = FastAPI()

config = AuthXConfig(
     JWT_ALGORITHM = "HS256",
     JWT_SECRET_KEY = "SECRET_KEY",
     JWT_TOKEN_LOCATION = ["headers"],
)

auth = AuthX(config=config)
auth.handle_errors(app)

@app.get('/login')
def login(username: str, password: str):
     if username == "xyz" and password == "xyz":
          token = auth.create_access_token(uid=username)
          return {"access_token": token}
     raise HTTPException(401, detail={"message": "Invalid credentials"})

@app.get("/protected", dependencies=[Depends(auth.get_token_from_request)])
def get_protected(token: RequestToken = Depends()):
     try:
          auth.verify_token(token=token)
          return {"message": "Hello world !"}
     except Exception as e:
          raise HTTPException(401, detail={"message": str(e)}) from e

Contributors and sponsors

Thanks goes to these wonderful people (emoji key):

_{Yasser Tahiri} 💻 📖 🚧 🚇	_{Abderrahim SOUBAI-ELIDRISI} 👀 📖	_{Ismail Ghallou} 💻 🛡️	_MojixCoder 💻 🐛	_{Stéphane Raimbault} 💻 🔌	_theoohoho 📖	_{Yogesh Upadhyay} 🐛
_Roman 🐛	_{Alvaro Lopez Ortega} 📖	_{Devy Santo} 🚇	_pg365 🚇	_Jorrit 📦