Das Google-ID-Token auf Serverseite überprüfen

Nachdem Google ein ID-Token zurückgegeben hat, wird es mit einer HTTP-Anfrage der Methode POST mit dem Parameternamen credential an Ihren Anmeldeendpunkt gesendet.

Das folgende Beispiel zeigt in der Sprache Python die üblichen Schritte zum Validieren und Verwenden des ID-Tokens:

1. Überprüfen Sie das CSRF-Token (Cross-Site Request Forgery). Wenn Sie Anmeldedaten an Ihren Anmeldeendpunkt senden, verwenden wir das Muster „Double-Submit-Cookie“, um CSRF-Angriffe zu verhindern. Vor jeder Einreichung generieren wir ein Token. Dann wird das Token sowohl in das Cookie als auch in den Post-Text eingefügt, wie im folgenden Codebeispiel gezeigt:

   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. Prüfen Sie das ID-Token.

   Prüfen Sie, ob die folgenden Kriterien erfüllt sind:

   • Das ID-Token ist ordnungsgemäß von Google signiert. Verwenden Sie die öffentlichen Schlüssel von Google (verfügbar im Format JWK oder PEM), um die Signatur des Tokens zu prüfen. Diese Schlüssel werden regelmäßig rotiert. Prüfen Sie den Cache-Control-Header in der Antwort, um festzustellen, wann Sie sie noch einmal abrufen sollten.
   • Der Wert von aud im ID-Token entspricht einer der Client-IDs der Anwendung. Diese Prüfung ist erforderlich, um zu verhindern, dass ID-Tokens, die an eine schädliche Anwendung gesendet wurden, für den Zugriff auf Daten desselben Nutzers auf dem Back-End-Server der Anwendung verwendet werden.
   • Der Wert von iss im ID-Token ist accounts.google.com oder https://accounts.google.com.
   • Die Ablaufzeit (exp) des ID-Tokens ist noch nicht verstrichen.
   • Wenn Sie überprüfen müssen, ob das ID-Token ein Google Workspace- oder Cloud-Organisationskonto darstellt, können Sie die hd-Anforderung prüfen, die die gehostete Domain des Nutzers angibt. Dies muss verwendet werden, wenn der Zugriff auf eine Ressource auf Mitglieder bestimmter Domains beschränkt werden soll. Falls dieser Anspruch fehlt, bedeutet das, dass das Konto nicht zu einer von Google gehosteten Domain gehört.

   Anstatt eigenen Code zu schreiben, um diese Überprüfungsschritte auszuführen, empfehlen wir dringend, eine Google API-Clientbibliothek für Ihre Plattform oder eine allgemeine JWT-Bibliothek zu verwenden. Zur Entwicklung und Fehlerbehebung können Sie unseren Validierungsendpunkt tokeninfo aufrufen.

   使用 Google API 客户端库

   在生产环境中验证 Google ID 令牌时，建议使用一个 Google API 客户端库（例如 Java、Node.js、PHP、Python）。

   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 组织帐号，则可以通过检查 Payload.getHostedDomain() 方法返回的域名来验证 hd 声明。email 声明的网域不足以确保帐号由网域或组织管理。

   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: 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 声明。您还必须通过检查 verify_oauth2_token 返回的对象来验证 hd 声明（如果适用）。如果多个客户端访问后端服务器，则还需要手动验证 aud 声明。

   Wichtiger Hinweis :Das ID-Token wird im Feld credential und nicht im Feld g_csrf_token zurückgegeben.

3. Sobald die Gültigkeit des Tokens bestätigt wurde, kannst du den Kontostatus deiner Website anhand der Informationen im Google-ID-Token korrelieren:

   • Ein nicht registrierter Nutzer:Sie können eine Benutzeroberfläche zur Registrierung anzeigen lassen, über die der Nutzer bei Bedarf zusätzliche Profilinformationen angeben kann. Außerdem kann der Nutzer das neue Konto und eine angemeldete Nutzersitzung im Hintergrund erstellen.

   • Ein vorhandenes Konto, das bereits auf Ihrer Website vorhanden ist:Sie können eine Webseite anzeigen, auf der der Endnutzer sein Passwort eingeben und das alte Konto mit seinen Google-Anmeldedaten verknüpfen kann. Dadurch wird bestätigt, dass der Nutzer Zugriff auf das vorhandene Konto hat.

   • Wiederkehrender föderierter Nutzer:Sie können den Nutzer automatisch anmelden.

Wichtiger Hinweis: Verwenden Sie das Google-ID-Token sub nur als Kennung für den Nutzer, da es unter allen Google-Konten eindeutig ist und nie wiederverwendet wird. Sie sollten das Feld sub speichern und dem Nutzer in Ihrem Kontoverwaltungssystem zuordnen. Sie können anhand der E-Mail-Adresse aus dem ID-Token prüfen, ob der Nutzer bereits ein Konto hat. Verwenden Sie jedoch nicht die E-Mail-Adresse als Kennung, da ein Google-Konto zu verschiedenen Zeitpunkten mehrere E-Mail-Adressen haben kann.