在示例 WPF 桌面应用程序中让用户登录
本指南使用 Windows Presentation Foundation (WPF) 应用程序示例来演示如何向 WPF 桌面应用程序添加身份验证。 示例应用程序使用户能够登录和退出登录。示例桌面应用程序使用适用于 .NET 的 Microsoft 身份验证库来处理身份验证。
先决条件
- Visual Studio Code 或其他代码编辑器。
- .NET 7.0 或更高版本。
- 外部租户。 若要创建,可以选择以下方法:
- (推荐)使用 Microsoft Entra 外部 ID 扩展直接在 Visual Studio Code 中设置外部租户。
- 在 Microsoft Entra 管理中心创建新的外部租户。
注册桌面应用
若要使应用程序能够让用户通过 Microsoft Entra 登录,必须让 Microsoft Entra 外部 ID 能够感知你创建的应用程序。 应用注册会在应用与 Microsoft Entra 之间建立信任关系。 注册应用程序时,外部 ID 会生成一个称为“应用程序(客户端)ID”的唯一标识符,该值用于在创建身份验证请求时标识应用。
以下步骤演示如何在 Microsoft Entra 管理中心注册应用:
至少以应用程序开发人员的身份登录到 Microsoft Entra 管理中心。
如果你有权访问多个租户,请使用顶部菜单中的“设置”图标 ,通过“目录 + 订阅”菜单切换到你的外部租户。
浏览到“标识”>“应用程序”>“应用注册”。
选择“+ 新建注册”。
在显示的“注册应用程序”页中;
- 输入一个向应用用户显示的、有意义的应用程序名称,例如 ciam-client-app。
- 在“支持的帐户类型”下,选择“仅此组织目录中的帐户” 。
选择“注册”。
成功注册后,会显示应用程序的“概述”窗格。 记录要在应用程序源代码中使用的应用程序(客户端)ID。
指定应用平台
若要为应用注册指定应用类型,请执行以下步骤:
- 在“管理”下,选择“身份验证”。
- 在“平台配置”页上,选择“添加平台”,然后选择“移动和桌面应用程序”选项。
- 在自定义重定向 URI 下的输入字段中,手动输入
https://login.microsoftonline.com/common/oauth2/nativeclient
,然后选择配置。 如果在选择框中选择此 URI,则可能会收到重定向 URI 错误。
授权管理员同意
注册应用程序后,它会分配有 User.Read 权限。 但由于该租户是外部租户,因此客户用户本身不能同意此权限。 作为管理员,你必须代表租户中的所有用户同意此权限:
从“应用注册”页中,选择创建的应用程序(例如 ciam-client-app)以打开其“概述”页。
在“管理”下选择“API 权限”。
- 选择“为 <租户名称> 授予管理员同意”,然后选择“是”。
- 选择“刷新”,然后验证相应权限的“状态”下是否显示“已为 <租户名称> 授权”。
创建用户流
按照这些步骤创建可供客户用于登录或注册应用程序的用户流。
至少以外部 ID 用户流管理员身份登录到 Microsoft Entra 管理中心。
如果你有权访问多个租户,请使用顶部菜单中的“设置”图标 ,通过“目录 + 订阅”菜单切换到你的外部租户。
浏览到“标识”>“外部标识”>“用户流”。
选择“+ 新建用户流”。
在“创建”页上执行以下操作:
为用户流输入名称,例如 SignInSignUpSample。
在“标识提供者”列表中,选择“电子邮件帐户”。 此标识提供者使用户能够使用其电子邮件地址登录或注册。
在“电子邮件帐户”下,可以选择两个选项之一。 对于本教程,请选择“电子邮件和密码”。
- 电子邮件和密码:使新用户能够使用电子邮件地址作为登录名称并使用密码作为其第一重身份验证凭据进行注册和登录。
- 电子邮件一次性密码:使新用户能够使用电子邮件地址作为登录名称并使用电子邮件一次性密码作为其第一重身份验证凭据进行注册和登录。 只有在租户级别启用电子邮件一次性密码(“所有标识提供者”>“电子邮件一次性密码”),才能在用户流级别使用此选项。
在“用户属性”下,选择要在用户注册时收集的用户属性。 选择“显示更多内容”即可选择“国家/地区”、“显示名称”和“邮政编码”的属性和声明。 选择“确定” 。 (系统仅在用户首次注册时提示输入属性。)
选择“创建” 。 此时,新的用户流将显示在“用户流”列表中。 如果需要,请刷新页面。
若要启用自助式密码重置,请使用启用自助式密码重置一文中的步骤。
将 WPF 应用程序与用户流相关联
为了让客户用户在使用你的应用时看到注册或登录体验,你需要将自己的应用与用户流相关联。 尽管许多应用程序可与用户流相关联,但单个应用程序只能与一个用户流相关联。
在边栏菜单中选择“标识”。
依次选择“外部标识”和“用户流”。
在“用户流”页中,选择之前创建的用户流名称,例如 SignInSignUpSample。
在“使用”下,选择“应用程序”。
选择“添加应用程序”。
从列表中选择应用程序(如 ciam-client-app),或使用搜索框查找应用程序,然后将其选中。
选择“选择”。
将应用与用户流关联后,可以通过在 Microsoft Entra 管理中心内模拟用户在应用程序中的注册或登录体验来测试用户流。 为此,请使用测试注册和登录用户流中所述的步骤。
克隆或下载示例 WPF 应用程序
若要获取示例应用程序,可以从 GitHub 克隆它或将其下载为 .zip 文件。
若要克隆示例,请打开命令提示符并导航到要创建项目的位置,然后输入以下命令:
git clone https://github.com/Azure-Samples/ms-identity-ciam-dotnet-tutorial.git
下载 .zip 文件。 将其提取到名称长度小于 260 个字符的文件路径。
配置示例 WPF 应用
在 IDE(如 Visual Studio 或 Visual Studio Code)中打开项目以配置代码。
在代码编辑器中,打开 ms-identity-ciam-dotnet-tutorial>1-Authentication>5-sign-in-dotnet-wpf 文件夹中的 appsettings.json 文件。
将
Enter_the_Application_Id_Here
替换为之前注册的应用的应用程序(客户端)ID。将
Enter_the_Tenant_Subdomain_Here
替换为目录(租户)子域。 例如,如果主域为 contoso.onmicrosoft.com,请将Enter_the_Tenant_Subdomain_Here
替换为 contoso。 如果没有主域,请了解如何读取租户详细信息。
运行和测试示例 WPF 桌面应用
打开控制台窗口,切换到包含 WPF 桌面示例应用的目录:
cd 1-Authentication\5-sign-in-dotnet-wpf
在终端中,通过运行以下命令来运行应用:
dotnet run
启动示例后,应会看到一个带有“登录”按钮的窗口。 选择该“登录”按钮。
在登录页上,输入帐户电子邮件地址。 如果没有帐户,请选择“无帐户? 创建一个”,以启动注册流。 按照此流程创建新帐户并登录。
登录后,你将看到一个屏幕,显示登录成功以及存储在检索到的令牌中的用户帐户的基本信息。 基本信息显示在登录屏幕的“令牌信息”部分中
工作原理
公共客户端应用程序的主配置在 App.xaml.cs 文件中处理。 PublicClientApplication
会和缓存一起初始化,用于存储访问令牌。 应用程序将先检查是否存在可用于让用户登录的缓存令牌。 如果没有缓存的令牌,系统将提示用户提供凭据并登录。 退出登录后,将清除所有帐户的缓存和所有相应的访问令牌。