Pular para o conteúdo principal

Quarkus

A extensão Quarkus Casdoor Auth conecta aplicações Quarkus ao Casdoor. Ela faz parte do Quarkiverse, a casa das extensões Quarkus da comunidade.

A extensão baseia-se no próprio quarkus-oidc do Quarkus, que lida com o login e a verificação de tokens, e adiciona o que é específico do Casdoor:

  • os papéis do usuário no Casdoor tornam-se papéis do Quarkus, então @RolesAllowed funciona;
  • @PermissionsAllowed("resource:action") é verificado contra as permissões do Casdoor com a Enforce API;
  • uma política de segurança HTTP chamada casdoor verifica o caminho da solicitação e o método contra as permissões do Casdoor.

A versão 0.1.0 é construída com Quarkus 3.40 e requer Java 17 ou posterior.

Etapa 1: Crie uma aplicação no Casdoor​

  1. Na interface do usuário do Casdoor, abra Applications e adicione uma aplicação à sua organização.
  2. Adicione a URL de callback da sua aplicação, por exemplo, http://localhost:8080/, em Redirect URLs.
  3. Copie o Client ID e o Client secret.

Etapa 2: Adicione a extensão​

Com Maven:

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

Com Gradle:

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

A extensão traz o quarkus-oidc, então você não precisa adicioná-lo.

Etapa 3: Configure o login​

Aponte o quarkus-oidc para seu servidor Casdoor em 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

O Casdoor publica seu documento de descoberta OIDC em /.well-known/openid-configuration, então nada mais é necessário. Para todas as opções de quarkus.oidc, consulte os guias do Quarkus sobre o authorization code flow e bearer tokens.

A identidade de segurança recebe dois atributos, casdoor.organization e casdoor.username, lidos das declarações owner e name (ou preferred_username) do token.

Etapa 4: Use papéis do Casdoor​

Os nomes dos papéis do usuário no Casdoor são adicionados à identidade:

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

Com o formato de token padrão JWT, os papéis estão no token. O formato JWT-Standard não possui papéis no token, então a extensão os lê da resposta UserInfo em vez disso; habilite-o com:

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

Os grupos do Casdoor estão na claim padrão groups, que o quarkus-oidc já mapeia para roles.

Etapa 5: Verifique as permissões do Casdoor​

@PermissionsAllowed("data1:read") envia a solicitação Casbin ["<organization>/<username>", "data1", "read"] ao Casdoor e permite a chamada se uma de suas permissões do Casdoor permitir:

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

Por exemplo, uma permissão na organização my-org com role my-org/admin, recurso data1 e ação read, usando um 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 todos os membros da role admin.

Por padrão, todas as permissões da organização do usuário são verificadas. Para verificar uma única permissão, modelo, recurso ou enforcer, defina um dos seguintes:

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

A extensão chama a API Enforce com o client ID e secret da aplicação, portanto, a permissão, modelo ou enforcer deve pertencer à organização da aplicação.

Autorização baseada em caminho​

A política de segurança HTTP casdoor envia ["<organization>/<username>", "<path>", "<method>"], por exemplo, ["my-org/alice", "/api/orders", "GET"], então uma permissão do Casdoor com recurso /api/orders e ação GET controla esse endpoint. Aplique-a aos caminhos:

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

ou a endpoints com @AuthorizationPolicy(name = "casdoor"). Solicitações anônimas são negadas.

Cache​

Cada verificação chama o Casdoor, então alterações nas permissões entram em vigor imediatamente. Para armazenar os resultados em cache, defina, por exemplo, quarkus.casdoor.authorization.cache-ttl=30S.

Referência de configuração​

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