Passer au contenu principal

FastAPI

casbin-fastapi-decorator est une bibliothèque communautaire qui protège les routes FastAPI avec des décorateurs. Son package Casdoor, casbin-fastapi-decorator-casdoor, connecte les utilisateurs via Casdoor (OAuth2) et vérifie les permissions en appelant l'API /api/enforce de Casdoor, afin que les politiques résident dans Casdoor plutôt que dans votre application.

note

Cette bibliothèque est maintenue par la communauté, et non par l'équipe Casdoor. Signalez les bugs dans son dépôt GitHub.

Voici quelques-uns des noms dans la configuration :

CASDOOR_HOSTNAME : Le nom de domaine ou l'IP où le serveur Casdoor est déployé, par exemple http://localhost:8000.

FASTAPI_HOSTNAME : Le nom de domaine ou l'IP où votre application FastAPI est déployée, par exemple http://localhost:8080.

Étape 1 : Déployer Casdoor​

Déployez Casdoor et assurez-vous que vous pouvez vous y connecter.

Étape 2 : Configurer Casdoor​

  1. Créez une nouvelle application ou utilisez-en une existante.
  2. Ajoutez FASTAPI_HOSTNAME/callback aux Redirect URLs de l'application.
  3. Copiez le Client ID, le Client Secret, le nom de l'organisation et le nom de l'application.
  4. Ouvrez le certificat utilisé par l'application (page Certs) et copiez sa clé publique.
  5. Créez les règles de permission que l'application doit vérifier. Vous pouvez utiliser un enforcer, une permission, un modèle, une ressource ou une organisation entière comme cible ; vous passerez son ID à l'étape 4.

Étape 3 : Installer la bibliothèque​

pip install "casbin-fastapi-decorator[casdoor]"

Python 3.10 ou version ultérieure est requis.

Étape 4 : Protéger vos routes​

CasdoorIntegration crée le client SDK Casdoor, les routes de connexion et un PermissionGuard en un seul appel :

from fastapi import FastAPI
from casbin_fastapi_decorator_casdoor import CasdoorEnforceTarget, CasdoorIntegration

casdoor = CasdoorIntegration(
endpoint="http://localhost:8000",
client_id="<client-id>",
client_secret="<client-secret>",
certificate="-----BEGIN CERTIFICATE-----\n...",
org_name="built-in",
application_name="app-built-in",
target=CasdoorEnforceTarget(
# the enforcer ID is built from the signed-in user's organization
enforce_id=lambda parsed: f"{parsed['owner']}/my-enforcer",
),
cookie_secure=False, # only for local HTTP testing; keep the default True in production
)

app = FastAPI()
app.include_router(casdoor.router) # GET /login, GET /callback, POST /logout, GET /me
guard = casdoor.create_guard()

@app.get("/articles")
@guard.require_permission("articles", "read")
async def list_articles():
return []

@app.get("/profile")
@guard.auth_required()
async def profile():
return {"ok": True}

Comment ça fonctionne:

  1. Envoyez l'utilisateur vers FASTAPI_HOSTNAME/login. L'application redirige vers Casdoor avec une valeur state aléatoire.
  2. Après la connexion, Casdoor redirige vers /callback. L'application vérifie state, échange le code contre des jetons et les stocke dans les cookies access_token et refresh_token.
  3. Sur chaque requête protégée, l'application vérifie le jeton avec le certificat et appelle /api/enforce de Casdoor avec ["<owner>/<name>", "articles", "read"]. Les requêtes refusées reçoivent 403 Forbidden.
  4. POST /logout déconnecte l'utilisateur de Casdoor et efface les cookies.

Étape 5 : Choisir la cible d'enforcement​

CasdoorEnforceTarget décide quel objet Casdoor contient les règles. Définissez exactement un champ, soit avec un ID fixe, soit avec une fonction qui reçoit le JWT analysé :

ChampCasdoor object
enforce_idEnforcer, e.g. built-in/my-enforcer
permission_idPermission, e.g. built-in/can-read-articles
model_idModel, e.g. built-in/rbac-model
resource_idResource
propriétaireAll permissions of an organization, e.g. built-in
CasdoorEnforceTarget(permission_id="built-in/can-read-articles")

Utilisation avancée​

Pour utiliser votre propre format d'ID utilisateur, une cible différente par guard, ou vos propres réponses d'erreur, construisez les composants vous-même :

from casdoor import AsyncCasdoorSDK
from fastapi import FastAPI, HTTPException
from casbin_fastapi_decorator import PermissionGuard
from casbin_fastapi_decorator_casdoor import (
CasdoorEnforcerProvider,
CasdoorEnforceTarget,
CasdoorUserProvider,
make_casdoor_router,
)

sdk = AsyncCasdoorSDK(
endpoint="http://localhost:8000",
client_id="<client-id>",
client_secret="<client-secret>",
certificate="<certificate>",
org_name="built-in",
application_name="app-built-in",
)

guard = PermissionGuard(
user_provider=CasdoorUserProvider(sdk=sdk),
enforcer_provider=CasdoorEnforcerProvider(
sdk=sdk,
target=CasdoorEnforceTarget(enforce_id="built-in/my-enforcer"),
user_factory=lambda parsed: parsed["email"], # default is "owner/name"
),
error_factory=lambda user, *rvals: HTTPException(403, "Forbidden"),
)

app = FastAPI()
app.include_router(make_casdoor_router(sdk, redirect_after_login="/docs"))

Consultez le README de la bibliothèque pour toutes les options, telles que les noms de cookies, le domaine des cookies et un store state personnalisé.