Valider le jeton d'ID Google côté serveur

Lorsque vous utilisez Google Identity Services ou le flux avec code d'autorisation OAuth 2.0, Google renvoie le jeton d'identification à l'aide de la méthode POST au point de terminaison de redirection. Le flux implicite OIDC utilise une requête GET. Par conséquent, votre application est responsable de la transmission sécurisée de ces identifiants reçus à votre serveur.

GET

Il s'agit du flux implicite. Le jeton d'identité est renvoyé dans le fragment d'URL, que le code JavaScript côté client doit analyser. Votre application est responsable de l'implémentation de ses propres mécanismes de validation pour garantir l'authenticité de la requête et prévenir les attaques telles que CSRF.

    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

Le jeton d'identité est renvoyé sous la forme du champ credential. Lors de la préparation de l'envoi du jeton d'identité au serveur, la bibliothèque GIS ajoute automatiquement le g_csrf_token au cookie d'en-tête et au corps de la requête. Voici un exemple de requête POST :

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. Valider le g_csrf_token pour empêcher les attaques de falsification de requêtes intersites (CSRF) :

   • Extrayez la valeur du jeton CSRF du cookie g_csrf_token.
   • Extrayez la valeur du jeton CSRF du corps de la requête. La bibliothèque GIS inclut ce jeton dans le corps de la requête POST en tant que paramètre, également nommé g_csrf_token.
   • Comparez les deux valeurs de jeton.
     • Si les deux valeurs sont présentes et correspondent parfaitement, la demande est considérée comme légitime et provenant de votre domaine.
     • Si les valeurs ne sont pas présentes ou ne correspondent pas, la requête doit être rejetée par le serveur. Cette vérification permet de s'assurer que la requête a été lancée à partir de JavaScript exécuté sur votre propre domaine, car seul votre domaine peut accéder au cookie g_csrf_token.

2. Validez le jeton d'identité.

   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.

   Utiliser une bibliothèque cliente des API Google

   En utilisant l'une des bibliothèques clientes des API Google (par exemple, Java Node.js PHP Python). est la méthode recommandée pour valider les jetons d'ID Google dans un environnement de production.

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

   </ph>

   Java

   Pour valider un jeton d'identification en Java, utilisez la fonction GoogleIdTokenVerifier. Exemple :

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

   La méthode GoogleIdTokenVerifier.verify() vérifie le jeton JWT. signature, la revendication aud, la revendication iss et Revendication exp.

   Si vous devez vérifier que le jeton d'ID représente un compte Google Workspace ou compte d'organisation, vous pouvez valider la revendication hd en consultant le nom de domaine renvoyé par la méthode Payload.getHostedDomain(). Domaine du La revendication email ne suffit pas à garantir que le compte est géré par un domaine. ou une organisation.

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

   </ph>

   Node.js

   Pour valider un jeton d'ID dans Node.js, utilisez la bibliothèque Google Auth pour Node.js. Installez la bibliothèque :

   npm install google-auth-library --save

   Appelez ensuite la fonction verifyIdToken(). Exemple :

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

   La fonction verifyIdToken vérifie la signature JWT, aud, exp, et la revendication iss.

   Si vous devez vérifier que le jeton d'ID représente un compte Google Workspace ou compte d'organisation, vous pouvez consulter la revendication hd, qui indique domaine de l'utilisateur. Utilisez cette option lorsque vous limitez l'accès à une ressource aux seuls membres. de certains domaines. L'absence de cette réclamation indique que le compte n'appartient pas à un domaine hébergé par Google.

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

   </ph>

   PHP

   Pour valider un jeton d'ID en PHP, utilisez la bibliothèque cliente des API Google pour PHP. Installez la bibliothèque (à l'aide de Composer, par exemple):

   composer require google/apiclient

   Appelez ensuite la fonction verifyIdToken(). Exemple :

   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
   }

   La fonction verifyIdToken vérifie la signature JWT, aud, exp, et la revendication iss.

   Si vous devez vérifier que le jeton d'ID représente un compte Google Workspace ou compte d'organisation, vous pouvez consulter la revendication hd, qui indique que domaine de l'utilisateur. Utilisez cette option lorsque vous limitez l'accès à une ressource aux seuls membres. de certains domaines. L'absence de cette réclamation indique que le compte n'appartient pas à un domaine hébergé par Google.

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

   </ph>

   Python

   Pour valider un jeton d'ID en Python, utilisez la méthode verify_oauth2_token . Exemple :

   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

   La fonction verify_oauth2_token vérifie le jeton JWT signature, la revendication aud et la revendication exp. Vous devez également valider les hd (le cas échéant) en examinant l'objet verify_oauth2_token est renvoyé. Si plusieurs clients accèdent et vérifiez manuellement la revendication aud.

   Point clé : Le jeton d'identité est renvoyé dans le champ credential au lieu du champ g_csrf_token.

3. Une fois la validité du jeton confirmée, vous pouvez utiliser les informations du jeton d'identité Google pour corréler l'état du compte de votre site :

   • Utilisateur non enregistré : vous pouvez afficher une interface utilisateur d'inscription qui permet à l'utilisateur de fournir des informations de profil supplémentaires, si nécessaire. Il permet également à l'utilisateur de créer le nouveau compte et une session utilisateur connectée en mode silencieux.

   • Un compte existant sur votre site : vous pouvez afficher une page Web qui permet à l'utilisateur final de saisir son mot de passe et d'associer l'ancien compte à ses identifiants Google. Cela confirme que l'utilisateur a accès au compte existant.

   • Un utilisateur fédéré connu : vous pouvez le connecter en mode silencieux.

Important : N'utilisez que le champ Jeton d'ID Google sub comme identifiant de l'utilisateur, car il est unique pour tous les comptes Google et n'est jamais réutilisé. Vous devez stocker le champ sub et l'associer à l'utilisateur dans votre système de gestion de compte. Bien que vous puissiez utiliser l'adresse e-mail du jeton d'identité pour vérifier si l'utilisateur possède déjà un compte, n'utilisez pas l'adresse e-mail comme identifiant, car un compte Google peut avoir plusieurs adresses e-mail à différents moments.