Перейти до основного вмісту

Quarkus

Розширення Quarkus Casdoor Auth підключає додатки Quarkus до Casdoor. Воно є частиною Quarkiverse — дому спільнотних розширень Quarkus.

Розширення базується на власному quarkus-oidc, який обробляє вхід та перевірку токенів, і додає специфічне для Casdoor:

  • ролі користувача Casdoor стають ролями Quarkus, тому @RolesAllowed працює;
  • @PermissionsAllowed("resource:action") перевіряється проти прав доступу Casdoor за допомогою Enforce API;
  • політика безпеки HTTP під назвою casdoor перевіряє шлях запиту та метод відносно прав доступу Casdoor.

Версія 0.1.0 зібрана з Quarkus 3.40 і потребує Java 17 або новішої версії.

Крок 1: Створіть додаток у Casdoor​

  1. У інтерфейсі Casdoor відкрийте Applications і додайте додаток у вашу організацію.
  2. Додайте callback 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 щодо authorization code flow та bearer tokens.

Ідентичність безпеки отримує два атрибути, casdoor.organization та casdoor.username, прочитані з клеймів owner та name (або preferred_username) токена.

Крок 4: Використовуйте ролі Casdoor​

Назви ролей користувача Casdoor додаються до ідентичності:

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

За замовчуванням у форматі токена JWT (token format) ролі містяться в токені. Формат 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

дозволяє @PermissionsAllowed("data1:read") для кожного учасника ролі admin.

За замовчуванням перевіряються всі дозволи організації користувача. Щоб перевірити окремий дозвіл, модель, ресурс або ендфорсер, встановіть один із таких параметрів:

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

Розширення викликає API Enforce з ідентифікатором клієнта та секретом додатка, тому дозвіл, модель або ендфорсер мають належати до організації додатка.

Авторизація на основі шляхів​

Політика безпеки HTTP casdoor надсилає ["<organization>/<username>", "<path>", "<method>"], наприклад ["my-org/alice", "/api/orders", "GET"], тому дозвіл Casdoor з ресурсом /api/orders та дією GET керує цим ендпоінтом. Застосуйте його до шляхів:

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