FastAPI
casbin-fastapi-decorator — це бібліотека спільноти, яка захищає маршрути FastAPI за допомогою декораторів. Її пакет Casdoor, casbin-fastapi-decorator-casdoor, виконує вхід користувачів через Casdoor (OAuth2) та перевіряє дозволи, викликаючи API /api/enforce Casdoor, тому політики зберігаються в Casdoor, а не у вашому додатку.
Ця бібліотека підтримується спільнотою, а не командою Casdoor. Повідомляйте про помилки у її репозиторії GitHub.
Нижче наведено деякі з назв у конфігурації:
CASDOOR_HOSTNAME: Доменне ім'я або IP-адреса, де розгорнуто сервер Casdoor, напр. http://localhost:8000.
FASTAPI_HOSTNAME: Доменне ім'я або IP-адреса, де розгорнуто ваш додаток FastAPI, напр. http://localhost:8080.
Крок 1: Розгортання Casdoor
Розгорніть Casdoor і переконайтеся, що ви можете увійти до нього.
Крок 2: Налаштування Casdoor
- Створіть новий додаток або використайте існуючий.
- Додайте
FASTAPI_HOSTNAME/callbackдо Redirect URLs додатка. - Скопіюйте Client ID, Client Secret, назву організації та назву додатка.
- Відкрийте сертифікат, який використовується додатком (сторінка Certs), і скопіюйте його відкритий ключ.
- Створіть правила дозволів, які має перевіряти додаток. Ви можете використовувати енфорсер, дозвіл, модель, ресурс або всю організацію як ціль; ви передасте їхній ID на Кроці 4.
Крок 3: Встановлення бібліотеки
pip install "casbin-fastapi-decorator[casdoor]"
Потрібен Python 3.10 або новішої версії.
Крок 4: Захист ваших маршрутів
CasdoorIntegration створює клієнт SDK Casdoor, маршрути входу та PermissionGuard одним викликом:
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}
Як це працює:
- Направляйте користувача на
FASTAPI_HOSTNAME/login. Додаток перенаправляє на Casdoor зі випадковим значеннямstate. - Після входу Casdoor перенаправляє назад на
/callback. Додаток перевіряєstate, обмінює код на токени та зберігає їх у кукахaccess_tokenтаrefresh_token. - При кожному захищеному запиті додаток перевіряє токен за допомогою сертифіката та викликає
/api/enforceCasdoor з["<owner>/<name>", "articles", "read"]. Запитам, яким відмовлено, повертається403 Forbidden. POST /logoutвиконує вихід користувача з Casdoor та очищує куки.
Крок 5: Вибір цілі enforce
CasdoorEnforceTarget визначає, який об'єкт Casdoor містить правила. Встановіть рівно одне поле, або фіксований ID, або функцію, яка отримує розпарсений JWT:
| Поле | 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 |
власник | All permissions of an organization, e.g. built-in |
CasdoorEnforceTarget(permission_id="built-in/can-read-articles")
Розширене використання
Щоб використовувати власний формат ID користувача, різні цілі для різних guard або власні відповіді про помилки, побудуйте компоненти самостійно:
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"))
Перегляньте README бібліотеки для всіх опцій, таких як імена куків, домен куків та власне сховище state.