驗證伺服器端的 Google ID 權杖

Google 傳回 ID 權杖後,會透過 HTTP POST 方法要求,將權杖連同參數名稱 credential 提交至登入端點。

以下是 Python 語言的範例,說明驗證及使用 ID 權杖的一般步驟:

  1. 驗證跨網站偽造要求 (CSRF) 權杖。當您將憑證提交至登入端點時,我們會使用雙重提交 Cookie 模式來防範 CSRF 攻擊。每次提交前,我們都會產生權杖。接著,將權杖放入 Cookie 和 POST 主體中,如以下程式碼範例所示:

    csrf_token_cookie = self.request.cookies.get('g_csrf_token')
    if not csrf_token_cookie:
        webapp2.abort(400, 'No CSRF token in Cookie.')
    csrf_token_body = self.request.get('g_csrf_token')
    if not csrf_token_body:
        webapp2.abort(400, 'No CSRF token in post body.')
    if csrf_token_cookie != csrf_token_body:
        webapp2.abort(400, 'Failed to verify double submit cookie.')
  2. 驗證 ID 權杖。

    如要驗證權杖是否有效,請確認下列事項 符合下列條件:

    • Google 正確簽署 ID 權杖。使用 Google 的公開金鑰 (支援語言: JWKPEM 格式) 驗證權杖的簽章我們會定期輪替這些金鑰。檢查 回應中的 Cache-Control 標頭,判斷何時 您必須重新擷取這些資料
    • ID 權杖中的 aud 值等於應用程式的其中一個 用戶端 ID這項檢查是為了避免核發給惡意人士的 ID 權杖 應用程式存取同一使用者在應用程式後端伺服器上的資料。
    • ID 權杖中的 iss 值等於 accounts.google.comhttps://accounts.google.com
    • ID 權杖的到期時間 (exp) 已過。
    • 如需驗證 ID 權杖是否代表 Google Workspace 或 Cloud 機構帳戶,您可以檢查 hd 憑證附加資訊,也就是 使用者的網域將資源存取權授予僅限以下成員時,就必須使用這個引數 避免特定網域若沒有這項聲明,表示帳戶不屬於 Google 代管的網域。

    您可以利用 emailemail_verifiedhd 欄位判斷 Google 代管且具公信力的電子郵件地址。如果 Google 的公信力 使用者是合法帳戶擁有者,您可以略過密碼或其他 挑戰方法

    Google 具有公信力的案例:

    • email 的尾碼是 @gmail.com,這是 Gmail 帳戶。
    • email_verified」為 true,且已設定「hd」,代表這是 G Suite 帳戶。

    使用者註冊 Google 帳戶時,不必使用 Gmail 或 G Suite。時間 email 未包含 @gmail.com 後置字串,但 hd 缺少,Google 不會 建議使用權威性密碼、密碼或其他驗證方法 使用者。email_verified 也可能是 true,因為 Google 一開始就驗證過 使用者就是 Google 帳戶建立時的使用者,但第三方的擁有權 電子郵件帳戶可能會有所變更。

    執行這些驗證步驟時,與其自行編寫程式碼, 建議您為平台或一般用途使用 Google API 用戶端程式庫 JWT 程式庫。如要進行開發和偵錯,您可以呼叫 tokeninfo 驗證端點

    使用 Google API 用戶端程式庫

    使用其中一個 Google API 用戶端程式庫 (例如 JavaNode.jsPHPPython) 是在正式環境中驗證 Google ID 權杖的建議做法。

    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 CLIENT_ID of the app that accesses the backend:
        .setAudience(Collections.singletonList(CLIENT_ID))
        // Or, if multiple clients access the backend:
        //.setAudience(Arrays.asList(CLIENT_ID_1, CLIENT_ID_2, CLIENT_ID_3))
        .build();
    
    // (Receive idTokenString by HTTPS POST)
    
    GoogleIdToken idToken = verifier.verify(idTokenString);
    if (idToken != null) {
      Payload payload = idToken.getPayload();
    
      // Print user identifier
      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

    如要透過 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: CLIENT_ID,  // Specify the CLIENT_ID of the app that accesses the backend
          // Or, if multiple clients access the backend:
          //[CLIENT_ID_1, CLIENT_ID_2, CLIENT_ID_3]
      });
      const payload = ticket.getPayload();
      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

    如要在 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' => $CLIENT_ID]);  // Specify the CLIENT_ID of the app that accesses the backend
    $payload = $client->verifyIdToken($id_token);
    if ($payload) {
      $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

    如要在 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 CLIENT_ID of the app that accesses the backend:
        idinfo = id_token.verify_oauth2_token(token, requests.Request(), CLIENT_ID)
    
        # Or, if multiple clients access the backend server:
        # idinfo = id_token.verify_oauth2_token(token, requests.Request())
        # if idinfo['aud'] not in [CLIENT_ID_1, CLIENT_ID_2, 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.
        userid = idinfo['sub']
    except ValueError:
        # Invalid token
        pass
    

    verify_oauth2_token 函式會驗證 JWT 簽章、aud 聲明和 exp 聲明。 並驗證hd 來識別請求 (如果適用的話) 來檢查 會傳回 verify_oauth2_token。如果多位用戶端存取 後端伺服器,也手動驗證 aud 憑證附加資訊。

  3. 確認憑證有效性後,您就可以使用 Google ID 權杖中的資訊,與網站狀態建立關聯:

    • 未註冊的使用者:您可以顯示註冊使用者介面 (UI),讓使用者提供其他個人資料 (如有需要)。也可以讓使用者在不發出通知的情況下建立新帳戶和登入使用者工作階段。

    • 網站中已有現有帳戶:您可以顯示網頁,讓使用者輸入密碼,並將舊帳戶連結至 Google 憑證。這表示使用者有現有帳戶的存取權。

    • 回訪的聯合使用者:您可以自動讓使用者登入。