Zum Hauptinhalt springen

FastAPI

casbin-fastapi-decorator ist eine Community-Bibliothek, die FastAPI-Routen mit Decorators schützt. Ihr Casdoor-Paket, casbin-fastapi-decorator-casdoor, meldet Benutzer über Casdoor an (OAuth2) und prüft Berechtigungen durch Aufruf der /api/enforce-API von Casdoor, sodass die Richtlinien in Casdoor statt in Ihrer App liegen.

Notiz

Diese Bibliothek wird von der Community und nicht vom Casdoor-Team gepflegt. Melden Sie Fehler im GitHub-Repository.

Die folgenden sind einige der Namen in der Konfiguration:

CASDOOR_HOSTNAME: Der Domainname oder die IP, unter der der Casdoor-Server bereitgestellt wird, z. B. http://localhost:8000.

FASTAPI_HOSTNAME: Der Domainname oder die IP, unter der Ihre FastAPI-App bereitgestellt wird, z. B. http://localhost:8080.

Schritt 1: Casdoor bereitstellen​

Stellen Sie Casdoor bereit und stellen Sie sicher, dass Sie sich anmelden können.

Schritt 2: Casdoor konfigurieren​

  1. Erstellen Sie eine neue Anwendung oder verwenden Sie eine vorhandene.
  2. Fügen Sie FASTAPI_HOSTNAME/callback zu den Redirect URLs der Anwendung hinzu.
  3. Kopieren Sie die Client ID, das Client Secret, den Organisationsnamen und den Anwendungsnamen.
  4. Öffnen Sie das Zertifikat, das von der Anwendung verwendet wird (Certs-Seite), und kopieren Sie dessen öffentlichen Schlüssel.
  5. Erstellen Sie die Berechtigungsregeln, die die App überprüfen soll. Sie können einen Enforcer, eine Berechtigung, ein Modell, eine Ressource oder eine gesamte Organisation als Ziel verwenden; übergeben Sie dessen ID in Schritt 4.

Schritt 3: Installieren der Bibliothek​

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

Python 3.10 oder neuer ist erforderlich.

Schritt 4: Schützen Ihrer Routen​

CasdoorIntegration erstellt den Casdoor-SDK-Client, die Anmelde-Routen und einen PermissionGuard mit einem einzigen Aufruf:

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}

Wie es funktioniert:

  1. Leiten Sie den Benutzer zu FASTAPI_HOSTNAME/login. Die App leitet zu Casdoor weiter, zusammen mit einem zufälligen state-Wert.
  2. Nach der Anmeldung leitet Casdoor zurück zu /callback. Die App prüft state, tauscht den Code gegen Tokens aus und speichert diese in den Cookies access_token und refresh_token.
  3. Bei jeder geschützten Anfrage verifiziert die App das Token mit dem Zertifikat und ruft Casdoors /api/enforce mit ["<owner>/<name>", "articles", "read"] auf. Abgelehnte Anfragen erhalten 403 Forbidden.
  4. POST /logout meldet den Benutzer bei Casdoor ab und löscht die Cookies.

Schritt 5: Auswählen des Enforce-Ziels​

CasdoorEnforceTarget bestimmt, welches Casdoor-Objekt die Regeln enthält. Legen Sie genau ein Feld fest, entweder auf eine feste ID oder auf eine Funktion, die das geparste JWT empfängt:

FeldCasdoor 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
eigentümerAll permissions of an organization, e.g. built-in
CasdoorEnforceTarget(permission_id="built-in/can-read-articles")

Erweiterte Verwendung​

Um Ihr eigenes Benutzer-ID-Format, ein unterschiedliches Ziel pro Guard oder eigene Fehlerantworten zu verwenden, erstellen Sie die Teile selbst:

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

Siehe die Library README für alle Optionen, wie Cookie-Namen, Cookie-Domäne und ein benutzerdefiniertes state-Store.