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 das Token gültig ist: erfüllt sind:

    • Das ID-Token wurde von Google ordnungsgemäß signiert. Öffentliche Schlüssel von Google verwenden (verfügbar in JWK oder PEM-Format) um die Signatur des Tokens zu überprüfen. Diese Schlüssel werden regelmäßig rotiert. untersuchen den Cache-Control-Header in der Antwort, um zu bestimmen, wann sollten Sie sie erneut abrufen.
    • Der Wert von aud im ID-Token entspricht einem der Werte Client-IDs. Diese Prüfung ist erforderlich, um zu verhindern, dass ID-Tokens, die an einen App, die für den Zugriff auf Daten über denselben Nutzer auf dem Back-End-Server Ihrer App verwendet wird.
    • Der Wert von iss im ID-Token ist gleich accounts.google.com oder https://accounts.google.com.
    • Die Ablaufzeit (exp) des ID-Tokens ist noch nicht abgelaufen.
    • Wenn Sie prüfen müssen, ob das ID-Token für Google Workspace oder Cloud steht Unternehmenskonto haben, können Sie die hd-Anforderung prüfen, die angibt, Domain des Nutzers. Dies muss verwendet werden, wenn der Zugriff auf eine Ressource auf Mitglieder von bestimmten Domains. Fehlt dieser Anspruch, gehört das Konto nicht zu einem Von Google gehostete Domain.

    Mit den Feldern email, email_verified und hd können Sie festlegen, Google hostet eine E-Mail-Adresse und ist für sie maßgeblich. In Fällen, in denen Google maßgeblich ist, dass der Nutzer als rechtmäßiger Kontoinhaber bekannt ist und Sie das Passwort oder andere Challenge-Methoden.

    Fälle, in denen Google als vertrauenswürdig eingestuft wird:

    • email hat das Suffix @gmail.com. Dies ist ein Gmail-Konto.
    • email_verified ist „true“ und hd ist festgelegt. Dies ist ein G Suite-Konto.

    Nutzer können sich für ein Google-Konto registrieren, ohne Gmail oder die G Suite zu verwenden. Wann? email enthält kein @gmail.com-Suffix und hd ist nicht vorhanden, Google nicht werden zur Bestätigung der Identität empfohlen, Nutzenden. email_verified kann auch „true“ sein, da Google das Nutzer beim Erstellen des Google-Kontos, die Inhaberschaft des Drittanbieters Ihr E-Mail-Konto hat sich in der Zwischenzeit möglicherweise geändert.

    Sie müssen keinen eigenen Code für diese Bestätigungsschritte schreiben, empfehlen die Verwendung einer Google API-Client-Bibliothek für Ihre Plattform oder eine allgemeine JWT-Bibliothek. Für Entwicklung und Fehlerbehebung können Sie unser tokeninfo Validierungsendpunkt.

    Google API-Clientbibliothek verwenden

    Mit einer der Google API-Clientbibliotheken (z.B. Java Node.js PHP Python) wird empfohlen, um Google-ID-Tokens in einer Produktionsumgebung zu validieren.

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

    Verwenden Sie zum Validieren eines ID-Tokens in Java die Methode GoogleIdTokenVerifier-Objekt. 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() prüft das JWT Signatur, aud- und iss-Anforderung und exp-Anspruch.

    Wenn Sie prüfen müssen, ob das ID-Token für Google Workspace oder Cloud steht Organisationskonto haben, können Sie die hd-Beanspruchung bestätigen, indem Sie den Domainnamen überprüfen Payload.getHostedDomain() zurückgegeben. Die Domain der Der Anspruch von email reicht nicht aus, um sicherzustellen, dass das Konto von einer Domain verwaltet wird oder einer Organisation.

    <ph type="x-smartling-placeholder">
    </ph>
    Node.js

    Verwenden Sie die Google-Authentifizierungsbibliothek für Node.js, um ein ID-Token in Node.js zu validieren. 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 the request specified a Google Workspace domain:
  // const domain = payload['hd'];
}
verify().catch(console.error);

    Mit der Funktion verifyIdToken wird überprüft, die JWT-Signatur, die aud-Anforderung, die exp-Anforderung und die iss-Behauptung.

    Wenn Sie prüfen müssen, ob das ID-Token für Google Workspace oder Cloud steht Unternehmenskonto haben, können Sie die hd-Anforderung prüfen, die angibt, Domain des Nutzers. Muss verwendet werden, wenn der Zugriff auf eine Ressource auf Mitglieder beschränkt wird von bestimmten Domains. Das Fehlen dieses Anspruchs bedeutet, dass das Konto nicht zu eine von Google gehostete Domain.

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

    Um ein ID-Token in PHP zu validieren, verwenden Sie die Google API-Clientbibliothek für PHP. 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 the request specified a Google Workspace domain
  //$domain = $payload['hd'];
} else {
  // Invalid ID token
}

    Mit der Funktion verifyIdToken wird überprüft, die JWT-Signatur, die aud-Anforderung, die exp-Anforderung und die iss-Behauptung.

    Wenn Sie prüfen müssen, ob das ID-Token für Google Workspace oder Cloud steht Unternehmenskonto haben, können Sie die hd-Anforderung überprüfen, die angibt, Domain des Nutzers. Muss verwendet werden, wenn der Zugriff auf eine Ressource auf Mitglieder beschränkt wird bestimmter Domains. Das Fehlen dieses Anspruchs bedeutet, dass das Konto nicht zu eine von Google gehostete Domain.

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

    Verwenden Sie zum Validieren eines ID-Tokens in Python die Methode verify_oauth2_token . 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 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

    Die Funktion verify_oauth2_token prüft das JWT Signatur, aud und exp. Sie müssen auch die hd bestätigen (falls zutreffend), indem wir das Objekt untersuchen, verify_oauth2_token kehrt zurück. Wenn mehrere Clients auf die Backend-Server, auch die aud-Anforderung manuell verifizieren.

  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.