メインコンテンツにスキップ

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を設定する​

  1. 新しいアプリケーションを作成するか、既存のものを使用します。
  2. アプリケーションの Redirect URLs に FASTAPI_HOSTNAME/callback を追加します。
  3. Client ID、Client Secret、組織名、およびアプリケーション名をコピーします。
  4. アプリケーションで使用される証明書(Certs ページ)を開き、公開鍵をコピーします。
  5. アプリがチェックすべき権限ルールを作成します。ターゲットとして 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}

仕組み:

  1. ユーザーを FASTAPI_HOSTNAME/login に送信します。アプリはランダムな state 値で Casdoor にリダイレクトします。
  2. サインイン後、Casdoor は /callback に戻ります。アプリは state を確認し、コードをトークンと交換して、access_token および refresh_token クッキーに保存します。
  3. 保護された各リクエストにおいて、アプリは証明書を使用してトークンを検証し、Casdoor の /api/enforce を ["<owner>/<name>", "articles", "read"] で呼び出します。拒否されたリクエストには 403 Forbidden が返されます。
  4. POST /logout はユーザーを Casdoor からサインアウトし、クッキーをクリアします。

ステップ 5: enforce ターゲットの選択​

CasdoorEnforceTarget は、ルールを保持する Casdoor オブジェクトを決定します。固定 ID または解析済み JWT を受け取る関数のいずれかに設定することで、フィールドを 1 つだけ指定します:

フィールドCasdoor 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
所有者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 を参照してください。