驗證伺服器端的 Google ID 權杖

使用 Google Identity Services 或 OAuth 2.0 授權碼流程時，Google 會透過 POST 方法將 ID 權杖傳回重新導向端點。或者，OIDC 隱含流程會使用 GET 要求。因此，應用程式有責任將收到的憑證安全地傳輸至伺服器。

    HTTP/1.1 302 Found
    Location: https://<REDIRECT_URI>#access_token=<ACCESS_TOKEN>&token_type=bearer&expires_in=<TIME_IN_SECONDS>&scope=<SCOPE>&state=<STATE_STRING>
    

POST /auth/token-verification HTTP/1.1
Host: example.com
Content-Type: application/json;charset=UTF-8
Cookie: g_csrf_token=<CSRF_TOKEN>
Origin: https://example.com
Content-Length: <LENGTH_OF_JSON_BODY>
    {
      "credential": "<ID_TOKEN>",
      "g_csrf_token": "<CSRF_TOKEN>",
      "client_id": "<CLIENT_ID>"
    }

1. 驗證 g_csrf_token，防範跨網站偽造要求 (CSRF) 攻擊：

   • 從 g_csrf_token Cookie 擷取 CSRF 權杖值。
   • 從要求內文中擷取 CSRF 權杖值。GIS 程式庫會在 POST 要求主體中加入這個權杖做為參數，同樣命名為 g_csrf_token。
   • 比較兩個權杖值
     • 如果這兩個值都存在且完全相符，系統就會將要求視為合法，且來自您的網域。
     • 如果值不存在或不相符，伺服器必須拒絕要求。這項檢查可確保要求是從您網域上執行的 JavaScript 發出，因為只有您的網域可以存取 g_csrf_token Cookie。

2. 驗證 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 帳戶。@gmail.com
   • 為 true 且 hd 已設定，則為 Google Workspace 帳戶。email_verified

   使用者可以註冊 Google 帳戶，不必使用 Gmail 或 Google Workspace。如果 email 不含 @gmail.com 後置字串，且沒有 hd，Google 就不是授權機構，建議使用密碼或其他驗證方法來驗證使用者。email_verified 也可能成立，因為 Google 最初是在建立 Google 帳戶時驗證使用者，但第三方電子郵件帳戶的擁有權可能已變更。

   強烈建議您使用適用於平台的 Google API 用戶端程式庫，或一般用途的 JWT 程式庫，而不要自行編寫程式碼來執行這些驗證步驟。如要進行開發和偵錯，可以呼叫我們的tokeninfo驗證端點。

   使用 Google API 客户端库

   使用某个 Google API 客户端库（例如 Java、 Node.js、 PHP、 Python） 是在生产环境中验证 Google ID 令牌的推荐方法。

   <ph type="x-smartling-placeholder">
   </ph> <ph type="x-smartling-placeholder">

   </ph>

   Java

   要在 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 声明不足以保证账号是由网域管理 或组织。

   。 <ph type="x-smartling-placeholder">

   </ph>

   Node.js

   要在 Node.js 中验证 ID 令牌，请使用适用于 Node.js 的 Google Auth 库。 安装该库：

   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 托管的域。

   。 <ph type="x-smartling-placeholder">

   </ph>

   PHP

   要在 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 托管的域。

   。 <ph type="x-smartling-placeholder">

   </ph>

   Python

   要在 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 声明。

3. 確認權杖有效後，您可以使用 Google ID 權杖中的資訊，將網站的帳戶狀態與下列項目建立關聯：

   • 未註冊的使用者：您可以顯示註冊使用者介面 (UI)，讓使用者提供額外的個人資料資訊 (如有需要)。使用者也可以透過這項功能，在不顯示任何提示的情況下建立新帳戶和登入使用者工作階段。

   • 網站上已有的現有帳戶：您可以顯示網頁，讓使用者輸入密碼，並將舊版帳戶連結至 Google 憑證。確認使用者可以存取現有帳戶。

   • 回訪的同盟使用者：您可以讓使用者無須輸入憑證即可登入。