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

Quarkus

Quarkus Casdoor Auth 拡張機能は、Quarkus アプリケーションを Casdoor に接続します。これはコミュニティによる Quarkus 拡張機能の本拠地である Quarkiverse の一部です。

この拡張機能は、サインインとトークン検証を処理する Quarkus 自体の quarkus-oidc を基盤としており、Casdoor に固有の機能を追加します:

  • ユーザーの Casdoor ロール が Quarkus ロールになるため、@RolesAllowed が機能します;
  • @PermissionsAllowed("resource:action") は、Enforce API を使用して Casdoor の権限に対してチェックされます;
  • casdoor という名前の HTTP セキュリティポリシーが、リクエストパスとメソッドを Casdoor の権限に対してチェックします。

バージョン 0.1.0 は Quarkus 3.40 でビルドされており、Java 17 以降が必要です。

ステップ 1: Casdoor でアプリケーションを作成する​

  1. Casdoor UI で Applications を開き、組織にアプリケーションを追加します。
  2. アプリケーションのコールバック URL(例:http://localhost:8080/)を Redirect URLs に追加します。
  3. Client ID と Client secret をコピーします。

ステップ 2:拡張機能の追加​

Maven の場合:

<dependency>
<groupId>io.quarkiverse.casdoor-auth</groupId>
<artifactId>quarkus-casdoor-auth</artifactId>
<version>0.1.0</version>
</dependency>

Gradle の場合:

implementation("io.quarkiverse.casdoor-auth:quarkus-casdoor-auth:0.1.0")

この拡張機能は quarkus-oidc を取り込むため、別途追加する必要はありません。

ステップ 3:サインインの設定​

application.properties で quarkus-oidc が Casdoor サーバーを指すように設定します:

quarkus.oidc.auth-server-url=https://door.casdoor.com
quarkus.oidc.client-id=<Client ID>
quarkus.oidc.credentials.secret=<Client secret>
# web-app: redirect users to the Casdoor sign-in page
# service (the default): accept bearer tokens only, e.g. for a REST API called by a frontend
quarkus.oidc.application-type=web-app

Casdoor は OIDC 発見ドキュメントを /.well-known/openid-configuration で公開しているため、他の設定は不要です。すべての quarkus.oidc オプションについては、Quarkus ガイドの 認可コードフロー および ベアラー トークン を参照してください。

セキュリティ アイデンティティには、トークンの owner および name(または preferred_username)クレームから読み取られた casdoor.organization と casdoor.username の 2 つの属性が追加されます。

ステップ 4:Casdoor ロールの使用​

ユーザーの Casdoor ロール名がアイデンティティに追加されます:

@GET
@Path("/admin")
@RolesAllowed("admin")
public String admin() {
return "admin";
}

デフォルトの JWT トークン形式では、ロールがトークンに含まれます。JWT-Standard 形式ではトークンにロールが含まれないため、拡張機能は代わりに UserInfo レスポンスから読み取ります。これを有効にするには以下を設定します:

quarkus.oidc.authentication.user-info-required=true

Casdoor グループは標準の groups クレームに含まれており、quarkus-oidc はすでにこれをロールにマッピングしています。

ステップ 5:Casdoor 権限の確認​

@PermissionsAllowed("data1:read") は、Casbin リクエスト ["<organization>/<username>", "data1", "read"] を Casdoor に送信し、あなたの Casdoor 権限のいずれかが許可する場合のみ呼び出しを許可します:

@GET
@Path("/data1")
@PermissionsAllowed("data1:read")
public String data1() {
return "data1";
}

例えば、組織 my-org 内の権限で、ロール my-org/admin、リソース data1、アクション read を持つ場合、次のようなモデルを使用します:

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

[role_definition]
g = _, _

[policy_effect]
e = some(where (p.eft == allow))

[matchers]
m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act

これにより、admin ロールのすべてのメンバーに対して @PermissionsAllowed("data1:read") が許可されます。

デフォルトでは、ユーザーの組織のすべての権限がチェックされます。単一の権限、モデル、リソース、またはエンフォーサーをチェックするには、以下のいずれかを設定します:

quarkus.casdoor.authorization.permission-id=my-org/my-permission
# quarkus.casdoor.authorization.model-id=my-org/my-model
# quarkus.casdoor.authorization.resource-id=my-resource
# quarkus.casdoor.authorization.enforcer-id=my-org/my-enforcer

拡張機能は、アプリケーションのクライアント ID とシークレットを使用して Enforce API を呼び出すため、権限、モデル、またはエンフォーサーはアプリケーションの組織に属している必要があります。

パスベースの認可​

casdoor HTTP セキュリティ ポリシーは ["<organization>/<username>", "<path>", "<method>"] を送信します。例えば ["my-org/alice", "/api/orders", "GET"] です。したがって、リソース /api/orders とアクション GET を持つ Casdoor 権限がこのエンドポイントを制御します。パスに適用するには:

quarkus.http.auth.permission.casdoor.paths=/api/*
quarkus.http.auth.permission.casdoor.policy=casdoor

または、@AuthorizationPolicy(name = "casdoor") を使用してエンドポイントに適用します。匿名のリクエストは拒否されます。

キャッシュ​

各チェックで Casdoor を呼び出すため、権限の変更は即座に反映されます。結果をキャッシュするには、例えば quarkus.casdoor.authorization.cache-ttl=30S を設定します。

設定リファレンス​

PropertyDefaultDescription
quarkus.casdoor.endpointquarkus.oidc.auth-server-urlCasdoor server URL used for the Enforce API
quarkus.casdoor.client-idquarkus.oidc.client-idClient ID used to call the Casdoor API
quarkus.casdoor.client-secretquarkus.oidc.credentials.secretClient secret used to call the Casdoor API
quarkus.casdoor.roles.enabledtrueAdd the user's Casdoor roles to the identity
quarkus.casdoor.authorization.enabledtrueCheck @PermissionsAllowed with Casdoor
quarkus.casdoor.authorization.permission-idPermission to enforce, as <organization>/<name>
quarkus.casdoor.authorization.model-idModel whose permissions are enforced
quarkus.casdoor.authorization.resource-idResource whose permissions are enforced
quarkus.casdoor.authorization.enforcer-idEnforcer to use
quarkus.casdoor.authorization.cache-ttl0SHow long an enforce result is cached
quarkus.casdoor.authorization.timeout10STimeout of a call to the Casdoor API