如果您使用 Google 登入與與後端通訊的應用程式或網站 您可能需要在伺服器上找出目前登入的使用者。 為了安全執行這項作業,請在使用者成功登入後,將 ID 權杖傳送至您的伺服器接著,在伺服器上驗證完整性 並使用權杖內的使用者資訊建立 建立工作階段或建立新帳戶。
將 ID 權杖傳送至伺服器
使用者成功登入後,取得使用者的 ID 權杖:
function onSignIn(googleUser) { var id_token = googleUser.getAuthResponse().id_token; ... }
然後,使用 HTTPS POST 要求將 ID 權杖傳送至伺服器:
var xhr = new XMLHttpRequest(); xhr.open('POST', 'https://yourbackend.example.com/tokensignin'); xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded'); xhr.onload = function() { console.log('Signed in as: ' + xhr.responseText); }; xhr.send('idtoken=' + id_token);
驗證 ID 權杖的完整性
透過 HTTPS POST 收到 ID 權杖後,必須驗證完整性 符記
如需验证令牌是否有效,请确保满足以下条件:
- ID 令牌已由 Google 正确签名。使用 Google 的公钥(以 JWK 或 PEM 格式提供)验证令牌的签名。这些密钥会定期轮换;请检查响应中的
Cache-Control标头,以确定何时应再次检索这些密钥。 - ID 令牌中的
aud值等于您应用的某个客户端 ID。此检查是必要的,可防止向恶意应用发放的 ID 令牌被用于访问您应用后端服务器上有关同一用户的数据。 - ID 令牌中
iss的值等于accounts.google.com或https://accounts.google.com。 - ID 令牌的到期时间 (
exp) 尚未到期。 - 如果您需要验证 ID 令牌是否代表 Google Workspace 或 Cloud 组织账号,可以检查
hd声明,该声明表示用户的托管网域。如果需要将对资源的访问权限限制为仅限特定网域的成员,则必须使用此方法。如果缺少此声明,则表示相应账号不属于 Google 托管网域。
通过使用 email、email_verified 和 hd 字段,您可以确定 Google 是否托管某个电子邮件地址并对其具有权威性。如果 Google 是权威方,则表示用户是合法的账号所有者,您可以跳过密码或其他身份验证方法。
Google 具有权威性的情况:
email带有@gmail.com后缀,则表示这是 Gmail 账号。email_verified为 true 且设置了hd,则为 Google Workspace 账号。
用户可以注册 Google 账号,而无需使用 Gmail 或 Google Workspace。如果 email 不包含 @gmail.com 后缀且 hd 不存在,则 Google 不具有权威性,建议使用密码或其他质询方法来验证用户身份。email_verified 也可能为 true,因为 Google 最初在创建 Google 账号时验证了用户身份,但第三方电子邮件账号的所有权可能已发生变化。
我们强烈建议您使用适用于您平台的 Google API 客户端库或通用 JWT 库,而不是自行编写代码来执行这些验证步骤。对于开发和调试,您可以调用我们的 tokeninfo 验证端点。
使用 Google API 用戶端程式庫
使用其中一個 Google API 用戶端程式庫 (例如 Java、 Node.js、 PHP、 Python) 是在正式環境中驗證 Google ID 權杖的建議做法。
如要在 Java 中驗證 ID 符記,請使用 GoogleIdTokenVerifier物件。例如:
import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken; import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload; import com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier; ... GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory) // Specify the WEB_CLIENT_ID of the app that accesses the backend: .setAudience(Collections.singletonList(WEB_CLIENT_ID)) // Or, if multiple clients access the backend: //.setAudience(Arrays.asList(WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3)) .build(); // (Receive idTokenString by HTTPS POST) GoogleIdToken idToken = verifier.verify(idTokenString); if (idToken != null) { Payload payload = idToken.getPayload(); // Print user identifier. This ID is unique to each Google Account, making it suitable for // use as a primary key during account lookup. Email is not a good choice because it can be // changed by the user. String userId = payload.getSubject(); System.out.println("User ID: " + userId); // Get profile information from payload String email = payload.getEmail(); boolean emailVerified = Boolean.valueOf(payload.getEmailVerified()); String name = (String) payload.get("name"); String pictureUrl = (String) payload.get("picture"); String locale = (String) payload.get("locale"); String familyName = (String) payload.get("family_name"); String givenName = (String) payload.get("given_name"); // Use or store profile information // ... } else { System.out.println("Invalid ID token."); }
GoogleIdTokenVerifier.verify() 方法會驗證 JWT
簽章、aud 宣告、iss 憑證和
exp著作權聲明。
如需驗證 ID 權杖是否代表 Google Workspace 或 Cloud
機構帳戶,您可以藉由檢查網域名稱來驗證 hd 擁有權聲明
是由 Payload.getHostedDomain() 方法傳回的。網域
email 憑證附加資訊不足以確保帳戶是由網域管理
或機構
如要透過 Node.js 驗證 ID 權杖,請使用 Node.js 適用的 Google 驗證程式庫。 安裝程式庫:
npm install google-auth-library --save
verifyIdToken() 函式。例如:
const {OAuth2Client} = require('google-auth-library'); const client = new OAuth2Client(); async function verify() { const ticket = await client.verifyIdToken({ idToken: token, audience: WEB_CLIENT_ID, // Specify the WEB_CLIENT_ID of the app that accesses the backend // Or, if multiple clients access the backend: //[WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3] }); const payload = ticket.getPayload(); // This ID is unique to each Google Account, making it suitable for use as a primary key // during account lookup. Email is not a good choice because it can be changed by the user. const userid = payload['sub']; // If the request specified a Google Workspace domain: // const domain = payload['hd']; } verify().catch(console.error);
verifyIdToken 函式會驗證
JWT 簽名、aud 憑證附加資訊、exp 憑證附加資訊
和 iss 聲明
如需驗證 ID 權杖是否代表 Google Workspace 或 Cloud
機構帳戶,您可以檢查 hd 憑證附加資訊,也就是
使用者的網域將資源存取權授予僅限成員時,就必須使用這個引數
無法歸類到特定網域沒有出現這項聲明,表示帳戶不屬於該帳戶所有
Google 代管的網域
如要在 PHP 中驗證 ID 符記,請使用 PHP 適用的 Google API 用戶端程式庫。 安裝程式庫 (例如使用 Composer):
composer require google/apiclient
verifyIdToken() 函式。例如:
require_once 'vendor/autoload.php'; // Get $id_token via HTTPS POST. $client = new Google_Client(['client_id' => $WEB_CLIENT_ID]); // Specify the WEB_CLIENT_ID of the app that accesses the backend $payload = $client->verifyIdToken($id_token); if ($payload) { // This ID is unique to each Google Account, making it suitable for use as a primary key // during account lookup. Email is not a good choice because it can be changed by the user. $userid = $payload['sub']; // If the request specified a Google Workspace domain //$domain = $payload['hd']; } else { // Invalid ID token }
verifyIdToken 函式會驗證
JWT 簽名、aud 憑證附加資訊、exp 憑證附加資訊
和 iss 聲明
如需驗證 ID 權杖是否代表 Google Workspace 或 Cloud
機構帳戶,您可以檢查 hd 憑證附加資訊,也就是
使用者的網域將資源存取權授予僅限成員時,就必須使用這個引數
無法歸類到特定網域沒有出現這項聲明,表示帳戶不屬於該帳戶所有
Google 代管的網域
如要在 Python 中驗證 ID 符記,請使用 verify_oauth2_token 函式。例如:
from google.oauth2 import id_token from google.auth.transport import requests # (Receive token by HTTPS POST) # ... try: # Specify the WEB_CLIENT_ID of the app that accesses the backend: idinfo = id_token.verify_oauth2_token(token, requests.Request(), WEB_CLIENT_ID) # Or, if multiple clients access the backend server: # idinfo = id_token.verify_oauth2_token(token, requests.Request()) # if idinfo['aud'] not in [WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3]: # raise ValueError('Could not verify audience.') # If the request specified a Google Workspace domain # if idinfo['hd'] != DOMAIN_NAME: # raise ValueError('Wrong domain name.') # ID token is valid. Get the user's Google Account ID from the decoded token. # This ID is unique to each Google Account, making it suitable for use as a primary key # during account lookup. Email is not a good choice because it can be changed by the user. userid = idinfo['sub'] except ValueError: # Invalid token pass
verify_oauth2_token 函式會驗證 JWT
簽章、aud 聲明和 exp 聲明。
並驗證hd
來識別請求 (如果適用的話) 來檢查
會傳回 verify_oauth2_token。如果多位用戶端存取
後端伺服器,也手動驗證 aud 憑證附加資訊。
呼叫 tokeninfo 端點
驗證 ID 權杖簽名以進行偵錯的簡單方式,是
使用 tokeninfo 端點呼叫這個端點涉及
額外的網路要求,這類要求會對您進行大部分的驗證,
導入自己的 AI 程式碼驗證和酬載擷取機制。不適合用於正式環境
因為要求可能會受到節流限制
或以其他方式造成間歇性錯誤
如要使用 tokeninfo 端點驗證 ID 權杖,請進行 HTTPS
將 POST 或 GET 要求傳送至端點,並在
id_token 參數。
舉例來說,如要驗證權杖「XYZ123」,請提出下列 GET 要求:
https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123
如果權杖已正確簽署,且 iss 和 exp
和 宣告的預期值相符,您會收到 HTTP 200 回應,
包含 JSON 格式的 ID 符記憑證附加資訊。
回應範例如下:
{
// These six fields are included in all Google ID Tokens.
"iss": "https://accounts.google.com",
"sub": "110169484474386276334",
"azp": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
"aud": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
"iat": "1433978353",
"exp": "1433981953",
// These seven fields are only included when the user has granted the "profile" and
// "email" OAuth scopes to the application.
"email": "testuser@gmail.com",
"email_verified": "true",
"name" : "Test User",
"picture": "https://lh4.googleusercontent.com/-kYgzyAWpZzJ/ABCDEFGHI/AAAJKLMNOP/tIXL9Ir44LE/s99-c/photo.jpg",
"given_name": "Test",
"family_name": "User",
"locale": "en"
}
如需驗證 ID 權杖是否代表 Google Workspace 帳戶,可以檢查
hd 聲明,代表使用者的代管網域。只有在出現下列情況時,
將資源存取權限制為僅限特定網域的成員存取。申訴是否不存在
表示帳戶不屬於 Google Workspace 代管網域。
建立帳戶或工作階段
驗證權杖後,請檢查使用者是否已存在於你的使用者中 資料庫如果是的話,請為使用者建立已驗證的工作階段。如果使用者 尚未在您的使用者資料庫中,請從這份資訊中建立新的使用者記錄 並為使用者建立工作階段。您可以提示 要求使用者在偵測到 新建立的使用者
保護使用者帳戶採用跨帳戶防護功能
只要您仰賴 Google 登入使用者,就能自動享有 安全功能和基礎架構,這是 Google 為了保護使用者資料而打造。不過 萬一使用者的 Google 帳戶遭到入侵,或發生其他 重大安全性事件,您的應用程式也較容易受到攻擊。進一步保護 帳戶不受重大安全性事件影響,請使用跨帳戶 保護措施,可接收 Google 的安全性警示。收到這些活動後,您 掌握使用者的 Google 帳戶安全性重大異動 即可對你的服務採取行動來保護帳戶安全。