Passer au contenu principal

Quarkus

L'extension Quarkus Casdoor Auth connecte les applications Quarkus à Casdoor. Elle fait partie de Quarkiverse, la plateforme des extensions communautaires Quarkus.

L'extension s'appuie sur quarkus-oidc de Quarkus, qui gère la connexion et la vérification des jetons, et ajoute ce qui est spécifique à Casdoor :

  • les rôles Casdoor de l'utilisateur deviennent des rôles Quarkus, afin que @RolesAllowed fonctionne ;
  • @PermissionsAllowed("resource:action") est vérifié par rapport aux permissions Casdoor via l'API Enforce ;
  • une politique de sécurité HTTP nommée casdoor vérifie le chemin de la requête et la méthode par rapport aux permissions Casdoor.

La version 0.1.0 est compilée avec Quarkus 3.40 et nécessite Java 17 ou ultérieur.

Étape 1 : Créer une application dans Casdoor​

  1. Dans l'interface utilisateur Casdoor, ouvrez Applications et ajoutez une application dans votre organisation.
  2. Ajoutez l'URL de rappel de votre application, par exemple http://localhost:8080/, dans Redirect URLs.
  3. Copiez le Client ID et le Client secret.

Étape 2 : Ajouter l'extension​

Avec Maven :

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

Avec Gradle :

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

L'extension inclut quarkus-oidc, donc vous n'avez pas besoin de l'ajouter séparément.

Étape 3 : Configurer la connexion​

Pointez quarkus-oidc vers votre serveur Casdoor dans application.properties :

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 publie son document de découverte OIDC sur /.well-known/openid-configuration, donc rien d'autre n'est nécessaire. Pour toutes les options quarkus.oidc, consultez les guides Quarkus sur le flux de code d'autorisation et les jetons bearer.

L'identité de sécurité obtient deux attributs, casdoor.organization et casdoor.username, lus à partir des claims owner et name (ou preferred_username) du jeton.

Étape 4 : Utiliser les rôles Casdoor​

Les noms des rôles Casdoor de l'utilisateur sont ajoutés à l'identité :

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

Avec le format de jeton JWT par défaut (options de format de jeton), les rôles sont dans le jeton. Le format JWT-Standard ne contient pas de rôles dans le jeton, donc l'extension les lit depuis la réponse UserInfo à la place ; activez-le avec :

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

Les groupes Casdoor sont dans le claim standard groups, que quarkus-oidc mappe déjà sur des rôles.

Étape 5 : Vérifier les permissions Casdoor​

@PermissionsAllowed("data1:read") envoie la requête Casbin ["<organization>/<username>", "data1", "read"] à Casdoor et autorise l'appel si l'une de vos permissions Casdoor l'autorise :

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

Par exemple, une permission dans l'organisation my-org avec le rôle my-org/admin, la ressource data1 et l'action read, utilisant un modèle comme :

[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

autorise @PermissionsAllowed("data1:read") pour tous les membres du rôle admin.

Par défaut, toutes les permissions de l'organisation de l'utilisateur sont vérifiées. Pour vérifier une seule permission, un seul modèle, une seule ressource ou un seul enforceur, définissez l'un des éléments suivants :

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

L'extension appelle l'API Enforce avec l'ID client et le secret de l'application, donc la permission, le modèle ou l'enforceur doit appartenir à l'organisation de l'application.

Autorisation basée sur le chemin​

La politique de sécurité HTTP casdoor envoie ["<organization>/<username>", "<path>", "<method>"], par exemple ["my-org/alice", "/api/orders", "GET"], donc une permission Casdoor avec la ressource /api/orders et l'action GET contrôle ce point de terminaison. Appliquez-la aux chemins :

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

ou vers des endpoints avec @AuthorizationPolicy(name = "casdoor"). Les requêtes anonymes sont refusées.

Mise en cache​

Chaque vérification appelle Casdoor, donc les changements de permission prennent effet immédiatement. Pour mettre en cache les résultats, définissez par exemple quarkus.casdoor.authorization.cache-ttl=30S.

Référence de configuration​

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