Saltar al contenido principal

Quarkus

La extensión Quarkus Casdoor Auth conecta las aplicaciones Quarkus con Casdoor. Forma parte de Quarkiverse, el hogar de las extensiones comunitarias de Quarkus.

La extensión se basa en quarkus-oidc de Quarkus, que maneja el inicio de sesión y la verificación de tokens, y añade lo específico de Casdoor:

  • los roles de usuario de Casdoor se convierten en roles de Quarkus, por lo que @RolesAllowed funciona;
  • @PermissionsAllowed("resource:action") se verifica contra los permisos de Casdoor mediante la Enforce API;
  • una política de seguridad HTTP llamada casdoor comprueba la ruta de solicitud y el método contra los permisos de Casdoor.

La versión 0.1.0 está construida con Quarkus 3.40 y requiere Java 17 o posterior.

Paso 1: Crear una aplicación en Casdoor​

  1. En la interfaz de usuario de Casdoor, abra Applications y añada una aplicación a su organización.
  2. Añada la URL de devolución de llamada de su aplicación, p. ej., http://localhost:8080/, a Redirect URLs.
  3. Copie el Client ID y el Client secret.

Paso 2: Añadir la extensión​

Con Maven:

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

Con Gradle:

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

La extensión incluye quarkus-oidc, por lo que no necesita añadirlo.

Paso 3: Configurar el inicio de sesión​

Apunte quarkus-oidc a su servidor Casdoor en 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 publica su documento de descubrimiento OIDC en /.well-known/openid-configuration, por lo que no se necesita nada más. Para todas las opciones de quarkus.oidc, consulte las guías de Quarkus sobre el flujo de código de autorización y los tokens de portador.

La identidad de seguridad obtiene dos atributos, casdoor.organization y casdoor.username, leídos de las reclamaciones owner y name (o preferred_username) del token.

Paso 4: Usar roles de Casdoor​

Los nombres de los roles de Casdoor del usuario se añaden a la identidad:

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

Con el formato de token JWT predeterminado, los roles están en el token. El formato JWT-Standard no tiene roles en el token, por lo que la extensión los lee de la respuesta UserInfo en su lugar; habilítelo con:

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

Los grupos de Casdoor están en la reclamación estándar groups, que quarkus-oidc ya asigna a roles.

Paso 5: Comprobar permisos de Casdoor​

@PermissionsAllowed("data1:read") envía la solicitud Casbin ["<organization>/<username>", "data1", "read"] a Casdoor y permite la llamada si uno de sus permisos de Casdoor lo permite:

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

Por ejemplo, un permiso en la organización my-org con rol my-org/admin, recurso data1 y acción read, usando un modelo como:

[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

permite @PermissionsAllowed("data1:read") para cada miembro del rol admin.

De forma predeterminada, se comprueban todos los permisos de la organización del usuario. Para comprobar un único permiso, modelo, recurso o ejecutor, establezca uno de:

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

La extensión llama a la API Enforce con el ID de cliente y el secreto de la aplicación, por lo que el permiso, modelo o enforcer debe pertenecer a la organización de la aplicación.

Autorización basada en rutas​

La política de seguridad HTTP casdoor envía ["<organization>/<username>", "<path>", "<method>"], p. ej., ["my-org/alice", "/api/orders", "GET"], por lo que un permiso de Casdoor con recurso /api/orders y acción GET controla ese endpoint. Aplíquelo a las rutas:

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

o a endpoints con @AuthorizationPolicy(name = "casdoor"). Las solicitudes anónimas son denegadas.

Caché​

Cada comprobación llama a Casdoor, por lo que los cambios de permisos surten efecto inmediatamente. Para cachear los resultados, configure p. ej. quarkus.casdoor.authorization.cache-ttl=30S.

Referencia de configuración​

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