如何共用 OAuth 用戶端

本頁面說明如何與組織內的其他應用程式共用 OAuth 用戶端。

總覽

在專案之間共用 OAuth 用戶端,是指將單一自訂 OAuth 用戶端用於多個受 Identity-Aware Proxy (IAP) 保護的應用程式,而非為每個應用程式建立新的 OAuth 用戶端。這種做法可簡化管理作業,特別適合擁有多個應用程式的組織。

設定 IAP 時,您可以使用下列其中一種 OAuth 用戶端類型:

  • Google 代管的 OAuth 用戶端:IAP 預設會自動使用這個用戶端。這個內建選項不需要手動建立用戶端,但有兩項主要限制:

    • 僅允許貴組織內的使用者 (內部使用者) 存取

    • 在同意畫面上顯示 Google Cloud 品牌宣傳內容,而非貴機構的品牌宣傳內容

  • 自訂 OAuth 用戶端:由您自行建立及管理。這個選項:

    • 可與多個應用程式共用

    • 允許自訂同意畫面上的品牌宣傳

    • 支援外部使用者 (機構外人士) 存取

建立自訂 OAuth 用戶端時,您可以彈性地將其用於單一應用程式,或在多個應用程式之間共用。共用自訂 OAuth 用戶端有幾項優點:

  • 減少管理多個用戶端的管理負擔

  • 簡化為不應存取「憑證」頁面的團隊成員啟用 IAP 的程序

  • 可讓程式輔助 (非瀏覽器) 存取受 IAP 保護的應用程式

如要瞭解如何建立 OAuth 用戶端,請參閱「建立 IAP 的 OAuth 用戶端」。如要進一步瞭解 Google 代管的 OAuth 用戶端,請參閱「自訂 OAuth 設定以啟用 IAP」。

事前準備

完成建立 OAuth 用戶端中的步驟,建立新的 OAuth 用戶端,或使用現有的 OAuth 用戶端。

程式輔助存取機制

設定 OAuth 用戶端以程式輔助方式存取,允許非瀏覽器應用程式向受 IAP 保護的資源進行驗證。這樣一來,指令碼、自動化工作和後端服務就能安全存取受保護的應用程式,不需使用者互動式登入。

您可以在資源階層的任何層級套用這些驗證設定:組織、資料夾或專案。

如需實作步驟,請參閱程式輔助驗證指南和 IAP 設定管理說明文件。

gcloud

  1. 準備含有 OAuth 用戶端 ID 的設定檔:

    cat << EOF > SETTINGS_FILENAME
      access_settings:
        oauth_settings:
          programmatic_clients: [clientId1, clientId2, ..]
    EOF
    
  2. 使用 gcloud iap settings set 指令套用設定:

    gcloud iap settings set SETTINGS_FILENAME \
      [--organization=ORGANIZATION | --folder=FOLDER | --project=PROJECT] \
      [--resource-type=RESOURCE_TYPE] \
      [--service=SERVICE] \
      [--version=VERSION]
    

    指令範例:

    # Organization level
    gcloud iap settings set SETTINGS_FILENAME --organization=ORGANIZATION
    
    # Folder level
    gcloud iap settings set SETTINGS_FILENAME --folder=FOLDER
    
    # Project level (web resources)
    gcloud iap settings set SETTINGS_FILENAME \
      --project=PROJECT \
      --resource-type=iap_web
    
    # App Engine service in a project
    gcloud iap settings set SETTINGS_FILENAME \
      --project=PROJECT \
      --resource-type=app-engine \
      --service=SERVICE
    

    其中:

    • SETTINGS_FILENAME:您準備的 YAML 檔案。

    • ORGANIZATION:組織 ID

    • FOLDER:資料夾 ID

    • PROJECT:專案 ID

    • RESOURCE_TYPE:IAP 資源類型 (app-engine、iap_web、compute、organization 或 folder)

    • SERVICE:服務名稱 (compute 或 app-engine 資源類型可不填)

    • VERSION:版本名稱 (不適用於 compute,app-engine 則可選用)

API

  1. 準備設定 JSON 檔案:

    cat << EOF > iap_settings.json
    {
      "access_settings": {
        "oauth_settings": {
          programmatic_clients: [clientId1, clientId2, ..]
        }
      }
    }
    EOF
    
  2. 取得資源名稱:

    gcloud iap settings get \
      [--organization=ORGANIZATION | --folder=FOLDER | --project=PROJECT] \
      [--resource-type=RESOURCE_TYPE] \
      [--service=SERVICE] \
      [--version=VERSION]
    
  3. 使用資源名稱更新設定:

    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.oauthSettings.programmaticClients"
    

    其中:

    • ORGANIZATION:組織 ID

    • FOLDER:資料夾 ID

    • PROJECT:專案 ID

    • RESOURCE_TYPE:IAP 資源類型 (app-engine、iap_web、compute、organization 或 folder)

    • SERVICE:服務名稱 (compute 或 app-engine 資源類型可不填)

    • VERSION:版本名稱 (不適用於 compute,app-engine 則可選用)

設定完成後,請使用您設定的任一 OAuth 用戶端 ID 登入應用程式。詳情請參閱「程式輔助驗證」。

瀏覽器存取權

如要透過Google Cloud 控制台啟用 IAP,以便使用用戶端 ID 和密鑰,請完成下列操作說明:

風險

雖然在應用程式之間共用用戶端很方便,但也有風險。本節將概述共用用戶端時可能面臨的風險,以及如何降低這些風險。

單點故障

如果多個應用程式使用同一個 OAuth 用戶端,就會產生單一依附元件。如果用戶端遭到刪除或修改錯誤,所有使用該用戶端的應用程式都會受到影響。已刪除的 OAuth 用戶端可在 30 天內還原。

如要有效管理這項營運風險,請採取下列做法:

這主要是營運風險,而非安全風險。只要有適當的存取控管和監控機制,共用 OAuth 用戶端帶來的便利性和管理優勢,通常會大於這項考量。

用戶端密鑰外洩

如要共用用戶端,您必須與使用者和指令碼共用用戶端密鑰。 這會增加用戶端密鑰外洩的風險。IAP 無法區分由應用程式建立的權杖,以及由外洩用戶端密鑰建立的權杖。

如何降低這類風險:

  • 請像保護密碼一樣保護用戶端密鑰,切勿以純文字形式儲存

  • 使用 Secret Manager 實作安全憑證管理

  • 使用 Cloud 稽核記錄監控 IAP 資源的存取權

  • 用戶端密鑰外洩只會影響驗證,不會影響資源存取授權。如果懷疑密鑰外洩,請立即重設。

如要透過程式輔助方式存取受 IAP 保護的資源,建議使用服務帳戶 JWT 驗證,而非與個別使用者共用 OAuth 用戶端密鑰。這種做法可提供更完善的安全隔離,同時保有共用 OAuth 用戶端對應用程式的好處。

權限範圍注意事項

共用 OAuth 用戶端時,所有應用程式都會使用相同的權限範圍。如果是 IAP,openid 和 email 是唯一必要的範圍。這項考量本身並非重大風險,但請務必瞭解:

  • OAuth 僅用於 IAP 的驗證 (驗證身分);授權 (資源存取權) 則透過 IAM 政策另外處理

  • 即使驗證憑證遭到入侵,攻擊者仍須具備適當的 IAM 權限,才能存取受保護的資源

  • 將用戶端限制為僅限必要的 openid 和 email 範圍,有助於限制潛在的安全性影響