本文說明如何透過使用者帳戶或服務帳戶,驗證受 IAP 保護的資源。
程式輔助存取是指從非瀏覽器用戶端 (例如指令列工具、服務對服務呼叫和行動應用程式) 呼叫 IAP 保護的應用程式。視用途而定,您可能想使用使用者憑證或服務憑證向 IAP 進行驗證。
「使用者帳戶」屬於個別使用者。當您的應用程式需要代表使用者存取受 IAP 保護的資源時,您可以驗證使用者帳戶。詳情請參閱「使用者帳戶」。
「服務帳戶」代表應用程式,而非個別使用者。當您想讓應用程式存取受 IAP 保護的資源時,可以驗證服務帳戶。詳情請參閱服務帳戶。
IAP 支援下列類型的憑證,用於程式輔助存取:
- OAuth 2.0 ID 權杖 - Google 為使用者或服務帳戶核發的權杖,且目標對象聲明設定為 IAP 應用程式的資源 ID。
- 服務帳戶簽署的 JWT - 服務帳戶的自行簽署或 Google 發行的 JWT 權杖。
在要求的 Authorization 或 Proxy-Authorization HTTP 標頭中,將這些憑證傳送給 IAP。
事前準備
開始前,請確認您有受 IAP 保護的應用程式,且想使用開發人員帳戶、服務帳戶或行動應用程式憑證以程式化方式連線。
驗證使用者帳戶
您可以讓使用者從電腦或行動裝置存取您的應用程式,以讓程式與受 IAP 保護的資源互動。
透過行動應用程式驗證
- 為行動應用程式建立或使用現有的 OAuth 2.0 用戶端 ID。如要使用現有的 OAuth 2.0 用戶端 ID,請按照「如何共用 OAuth 用戶端」一文中的步驟操作。將 OAuth 用戶端 ID 新增至應用程式的程式輔助存取許可清單。
- 針對受 IAP 保護資源的 OAuth 2.0 用戶端 ID,取得 ID 符記。
- Android:使用 Google Sign-In API 要求 OpenID Connect (OIDC) 權杖。將
requestIdToken用戶端 ID 設為您將要連線的資源用戶端 ID。 - iOS:使用 Google 登入取得 ID 符記。
- Android:使用 Google Sign-In API 要求 OpenID Connect (OIDC) 權杖。將
- 將 ID 憑證包含在
Authorization: Bearer標頭中,以對受 IAP 保護的資源提出已驗證的要求。
透過電腦版應用程式驗證
本節說明如何透過電腦版指令列驗證使用者帳戶。
- 如要讓開發人員透過指令列存取應用程式,請建立 OAuth 2.0 電腦版用戶端 ID,或共用現有的 OAuth 電腦版用戶端 ID。
- 將 OAuth ID 加入應用程式的程式輔助存取許可清單。
登入應用程式
開發人員必須登入才能存取受 IAP 保護的應用程式。您可以將這個程序封裝到指令碼中,例如使用 gcloud CLI。以下範例使用 curl 登入並產生憑證,以便存取應用程式:
- 登入可存取 Google Cloud 資源的帳戶。
啟動本機伺服器,該伺服器可回應傳入的要求。
# Example using Netcat (http://netcat.sourceforge.net/) nc -k -l 4444前往下列 URI,其中
DESKTOP_CLIENT_ID是「Desktop app」(電腦應用程式) 用戶端 ID:https://accounts.google.com/o/oauth2/v2/auth?client_id=DESKTOP_CLIENT_ID&response_type=code&scope=openid%20email&access_type=offline&redirect_uri=http://localhost:4444&cred_ref=true在本機伺服器輸出內容中,找出要求參數:
GET /?code=CODE&scope=email%20openid%20https://www.googleapis.com/auth/userinfo.email&hd=google.com&prompt=consent HTTP/1.1複製 CODE 值,將下列指令中的 CODE 替換為該值,並一併提供桌面應用程式的用戶端 ID 和密鑰:
curl --verbose \ --data client_id=DESKTOP_CLIENT_ID \ --data client_secret=DESKTOP_CLIENT_SECRET \ --data code=CODE \ --data redirect_uri=http://localhost:4444 \ --data grant_type=authorization_code \ https://oauth2.googleapis.com/token這項指令會傳回具有
id_token欄位的 JSON 物件,您可以使用該欄位存取應用程式。
存取應用程式
如要存取應用程式,請使用 id_token:
curl --verbose --header 'Authorization: Bearer ID_TOKEN' URL
重新整理權杖
您可以使用登入流程中產生的更新權杖,取得新的 ID 權杖。如果原始 ID 權杖過期,這項功能就很有用。每個 ID 權杖的效期約為一小時,在此期間,您可以對特定應用程式提出多次要求。
下列範例使用 curl,透過更新權杖取得新的 ID 權杖。在本範例中,REFRESH_TOKEN 是登入流程中的權杖。DESKTOP_CLIENT_ID 和 DESKTOP_CLIENT_SECRET 與登入流程中使用的相同:
curl --verbose \
--data client_id=DESKTOP_CLIENT_ID \
--data client_secret=DESKTOP_CLIENT_SECRET \
--data refresh_token=REFRESH_TOKEN \
--data grant_type=refresh_token \
https://oauth2.googleapis.com/token
這項指令會傳回具有新 id_token 欄位的 JSON 物件,您可以使用該欄位存取應用程式。
驗證服務帳戶
您可以使用服務帳戶 JWT 或 OpenID Connect (OIDC) 權杖,向受 IAP 保護的資源驗證服務帳戶。下表列出不同驗證權杖及其功能的差異。
| 驗證功能 | 服務帳戶 JWT | OpenID Connect 權杖 |
|---|---|---|
| 情境感知存取權支援 | ||
| OAuth 2.0 用戶端 ID 規定 | ||
| 權杖範圍 | 受 IAP 保護的資源網址 | OAuth 2.0 用戶端 ID |
使用服務帳戶 JWT 進行驗證
IAP 支援 Google 身分、Identity Platform 和 Workforce Identity Federation 設定應用程式的服務帳戶 JWT 驗證。
使用 JWT 驗證服務帳戶的步驟如下:
將服務帳戶憑證建立者角色 (
roles/iam.serviceAccountTokenCreator) 授予呼叫服務帳戶。這個角色可授與主體建立 短期憑證 (例如 JWT) 的權限。
為受 IAP 保護的資源建立 JWT。
使用服務帳戶私密金鑰簽署 JWT。
建立 JWT
建立的 JWT 應具有類似下列範例的酬載:
{
"iss": SERVICE_ACCOUNT_EMAIL_ADDRESS,
"sub": SERVICE_ACCOUNT_EMAIL_ADDRESS,
"aud": TARGET_URL,
"iat": IAT,
"exp": EXP,
}
在
iss和sub欄位中,指定服務帳戶的電子郵件地址。電子郵件地址位於服務帳戶 JSON 檔案的client_email欄位中,或以輸入內容的形式提供。一般格式:service-account@PROJECT_ID.iam.gserviceaccount.com在
aud欄位中,指定確切網址或含有路徑萬用字元 (/*) 的網址,例如https://example.com/或https://example.com/*。如果 JWT 的aud欄位包含確切網址,就只能存取該網址。如果 JWT 的aud欄位含有路徑萬用字元 (/*),則可存取所有以aud字串為前置字元的網址,但結尾不得有*。針對
iat欄位,請指定目前的 Unix Epoch 時間;針對exp欄位,請指定 3600 秒內的時間。這會定義 JWT 的到期時間。
簽署 JWT
您可以使用下列任一方法簽署 JWT:
- 使用 IAM 憑證 API 簽署 JWT,不必直接存取私密金鑰。
- 使用本機憑證金鑰檔案在本機簽署 JWT。
使用 IAM 服務帳戶憑證 API 簽署 JWT
使用 IAM 服務帳戶憑證 API 簽署服務帳戶 JWT。這個方法會擷取與服務帳戶相關聯的私密金鑰,並使用該金鑰簽署 JWT 酬載。這樣一來,您不必直接存取私密金鑰,就能簽署 JWT。
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
gcloud
- 執行下列指令,使用 JWT 酬載準備要求:
cat > claim.json << EOM
{
"iss": "SERVICE_ACCOUNT_EMAIL_ADDRESS",
"sub": "SERVICE_ACCOUNT_EMAIL_ADDRESS",
"aud": "TARGET_URL",
"iat": $(date +%s),
"exp": $((`date +%s` + 3600))
}
EOM
- 使用下列 Google Cloud CLI 指令,在
claim.json中簽署酬載:
gcloud iam service-accounts sign-jwt --iam-account="SERVICE_ACCOUNT_EMAIL_ADDRESS" claim.json output.jwt
要求成功後,output.jwt 會包含已簽署的 JWT,可用於存取受 IAP 保護的資源。
Python
import datetime
import json
import google.auth
from google.cloud import iam_credentials_v1
def generate_jwt_payload(service_account_email: str, resource_url: str) -> str:
"""Generates JWT payload for service account.
Creates a properly formatted JWT payload with standard claims (iss, sub,
aud, iat, exp) needed for IAP authentication.
Args:
service_account_email (str): Specifies the service account that the
JWT is created for.
resource_url (str): Specifies the scope of the JWT, the URL that the
JWT will be allowed to access.
Returns:
str: JSON string containing the JWT payload with properly formatted
claims.
"""
# Create current time and expiration time (1 hour later) in UTC
iat = datetime.datetime.now(tz=datetime.timezone.utc)
exp = iat + datetime.timedelta(seconds=3600)
# Convert datetime objects to numeric timestamps (seconds since epoch)
# as required by JWT standard (RFC 7519)
payload = {
"iss": service_account_email,
"sub": service_account_email,
"aud": resource_url,
"iat": int(iat.timestamp()),
"exp": int(exp.timestamp()),
}
return json.dumps(payload)
def sign_jwt(target_sa: str, resource_url: str) -> str:
"""Signs JWT payload using ADC and IAM credentials API.
Uses Google Cloud's IAM Credentials API to sign a JWT. This requires the
caller to have iap.webServiceVersions.accessViaIap permission on the
target service account.
Args:
target_sa (str): Service Account JWT is being created for.
iap.webServiceVersions.accessViaIap permission is required.
resource_url (str): Audience of the JWT and scope of the JWT token.
This is the URL of the IAP-secured application.
Returns:
str: A signed JWT that can be used to access IAP-secured applications.
Use in Authorization header as: 'Bearer <signed_jwt>'
"""
# Get default credentials from environment or application credentials
source_credentials, project_id = google.auth.default()
# Initialize IAM credentials client with source credentials
iam_client = iam_credentials_v1.IAMCredentialsClient(credentials=source_credentials)
# Generate the service account resource name.
# Project should always be "-".
# Replacing the wildcard character with a project ID is invalid.
name = iam_client.service_account_path("-", target_sa)
# Create and sign the JWT payload
payload = generate_jwt_payload(target_sa, resource_url)
# Sign the JWT using the IAM credentials API
response = iam_client.sign_jwt(name=name, payload=payload)
return response.signed_jwt
curl
執行下列指令,準備含有 JWT 酬載的要求:
cat << EOF > request.json { "payload": JWT_PAYLOAD } EOF使用 IAM 簽署 JWT
Service Account Credentials API:
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/SERVICE_ACCOUNT_EMAIL_ADDRESS:signJwt"要求成功後,回應中會傳回已簽署的 JWT。
使用 JWT 存取受 IAP 保護的資源。
從本機憑證金鑰檔案簽署 JWT
JWT 會使用服務帳戶的私密金鑰簽署。
如果您有服務帳戶金鑰檔案,則可在本機簽署 JWT。
在本地簽署 JWT 時,請在酬載中加入 JWT 標頭。如要使用標頭中的 kid 欄位,請使用服務帳戶的私密金鑰 ID,該 ID 位於服務帳戶憑證 JSON 檔案的 private_key_id 欄位中。檔案中的私密金鑰會用來簽署 JWT。
存取應用程式
如要存取應用程式,請在 Authorization 標頭中加入已簽署的 JWT:
curl --verbose --header 'Authorization: Bearer SIGNED_JWT' URL
使用服務帳戶 OIDC 權杖進行驗證
- 建立或使用現有的 OAuth 2.0 用戶端 ID。如要使用現有的 OAuth 2.0 用戶端 ID,請按照「如何共用 OAuth 用戶端」一文中的步驟操作。
- 將 OAuth ID 加入應用程式的程式輔助存取許可清單。
- 確認預設服務帳戶已新增至受 IAP 保護專案的存取清單。
向受 IAP 保護的資源提出要求時,您必須在 Authorization 標頭中加入權杖:Authorization: 'Bearer OIDC_TOKEN'
下列程式碼範例說明如何取得 OIDC 權杖。
取得預設服務帳戶的 OIDC 權杖
如要取得 Compute Engine、App Engine 或 Cloud Run 預設服務帳戶的 OIDC 權杖,請參考下列程式碼範例產生權杖,以存取受 IAP 保護的資源:
C#
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Go
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Java
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Node.js
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
PHP
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Python
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
Ruby
如要向 IAP 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
從本機服務帳戶金鑰檔案取得 OIDC 權杖
如要使用服務帳戶金鑰檔案產生 OIDC 權杖,請使用金鑰檔案建立並簽署 JWT 聲明,然後將該聲明換成 ID 權杖。下列 Bash 指令碼示範了這個程序:
Bash
#!/usr/bin/env bash
#
# Example script that generates an OIDC token using a service account key file and uses it to access an IAP-secured resource.
set -euo pipefail
get_token() {
# Get the bearer token in exchange for the service account credentials
local service_account_key_file_path="${1}"
local iap_client_id="${2}"
# Define the scope and token endpoint
local iam_scope="https://www.googleapis.com/auth/iam"
local oauth_token_uri="https://www.googleapis.com/oauth2/v4/token"
# Extract data from service account key file
local private_key_id="$(cat "${service_account_key_file_path}" | jq -r '.private_key_id')"
local client_email="$(cat "${service_account_key_file_path}" | jq -r '.client_email')"
local private_key="$(cat "${service_account_key_file_path}" | jq -r '.private_key')"
# Set token timestamps (current time and expiration 10 minutes later)
local issued_at="$(date +%s)"
local expires_at="$((issued_at + 600))"
# Create JWT header and payload
local header="{'alg':'RS256','typ':'JWT','kid':'${private_key_id}'}"
local header_base64="$(echo "${header}" | base64 | tr -d '\n')"
local payload="{'iss':'${client_email}','aud':'${oauth_token_uri}','exp':${expires_at},'iat':${issued_at},'sub':'${client_email}','target_audience':'${iap_client_id}'}"
local payload_base64="$(echo "${payload}" | base64 | tr -d '\n')"
# Create JWT signature using the private key
local signature_base64="$(printf %s "${header_base64}.${payload_base64}" | openssl dgst -binary -sha256 -sign <(printf '%s\n' "${private_key}") | base64 | tr -d '\n')"
local assertion="${header_base64}.${payload_base64}.${signature_base64}"
# Exchange the signed JWT assertion for an ID token
local token_payload="$(curl -s \
--data-urlencode "grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer" \
--data-urlencode "assertion=${assertion}" \
https://www.googleapis.com/oauth2/v4/token)"
# Extract just the ID token from the response
local bearer_id_token="$(echo "${token_payload}" | jq -r '.id_token')"
echo "${bearer_id_token}"
}
main() {
# Check if required arguments are provided
if [[ $# -lt 3 ]]; then
echo "Usage: $0 <service_account_key_file.json> <iap_client_id> <url>"
exit 1
fi
# Assign parameters to variables
SERVICE_ACCOUNT_KEY="$1"
IAP_CLIENT_ID="$2"
URL="$3"
# Generate the ID token
echo "Generating token..."
ID_TOKEN=$(get_token "${SERVICE_ACCOUNT_KEY}" "${IAP_CLIENT_ID}")
# Access the IAP-secured resource with the token
echo "Accessing: ${URL}"
curl --header "Authorization: Bearer ${ID_TOKEN}" "${URL}"
}
# Run the main function with all provided arguments
main "$@"
這段指令碼會執行下列步驟:
- 從 JSON 金鑰檔案中擷取服務帳戶金鑰資訊
- 建立含有必要欄位的 JWT,包括做為目標對象的 IAP 用戶端 ID
- 使用服務帳戶的私密金鑰簽署 JWT
- 透過 Google 的 OAuth 服務,將這個 JWT 交換為 OIDC 權杖
- 使用產生的權杖,對受 IAP 保護的資源提出已驗證的要求
如何使用這個指令碼:
- 將其儲存至檔案,例如:
get_iap_token.sh - 將其設為可執行:
chmod +x get_iap_token.sh - 使用三個參數執行:
./get_iap_token.sh service-account-key.json \
OAUTH_CLIENT_ID \
URL
其中:
service-account-key.json是您下載的服務帳戶金鑰檔案- OAUTH_CLIENT_ID 是受 IAP 保護資源的 OAuth 用戶端 ID
- URL 是您要存取的網址
使用服務帳戶模擬功能取得 OIDC 權杖
在所有其他情況下,請使用 IAM 憑證 API,在存取受 IAP 保護的資源之前,先模擬目標服務帳戶,產生 OIDC 權杖。這項程序包含下列步驟:
為呼叫服務帳戶 (與取得 ID 權杖的程式碼相關聯的服務帳戶) 提供「服務帳戶 OpenID Connect 身分識別權杖建立者」角色 (
roles/iam.serviceAccountOpenIdTokenCreator)。這項權限可讓呼叫服務帳戶模擬目標服務帳戶。
使用呼叫服務帳戶提供的憑證,在目標服務帳戶上呼叫 generateIdToken 方法。
將
audience欄位設為您的用戶端 ID。
如需逐步操作說明,請參閱「建立 ID 權杖」。
透過 Proxy-Authorization 標頭驗證
如果應用程式使用 Authorization 要求標頭,您可以改為在 Proxy-Authorization: Bearer 標頭中加入 ID 權杖。如果 IAP 在 Proxy-Authorization 標頭中找到有效的 ID 權杖,就會使用該權杖授權要求。授權要求後,IAP 會將 Authorization 標頭傳遞至應用程式,但不會處理內容。
如果在 Proxy-Authorization 標頭中找不到有效的 ID 權杖,IAP 會繼續處理 Authorization 標頭,並在將要求傳遞至應用程式之前,先移除 Proxy-Authorization 標頭。
後續步驟
- 進一步瞭解 授權:不記名憑證。
- 測試 登入功能在 Android 應用程式的運作效果 或 登入功能在 iOS 應用程式的運作效果。