FastAPI
casbin-fastapi-decorator は、デコレーターを使って FastAPI のルートを保護するコミュニティライブラリです。その Casdoor パッケージ casbin-fastapi-decorator-casdoor は、Casdoor(OAuth2)を介してユーザーのサインインを行い、Casdoor の /api/enforce API を呼び出して権限を確認します。これにより、ポリシーはアプリ内ではなく Casdoor に保存されます。
このライブラリはコミュニティによって維持管理されており、Casdoor チームによるものではありません。バグは GitHub リポジトリ で報告してください。
以下は設定内のいくつかの名前です:
CASDOOR_HOSTNAME: Casdoor サーバーがデプロイされているドメイン名または IP アドレス。例: http://localhost:8000。
FASTAPI_HOSTNAME: FastAPI アプリがデプロイされているドメイン名または IP アドレス。例: http://localhost:8080。
ステップ1: Casdoorのデプロイ
Casdoor をデプロイし、サインインできることを確認してください。
ステップ2: Casdoorを設定する
- 新しいアプリケーションを作成するか、既存のものを使用します。
- アプリケーションの Redirect URLs に
FASTAPI_HOSTNAME/callbackを追加します。 - Client ID、Client Secret、組織名、およびアプリケーション名をコピーします。
- アプリケーションで使用される証明書(Certs ページ)を開き、公開鍵をコピーします。
- アプリがチェックすべき権限ルールを作成します。ターゲットとして enforcer、permission、モデル、リソース、または組織全体を使用できます。ステップ 4 でその ID を渡します。
ステップ 3: ライブラリのインストール
pip install "casbin-fastapi-decorator[casdoor]"
Python 3.10 以降が必要です。
ステップ 4: ルートの保護
CasdoorIntegration は、Casdoor SDK クライアント、サインインルート、および 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に送信します。アプリはランダムなstate値で Casdoor にリダイレクトします。 - サインイン後、Casdoor は
/callbackに戻ります。アプリはstateを確認し、コードをトークンと交換して、access_tokenおよびrefresh_tokenクッキーに保存します。 - 保護された各リクエストにおいて、アプリは証明書を使用してトークンを検証し、Casdoor の
/api/enforceを["<owner>/<name>", "articles", "read"]で呼び出します。拒否されたリクエストには403 Forbiddenが返されます。 POST /logoutはユーザーを Casdoor からサインアウトし、クッキーをクリアします。
ステップ 5: enforce ターゲットの選択
CasdoorEnforceTarget は、ルールを保持する Casdoor オブジェクトを決定します。固定 ID または解析済み JWT を受け取る関数のいずれかに設定することで、フィールドを 1 つだけ指定します:
| フィールド | 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 フォーマットの使用、ガードごとの異なるターゲットの設定、または独自のエラーレスポンスの実装を行う場合は、パーツを自分で構築します:
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"))
すべてのオプション(クッキー名、クッキードメイン、カスタム state ストアなど)については、ライブラリの README を参照してください。