FastAPI
casbin-fastapi-decorator é uma biblioteca comunitária que protege rotas do FastAPI com decorators. Seu pacote Casdoor, casbin-fastapi-decorator-casdoor, autentica usuários através do Casdoor (OAuth2) e verifica permissões chamando a API /api/enforce do Casdoor, fazendo com que as políticas residam no Casdoor em vez do seu aplicativo.
Esta biblioteca é mantida pela comunidade, não pela equipe do Casdoor. Reporte bugs em seu repositório GitHub.
Os seguintes são alguns dos nomes na configuração:
CASDOOR_HOSTNAME: O nome de domínio ou IP onde o servidor Casdoor está implantado, por exemplo, http://localhost:8000.
FASTAPI_HOSTNAME: O nome de domínio ou IP onde seu aplicativo FastAPI está implantado, por exemplo, http://localhost:8080.
Passo 1: Implante o Casdoor
Implante o Casdoor e certifique-se de que você consegue fazer login nele.
Passo 2: Configurar Casdoor
- Crie uma nova aplicação ou use uma existente.
- Adicione
FASTAPI_HOSTNAME/callbackàs Redirect URLs da aplicação. - Copie o Client ID, o Client Secret, o nome da organização e o nome da aplicação.
- Abra o certificado usado pela aplicação (página Certs) e copie sua chave pública.
- Crie as regras de permissão que o aplicativo deve verificar. Você pode usar um enforcer, uma permissão, um modelo, um recurso ou uma organização inteira como alvo; você passará seu ID na Etapa 4.
Etapa 3: Instalar a biblioteca
pip install "casbin-fastapi-decorator[casdoor]"
É necessário Python 3.10 ou posterior.
Etapa 4: Proteger suas rotas
CasdoorIntegration cria o cliente SDK do Casdoor, as rotas de login e um PermissionGuard em uma única chamada:
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}
Como funciona:
- Envie o usuário para
FASTAPI_HOSTNAME/login. O aplicativo redireciona para o Casdoor com um valorstatealeatório. - Após o login, o Casdoor redireciona de volta para
/callback. O aplicativo verifica ostate, troca o código por tokens e os armazena nos cookiesaccess_tokenerefresh_token. - Em cada solicitação protegida, o aplicativo verifica o token com o certificado e chama
/api/enforcedo Casdoor com["<owner>/<name>", "articles", "read"]. Solicitações negadas recebem403 Forbidden. POST /logoutdesconecta o usuário do Casdoor e limpa os cookies.
Etapa 5: Escolher o alvo enforce
CasdoorEnforceTarget decide qual objeto do Casdoor contém as regras. Defina exatamente um campo, seja para um ID fixo ou para uma função que recebe o JWT analisado:
| Campo | Casdoor object |
|---|---|
enforce_id | Enforcer, e.g. built-in/my-enforcer |
permission_id | Permission, e.g. built-in/can-read-articles |
model_id | Model, e.g. built-in/rbac-model |
resource_id | Resource |
proprietário | All permissions of an organization, e.g. built-in |
CasdoorEnforceTarget(permission_id="built-in/can-read-articles")
Uso avançado
Para usar seu próprio formato de ID de usuário, um alvo diferente por guard ou suas próprias respostas de erro, construa as partes você mesmo:
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"))
Consulte o README da biblioteca para todas as opções, como nomes de cookies, domínio de cookies e um armazenamento state personalizado.