使用员工身份联合配置 IAP

本页介绍了如何配置 Identity-Aware Proxy (IAP) 以使用员工身份联合

使用 IAP 配置员工身份联合时,您可以使用外部身份提供方 (IdP) 通过 Identity and Access Management (IAM) 对员工(用户群组,例如员工、合作伙伴和承包商)进行身份验证和授权,以便用户能够安全地访问在 Google Cloud 或本地部署的服务。

通过使用员工身份联合配置 IAP,您可以针对通过 IAP 保护的应用执行以下操作:

  • 将最终用户重定向到外部 IdP(例如 Okta)进行登录。
  • 将登录会话配置为介于 15 分钟到 12 小时之间。
  • 仅允许身份提供程序中的特定最终用户或最终用户组访问您的应用。
  • 指定最终用户可以在哪些情境下访问应用。例如,仅允许在一天中的特定时间访问。

您可以在 IAP 支持的所有现有资源和负载平衡器上将 IAP 与员工身份联合搭配使用。

为应用使用员工身份联合配置 IAP

使用员工身份联合配置 IAP 包括以下主要任务:

  1. 设置员工池和提供方。
  2. 创建 OAuth 客户端 ID 和 Secret。
  3. 启用 IAP 并将其配置为使用员工身份联合。

设置员工池和提供方

如需设置员工身份池和提供方,请按照员工身份联合中的说明操作;在设置会话时长时,请参阅使用员工身份联合会话管理 IAP

如果您想将第三方 IdP 中的电子邮件地址映射到 Google Cloud,则必须在员工池提供方中为 google.email 添加属性映射。示例:google.email=assertion.email

创建 OAuth 客户端 ID 和 Secret

  1. 按照说明在与要用于此配置的员工池所属的组织相同的项目下创建 OAuth 客户端 ID 和密钥。该项目不一定与受 IAP 保护的资源所属的项目相同。创建 OAuth 客户端 ID 和 Secret 时,请执行以下操作:

    1. 创建客户端 ID 时,请为重定向 URI 使用占位符。创建客户端 ID 后,运行 describeOAuth 客户端以获取生成的 clientID

    2. 获取 clientID 后,运行 updateOAuth 客户端,将 allowed-redirect-uris 更新为以下内容:https://iap.googleapis.com/v1/oauth/clientIds/$CLIENT_ID:handleRedirect

      其中,CLIENT_ID 是在上一步中检索的 clientID

    3. 创建客户端密钥后,运行 describe OAuth 客户端凭据以获取生成的 clientSecret

    保存 clientIdclientSecret,因为您需要在后续步骤中使用它们。

允许 IAP 使用员工身份联合

控制台

  1. 在 Google Cloud 控制台中,打开 IAP 页面。
    前往 IAP 页面
  2. 选择一个项目。该项目必须与您之前创建的员工池位于同一组织中。该项目不必是您创建 OAuth 客户端 ID 和密钥的项目。
  3. 点击应用标签页,然后找到您要使用 IAP 限制其访问权限的应用。
  4. 在 IAP 列中,将开关切换为开启

gcloud

如需使用 gcloud CLI 启用 IAP,请按照适用服务的步骤操作:

API

  1. 创建 settings.json 文件。

    cat << EOF > settings.json
    {
    "iap":
      {
        "enabled":true,
     }
    }
    EOF
    
  2. 在 App Engine 上启用 IAP。

    curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d @settings.json \
    "https://appengine.googleapis.com/v1/apps/PROJECT_ID?updateMask=iap.enabled"
    

    如需在 Compute Engine 上启用 IAP,请使用以下网址:https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/REGION/backendServices/BACKEND_SERVICE_NAME?updateMask=iap.enabled

更新 IAP 设置

如需将 IAP 配置为使用员工身份联合,您必须配置以下设置:

  • WorkforceIdentitySettings:之前创建的 OAuth 客户端 ID 和密钥。
  • IdentitySources:身份来源。

如需了解详情,请参阅 IAP API

gcloud

  1. 以以下示例为参考,创建一个 iap_settings.yaml 文件。

    CLIENT_ID=clientId
    CLIENT_SECRET=clientSecret
    WORKFORCE_POOL_NAME=locations/global/workforcePools/test-pool
    cat <<EOF > iap_settings.yaml
    access_settings:
      identity_sources: ["WORKFORCE_IDENTITY_FEDERATION"]
      workforce_identity_settings:
        workforce_pools: ["$WORKFORCE_POOL_NAME"]
        oauth2:
          client_id: "$CLIENT_ID"
          client_secret: "$CLIENT_SECRET"
    EOF
    
  2. 运行以下命令以更新资源的 IAP 设置。

    gcloud iap settings set iap_settings.yaml --project=PROJECT --resource-type=RESOURCE_TYPE --service=SERVICE
    

    替换以下内容:

    • PROJECT:项目 ID。
    • RESOURCE_TYPE:IAP 资源类型。资源类型必须为 app-engineiap_webcomputeorganizationfolder
    • SERVICE:服务名称。app-enginecompute 的可选参数。

    如需详细了解该命令,请参阅 gcloud iap settings set

API

  1. 以以下示例为参考,创建 iap_settings.json 设置文件。

    CLIENT_ID=clientId
    CLIENT_SECRET=clientSecret
    WORKFORCE_POOL_NAME=locations/global/workforcePools/test-pool
    cat <<EOF > iap_settings.json
    {
       "access_settings": {
         "identity_sources": ["WORKFORCE_IDENTITY_FEDERATION"],
         "workforce_identity_settings": {
           "workforce_pools": ["$WORKFORCE_POOL_NAME"],
           "oauth2": {
             "client_id": "$CLIENT_ID",
             "client_secret": "$CLIENT_SECRET",
           }
        }
      }
    }
    EOF
    
  2. 使用 gcloud CLI 获取资源的名称,然后从输出中复制 RESOURCE_NAME,因为您在后续步骤中需要它。

    gcloud iap settings get \
        --project=PROJECT \
        --resource-type=RESOURCE_TYPE \
        --service=SERVICE
    

    替换以下内容:

    • PROJECT:项目 ID。
    • RESOURCE_TYPE:IAP 资源类型。资源类型必须为 app-engineiap_webcomputeorganizationfolder
    • SERVICE:服务名称。app-enginecompute 的可选参数。
  3. 将以下命令中的 RESOURCE_NAME 替换为上一步中的 RESOURCE_NAME

    curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -d @iap_settings.json \
    "https://iap.googleapis.com/v1/RESOURCE_NAME:iapSettings?updateMask=iapSettings.accessSettings.identitySources,iapSettings.accessSettings.workforceIdentitySettings.workforcePools,iapSettings.accessSettings.workforceIdentitySettings.oauth2.clientId,iapSettings.accessSettings.workforceIdentitySettings.oauth2.clientSecret" 
    

授予对受 IAP 保护的资源的访问权限

若要访问受 IAP 保护的资源,最终用户必须对该资源拥有 IAP-Secured Web App User 角色。您可以向单个用户(主账号)或一组用户(主账号组,映射到群组、特定属性或整个用户池)授予 IAP-Secured Web App User 角色。

不支持对受 IAP 保护的资源进行无限制访问。

控制台

  1. 在 Google Cloud 控制台中,打开 IAP 页面。
    前往 IAP 页面
  2. 选择要用 IAP 保护的资源。
  3. 点击添加主账号,然后添加您要为其授予某一资源 IAM 角色的群组或个人的主账号标识符
  4. 分配角色中,选择 IAP-Secured Web App User
  5. 点击添加

gcloud

运行以下命令:

gcloud iap web add-iam-policy-binding \
    --member=PRINCIPAL_IDENTIFIER \
    --role='roles/iap.httpsResourceAccessor' \
    --project=PROJECT_ID \
    --resource-type=RESOURCE_TYPE \
    --service=SERVICE \
    --condition=CONDITION

请替换以下内容:

  • PRINCIPAL_IDENTIFIER主要标识符
  • PROJECT_ID:项目 ID。
  • RESOURCE_TYPE:IAP 资源类型,可以是 app-enginebackend-services
  • SERVICE:(可选)服务名称。
  • CONDITION:(可选)IAM 条件。以下是使用访问权限级别配置的条件示例:
expression="accessPolicies/12345678/accessLevels/iap_test_access_level" in request.auth.access_levels,title=iap-test-access-level,description=only access in weekdays

API

不建议使用此方法,因为它会涉及资源的整个 IAM 政策。错误可能会导致政策从资源中移除。

  1. 获取现有 IAM 政策绑定。

    curl -X POST \
      -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
      -d {} \
    "https://iap.googleapis.com/v1/RESOURCE_NAME:getIamPolicy" -o iam_policy_bindings.json
    

    RESOURCE_NAME 替换为您在前面的步骤中获取的 RESOURCE_NAME

  2. 在您从上一步中获取的 iam_policy_bindings.json 文件中,移除版本和 etag 行,然后添加要为主账号标识符添加的绑定。如需了解详情,请参阅了解允许政策

    {
      "bindings": [
        {
          // existing bindings
        },
        {
          "role": "roles/iap.httpsResourceAccessor",
          "members": [
          "principal://iam.googleapis.com/locations/global/workforcePools/iap-test-pool/subject/iap-test-subject"
          ],
          "condition": {
            "expression": "\"accessPolicies/12345678/accessLevels/iap_test_access_level\" in request.auth.access_levels",
            "title": "iap-test-access-level",
            "description": "only access in week days"
          }
        }
      ]
    }
    
  3. 更新 IAM 政策绑定。

    curl -X POST \
      -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
      -d "{"policy":$(cat iam_policy_bindings.json)}" \
    "https://iap.googleapis.com/v1/RESOURCE_NAME:setIamPolicy"
    

    RESOURCE_NAME 替换为您在前面的步骤中获取的 RESOURCE_NAME

如需了解详情,请参阅 GetIamPolicySetIamPolicy

(可选)设置情境感知访问权限

(可选)您可以为高级授权设置情境感知访问权限规则。

如需设置访问权限级别,请参阅创建和应用访问权限级别。使用员工身份联合时,无法使用基于设备信息的访问权限级别。您仍然可以使用基于请求情境的访问权限级别,并设置 IP 地址、时间和日期条件。

使用员工池时的限制

  • 对于每个启用 IAP 的应用,只能配置一个员工池,并且员工池只能包含一个提供方。
  • 员工身份池、OAuth 客户端 ID 和密钥,以及启用了 IAP 的应用都必须位于同一组织中。
  • 不支持设备相关信息的访问权限级别。
  • 仅支持以下 IAP 设置配置:
  • 不支持使用员工身份联合进行程序化访问。