你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

使用 Azure API 管理中的客户端证书身份验证确保后端服务安全

API 管理允许你使用客户端证书确保对 API 后端服务进行安全访问。 本指南介绍如何使用 Azure 门户在 Azure API 管理服务实例中管理证书。 它还说明了如何配置 API 以使用证书来访问后端服务。

你还可以使用 管理 REST API管理 API 管理证书。

证书选项

API 管理提供了两个选项来管理用于确保对后端服务进行安全访问的证书:

  • 引用 Azure Key Vault 中托管的证书
  • 直接在 API 管理中添加证书文件

建议使用密钥保管库证书,因为它有助于提高 API 管理安全性:

  • 密钥保管库中存储的证书可以在服务上重复使用
  • 粒度访问策略 可应用到密钥保管库中存储的证书
  • 密钥保管库中更新的证书会在 API 管理中自动轮换。 在密钥保管库中更新后,API 管理中的证书会在 4 小时内更新。 你还可以使用 Azure 门户或通过管理 REST API 手动刷新证书。

先决条件

注意

建议使用 Azure Az PowerShell 模块与 Azure 交互。 请参阅安装 Azure PowerShell 以开始使用。 若要了解如何迁移到 Az PowerShell 模块,请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az

  • 如果尚未创建 API 管理服务实例,请参阅创建 API 管理服务实例
  • 应将后端服务配置为进行客户端证书身份验证。 若要在 Azure 应用服务中配置证书身份验证,请参阅此文
  • 需要有权访问证书以及 Azure 密钥保管库中用于管理的密码,或上传到 API 管理服务。 证书必须采用 PFX 格式。 允许使用自签名证书。

密钥保管库集成的先决条件

  1. 有关创建密钥保管库的步骤,请参阅快速入门:使用 Azure 门户创建密钥保管库
  2. 在 API 管理实例中启用系统分配的或用户分配的托管标识
  3. 将一个密钥保管库访问策略分配给托管标识,该策略提供从保管库获取和列出机密的权限。 若要添加策略,请执行以下操作:
    1. 在门户中导航到你的密钥保管库。
    2. 选择“设置”>“访问策略”>“+添加访问策略”。
    3. 选择“机密权限”,然后选择“获取”和“列出”。
    4. 在“选择主体”中,选择你的托管标识的资源名称。 如果你使用系统分配的标识,则主体为你的 API 管理实例的名称。
  4. 创建证书或将证书导入到密钥保管库。 请参阅快速入门:使用 Azure 门户在 Azure Key Vault 中设置和检索证书
  5. 将密钥保管库证书添加到 API 管理实例时,必须有权列出密钥保管库中的机密。

Key Vault 防火墙要求

如果在密钥保管库上启用了 Key Vault 防火墙,则具有以下附加要求:

  • 必须使用 API 管理实例的“系统分配的”托管标识来访问密钥保管库。

  • 在 Key Vault 防火墙中,启用“允许受信任的 Microsoft 服务绕过此防火墙”选项。

  • 在选择要添加到 Azure API 管理的证书或机密时,请确保允许本地客户端 IP 地址临时访问密钥保管库。 有关详细信息,请参阅配置 Azure Key Vault 网络设置

    完成配置后,可以在密钥保管库防火墙中阻止客户端地址。

虚拟网络要求

如果 API 管理实例部署在虚拟网络中,则还应配置下列网络设置:

  • 在 API 管理子网上,启用 Azure Key Vault 的服务终结点
  • 配置一个网络安全组 (NSG) 规则,以允许指向 AzureKeyVault 和 AzureActiveDirectory 服务标记的出站流量。

有关详细信息,请参阅在 VNET 中设置 Azure API 管理时使用的网络配置

添加密钥保管库证书

请参阅密钥保管库集成的先决条件

注意

在 API 管理中使用密钥保管库证书时,请注意不要删除证书、密钥保管库或用于访问密钥保管库的托管标识。

将密钥保管库证书添加到 API 管理:

  1. Azure 门户,导航到 API 管理实例。

  2. 在“安全性”下,选择“证书” 。

  3. 选择“证书”>+ 添加” 。

  4. 在“Id”中,输入所选的名称。

  5. 在“证书”下,选择“密钥保管库” 。

  6. 输入密钥保管库证书的标识符,或选择“选择”来选择密钥保管库中的证书。

    重要

    如果你自己输入密钥保管库证书标识符,请确保它不包含版本信息。 否则,在密钥保管库中更新后,证书不会在 API 管理中自动轮换。

  7. 在“客户端标识”中,选择一个系统分配的托管标识,或一个现有的用户分配的托管标识。 了解如何在 API 管理服务中添加或修改托管标识

    注意

    标识需要从密钥保管库获取和列出证书的权限。 如果你尚未配置对密钥保管库的访问权限,则 API 管理会提示你,你可以让其自动为标识配置必要的权限。

  8. 选择 添加

    添加密钥保管库证书

  9. 选择“保存”。

上传证书

将客户端证书上传到 API 管理:

  1. Azure 门户,导航到 API 管理实例。

  2. 在“安全性”下,选择“证书” 。

  3. 选择“证书”>+ 添加” 。

  4. 在“Id”中,输入所选的名称。

  5. 在“证书”下,选择“自定义” 。

  6. 浏览以选择证书 .pfx 文件并输入其密码。

  7. 选择 添加

    上传客户端证书

  8. 选择“保存”。

证书上传后,会显示在“证书”窗口中。 如果有多个证书,请记下所需证书的指纹,以便将 API 配置为使用客户端证书进行网关身份验证

注意

若要在使用某个证书(例如自签名证书)时关闭证书链验证,请执行本文后面的自签名证书中描述的步骤。

将 API 配置为使用客户端证书进行网关身份验证

  1. Azure 门户,导航到 API 管理实例。

  2. 在“API”下选择“API” 。

  3. 从列表中选择 API。

  4. 在“设计”选项卡中,选择“后端”部分中的编辑器图标 。

  5. 在“网关凭据”中,选择“客户端证书”,然后从下拉列表中选择证书 。

  6. 选择“保存”。

    使用客户端证书进行网关身份验证

注意

此更改立即生效,对该 API 的操作进行调用时,会使用证书在后端服务器上进行身份验证。

提示

为 API 的后端服务指定证书进行网关身份验证时,此证书会成为该 API 策略的一部分,并可在策略编辑器中查看。

自签名证书

如果你使用的是自签名证书,则将需要禁用证书链验证,以便 API 管理与后端系统进行通信。 否则,它将返回 500 错误代码。 若要配置此项,可以使用 New-AzApiManagementBackend(适用于新后端)或 Set-AzApiManagementBackend(适用于现有后端)PowerShell cmdlet 并将 -SkipCertificateChainValidation 参数设置为 True

$context = New-AzApiManagementContext -resourcegroup 'ContosoResourceGroup' -servicename 'ContosoAPIMService'
New-AzApiManagementBackend -Context  $context -Url 'https://contoso.com/myapi' -Protocol http -SkipCertificateChainValidation $true

还可以使用后端 REST API 禁用证书链验证。

删除客户端证书

若要删除证书,请选择该证书,然后从上下文菜单 (...) 中选择“删除” 。

删除证书

重要

如果证书被某个策略引用,则会显示警告界面。 若要删除证书,必须先将证书从配置为使用该证书的策略中删除。

后续步骤