启用 JBoss EAP 应用登录并访问 Microsoft Graph - Azure

项目
06/13/2024

本文演示了一个 Java JBoss EAP 应用，该应用可让用户登录并获取用于调用 Microsoft Graph 的访问令牌。它使用适用于 Java 的Microsoft身份验证库（MSAL）。

下图显示了应用的拓扑：

显示应用的拓扑的关系图。

客户端应用使用 MSAL for Java（MSAL4J）登录用户，并从 Microsoft Entra ID 获取 Microsoft Graph 的访问令牌。访问令牌证明用户有权访问作用域中定义的Microsoft图形 API 终结点。

先决条件

Java 8 或更高版本
Maven 3
Microsoft Entra ID 租户。有关详细信息，请参阅如何获取Microsoft Entra ID 租户。
如果只想在组织目录中使用帐户（即在单租户模式下）使用自己的Microsoft Entra ID 租户中的用户帐户。如果尚未在租户中创建用户帐户，则应在继续操作之前执行此操作。有关详细信息，请参阅如何创建、邀请和删除用户。
如果要在任何组织目录中使用帐户（即多租户模式）中的帐户，则任何组织的 Microsoft Entra ID 租户中的用户帐户。必须修改此示例才能使用个人Microsoft帐户。如果尚未在租户中创建用户帐户，则应在继续操作之前执行此操作。有关详细信息，请参阅如何创建、邀请和删除用户。
若要使用个人Microsoft帐户（例如 Xbox、Hotmail、Live 等）个人Microsoft帐户。

建议

一些熟悉 Java/Jakarta Servlets。
一些熟悉 Linux/OSX 终端或 Windows PowerShell。
用于检查令牌的 jwt.ms。
用于监视网络活动和故障排除的 Fiddler 。
按照 Microsoft Entra ID 博客了解最新开发的最新动态。

设置示例

以下部分演示如何设置示例应用程序。

克隆或下载示例存储库

若要克隆示例，请打开 Bash 窗口并使用以下命令：

git clone https://github.com/Azure-Samples/ms-identity-msal-java-samples.git
cd 3-java-servlet-web-app/2-Authorization-I/call-graph

或者，导航到 ms-identity-msal-java-samples 存储库，然后将其下载为 .zip 文件并将其提取到硬盘驱动器。

重要

若要避免 Windows 上的文件路径长度限制，请将存储库克隆或提取到硬盘驱动器根附近的目录中。

将示例应用程序注册到 Microsoft Entra ID 租户

此示例中有一个项目。以下部分演示如何使用Azure 门户注册应用。

选择要在其中创建应用程序的Microsoft Entra ID 租户

若要选择租户，请使用以下步骤：

登录到 Azure 门户。
如果帐户存在于多个Microsoft Entra ID 租户中，请选择Azure 门户角的配置文件，然后选择“切换目录”，将会话更改为所需的Microsoft Entra ID 租户。

注册应用（java-servlet-webapp-call-graph）

首先，按照快速入门中的说明在 Azure 门户中注册新应用：将应用程序注册到Microsoft 标识平台。

然后，使用以下步骤完成注册：

导航到面向开发人员的 Microsoft 标识平台应用注册页。
选择“新注册”。
在 显示的“注册应用程序”页 中，输入以下应用程序注册信息：
- 在“ 名称 ”部分中，输入一个有意义的应用程序名称，以便向应用的用户显示，例如 java-servlet-webapp-call-graph。
- 在 “支持的帐户类型”下，选择以下选项之一：
  - 仅当正在生成应用程序以供租户中的用户（即单租户应用程序）使用时，才选择此组织目录中的帐户。
  - 如果希望任何Microsoft Entra ID 租户中的用户能够使用应用程序（即多租户应用程序），请选择任何组织目录中的帐户。
  - 为最广泛的客户选择任何组织目录中的帐户和个人Microsoft帐户，即支持Microsoft 个人帐户的多租户应用程序。
- 选择 个人Microsoft帐户 ，仅供个人Microsoft帐户（例如 Hotmail、Live、Skype 和 Xbox 帐户）的用户使用。
- 在“重定向 URI”部分中，在组合框中选择“Web”，并输入以下重定向 URI： http://localhost:8080/msal4j-servlet-graph/auth/redirect
选择“注册”以创建应用程序。
在应用的注册页上，查找并复制 应用程序（客户端）ID 值以供以后使用。在应用的配置文件或文件中使用此值。
选择“保存”以保存更改。
在应用的注册页上，选择 导航窗格中的“证书和机密 ”，打开可以生成机密并上传证书的页面。
在“客户端密码”部分中，选择“新建客户端密码” 。
键入说明 - 例如应用机密。
选择可用持续时间之一： 1 年、 2 年内或 永不过期。
选择添加。将显示生成的值。
复制并保存生成的值，以便在后续步骤中使用。代码的配置文件需要此值。此值不会再次显示，不能通过任何其他方式检索该值。因此，在导航到任何其他屏幕或窗格之前，请务必将其从Azure 门户保存。
在应用的注册页上，从导航窗格中选择 API 权限 以打开该页面，以添加对应用程序所需的 API 的访问权限。
选择“添加权限”。
确保已选择“Microsoft API”选项卡。
在“常用 Microsoft API”部分，选择“Microsoft Graph”。
在 “委派权限 ” 部分中，从列表中选择“User.Read ”。如有必要，请使用搜索框。
选择“添加权限”。

配置应用（java-servlet-webapp-call-graph）以使用应用注册

使用以下步骤配置应用：

注意

在以下步骤中， ClientID 与 Application ID 或 AppId相同。

在 IDE 中打开项目。
打开 ./src/main/resources/authentication.properties 文件。
找到字符串 {enter-your-tenant-id-here}。将现有值替换为以下值之一：
- 如果将应用注册到此组织目录中的 “帐户 ”选项，则Microsoft Entra ID 租户 ID。
- 如果将应用注册到任何组织目录选项中的“帐户”，则为该单词organizations。
- common如果将应用注册到任何组织目录中的帐户和个人Microsoft帐户选项中。
- 如果将应用注册到个人Microsoft帐户选项，则为该单词consumers。
找到字符串{enter-your-client-id-here}，并将现有值替换为从Azure 门户复制的应用程序 ID 或clientIdjava-servlet-webapp-call-graph应用程序。
找到字符串{enter-your-client-secret-here}，并将现有值替换为在创建java-servlet-webapp-call-graph应用期间保存的值（在Azure 门户中）。

生成示例

若要使用 Maven 生成示例，请导航到包含 示例pom.xml 文件的目录，然后运行以下命令：

mvn clean package

此命令生成可在 各种应用程序服务器上运行的 .war 文件。

以下部分演示如何将示例部署到Azure App 服务。

先决条件

适用于Azure App 服务应用的 Maven 插件

如果 Maven 不是首选开发工具，请参阅以下使用其他工具的类似教程：

配置 Maven 插件

部署到 Azure 应用服务的过程会自动使用 Azure CLI 中的 Azure 凭据。如果未在本地安装 Azure CLI，则 Maven 插件会使用 OAuth 或设备登录来进行身份验证。有关详细信息，请参阅 Maven 插件的身份验证。

使用以下步骤配置插件：

运行接下来显示的 Maven 命令来配置部署。此命令将帮助你设置应用服务操作系统、Java 版本和 Tomcat 版本。
```
mvn com.microsoft.azure:azure-webapp-maven-plugin:2.12.0:config
```
对于 “创建新的运行配置”，请按 Y，然后按 Enter。
对于 OS 的“定义”值，请按 2 表示 Linux，然后按 Enter。
对于 javaVersion 的定义值，请按 2 for Java 11，然后按 Enter。
对于 WebContainer 的 Define 值，请按 1 表示 JBosseap7，然后按 Enter。
对于 “定义 pricingTier”值，请按 Enter 选择默认 的 P1v3 层。
对于 “确认”，请按 Y，然后按 Enter。

以下示例显示了部署过程的输出：

Please confirm webapp properties
AppName : msal4j-servlet-auth-1707220080695
ResourceGroup : msal4j-servlet-auth-1707220080695-rg
Region : centralus
PricingTier : P1v3
OS : Linux
Java Version: Java 11
Web server stack: JBosseap 7
Deploy to slot : false
Confirm (Y/N) [Y]:
[INFO] Saving configuration to pom.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  26.196 s
[INFO] Finished at: 2024-02-06T11:48:16Z
[INFO] ------------------------------------------------------------------------

确认选择后，该插件会将插件配置和所需的设置添加到项目的pom.xml文件中，以将应用配置为在Azure App 服务中运行。

pom.xml文件的相关部分应类似于以下示例：

<build>
    <plugins>
        <plugin>
            <groupId>com.microsoft.azure</groupId>
            <artifactId>>azure-webapp-maven-plugin</artifactId>
            <version>x.xx.x</version>
            <configuration>
                <schemaVersion>v2</schemaVersion>
                <resourceGroup>your-resourcegroup-name</resourceGroup>
                <appName>your-app-name</appName>
            ...
            </configuration>
        </plugin>
    </plugins>
</build>

可以直接在pom.xml中修改App 服务的配置。下表列出了一些常见配置：

properties	必选	说明	版本
`schemaVersion`	false	配置架构的版本。支持的值为 `v1` 和 `v2`。	1.5.2
`subscriptionId`	false	订阅的 ID。	0.1.0+
`resourceGroup`	是	应用的 Azure 资源组。	0.1.0+
`appName`	是	应用的名称。	0.1.0+
`region`	false	托管应用的区域。默认值为 `centralus`。有关有效区域，请参阅支持的区域。	0.1.0+
`pricingTier`	false	应用的定价层。生产工作负荷的默认值为 P1v2 。 Java 开发和测试的建议最小值是 `B2`。有关详细信息，请参阅应用服务定价	0.1.0+
`runtime`	false	运行时环境配置。有关详细信息，请参阅配置详细信息。	0.1.0+
`deployment`	false	部署配置。有关详细信息，请参阅配置详细信息。	0.1.0+

有关配置的完整列表，请参阅插件参考文档。所有 Azure Maven 插件共享一组常见的配置。有关这些配置，请参阅常见配置。有关特定于Azure App 服务的配置，请参阅 Azure 应用：配置详细信息。

请务必保存保留这些 appName 值， resourceGroup 供以后使用。

准备应用进行部署

将应用程序部署到App 服务时，重定向 URL 将更改为已部署的应用实例的重定向 URL。使用以下步骤更改属性文件中的这些设置：

导航到应用的 authentication.properties 文件并更改已部署应用的域名的值 app.homePage ，如以下示例所示。例如，如果在example-domain上一步中选择了应用名称，则现在必须用于https://example-domain.azurewebsites.netapp.homePage该值。请确保也已将协议从 http 此更改为 https。
```
# app.homePage is by default set to dev server address and app context path on the server
# for apps deployed to azure, use https://your-sub-domain.azurewebsites.net
app.homePage=https://<your-app-name>.azurewebsites.net
```
保存此文件后，使用以下命令重新生成应用：
```
mvn clean package
```

重要

在此相同的 authentication.properties 文件中，你有一个设置 aad.secret。最好将此值部署到App 服务。在代码中保留此值并可能将其推送到 git 存储库，这两种做法都不是很好的做法。若要从代码中删除此机密值，可以在“部署到 App 服务 - 删除机密”部分中找到更详细的指导。本指南增加了将机密值推送到密钥库并使用密钥库引用的额外步骤。

更新Microsoft Entra ID 应用注册

由于重定向 URI 更改为已部署的应用Azure App 服务，因此还需要更改Microsoft Entra ID 应用注册中的重定向 URI。若要进行此更改，请使用以下步骤：

导航到面向开发人员的 Microsoft 标识平台应用注册页。
使用搜索框搜索应用注册，例如 java-servlet-webapp-authentication。
通过选择应用名称打开应用注册。
从菜单中选择“身份验证”。
在“Web - 重定向 URI”部分中，选择“添加 URI”。
填写应用的 URI，追加 /auth/redirect - 例如。 https://<your-app-name>.azurewebsites.net/auth/redirect
选择“保存”。

部署应用

现在可以将应用部署到Azure App 服务。使用以下命令确保登录到 Azure 环境以执行部署：

az login

在pom.xml文件中准备好所有配置后，现在可以使用以下命令将 Java 应用部署到 Azure：

mvn package azure-webapp:deploy

部署完成后，应用程序已 http://<your-app-name>.azurewebsites.net/准备就绪。使用本地 Web 浏览器打开 URL，此时应会看到应用程序的起始页 msal4j-servlet-auth 。

在部署到 JBoss 之前，请使用以下步骤在示例本身中进行一些配置更改，然后生成或重新生成包：

在示例中，找到 配置客户端 ID、租户、重定向 URL 等的 application.properties 或 authentication.properties 文件。
在此文件中，更改对 JBoss 运行时的 URL 和端口的引用 localhost:8080 ， localhost:8443 默认情况下，该 URL 和端口应 localhost:9990为。
还需要在 Azure 应用注册中进行更改，在Azure 门户中将其设置为“身份验证”选项卡上的“重定向 URI”值。

使用以下步骤通过 Web 控制台将示例部署到 JBoss EAP：

使用 %JBOSS_HOME%\bin\standalone.bat 启动 JBoss 服务器。
在浏览器中 http://localhost:9990导航到 JBoss Web 控制台。
转到“部署”，选择“添加”，然后上传生成的 .war。
大多数默认设置都应正常，只是应将应用程序命名为与示例配置或 Azure 应用注册中设置的重定向 URI 匹配。也就是说，如果重定向 URI 为 http://localhost:9990/msal4j-servlet-auth/，则应将应用程序 msal4j-servlet-auth命名。
选择上传的 .war 文件，选择 “En/Disable ”并确认以启动应用程序。
应用程序启动后，导航到 http://localhost:9990/<application-name>/，应该能够访问该应用程序。

探索示例

使用以下步骤浏览示例：

请注意屏幕中心显示的已登录或注销状态。
选择角落中的上下文敏感按钮。首次运行应用时，此按钮将 读取登录 。
在下一页上，按照说明使用 Microsoft Entra ID 租户中的帐户登录。
在同意屏幕上，请注意请求的范围。
请注意，上下文敏感按钮现在显示 “注销 ”并显示用户名。
选择 ID 令牌详细信息 以查看某些 ID 令牌的解码声明。
选择 “呼叫关系图 ”以调用 Microsoft Graph 的 /me 终结点，并查看获取的用户详细信息。
使用角落中的按钮注销。

关于代码

此示例使用 MSAL for Java（MSAL4J）登录并获取Microsoft图形 API 的令牌。它使用适用于 Java 的 Microsoft Graph SDK 从 Graph 获取数据。必须使用 Maven 将这些库添加到项目中。

如果要复制此示例的行为，可以复制 src/main/java/com/microsoft/azuresamples/msal4j 文件夹中的 pom.xml文件和 authservlet 文件夹的内容。还需要 authentication.properties 文件。这些类和文件包含可在各种应用程序中使用的通用代码。也可以复制示例的其余部分，但会专门生成其他类和文件来解决此示例的目标。

文件/文件夹	说明
src/main/java/com/microsoft/azuresamples/msal4j/callgraphwebapp/	此目录包含定义应用的后端业务逻辑的类。
src/main/java/com/microsoft/azuresamples/msal4j/authservlets/	此目录包含用于登录和注销终结点的类。
____Servlet.java	所有可用的终结点在以 ____Servlet.java 结尾的.java类中定义。
src/main/java/com/microsoft/azuresamples/msal4j/helpers/	用于身份验证的帮助程序类。
AuthenticationFilter.java	将未经身份验证的请求重定向到受保护的终结点到 401 页。
src/main/resources/authentication.properties	Microsoft Entra ID 和程序配置。
src/main/webapp/	此目录包含 UI - JSP 模板
CHANGELOG.md	示例更改列表。
CONTRIBUTING.md	参与示例的指南。
许可证	示例的许可证。

ConfidentialClientApplication

ConfidentialClientApplication实例在AuthHelper.java文件中创建，如以下示例所示。此对象有助于创建Microsoft Entra ID 授权 URL，并有助于交换访问令牌的身份验证令牌。

// getConfidentialClientInstance method
IClientSecret secret = ClientCredentialFactory.createFromSecret(SECRET);
confClientInstance = ConfidentialClientApplication
                     .builder(CLIENT_ID, secret)
                     .authority(AUTHORITY)
                     .build();

以下参数用于实例化：

应用的客户端 ID。
客户端机密，这是机密客户端应用程序的要求。
Microsoft Entra ID 颁发机构，其中包括Microsoft Entra 租户 ID。

在此示例中，使用 Config.java 文件中的属性读取器从 authentication.properties 文件中读取这些值。

分步演练

以下步骤提供应用的功能的演练：

登录过程的第一步是向Microsoft Entra ID 租户的终结点发送请求 /authorize 。 MSAL4J ConfidentialClientApplication 实例用于构造授权请求 URL。应用将浏览器重定向到此 URL，这是用户登录的位置。
```
final ConfidentialClientApplication client = getConfidentialClientInstance();
AuthorizationRequestUrlParameters parameters = AuthorizationRequestUrlParameters.builder(Config.REDIRECT_URI, Collections.singleton(Config.SCOPES))
        .responseMode(ResponseMode.QUERY).prompt(Prompt.SELECT_ACCOUNT).state(state).nonce(nonce).build();

final String authorizeUrl = client.getAuthorizationRequestUrl(parameters).toString();
contextAdapter.redirectUser(authorizeUrl);
```
以下列表描述了此代码的功能：
- AuthorizationRequestUrlParameters：必须设置的参数才能生成 AuthorizationRequestUrl。
- REDIRECT_URI：收集用户凭据后，Microsoft Entra ID 会重定向浏览器以及身份验证代码。它必须与Azure 门户中Microsoft Entra ID 应用注册中的重定向 URI 匹配
- SCOPES：范围是应用程序请求的权限。
  - 通常，这三个范围 openid profile offline_access 足以接收 ID 令牌响应。
  - 可以在 authentication.properties 文件中找到应用请求的范围的完整列表。可以添加更多范围，例如 User.Read。
Microsoft Entra ID 将会向用户显示登录提示。如果登录尝试成功，则用户的浏览器将重定向到应用的重定向终结点。对此终结点的有效请求包含授权代码。

然后，该 ConfidentialClientApplication 实例将此授权代码交换Microsoft Entra ID 中的 ID 令牌和访问令牌。

// First, validate the state, then parse any error codes in response, then extract the authCode. Then:
// build the auth code params:
final AuthorizationCodeParameters authParams = AuthorizationCodeParameters
        .builder(authCode, new URI(Config.REDIRECT_URI)).scopes(Collections.singleton(Config.SCOPES)).build();

// Get a client instance and leverage it to acquire the token:
final ConfidentialClientApplication client = AuthHelper.getConfidentialClientInstance();
final IAuthenticationResult result = client.acquireToken(authParams).get();

以下列表描述了此代码的功能：

AuthorizationCodeParameters：必须设置的参数，才能交换 ID 和/或访问令牌的授权代码。
authCode：在重定向终结点收到的授权代码。
REDIRECT_URI：上一步中使用的重定向 URI 必须再次传递。
SCOPES：上一步中使用的范围必须再次传递。

如果 acquireToken 成功，则提取令牌声明。如果 nonce 检查通过，则结果将置于 context -- 实例 IdentityContextData 中，并保存到会话中。然后，应用程序可以通过需要访问会话的实例IdentityContextAdapterServlet来实例IdentityContextData化会话，如以下代码所示：

// parse IdToken claims from the IAuthenticationResult:
// (the next step - validateNonce - requires parsed claims)
context.setIdTokenClaims(result.idToken());

// if nonce is invalid, stop immediately! this could be a token replay!
// if validation fails, throws exception and cancels auth:
validateNonce(context);

// set user to authenticated:
context.setAuthResult(result, client.tokenCache().serialize());

保护路由

有关示例应用如何筛选路由访问权限的信息，请参阅 AuthenticationFilter.java。在 authentication.properties 文件中，该 app.protect.authenticated 属性包含仅经过身份验证的用户可以访问的逗号分隔路由，如以下示例所示：

# for example, /token_details requires any user to be signed in and does not require special roles or groups claim(s)
app.protect.authenticated=/token_details, /call_graph

调用图

当用户导航到 /call_graph时，应用程序将从 Java Graph SDK 创建一个实例 IGraphServiceClient ，并传递已登录用户的访问令牌。 Graph 客户端在其请求的标头中 Authorization 放置访问令牌。然后，应用要求 Graph 客户端调用 /me 终结点，以生成当前已登录用户的详细信息。

如果已有具有作用域的 User.Read Graph 服务的有效访问令牌，则只需以下代码即可访问 /me 终结点：

//CallGraphServlet.java
User user = GraphHelper.getGraphClient(contextAdapter).me().buildRequest().get();

作用域

范围告知Microsoft Entra ID 应用程序请求的访问级别。

根据请求的范围，Microsoft Entra ID 在登录时向用户显示同意对话。如果用户同意一个或多个范围并获取令牌，则 scopes-consented-to 编码为结果 access_token。

有关应用程序请求的范围，请参阅 authentication.properties。默认情况下，应用程序将范围值设置为 User.Read。此特定Microsoft图形 API 范围用于访问当前登录用户的信息。用于访问此信息的图形终结点为 https://graph.microsoft.com/v1.0/me。对此终结点发出的任何有效请求都必须包含access_token标头中的Authorization作用域User.Read。

通过

先决条件

建议

设置示例

克隆或下载示例存储库

将示例应用程序注册到 Microsoft Entra ID 租户

选择要在其中创建应用程序的Microsoft Entra ID 租户

注册应用（java-servlet-webapp-call-graph）

配置应用（java-servlet-webapp-call-graph）以使用应用注册

生成示例

运行示例

先决条件

配置 Maven 插件

准备应用进行部署

更新Microsoft Entra ID 应用注册

部署应用

探索示例

关于代码

目录

ConfidentialClientApplication

分步演练

保护路由

调用图

作用域

详细信息

反馈

反馈

其他资源

通过

启用 Java JBoss EAP 应用以登录用户并访问 Microsoft Graph

先决条件

建议

设置示例

克隆或下载示例存储库

将示例应用程序注册到 Microsoft Entra ID 租户

选择要在其中创建应用程序的Microsoft Entra ID 租户

注册应用（java-servlet-webapp-call-graph）

配置应用（java-servlet-webapp-call-graph）以使用应用注册

生成示例

运行示例

先决条件

配置 Maven 插件

准备应用进行部署

更新Microsoft Entra ID 应用注册

部署应用

探索示例

关于代码

目录

ConfidentialClientApplication

分步演练

保护路由

调用图

作用域

详细信息

反馈

反馈

其他资源