在示例 WPF 桌面应用程序中让用户登录

  • 项目

本文使用 Windows Presentation Foundation (WPF) 应用程序示例来演示如何向 WPF 桌面应用程序添加身份验证。 示例应用程序使用户能够登录和退出登录。示例桌面应用程序使用适用于 .NET 的 Microsoft 身份验证库来处理身份验证。

必备条件

注册桌面应用

要使应用程序能够让用户通过 Microsoft Entra 登录，必须让面向客户的 Microsoft Entra ID 能够感知你创建的应用程序。 应用注册会在应用与 Microsoft Entra 之间建立信任关系。 注册应用程序时，外部 ID 会生成一个称为“应用程序（客户端）ID”的唯一标识符，该值用于在创建身份验证请求时标识应用。

以下步骤演示如何在 Microsoft Entra 管理中心注册应用：

  1. 至少以应用程序开发人员的身份登录到 Microsoft Entra 管理中心。

  2. 如果有权访问多个租户，请使用顶部菜单中的“设置”图标 ，切换到“目录 + 订阅”菜单中的客户租户。

  3. 浏览到“标识”>“应用程序”>“应用注册”。

  4. 选择“+ 新建注册”。

  5. 在显示的“注册应用程序”页中；

    1. 输入一个向应用用户显示的、有意义的应用程序名称，例如 ciam-client-app。
    2. 在“支持的帐户类型”下，选择“仅此组织目录中的帐户” 。

  6. 选择“注册”。

  7. 成功注册后，会显示应用程序的“概述”窗格。 记录要在应用程序源代码中使用的应用程序（客户端）ID。

指定应用平台

若要为应用注册指定应用类型，请执行以下步骤：

  1. 在“管理”下，选择“身份验证”。
  2. 在“平台配置”页上，选择“添加平台”，然后选择“移动和桌面应用程序”选项。
  3. 在自定义重定向 URI 下的输入字段中，手动输入 https://login.microsoftonline.com/common/oauth2/nativeclient，然后选择配置。 如果在选择框中选择此 URI，则可能会收到重定向 URI 错误。

授予 API 权限

由于此应用可让用户登录，因此请添加委托的权限：

  1. 从“应用注册”页中，选择创建的应用程序（例如 ciam-client-app）以打开其“概述”页。

  2. 在“管理”下选择“API 权限” 。

  3. 在“已配置权限”下，选择“添加权限”。

  4. 选择“Microsoft API”选项卡。

  5. 在“常用 Microsoft API”部分下，选择“Microsoft Graph”。

  6. 选择“委托的权限”选项。

  7. 在“选择权限”部分下，搜索并选择“openid”和“offline_access”权限。

  8. 选择“添加权限”按钮。

  9. 此时，你已正确分配了权限。 但是，由于租户是客户的租户，因此使用者用户本身不能同意这些权限。 作为管理员，你必须代表租户中的所有用户同意这些权限：

    1. 选择“为 <租户名称> 授予管理员同意”，然后选择“是”。
    2. 选择“刷新”，然后验证两个范围的“状态”下是否均显示“已为 <租户名称> 授予”。

创建用户流

按照这些步骤创建可供客户用于登录或注册应用程序的用户流。

  1. 至少以外部 ID 用户流管理员身份登录到 Microsoft Entra 管理中心。

  2. 如果有权访问多个租户，请使用顶部菜单中的“设置”图标 ，切换到“目录 + 订阅”菜单中的客户租户。

  3. 浏览到“标识”>“外部标识”>“用户流”。

  4. 选择“+ 新建用户流”。

  5. 在“创建”页上执行以下操作：

    1. 为用户流输入名称，例如 SignInSignUpSample。

    2. 在“标识提供者”列表中，选择“电子邮件帐户”。 此标识提供者使用户能够使用其电子邮件地址登录或注册。

      注意

      只有在设置了与额外的标识提供者的联合身份验证之后，才会在此处列出这些标识提供者。 例如，如果设置了与 Google 或 Facebook 的联合身份验证，则能够在此处选择这些额外的标识提供者。

    3. 在“电子邮件帐户”下，可以选择两个选项之一。 对于本教程，请选择“电子邮件和密码”。

      • 电子邮件和密码：使新用户能够使用电子邮件地址作为登录名称并使用密码作为其第一重身份验证凭据进行注册和登录。

      • 电子邮件一次性密码：使新用户能够使用电子邮件地址作为登录名称并使用电子邮件一次性密码作为其第一重身份验证凭据进行注册和登录。

        注意

        只有在租户级别启用电子邮件一次性密码（“所有标识提供者”>“电子邮件一次性密码”），才能在用户流级别使用此选项。

    4. 在“用户属性”下，选择要在用户注册时收集的用户属性。 选择“显示更多内容”即可选择“国家/地区”、“显示名称”和“邮政编码”的属性和声明。 选择“确定” 。 （系统仅在用户首次注册时提示输入属性。）

  6. 选择“创建” 。 此时，新的用户流将显示在“用户流”列表中。 如果需要，请刷新页面。

若要启用自助式密码重置，请使用启用自助式密码重置一文中的步骤。

将 WPF 应用程序与用户流相关联

尽管许多应用程序可与用户流相关联，但单个应用程序只能与一个用户流相关联。 用户流允许为特定应用程序配置用户体验。 例如，可以配置一个要求用户使用电话号码或电子邮件地址登录或注册的用户流。

  1. 在边栏菜单中选择“标识”。

  2. 依次选择“外部标识”和“用户流”。

  3. 在“用户流”页中，选择之前创建的用户流名称，例如 SignInSignUpSample。

  4. 在“使用”下，选择“应用程序”。

  5. 选择“添加应用程序”。

  6. 从列表中选择应用程序（如 ciam-client-app），或使用搜索框查找应用程序，然后将其选中。

  7. 选择“选择”。

克隆或下载示例 WPF 应用程序

若要获取 WPF 桌面应用示例代码，可以执行以下任务之一：

  • 下载 zip 文件，或通过运行以下命令从 GitHub 克隆示例桌面应用程序：

        git clone https://github.com/Azure-Samples/ms-identity-ciam-dotnet-tutorial.git

如果选择下载 .zip 文件，请将示例应用文件提取到路径总长度不超过 260 个字符的文件夹。

配置示例 WPF 应用

  1. 在 IDE（如 Visual Studio 或 Visual Studio Code）中打开项目以配置代码。

  2. 在代码编辑器中，打开 ms-identity-ciam-dotnet-tutorial>1-Authentication>5-sign-in-dotnet-wpf 文件夹中的 appsettings.json 文件。

  3. 将 Enter_the_Application_Id_Here 替换为之前注册的应用的应用程序（客户端）ID。

  4. 将 Enter_the_Tenant_Subdomain_Here 替换为目录（租户）子域。 例如，如果主域为 contoso.onmicrosoft.com，请将 Enter_the_Tenant_Subdomain_Here 替换为 contoso。 如果没有主域，请了解如何读取租户详细信息。

运行和测试示例 WPF 桌面应用

  1. 打开控制台窗口，切换到包含 WPF 桌面示例应用的目录：

    cd 1-Authentication\5-sign-in-dotnet-wpf

  2. 在终端中，通过运行以下命令来运行应用：

    dotnet run

  3. 启动示例后，应会看到一个带有“登录”按钮的窗口。 选择“登录”按钮。

    Screenshot of sign-in screen for a WPF desktop application.

  4. 在登录页上，输入帐户电子邮件地址。 如果没有帐户，请选择“无帐户? 创建一个”，以启动注册流。 按照此流程创建新帐户并登录。

  5. 登录后，你将看到一个屏幕，显示登录成功以及存储在检索到的令牌中的用户帐户的基本信息。

    Screenshot of successful sign-in for desktop WPF app.

工作原理

公共客户端应用程序的主配置在 App.xaml.cs 文件中处理。 PublicClientApplication 会和缓存一起初始化，用于存储访问令牌。 应用程序将先检查是否存在可用于让用户登录的缓存令牌。 如果没有缓存的令牌，系统将提示用户提供凭据并登录。 退出登录后，将清除所有帐户的缓存和所有相应的访问令牌。

后续步骤

请参阅有关如何生成自己的 WPF 桌面应用以对用户进行身份验证的教程