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-Clientbibliothek verwenden

    Die Verwendung einer der Google API-Clientbibliotheken (z.B. Java, Node.js, PHP, Python) wird zum Prüfen von Google-ID-Tokens in einer Produktionsumgebung empfohlen.

    Java

    Verwenden Sie das Objekt GoogleIdTokenVerifier, um ein ID-Token in Java zu validieren. Beispiel:

    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.");
}

    Die Methode GoogleIdTokenVerifier.verify() überprüft die JWT-Signatur, die aud-Anforderung, die iss-Anforderung und die exp-Anforderung.

    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. Dazu prüfen Sie den Domainnamen, der von der Methode Payload.getHostedDomain() zurückgegeben wird. Die Domain der email-Anforderung reicht nicht aus, um dafür zu sorgen, dass das Konto von einer Domain oder Organisation verwaltet wird.

    Node.js

    Verwenden Sie zum Prüfen eines ID-Tokens in Node.js die Google-Authentifizierungsbibliothek für Node.js. Installieren Sie die Bibliothek: 

    npm install google-auth-library --save
    Rufen Sie dann die Funktion verifyIdToken() auf. Beispiel:

    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 request specified a G Suite domain:
  // const domain = payload['hd'];
}
verify().catch(console.error);

    Die Funktion verifyIdToken prüft die JWT-Signatur, die aud-Anforderung, die exp- und die iss-Anforderung.

    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.

    PHP

    Mit der Google API-Clientbibliothek für PHP können Sie ein ID-Token in PHP validieren. Installieren Sie die Bibliothek, z. B. mit Composer: 

    composer require google/apiclient
    Rufen Sie dann die Funktion verifyIdToken() auf. Beispiel:

    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 request specified a G Suite domain:
  //$domain = $payload['hd'];
} else {
  // Invalid ID token
}

    Die Funktion verifyIdToken prüft die JWT-Signatur, die aud-Anforderung, die exp- und die iss-Anforderung.

    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.

    Python

    Verwenden Sie die Funktion verify_oauth2_token, um ein ID-Token in Python zu validieren. Beispiel:

    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 auth request is from a G Suite domain:
    # if idinfo['hd'] != GSUITE_DOMAIN_NAME:
    #     raise ValueError('Wrong hosted domain.')

    # ID token is valid. Get the user's Google Account ID from the decoded token.
    userid = idinfo['sub']
except ValueError:
    # Invalid token
    pass

    Die Funktion verify_oauth2_token überprüft die JWT-Signatur, die aud-Anforderung und die exp-Anforderung. Sie müssen auch die hd-Anforderung (falls zutreffend) verifizieren, indem Sie das Objekt untersuchen, das verify_oauth2_token zurückgibt. Wenn mehrere Clients auf den Back-End-Server zugreifen, prüfen Sie die aud-Anforderung auch manuell.

  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.