Google-ID-Token auf Serverseite bestätigen

Wenn Sie Google Identity Services oder den OAuth 2.0-Vorgang mit Autorisierungscode verwenden, gibt Google das ID-Token über die POST-Methode an den Weiterleitungs-Endpunkt zurück. Alternativ wird beim impliziten OIDC-Ablauf eine GET-Anfrage verwendet. Daher ist Ihre Anwendung dafür verantwortlich, diese empfangenen Anmeldedaten sicher an Ihren Server zu übertragen.

    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. Validieren des g_csrf_token, um websiteübergreifende Anfragefälschungen (Cross-Site Request Forgery, CSRF) zu verhindern:

   • Extrahieren Sie den CSRF-Tokenwert aus dem Cookie g_csrf_token.
   • Extrahieren Sie den CSRF-Tokenwert aus dem Anfragetext. Die GIS-Bibliothek fügt dieses Token als Parameter mit dem Namen g_csrf_token in den POST-Anfragetext ein.
   • Vergleichen Sie die beiden Tokenwerte.
     • Wenn beide Werte vorhanden sind und vollständig übereinstimmen, gilt die Anfrage als legitim und stammt von Ihrer Domain.
     • Wenn die Werte nicht vorhanden sind oder nicht übereinstimmen, muss die Anfrage vom Server abgelehnt werden. Mit dieser Prüfung wird sichergestellt, dass die Anfrage von JavaScript initiiert wurde, das auf Ihrer eigenen Domain ausgeführt wird, da nur Ihre Domain auf das g_csrf_token-Cookie zugreifen kann.

2. ID-Token prüfen

   To verify that the token is valid, ensure that the following criteria are satisfied:

   • The ID token is properly signed by Google. Use Google's public keys (available in JWK or PEM format) to verify the token's signature. These keys are regularly rotated; examine the Cache-Control header in the response to determine when you should retrieve them again.
   • The value of aud in the ID token is equal to one of your app's client IDs. This check is necessary to prevent ID tokens issued to a malicious app being used to access data about the same user on your app's backend server.
   • The value of iss in the ID token is equal to accounts.google.com or https://accounts.google.com.
   • The expiry time (exp) of the ID token has not passed.
   • If you need to validate that the ID token represents a Google Workspace or Cloud organization account, you can check the hd claim, which indicates the hosted domain of the user. This must be used when restricting access to a resource to only members of certain domains. The absence of this claim indicates that the account does not belong to a Google hosted domain.

   Using the email, email_verified and hd fields, you can determine if Google hosts and is authoritative for an email address. In the cases where Google is authoritative, the user is known to be the legitimate account owner, and you may skip password or other challenge methods.

   Cases where Google is authoritative:

   • email has a @gmail.com suffix, this is a Gmail account.
   • email_verified is true and hd is set, this is a Google Workspace account.

   Users may register for Google Accounts without using Gmail or Google Workspace. When email does not contain a @gmail.com suffix and hd is absent, Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verified can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

   Rather than writing your own code to perform these verification steps, we strongly recommend using a Google API client library for your platform, or a general-purpose JWT library. For development and debugging, you can call our tokeninfo validation endpoint.

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

   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: 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);

   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' => $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
   }

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

   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, können Sie die Informationen im Google-ID-Token verwenden, um den Kontostatus Ihrer Website zu korrelieren:

   • Nicht registrierter Nutzer:Sie können eine Registrierungs-Benutzeroberfläche einblenden, ü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 bestehendes Konto auf Ihrer Website:Sie können eine Webseite anzeigen, auf der der Endnutzer sein Passwort eingeben und das alte Konto mit seinen Google-Anmeldedaten verknüpfen kann. Damit wird bestätigt, dass der Nutzer Zugriff auf das vorhandene Konto hat.

   • Wiederkehrender Föderationsnutzer:Sie können den Nutzer im Hintergrund anmelden.