Zum Hauptinhalt springen

Quarkus

Die Erweiterung Quarkus Casdoor Auth verbindet Quarkus-Anwendungen mit Casdoor. Sie ist Teil von Quarkiverse, der Heimat von Community-Quarkus-Erweiterungen.

Die Erweiterung basiert auf Quarkus' eigenem quarkus-oidc, das die Anmeldung und Token-Verifizierung handhabt, und fügt hinzu, was spezifisch für Casdoor ist:

  • die Casdoor-Rollen des Benutzers werden zu Quarkus-Rollen, sodass @RolesAllowed funktioniert;
  • @PermissionsAllowed("resource:action") wird gegen Casdoor-Berechtigungen mit der Enforce API geprüft;
  • eine HTTP-Sicherheitsrichtlinie namens casdoor prüft den Anfragepfad und die Methode gegen Casdoor-Berechtigungen.

Version 0.1.0 wurde mit Quarkus 3.40 erstellt und erfordert Java 17 oder neuer.

Schritt 1: Erstellen einer Anwendung in Casdoor​

  1. Öffnen Sie in der Casdoor-UI Applications und fügen Sie eine Anwendung in Ihrer Organisation hinzu.
  2. Fügen Sie die Callback-URL Ihrer Anwendung, z. B. http://localhost:8080/, zu Redirect URLs hinzu.
  3. Kopieren Sie die Client ID und das Client secret.

Schritt 2: Hinzufügen der Erweiterung​

Mit Maven:

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

Mit Gradle:

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

Die Erweiterung bringt quarkus-oidc mit, sodass Sie es nicht hinzufügen müssen.

Schritt 3: Konfigurieren der Anmeldung​

Weisen Sie quarkus-oidc in application.properties Ihren Casdoor-Server zu:

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 veröffentlicht sein OIDC-Discovery-Dokument unter /.well-known/openid-configuration, daher sind keine weiteren Schritte erforderlich. Für alle quarkus.oidc-Optionen siehe die Quarkus-Leitfäden zum authorization code flow und bearer tokens.

Die Sicherheitsidentität erhält zwei Attribute, casdoor.organization und casdoor.username, gelesen aus den Claims owner und name (oder preferred_username) des Tokens.

Schritt 4: Verwenden von Casdoor-Rollen​

Die Namen der Casdoor-Rollen des Benutzers werden zur Identität hinzugefügt:

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

Mit dem Standard-JWT-Tokenformat sind die Rollen im Token enthalten. Das Format JWT-Standard enthält keine Rollen im Token, daher liest die Erweiterung sie stattdessen aus der UserInfo-Antwort; aktivieren Sie dies mit:

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

Casdoor-Gruppen befinden sich im standardmäßigen groups-Claim, den quarkus-oidc bereits auf Rollen abbildet.

Schritt 5: Überprüfen der Casdoor-Berechtigungen​

@PermissionsAllowed("data1:read") sendet die Casbin-Anfrage ["<organization>/<username>", "data1", "read"] an Casdoor und erlaubt den Aufruf, wenn eine Ihrer Casdoor-Berechtigungen dies zulässt:

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

Zum Beispiel eine Berechtigung in der Organisation my-org mit der Rolle my-org/admin, der Ressource data1 und der Aktion read, unter Verwendung eines Modells wie:

[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

ermöglicht @PermissionsAllowed("data1:read") für jedes Mitglied der admin-Rolle.

Standardmäßig werden alle Berechtigungen der Organisation des Benutzers überprüft. Um eine einzelne Berechtigung, ein Modell, eine Ressource oder einen Enforcer zu überprüfen, setzen Sie eine der folgenden Optionen:

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

Die Erweiterung ruft die Enforce-API mit der Client-ID und dem Secret der Anwendung auf, daher müssen die Berechtigung, das Modell oder der Enforcer zur Organisation der Anwendung gehören.

Pfadbasierte Autorisierung​

Die casdoor HTTP-Sicherheitsrichtlinie sendet ["<organization>/<username>", "<path>", "<method>"], z. B. ["my-org/alice", "/api/orders", "GET"], sodass eine Casdoor-Berechtigung mit der Ressource /api/orders und der Aktion GET diesen Endpunkt steuert. Wenden Sie es auf Pfade an:

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

oder auf Endpunkte mit @AuthorizationPolicy(name = "casdoor"). Anonyme Anfragen werden abgelehnt.

Caching​

Jede Überprüfung ruft Casdoor auf, sodass Änderungen an Berechtigungen sofort wirksam werden. Um die Ergebnisse zu cachen, setzen Sie z. B. quarkus.casdoor.authorization.cache-ttl=30S.

Configuration reference​

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