Saltar al contenido principal

FastAPI

casbin-fastapi-decorator es una biblioteca comunitaria que protege las rutas de FastAPI con decoradores. Su paquete para Casdoor, casbin-fastapi-decorator-casdoor, inicia sesión en los usuarios a través de Casdoor (OAuth2) y comprueba permisos llamando a la API /api/enforce de Casdoor, por lo que las políticas residen en Casdoor en lugar de en tu aplicación.

nota

Esta biblioteca es mantenida por la comunidad, no por el equipo de Casdoor. Informa de errores en su repositorio de GitHub.

A continuación se presentan algunos de los nombres en la configuración:

CASDOOR_HOSTNAME: El nombre de dominio o IP donde está desplegado el servidor de Casdoor, p. ej. http://localhost:8000.

FASTAPI_HOSTNAME: El nombre de dominio o IP donde está desplegada tu aplicación FastAPI, p. ej. http://localhost:8080.

Paso 1: Desplegar Casdoor​

Despliega Casdoor y asegúrate de poder iniciar sesión en él.

Paso 2: Configurar Casdoor​

  1. Crea una nueva aplicación o utiliza una existente.
  2. Añade FASTAPI_HOSTNAME/callback a Redirect URLs de la aplicación.
  3. Copia el Client ID, el Client Secret, el nombre de la organización y el nombre de la aplicación.
  4. Abre el certificado utilizado por la aplicación (página Certs) y copia su clave pública.
  5. Crea las reglas de permiso que la aplicación debe comprobar. Puedes usar un enforcer, un permiso, un modelo, un recurso o toda una organización como objetivo; pasarás su ID en el Paso 4.

Paso 3: Instalar la biblioteca​

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

Se requiere Python 3.10 o posterior.

Paso 4: Proteger tus rutas​

CasdoorIntegration crea el cliente SDK de Casdoor, las rutas de inicio de sesión y un PermissionGuard en una sola llamada:

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}

Cómo funciona:

  1. Envía al usuario a FASTAPI_HOSTNAME/login. La aplicación redirige a Casdoor con un valor state aleatorio.
  2. Tras el inicio de sesión, Casdoor redirige de vuelta a /callback. La aplicación verifica state, intercambia el código por tokens y los almacena en las cookies access_token y refresh_token.
  3. En cada solicitud protegida, la aplicación verifica el token con el certificado y llama a /api/enforce de Casdoor con ["<owner>/<name>", "articles", "read"]. Las solicitudes denegadas reciben 403 Forbidden.
  4. POST /logout cierra la sesión del usuario en Casdoor y limpia las cookies.

Paso 5: Elegir el objetivo de enforce​

CasdoorEnforceTarget determina qué objeto de Casdoor contiene las reglas. Establece exactamente un campo, ya sea a un ID fijo o a una función que recibe el JWT analizado:

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

Uso avanzado​

Para usar tu propio formato de ID de usuario, un objetivo diferente por guard o tus propias respuestas de error, construye las partes tú mismo:

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

Consulta el README de la biblioteca para ver todas las opciones, como nombres de cookies, dominio de cookies y un almacén state personalizado.