概述
本文介绍如何生成使用 AD FS 进行 OpenID connect 登录的应用。 但是,在默认情况下,id_token 中只提供一组固定的声明。 AD FS 2016 及更高版本可在 OpenID Connect 方案中自定义 id_token。
何时使用自定义 ID 令牌?
在某些情况下,客户端应用程序可能没有要尝试访问的资源。 因此,它并不真正需要访问令牌。 在这种情况下,客户端应用程序实质上只需要一个 ID 令牌,但有一些其他声明可帮助提供此功能。
在 ID 令牌中获取自定义声明有哪些限制?
方案 1
显示方案1的屏幕截图,其中使用的是与客户端 d 相同的信赖方 D。
response_mode设置为form_post- 只有公用客户端才能获取 ID 令牌中的自定义声明
- (Web API 标识符) 的信赖方标识符应与客户端标识符相同
方案 2
显示使用 allatclaims 范围的方案2的屏幕截图。
在 AD FS 服务器上安装 KB4019472 或更高版本的安全更新
response_mode设置为 form_post- 公共和机密客户端都可以在 ID 令牌中获取自定义声明
- 将作用域分配
allatclaims到客户端– RP 配对。
可以按照 Grant-ADFSApplicationPermission 以下示例中所示,使用 cmdlet 来分配作用域:
Grant-AdfsApplicationPermission -ClientRoleIdentifier "https://my/privateclient" -ServerRoleIdentifier "https://rp/fedpassive" -ScopeNames "allatclaims","openid"
创建和配置 OAuth 应用程序以处理 ID 令牌中的自定义声明
按照以下步骤,在用于接收 ID 令牌的 AD FS 中创建和配置应用程序,并提供自定义声明。
在 AD FS 2016 或更高版本中创建和配置应用程序组
-
在 AD FS 管理 "中,右键单击" 应用程序组 ",然后选择" 添加应用程序组"。
-
在应用程序组向导上的 "输入 ADFSSSO " 和 "Client-Server 应用程序" 下,选择 本机应用程序访问 web 应用程序 模板。 单击“下一步” 。
"添加应用程序组向导" 的 "欢迎使用" 页的屏幕截图。
-
复制 " 客户端标识符 " 值。 它稍后将用作应用程序 web.config 文件中的 ida: ClientId 的值。
-
对于 "重定向 URI",请输入以下内容: - https://localhost:44320/ 。 单击“添加”。 单击“下一步” 。
"添加应用程序组向导" 的 "本机应用程序" 页的屏幕截图,显示 "重定向 U R I"。
-
在 "配置 WEB API " 屏幕上,输入以下 标识符作为标识符 - https://contoso.com/WebApp 。 单击“添加”。 单击“下一步” 。 稍后会将此值用于应用程序 web.config 文件中的 ida: ResourceID 。
"添加应用程序组" 向导的 "配置 Web API" 页的屏幕截图,其中显示了正确的标识符。
-
在 " 选择访问控制策略 " 屏幕上,选择 " 允许每个人 " 并单击 " 下一步"
"添加应用程序组向导" 的 "选择访问控制策略" 页的屏幕截图,显示突出显示 "允许所有人" 选项。
-
在 " 配置应用程序权限 " 屏幕上,确保已选中 " openid and allatclaims ",然后单击 " 下一步"。
"添加应用程序组" 向导的 "配置应用程序权限" 页的屏幕截图。
-
在 " 摘要 " 屏幕上,单击 " 下一步"。
"添加应用程序组" 向导的 "摘要" 页的屏幕截图。
-
在 " 完成 " 屏幕上,单击 " 关闭"。
-
在 AD FS 管理 "中,单击" 应用程序组 "以获取所有应用程序组的列表。 右键单击 ADFSSSO ,然后选择 " 属性"。 选择 ADFSSSO-WEB API ,然后单击 "编辑 ... "
显示 "应用程序" 部分中列出的 Web API 的 "D F S S O 属性" 对话框的屏幕截图。
-
在 ADFSSSO-WEB API 属性 屏幕上,选择 "颁发转换规则" 选项卡,然后单击 "添加规则 ... "
显示 "颁发转换规则" 选项卡的 "D F S S O 属性" 对话框的屏幕截图。
-
在 "添加转换声明规则向导" 屏幕上,从下拉菜单中选择 "使用自定义规则发送声明",然后单击 "下一步"
"添加转换声明规则向导" 的 "选择规则模板" 页的屏幕截图,其中选择了 "使用自定义规则发送声明" 选项。
-
在 "添加转换声明规则" 向导 屏幕上,在 "声明规则名称" 中输入 ForCustomIDToken ,并在 自定义规则 中输入以下声明规则。 单击“完成”
x:[] => issue(claim=x);"添加转换声明规则" 向导的 "配置规则" 页的屏幕截图,其中显示了 "声明规则名称" 和 "自定义规则文本" 字段填充。
NOTE 你还可以使用 PowerShell 来分配
allatclaims和openid作用域。Grant-AdfsApplicationPermission -ClientRoleIdentifier "[Client ID from #3 above]" -ServerRoleIdentifier "[Identifier from #5 above]" -ScopeNames "allatclaims","openid"
下载并修改示例应用程序,以便在 id_token 中发出自定义声明
本部分介绍如何在 Visual Studio 中下载示例 Web 应用并对其进行修改。 我们将使用 此处的 Azure AD 示例。
若要下载示例项目,请使用 Git Bash,并键入以下内容:
git clone https://github.com/Azure-Samples/active-directory-aspnetcore-webapp-openidconnect-v2/tree/master/1-WebApp-OIDC
Git Bash 窗口的屏幕截图,其中显示了 git clone 命令的结果。
修改应用程序
-
使用 Visual Studio 打开示例。
-
重新生成应用,以便还原所有缺少的 NuGet 包。
-
打开 web.config 文件。 修改以下值,使其类似于以下内容:
<add key="ida:ClientId" value="[Replace this Client Id from #3 above under section Create and configure an Application Group in AD FS 2016 or later]" /> <add key="ida:ResourceID" value="[Replace this with the Web API Identifier from #5 above]" /> <add key="ida:ADFSDiscoveryDoc" value="https://[Your ADFS hostname]/adfs/.well-known/openid-configuration" /> <!--<add key="ida:Tenant" value="[Enter tenant name, e.g. contoso.onmicrosoft.com]" /> <add key="ida:AADInstance" value="https://login.microsoftonline.com/{0}" />--> <add key="ida:PostLogoutRedirectUri" value="[Replace this with the Redirect URI from #4 above]" />显示修改后的值的 web 配置文件的屏幕截图。
-
打开 Startup.Auth.cs 文件并进行以下更改:
-
调整 OpenId Connect 中间件初始化逻辑,并进行以下更改:
private static string clientId = ConfigurationManager.AppSettings["ida:ClientId"]; //private static string aadInstance = ConfigurationManager.AppSettings["ida:AADInstance"]; //private static string tenant = ConfigurationManager.AppSettings["ida:Tenant"]; private static string metadataAddress = ConfigurationManager.AppSettings["ida:ADFSDiscoveryDoc"]; private static string resourceId = ConfigurationManager.AppSettings["ida:ResourceID"]; private static string postLogoutRedirectUri = ConfigurationManager.AppSettings["ida:PostLogoutRedirectUri"]; -
注释掉以下内容:
//string Authority = String.Format(CultureInfo.InvariantCulture, aadInstance, tenant);显示注释掉的代码行的启动身份验证文件屏幕截图。
-
再往下修改 OpenId Connect 中间件选项,如下所示:
app.UseOpenIdConnectAuthentication( new OpenIdConnectAuthenticationOptions { ClientId = clientId, //Authority = authority, Resource = resourceId, MetadataAddress = metadataAddress, PostLogoutRedirectUri = postLogoutRedirectUri, RedirectUri = postLogoutRedirectUri启动身份验证文件的屏幕截图,其中显示了已修改的打开 I D Connect 中间件选项。
-
-
打开 HomeController.cs 文件并进行以下更改:
-
添加以下内容:
using System.Security.Claims; -
更新
About()方法,如下所示:[Authorize] public ActionResult About() { ClaimsPrincipal cp = ClaimsPrincipal.Current; string userName = cp.FindFirst(ClaimTypes.WindowsAccountName).Value; ViewBag.Message = String.Format("Hello {0}!", userName); return View(); }带有未获知更新的主控制器文件的屏幕截图。
-
在 ID 令牌中测试自定义声明
进行上述更改后,按 F5。 这将显示示例页。 单击 "登录"。
浏览器中显示的示例应用程序的屏幕截图。
你将被重定向到 AD FS 登录页。 继续登录。
D F S 登录页的屏幕截图。
成功后,你应该会看到你现在已登录。
显示用户已登录的示例应用程序的屏幕截图。
单击“关于”链接。 你将看到 "Hello [Username]",它从 ID 令牌中的用户名声明检索
示例应用中的 "关于" 页的屏幕截图。
后续步骤
历史资料。此文对应 2021-03-23 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 anandyadavmsft)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体、发布器占位标签和导航标记。
