Protect Quarkus web application by using an Auth0 OpenID Connect provider

Prerequisites

在开始之前，请查看以下文档：

Create an Auth0 application

转到 Auth0 仪表板并创建一个常规 Web 应用程序。例如，创建一个名为 `QuarkusAuth0`的 Auth0 应用程序。

auth0 create application
Result

你的 Auth0 应用程序会使用客户端 ID、密钥和基于 HTTPS 的域创建。记下这些属性，因为在下一步中，你将需要它们来完成 Quarkus 配置。

auth0 created application

接下来，在仍然位于 Auth0 仪表板的情况下，将一些用户添加到你的应用程序中。

auth0 add user

现在你已经成功创建并配置了你的 Auth0 应用程序，你可以开始创建和配置 Quarkus 端点了。在以下步骤中，你还可以继续配置和更新 Auth0 应用程序。

Create a Quarkus application

使用以下 Maven 命令创建一个 Quarkus REST（以前称为 RESTEasy Reactive）应用程序，该应用程序可以用 Quarkus OIDC 扩展保护。

CLI
quarkus create app {create-app-group-id}:{create-app-artifact-id} \
    --no-code
cd {create-app-artifact-id}

要创建一个 Gradle 项目，添加 --gradle 或 --gradle-kotlin-dsl 选项。 有关如何安装和使用 Quarkus CLI 的详细信息，请参见 Quarkus CLI 指南。

Maven
mvn {quarkus-platform-groupid}:quarkus-maven-plugin:{quarkus-version}:create \
    -DprojectGroupId={create-app-group-id} \
    -DprojectArtifactId={create-app-artifact-id} \
    -DnoCode
cd {create-app-artifact-id}

要创建一个 Gradle 项目，添加 -DbuildTool=gradle 或 -DbuildTool=gradle-kotlin-dsl 选项。

适用于 Windows 用户：

  • 如果使用 cmd，（不要使用反斜杠 \ ，并将所有内容放在同一行上）

  • 如果使用 Powershell，将 -D 参数用双引号引起来，例如 "-DprojectArtifactId={create-app-artifact-id}"

创建应用程序工作区并将其导入你最喜欢的 IDE。我们添加一个只有经过身份验证的用户才能访问的 Jakarta REST 端点：

package org.acme;

import org.eclipse.microprofile.jwt.JsonWebToken;

import io.quarkus.oidc.IdToken;
import io.quarkus.security.Authenticated;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class GreetingResource {

    @Inject
    @IdToken                                        1
    JsonWebToken idToken;

    @GET
    @Authenticated                                  2
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello, " + idToken.getName();
    }
}
1 注入的`JsonWebToken`（JWT）bean 具有`@IdToken`限定符，这意味着它不是访问标记，而是 OIDC ID token。`IdToken`提供有关在 OIDC 授权代码流期间经过身份验证的当前用户声明形式的信息，并且你可以使用`JsonWebToken`API 访问这些声明。
2 `io.quarkus.security.Authenticated`注释添加到`hello()`方法中，这意味着只有经过身份验证的用户才能访问它。

授权代码流期间获取的访问令牌和 ID 令牌不会被端点直接使用，而是仅用于代表当前经过身份验证的用户访问下游服务。本教程稍后会详细介绍“访问令牌”的主题。

使用您先前创建的 Auth0 应用程序中的属性，在 Quarkus application.properties 文件中配置 OIDC。

# Make sure the application domain is prefixed with 'https://'
quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=web-app
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

在完成此步骤后，您刚刚将 Quarkus 配置为使用 Auth0 应用程序的域、客户端 ID 和密钥。设置属性 quarkus.oidc.application-type=web-app 指示 Quarkus 使用 OIDC 授权代码流，但还有一些其他方法，稍后会在本教程中讨论这些方法。

端点地址将为 [role="bare"]http://localhost:8080/hello，这也必须在您的 Auth0 应用程序中注册为允许的回调 URL。

auth0 allowed callback

完成此步骤后，当您从浏览器访问 Quarkus [role="bare"]http://localhost:8080/hello 端点时，Auth0 在完成身份验证后会将您重定向回同一地址。

默认情况下，Quarkus 会自动将当前请求路径用作回调路径。但您可以覆盖默认行为并通过设定 Quarkus quarkus.oidc.authentication.redirect-path 属性来配置特定的回调路径。 在生产中，您的应用程序很可能具有更大的 URL 空间，支持多个端点地址。在这种情况下，您可以设置专用回调（重定向）路径，并在提供程序控制台中注册此 URL，如下面的配置示例所示： quarkus.oidc.authentication.redirect-path=/authenticated-welcome 在示例场景中，Quarkus 在接受来自 Auth0 的重定向后、完成授权代码流程并创建会话 Cookie 后，调用 /authenticated-welcome。成功经过身份验证的用户还可以访问受保护应用程序空间的其它部分，而无需再次进行身份验证。例如，端点回调方法可以使用 JAX-RS API 将用户重定向到受保护应用程序的其它部分，其中会话 Cookie 将得到验证。

现在，您可以开始测试端点。

Test the Quarkus endpoint

在开发模式下启动 Quarkus：

$ mvn quarkus:dev

这是本教程中预期您手动在开发模式下启动 Quarkus 的唯一一次。本教程其余部分中的配置和代码更新步骤将由 Quarkus 自动观察和处理，而无需您手动重新启动应用程序。

打开浏览器并访问 [role="bare"][role="bare"]http://localhost:8080/hello。

您将被重定向到 Auth0 并提示您登录：

auth0 login

并授权 QuarkusAuth0 应用程序访问您的帐户：

auth0 authorize

最后，您将被重定向回 Quarkus 端点，该端点将返回以下响应：Hello, auth0|60e5a305e8da5a006aef5471

请注意，当前用户名未返回。要了解为何会出现此行为，您可以在“OpenID Connect (OIDC) 的开发服务和 UI”指南中的 Dev UI for all OpenID Connect Providers 部分和以下部分中了解有关如何使用 OIDC Dev UI 的信息。

Looking at Auth0 tokens in the OIDC Dev UI

Quarkus 提供了出色的 Dev UI 体验。具体来说，Quarkus 为使用 Keycloak 容器开发和测试 OIDC 端点提供内置支持。如果未针对 Quarkus quarkus.oidc.auth-server-url 配置属性指定 OIDC 提供程序的地址，DevService for Keycloak 将自动启动并使用。

当提供商已配置时，你可以继续使用 Quarkus OIDC 开发 UI。使用以下说明来更新你的配置：

首先，将你的 Quarkus 应用程序类型从 web-app 更改为 hybrid，如下所示：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid 1
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}
1 应用程序类型更改为 hybrid，因为 OIDC 开发 UI 当前仅支持 SPA 模式（单页面应用程序）。OIDC 开发 UI 单页面应用程序使用其自己的 JavaScript，将用户认证到 OIDC 提供商，并将访问令牌用作 Bearer 令牌以访问 Quarkus 终结点作为一个服务。

通常，Quarkus 必须配置 quarkus.oidc.application-type=service 来支持 Bearer 令牌验证，但它也支持 hybrid 应用程序类型，这意味着它可以同时支持授权码和 Bearer 令牌流程。

你还需要配置 Auth0 应用程序，以允许回调到 OIDC 开发 UI。使用以下 URL 格式：

http://localhost:8080/q/dev-ui/io.quarkus.quarkus-oidc/${provider-name}-provider

  • 在这个示例中，${provider-name} 为 auth0

auth0 allowed callbacks

现在，你可以与 Auth0 一起使用 OIDC 开发 UI。

在浏览器会话中打开 [role="bare"][role="bare"]http://localhost:8080/q/dev/ 。一个 OpenId Connect 卡显示，该卡链接到一个 Auth0 提供商 SPA，如下所示：

auth0 devui

单击 Auth0 provider，然后单击 Login into Single Page Application：

auth0 devui login to spa

你将被重定向到 Auth0 以登录。然后，你将被重定向到 OIDC 开发 UI 仪表板，如下所示：

auth0 devui dashboard without name

在这里，你可以查看编码和解码格式的 ID 和访问令牌，将其复制到剪贴板或使用它们来测试服务终结点。我们稍后将测试终结点，但现在让我们检查 ID 令牌：

auth0 idtoken without name

正如你所看到的，它没有任何代表用户名的声明，但如果你检查其 sub （主题）声明，你将看到它的值与你直接从浏览器访问 Quarkus 终结点时在响应中获得的值相匹配， auth0|60e5a305e8da5a006aef5471 。

通过配置 Quarkus 在身份验证过程中请求标准 OIDC profile 范围来解决此问题，这应导致 ID 令牌包含更多信息：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

quarkus.oidc.authentication.scopes=profile 1
1 请求 profile 范围，外加默认 openid 范围。

返回 [role="bare"][role="bare"]http://localhost:8080/q/dev/，重复登录 Auth0 的过程，然后再次检查 ID 令牌，现在你应该看到 ID 令牌包含 name 声明：

auth0 idtoken with name

当你直接从浏览器访问 Quarkus 终结点时，你应该会获得该名称。清除浏览器 cookie 缓存，访问 [role="bare"][role="bare"]http://localhost:8080/hello，你仍然会收到 Hello, auth0|60e5a305e8da5a006aef5471 返回。嗯，出了什么问题？

答案在于 org.eclipse.microprofile.jwt.JsonWebToken#getName() 实现的具体内容，根据 MicroProfile MP JWT RBAC specification，它检查一个 MP JWT 特定的 upn 声明，然后尝试 preferred_username 最后尝试 sub，这解释了为什么即使 ID 令牌包含 name 声明你也会收到 Hello, auth0|60e5a305e8da5a006aef5471 答案。我们可以通过将终结点 hello() 方法的实现更改为返回特定声明值来轻松解决此问题：

package org.acme;

import org.eclipse.microprofile.jwt.JsonWebToken;

import io.quarkus.oidc.IdToken;
import io.quarkus.security.Authenticated;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class GreetingResource {

    @Inject
    @IdToken
    JsonWebToken idToken;

    @GET
    @Authenticated
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello, " + idToken.getClaim("name");
    }
}

现在清除浏览器缓存，访问 [role="bare"][role="bare"]http://localhost:8080/hello，最后返回用户名。

Logout support

在 Auth0 的帮助下让用户登录 Quarkus 后，您可能希望支持用户发起的注销。Quarkus 支持 RP-initiated and other standard OIDC logout mechanisms, as well as the local session logout。

目前，Auth0 不支持标准 OIDC RP 发起的注销，也不在其可发现元数据中提供会话结束端点 URL，但它提供了自己的注销机制，其工作方式与标准机制几乎完全相同。

使用 Quarkus OIDC 可以很容易地支持它。您必须配置一个 Auth0 会话结束端点 URL，并让 Quarkus 在发往 Auth0 的 RP 发起的注销重定向请求中包含 `client-id`查询参数和注销后 URL 作为 `returnTo`查询参数：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}
quarkus.oidc.authentication.scopes=openid,profile

quarkus.oidc.end-session-path=v2/logout 1
quarkus.oidc.logout.post-logout-uri-param=returnTo 2
quarkus.oidc.logout.extra-params.client_id=${quarkus.oidc.client-id} 3
quarkus.oidc.logout.path=/logout 4
quarkus.oidc.logout.post-logout-path=/hello/post-logout 5

quarkus.http.auth.permission.authenticated.paths=/logout
quarkus.http.auth.permission.authenticated.policy=authenticated 6
1 Auth0 没有在其元数据中包含会话结束 URL，因此补充手动配置 Auth0 会话结束端点 URL。
2 Auth0 不会识别标准 post_logout_redirect_uri`查询参数，而是需要一个参数 `returnTo。
3 Auth0 要求在注销请求中含有 client-id。
4 对 `/logout`路径进行的经过身份验证的请求将被视为 RP 发起的注销请求。
5 这是一个被注销用户应该返回到的公共资源。
6 确保 `/logout`路径受到保护。

在这里，我们自定义了 Auth0 会话结束端点 URL，并向 Quarkus 进行了指示，表示一个 http://localhost:8080/logout`请求必须触发当前经过身份验证的用户的注销。关于 `/logout`路径的有趣之处在于它是一个 `virtual，并且不被 JAX-RS 端点中的任何方法支持，因此，为了使 Quarkus OIDC 能够对 /logout`请求做出反应，我们将一个 `authenticated HTTP security policy直接附加到配置中的此路径。

我们还配置了 Quarkus，将被注销的用户返回到公共 `/hello/post-logout`资源，并且此路径作为特定的 Auth0 `returnTo`查询参数包含在注销请求中。最后，该 Quarkus 应用的 `client-id`也包含在注销 URL 中。

更新端点以接受注销后重定向：

package org.acme;

import org.eclipse.microprofile.jwt.JsonWebToken;

import io.quarkus.oidc.IdToken;
import io.quarkus.security.Authenticated;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class GreetingResource {

    @Inject
    @IdToken
    JsonWebToken idToken;

    @GET
    @Authenticated
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello, " + idToken.getClaim("name");
    }

    @GET
    @Path("post-logout")
    @Produces(MediaType.TEXT_PLAIN)
    public String postLogout() {
        return "You were logged out";
    }
}

请注意，添加了公共 `/hello/post-logout`资源方法。

在我们测试注销之前，请确保配置了 `Auth0`应用程序，允许用户注销后将此注销后重定向返回到 Quarkus：

auth0 allowed logout

现在，清除浏览器 Cookie 缓存，访问 [role="bare"][role="bare"]http://localhost:8080/hello，使用 Auth0 登录 Quarkus，获得返回的用户名，然后转到 http://localhost:8080/logout。您会在浏览器中看到显示的 `You were logged out`消息。

下一步，转到 [role="bare"][role="bare"]http://localhost:8080/q/dev/，使用 Dev UI SPA 从 Auth0 登录，并注意您现在也可以从 OIDC Dev UI 注销，请参阅表示注销的符号，该符号显示在 `Logged in as Sergey Beryozkin`文本旁边：

auth0 devui dashboard with name

为了从 OIDC DevUI 执行注销，Auth0 应用程序的允许注销回调列表必须更新为包括 OIDC DevUI 端点：

auth0 allowed logouts

现在，直接从 OIDC Dev UI 注销并以新用户身份登录——如果需要，为已注册的 Auth0 应用程序添加更多用户。

Role-based access control

我们已经确认，经过 `Auth0`身份验证的用户可以访问 Quarkus 端点。

下一步是引入基于角色的访问控制 (RBAC)，让特定角色中的用户（例如 admin）能够访问端点。

另请参见下面的 Permission Based Access Control 部分。

默认情况下，Auth0 令牌不包含任何包含角色的声明，因此，您必须首先使用自定义操作来自定义 Auth0 应用程序的 Login 流程，该操作会向令牌添加角色。在 Auth0 仪表板中选择 Actions/Flows/Login，选择 Add Action/Build Custom，将其命名为 AddRoleClaim：

auth0 add role action

向其中添加以下操作脚本：

exports.onExecutePostLogin = async (event, api) => {
  const namespace = 'https://quarkus-security.com';
  if (event.authorization) {
    api.idToken.setCustomClaim(`${namespace}/roles`, event.authorization.roles);
    api.accessToken.setCustomClaim(`${namespace}/roles`, event.authorization.roles);
  }
};

请注意，自定义 Auth0 声明必须是命名空间限定的，因此包含角色的声明将被命名为 "https://quarkus-security.com/roles"。查看我们在前面的部分中分析的身份令牌内容，您将看到此声明的表示方式，例如：

{
  "https://quarkus-security.com/roles": [
      "admin"
  ]
}

现在，Auth0 登录流图应如下所示：

auth0 login flow

您必须向在 Auth0 应用程序中注册的用户添加角色，例如 admin。

创建 admin 角色：

auth0 create role

并将其添加到已注册用户：

auth0 add role to user

接下来，更新 Quarkus 端点以要求只有具有 admin 角色的用户才能访问端点：

package org.acme;

import org.eclipse.microprofile.jwt.JsonWebToken;

import io.quarkus.oidc.IdToken;
import jakarta.annotation.security.RolesAllowed;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class GreetingResource {

    @Inject
    @IdToken
    JsonWebToken idToken;

    @GET
    @RolesAllowed("admin")
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello, " + idToken.getClaim("name");
    }

    @GET
    @Path("post-logout")
    @Produces(MediaType.TEXT_PLAIN)
    public String postLogout() {
        return "You were logged out";
    }
}

打开 [role="bare"][role="bare"]http://localhost:8080/hello，向 Auth0 进行身份验证并获取 403。您获得 403 的原因是 Quarkus OIDC 无法识别 Auth0 令牌中的哪个声明表示角色信息，默认情况下会检查 groups 声明，而 Auth0 令牌现在必须具有 "https://quarkus-security.com/roles" 声明。

通过告诉 Quarkus OIDC 必须检查哪个声明来实施 RBAC，来解决此问题：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.authentication.scopes=profile
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

quarkus.oidc.roles.role-claim-path="https://quarkus-security.com/roles" 1

# Logout
quarkus.oidc.end-session-path=v2/logout
quarkus.oidc.logout.post-logout-uri-param=returnTo
quarkus.oidc.logout.extra-params.client_id=${quarkus.oidc.client-id}
quarkus.oidc.logout.path=/logout
quarkus.oidc.logout.post-logout-path=/hello/post-logout
quarkus.http.auth.permission.authenticated.paths=/logout
quarkus.http.auth.permission.authenticated.policy=authenticated
1 指向自定义角色声明。由于声明是命名空间限定的，因此角色声明的路径用双引号引起来。

现在，清除浏览器 Cookie 缓存，再次访问 [role="bare"][role="bare"]http://localhost:8080/hello，向 Auth0 进行身份验证并获取预期用户名。

Access Quarkus with opaque Auth0 access tokens

此部分的主要目的是说明如何调整 Quarkus 以接受 opaque 持有者 Auth0 访问令牌，而不是 Auth0 JWT 访问令牌，因为在授权代码流期间颁发的 Auth0 访问令牌默认情况下是不可见的，并且只能用来请求 UserInfo，除此外还包括身份令牌中已包含的有关当前用户的信息。学习如何验证不可见令牌非常有用，因为许多 OIDC 和 OAuth2 供应商只会颁发不可见访问令牌。 有关如何配置 Auth0 和 Quarkus 以在 JWT 格式中颁发授权代码访问令牌并将其传播到服务端点的更多信息，请参阅以下 Propagate access tokens to microservices 和 Access tokens in JWT format 部分。

到目前为止，我们只使用 OIDC 授权代码流测试了 Quarkus 端点。在此流中，您使用浏览器访问 Quarkus 端点，Quarkus 本身管理授权代码流，用户被重定向到 Auth0，登录，被重定向回 Quarkus，Quarkus 通过交换代码来完成流程用于 ID、访问和刷新令牌，并使用表示成功的用户身份验证的身份令牌。访问令牌目前无关紧要。如前所述，在授权代码流中，Quarkus 将仅使用访问令牌以当前已验证用户的身份访问下游服务。

不过，让我们想象一下，我们开发的 Quarkus 端点还必须接受 Bearer 访问令牌：它可能是将访问令牌传播到此端点的另一个 Quarkus 端点，或者可能是使用访问令牌来访问 Quarkus 端点的 SPA。我们已经用于分析身份令牌的 Quarkus OIDC DevUI SPA 非常适合于使用可供 SPA 使用的访问令牌来测试 Quarkus 端点。

我们再次转到 [role="bare"][role="bare"]http://localhost:8080/q/dev-ui，选择 OpenId Connect 卡片，登录到 Auth0，并检查访问令牌内容：

auth0 devui accesstoken

与我们之前查看的 ID 令牌相反，Quarkus 无法直接验证此访问令牌。这是因为访问令牌采用 JWE（加密）格式，而未使用 JWS（签名）格式。您可从解码令牌头中看到，它已直接通过仅 Auth0 知道的一个密钥进行加密，因此 Quarkus 无法解密其内容。从 Quarkus 的角度看，此访问令牌是一个 opaque，Quarkus 无法使用公共 Auth0 非对称验证密钥对其进行验证。

为确认这一点，请在 Test Service 区域中将 /hello 作为 Service Address 输入，然后按 With Access Token，您将获得 HTTP 401 状态：

auth0 devui test accesstoken 401

为使 Quarkus 能够接受此类访问令牌，应当具备以下两种选择之一。第一个选择是使用提供程序的内省端点对不透明令牌进行远程内省。令牌内省通常在 OAuth2 级别受到支持，并且由于 OIDC 构建在 OAuth2 之上，所以一些 OIDC 提供程序（如 Keycloak）也支持令牌内省。然而，Auth0 不支持令牌内省，您可以查看公开的 Auth0 元数据来进行检查，将 /.well-known/openid-configuration 添加到已配置的 Auth0 提供程序的地址，然后打开生成的 URL，https://dev-3ve0cgn7.us.auth0.com/.well-known/openid-configuration。您将看到 Auth0 没有内省端点：

auth0 well known config

因此，可以使用另一个选项，即间接访问令牌验证，其中访问令牌用于从 Auth0 中获取 UserInfo，以接受并验证不透明的 Auth0 令牌。此选项有效，因为 OIDC 提供商必须在他们发出 UserInfo 之前验证访问令牌，而且 Auth0 拥有 UserInfo 端点。

现在让我们配置 Quarkus 以请求使用它们获取 UserInfo 来验证访问令牌：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.authentication.scopes=profile
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

# Point to the custom roles claim
quarkus.oidc.roles.role-claim-path="https://quarkus-security.com/roles"

# Logout
quarkus.oidc.end-session-path=v2/logout
quarkus.oidc.logout.post-logout-uri-param=returnTo
quarkus.oidc.logout.extra-params.client_id=${quarkus.oidc.client-id}
quarkus.oidc.logout.path=/logout
quarkus.oidc.logout.post-logout-path=/hello/post-logout
quarkus.http.auth.permission.authenticated.paths=/logout
quarkus.http.auth.permission.authenticated.policy=authenticated

quarkus.oidc.token.verify-access-token-with-user-info=true 1
1 间接使用访问令牌（通过使用它们请求 UserInfo）验证访问令牌。

更新端点代码以期待 UserInfo 而不是 ID token：

package org.acme;

import io.quarkus.oidc.UserInfo;
import jakarta.annotation.security.RolesAllowed;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class GreetingResource {

    @Inject
    UserInfo userInfo;

    @GET
    @RolesAllowed("admin")
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello, " + userInfo.getName();
    }

    @GET
    @Path("post-logout")
    @Produces(MediaType.TEXT_PLAIN)
    public String postLogout() {
        return "You were logged out";
    }
}

此代码现在同时适用于授权代码和持有者访问令牌流。

让我们转到 OIDC Dev UI，我们在其中查看了访问令牌，在 Test Service 区域中将 /hello 输入为 Service Address，并按下 With Access Token，您将得到 200：

auth0 devui test accesstoken 200

为了确认它真的有效，请更新测试端点以仅使用 @RolesAllowed("user") 允许 user 角色。尝试再次从 OIDC Dev UI 访问端点，您将得到 HTTP 403 错误。将代码还原回 @RolesAllowed("admin") 以再次得到令人放心的 HTTP 200 状态。

间接验证不透明访问令牌时（通过使用它请求 UserInfo），如果存在，Quarkus 将把 UserInfo 作为角色信息的来源。碰巧的是，Auth0 包括之前在 UserInfo 响应中创建的自定义角色声明。

正如本节导言中已经提到的，本节的主要目标是解释 Quarkus 如何验证不透明访问令牌。通常，应该避免向其唯一目的是允许检索 UserInfo 到服务的访问令牌传播，除非前端 JAX-RS 端点或 SPA 更喜欢将 UserInfo 检索委托给可信服务。 有关使用 Auth0 访问令牌的推荐方法，请参阅以下 Propagate access tokens to microservices 和 Access tokens in JWT format 部分。

通常，人们使用访问令牌访问远程服务，但 OIDC DevUI SPA 仪表板也提供了一个使用 ID 令牌进行测试的选项。此选项仅适用于模拟 SPA 将一些信息从 ID 令牌中委托给端点以进行验证和检索的情况供 SPA 使用的情况 - 但 ID 令牌仍将作为持有者令牌发送到端点由 OIDC DevUI。在大多数情况下，更喜欢用访问令牌进行测试。

您可以使用 OIDC DevUI 中的 SwaggerUI 或 GraphQL 来测试服务，而不是手动输入服务路径进行测试。例如，如果您添加

<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-smallrye-openapi</artifactId>
</dependency>

到您的应用程序的 pom，那么您将在 OIDC Dev UI 中看到一个 Swagger 链接： image::auth0-devui-testservice-swagger.png[] 点击 Swagger 链接并开始测试服务。

Propagate access tokens to microservices

在我们设法使用 OIDC 授权码流并使用 ID 令牌和 UserInfo 来访问用户的信息后，下一个典型任务是传播当前 Auth0 访问令牌，以代表当前已验证的用户访问下游服务。

事实上，最后一个代码示例展示了注入的 UserInfo，它是一个访问令牌传播的具体示例，在这种情况下，Quarkus 将 Auth0 访问令牌传播到 Auth0 UserInfo`端点，以获取 `UserInfo。Quarkus 在无需用户自己进行任何操作的情况下完成了此操作。

但如何将访问令牌传播到某些自定义服务？在 Quarkus 中，实现这一点非常容易，无论是对于授权码还是持有者令牌流。你需要做的就是创建 REST Client 接口以调用需要持有者令牌访问的服务，并使用 `@AccessToken`对其进行注释，并且到达前端端点的访问令牌（作为 Auth0 持有者访问令牌或在完成 Auth0 授权码流后由 Quarkus 获取）将被传播到目标微服务。这非常简单。

有关传播访问令牌的示例，请参阅本教程中的以下部分。有关令牌传播的更多信息，请参阅 OIDC token propagation。

Access tokens in JWT format

我们已经详细研究了 Quarkus OIDC 如何处理 Access Quarkus with opaque Auth0 access tokens，但我们不希望将 Auth0 不透明令牌传播到代表当前经过验证的用户执行一些有用操作的微服务，而不仅仅是检查其 UserInfo。

前端 Quarkus 应用程序将通过将授权码流访问令牌传播到它而访问的微服务 在 Auth0 仪表板中表示为 API。我们将其添加到 `Applications/APIs`中：

auth0 api

创建的 `QuarkusAuth0API`的 `https://quarkus-auth0`标识符将作为此 API 的 `audience`充当。在授权码流重定向到 Auth0 中提供此受众作为查询参数将确保 Auth0 以 JWT 格式颁发访问令牌。

API microservice

将以下依赖项添加到项目，以支持 OIDC 令牌传播和 REST 客户端：

pom.xml
<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-rest-client-jackson</artifactId>
</dependency>
<dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-rest-client-oidc-token-propagation</artifactId>
</dependency>

创建 `ApiEchoService`服务类：

package org.acme;

import io.quarkus.security.Authenticated;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/echo")
public class ApiEchoService {

    @POST
    @Authenticated
    @Produces(MediaType.TEXT_PLAIN)
    public String echoUserName(String username) {
        return username;
    }
}

并将其配置为 OIDC `service`应用程序，该应用程序将仅从 Auth0 获取公共验证密钥。此微服务的配置应该只有一行：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com

这是 OIDC `service`应用程序获取 Auth0 公共验证密钥并使用它们以 JWT 格式验证 Auth0 访问令牌所需的一切。

在本教程中，你已配置 OIDC `hybrid`应用程序，它可以处理授权码和持有者令牌身份验证流。在生产中，你将微服务作为单独的服务器来运行，但为简单起见，不必将 `ApiEchoService`作为具有仅包含 `quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com`的自己的配置的第二个服务器来启动，因此将重复使用已配置了 Auth0 开发租户地址的当前配置。 `hybrid`OIDC 应用程序类型将确保对 `GreetingResource`的 `http://localhost:8080/hello`请求发起授权码流，而由 `GreetingResource`发起对 `ApiEchoService`的 `http://localhost:8080/echo`请求将导致 `ApiEchoService`以持有者 JWT 访问令牌的形式传播和接受授权码流令牌。

接下来，添加表示 `ApiEchoService`的 REST 客户端接口：

package org.acme;

import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
import io.quarkus.oidc.token.propagation.AccessToken;

@RegisterRestClient
@AccessToken 1
@Path("/echo")
public interface ApiEchoServiceClient {

    @POST
    @Produces(MediaType.TEXT_PLAIN)
    String echoUserName(String username);
}
1 将访问令牌传播为 HTTP `Authorization: Bearer accesstoken`头

并更新为早期创建的 Quarkus 前端应用程序的配置 GreetingResource，要求授权码流访问令牌（而不是 ID 令牌）包括针对 ApiEchoService`的 `aud（受众）声明，以及配置 `ApiEchoService`REST 客户端的基本 URL：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.authentication.scopes=profile
quarkus.oidc.authentication.extra-params.audience=https://quarkus-auth0 1
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

# Point to the custom roles claim
quarkus.oidc.roles.role-claim-path="https://quarkus-security.com/roles"

# Logout
quarkus.oidc.end-session-path=v2/logout
quarkus.oidc.logout.post-logout-uri-param=returnTo
quarkus.oidc.logout.extra-params.client_id=${quarkus.oidc.client-id}
quarkus.oidc.logout.path=/logout
quarkus.oidc.logout.post-logout-path=/hello/post-logout
quarkus.http.auth.permission.authenticated.paths=/logout
quarkus.http.auth.permission.authenticated.policy=authenticated

quarkus.oidc.token.verify-access-token-with-user-info=true

org.acme.ApiEchoServiceClient/mp-rest/url=http://localhost:${port} 2

quarkus.test.native-image-profile=test
%prod.port=8080
%dev.port=8080
%test.port=8081
1 在授权码流从 Quarkus 重定向到 Auth0 期间，将一个额外的 audience`查询参数传递给 Auth0 授权端点。它将确保以 JWT 格式颁发访问令牌，并且包括将包含 `https://quarkus-auth0`的 `aud（受众）声明。
2 将 ApiEchoServiceClient 指向 ApiEchoService 终端节点。org.acme.ApiEchoServiceClient/mp-rest/url=http://localhost:${port} 属性中的 HTTP 端口已参数化，以确保在使用开发、测试和生产模式时构建正确的 URL。

最后更新 GreetingResource 以请求 ApiEchoService 回显用户名：

package org.acme;

import io.quarkus.oidc.UserInfo;
import io.quarkus.security.Authenticated;
import jakarta.annotation.security.RolesAllowed;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

import org.eclipse.microprofile.rest.client.inject.RestClient;

@Path("/hello")
public class GreetingResource {
    @Inject
    @RestClient
    ApiEchoServiceClient echoClient; 1

    @Inject
    UserInfo userInfo;

    @GET
    @RolesAllowed("admin")
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return "Hello, " + echoClient.echoUserName(userInfo.getName()); 2
    }

    @GET
    @Path("post-logout")
    @Produces(MediaType.TEXT_PLAIN)
    public String postLogout() {
        return "You were logged out";
    }
}
1 Inject ApiEchoServiceClient REST client
2 使用 ApiEchoServiceClient 回显用户名。

打开浏览器，访问 [role="bare"][role="bare"]http://localhost:8080/hello，然后在浏览器中显示你的姓名。

让我们转到 [role="naked"][role="bare"]http://localhost:8080/q/dev-ui，选择 OpenId Connect 卡，登录到 Auth0，然后查看访问令牌内容：

auth0 devui jwt accesstoken

如您所见，访问令牌不再像 Access Quarkus with opaque Auth0 access tokens 部分中显示的那样进行加密，而实际上它现在采用 JWT 格式。

Permission Based Access Control

我们已在 Role-based access control 部分中讨论了如何获取 Quarkus 以检查包含用户角色的命名空间限定声明，以及如何使用此信息来强制基于角色的访问控制。您已配置 Auth0 以将自定义角色声明同时添加到 ID 和访问令牌中。

但是，基于权限的访问控制更适合于以下情况：访问令牌由前端端点传播到微服务，该微服务将检查给定的访问令牌是否已被授权此服务执行具体操作，而不是此令牌担保用户处于特定角色中。例如，处于管理员角色并不一定意味着该用户被允许读写此微服务的部分内容。

让我们看看如何将基于权限的访问控制约束应用到 ApiEchoService。

转到 Auth0 仪表板，向 QuarkusAuth0API API 添加 echo:name 权限：

auth0 api permissions

如果也将在授权代码流程期间请求此范围，则 echo:name 权限将作为标准 OAuth2 scope 声明值包含在访问令牌中。按照如下方式更新配置：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.authentication.scopes=profile,echo:name 1
quarkus.oidc.authentication.extra-params.audience=https://quarkus-auth0
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

# Point to the custom roles claim
quarkus.oidc.roles.role-claim-path="https://quarkus-security.com/roles"

# Logout
quarkus.oidc.end-session-path=v2/logout
quarkus.oidc.logout.post-logout-uri-param=returnTo
quarkus.oidc.logout.extra-params.client_id=${quarkus.oidc.client-id}
quarkus.oidc.logout.path=/logout
quarkus.oidc.logout.post-logout-path=/hello/post-logout
quarkus.http.auth.permission.authenticated.paths=/logout
quarkus.http.auth.permission.authenticated.policy=authenticated

quarkus.oidc.token.verify-access-token-with-user-info=true

org.acme.ApiEchoServiceClient/mp-rest/url=http://localhost:8080
1 在授权代码流程期间请求了额外的 echo:name 范围。

现在更新 ApiEchoService 以强制基于权限的访问控制：

package org.acme;

import io.quarkus.security.PermissionsAllowed;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/echo")
public class ApiEchoService {

    @POST
    @PermissionsAllowed("echo:name")
    @Produces(MediaType.TEXT_PLAIN)
    String echoUserName(String username) {
        return username;
    }
}

这是所有必需的内容，因为 Quarkus OIDC 自动将 scope 声明值作为权限与当前安全身份关联。

您可以通过组合 @RolesAllowed 和 @PermissionsAllowed 注释在 Quarkus 中强制基于角色和基于权限的访问控制。

打开浏览器，访问 [role="bare"][role="bare"]http://localhost:8080/hello，并在浏览器中显示该名称。

为确认已正确强制权限，请将其更改为 echo.name: @PermissionsAllowed("echo.name")。清除浏览器缓存，再次访问 [role="naked"][role="bare"]http://localhost:8080/hello 您将收到 ApiEchoService 报告的 403。现在将其恢复为 @PermissionsAllowed("echo:name")。

Integration testing

你已经使用 OIDC DevUI SPA 登录到 Auth0 并通过访问令牌测试了 Quarkus 端点，同时更新了端点代码。

但是，运行测试也至关重要，让我们看看如何使用 Quarkus Continuous Testing 功能测试本教程过程中开发的端点和配置。

从以下测试代码开始：

package org.acme;

import io.quarkus.test.junit.QuarkusTest;
import org.junit.jupiter.api.Test;

import static io.restassured.RestAssured.given;
import static org.hamcrest.CoreMatchers.is;

@QuarkusTest
public class GreetingResourceTest {

    @Test
    public void testHelloEndpoint() {
        given()
          .when().get("/hello")
          .then()
             .statusCode(200)
             .body(is("Hello, Sergey Beryozkin"));
    }

}

如果您还记得，当应用程序在开发模式下启动时，可以在 CLI 窗口中看到以下内容：

auth0 devmode started

按“r”，然后注意此测试失败，结果为“403”，这是预期的，因为测试未向端点发送令牌：

auth0 test failure 403

在修复测试之前，让我们回顾一下用于测试受 OIDC 保护的 Quarkus 端点的可用选项。这些选项可能有所不同，具体取决于您的应用程序支持的流程以及您首选的测试方式。可以使用“one of these options”测试使用 OIDC 授权代码流程的端点，可以使用“one of these options”测试使用 Bearer 令牌认证的端点。

如您所见，可以使用“Wiremock”或“@TestSecurity”注释来测试受 Auth0 保护的端点的。以自己的方式尝试编写此类测试，如果您遇到任何问题，请随时与我们联系。

不过，在本教程中，我们将使用最新添加的“OidcTestClient”来支持测试使用真实 Auth0 开发租户的端点。

以下是配置的相关片段：

quarkus.oidc.auth-server-url=https://dev-3ve0cgn7.us.auth0.com
quarkus.oidc.application-type=hybrid
quarkus.oidc.authentication.scopes=profile
quarkus.oidc.client-id=sKQu1dXjHB6r0sra0Y1YCqBZKWXqCkly
quarkus.oidc.credentials.secret=${client-secret}

在生产中，您将通过“%prod.”和“%test.”限定符区分 prod 和测试级别配置。让我们假设上述配置实际上将在您的真实应用程序中以“%test.”为前缀，该配置还包括“%prod.”限定的 Auth0 生产租户配置。

使用“OidcTestClient”测试此类配置时，需要使用 OAuth2 “password”或“client_credentials”授予来从 Auth0 开发租户获取令牌，我们将尝试“password”授予。确保在 Auth0 仪表板中注册的应用程序允许“password”授予：

auth0 password grant

重要的是要澄清，我们不建议在生产中使用已弃用的 OAuth2 “password”令牌授予。但是，使用它有助于测试从真实开发 Auth0 租户获取的令牌来测试端点。

“OidcTestClient”应用于测试接受 Bearer 令牌的应用程序，该应用程序适用于本教程中开发的端点，因为它同时支持授权代码流程和 Bearer 令牌认证。如果您仅支持授权代码流程，则需要直接针对 Auth0 开发租户使用 OIDC WireMock 或“HtmlUnit”，在这种情况下，“HtmlUnit”测试代码必须符合 Auth0 要求用户输入其凭证的方式。如果您愿意，可以从文档中复制“HtmlUnit test fragment”并对其进行实验。

在此期间，我们将继续使用“OidcTestClient”修复当前失败的测试。

首先，您必须添加以下依赖项：

pom.xml
<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-test-oidc-server</artifactId>
    <scope>test</scope>
</dependency>
build.gradle
testImplementation("io.quarkus:quarkus-test-oidc-server")

它提供了一个实用程序类“io.quarkus.test.oidc.client.OidcTestClient”，可在测试中用于获取访问令牌（此依赖项还提供 OIDC WireMock 支持 - 如果需要，请查看文档了解如何将其用于测试）。

现在像这样更新测试代码：

package org.acme;

import static io.restassured.RestAssured.given;
import static org.hamcrest.CoreMatchers.is;

import java.util.Map;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Test;

import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.oidc.client.OidcTestClient;

@QuarkusTest
public class GreetingResourceTest {

    static OidcTestClient oidcTestClient = new OidcTestClient();

    @AfterAll
    public static void close() {
        client.close();
    }

    @Test
    public void testHelloEndpoint() {
        given()
          .auth().oauth2(getAccessToken(`sberyozkin@gmail.com`, "userpassword"))
          .when().get("/hello")
          .then()
             .statusCode(200)
             .body(is("Hello, Sergey Beryozkin"));
    }

    private String getAccessToken(String name, String secret) {
        return oidcTestClient.getAccessToken(name, secret, 1
            Map.of("audience", "https://quarkus-auth0",
	           "scope", "openid profile"));
    }
}
1 “OidcTestClient”用于获取访问令牌，使用已注册的用户名和密码，以及“audience”和“scope”参数。

“OidcTestClient”本身将找出“Auth0”令牌端点地址、客户端 ID 和机密。

再次按“r”，使测试通过：

auth0 test success

顺便说一句，如果您愿意，您可以直接从 DevUI 以连续模式运行测试：

auth0 continuous testing

Production mode

在开发模式下开发、测试了通过 Auth0 保护的 Quarkus 端点。下一步是运行应用程序的生产模式。选择 JVM 和原生模式。

Run the Application in JVM mode

编译应用程序：

CLI
quarkus build
Maven
./mvnw install
Gradle
./gradlew build

运行应用程序：

java -jar target/quarkus-app/quarkus-run.jar

打开浏览器，访问 [role="bare"][role="bare"]http://localhost:8080/hello，并在浏览器中显示该名称。

Run the application in native mode

可以编译这个相同演示的原生模式，无需进行任何修改。这意味着你不再需要在生产环境中安装 JVM 了。运行时技术包含在生成二进制文件中，优化为以所需的最低资源运行。

编译花费的时间稍微长一点，所以默认情况下会禁用此步骤。

通过启用 native 配置文件重新构建你的应用程序：

CLI
quarkus build --native
Maven
./mvnw install -Dnative
Gradle
./gradlew build -Dquarkus.native.enabled=true

接下来直接运行以下二进制文件：

./target/quarkus-auth0-1.0.0-SNAPSHOT-runner

打开浏览器，访问 [role="bare"][role="bare"]http://localhost:8080/hello，并在浏览器中显示该名称。

Troubleshooting

本教程中的步骤按教程描述的一样工作。如果你已经在完成身份验证，访问更新的 Quarkus 端点时可能需要清除浏览器 Cookie。你可能需要手动重启开发模式中的 Quarkus 应用程序，但这不常见。如果你需要帮助完成本教程，你可以联系 Quarkus 团队。

Summary

本教程演示了如何使用授权代码和持有者令牌身份验证流，通过 `quarkus-oidc`扩展和 Auth0 来保护 Quarkus 端点，这两种流都受同一端点代码支持。在不编写任何代码行的情况下，你增加了对自定义 Auth0 注销流的支持，并使用自定义 Auth0 名称空间限定声明启用了基于角色的访问控制。通过将 `@AccessToken`注释添加到微服务 REST 客户端，实现了从前端端点到微服务端点的令牌传播。微服务端点使用 `@PermissionsAllowed`注释激活了基于许可的访问控制。你使用 Quarkus 开发模式来更新代码和配置，而无需重启端点；并使用 OIDC Dev UI 来显示和测试 Auth0 令牌。你使用 Quarkus 的持续测试功能，利用对实时 Auth0 开发租户的集成测试来补充 OIDC Dev UI 测试。最后，你以 JVM 和原生模式运行应用程序。

享受！

References