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.

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

   Pour vérifier que le jeton est valide, assurez-vous que les critères suivants sont remplis :

   • Le jeton d'identité est correctement signé par Google. Utilisez les clés publiques de Google (disponibles au format JWK ou PEM) pour valider la signature du jeton. Ces clés sont régulièrement renouvelées. Examinez l'en-tête Cache-Control dans la réponse pour déterminer quand vous devez les récupérer à nouveau.
   • La valeur de aud dans le jeton d'identité est égale à l'un des ID client de votre application. Cette vérification est nécessaire pour empêcher que des jetons d'identité émis pour une application malveillante ne soient utilisés pour accéder aux données du même utilisateur sur le serveur backend de votre application.
   • La valeur de iss dans le jeton d'identité est égale à accounts.google.com ou https://accounts.google.com.
   • Le délai d'expiration (exp) du jeton d'identité n'est pas encore écoulé.
   • Si vous devez valider que le jeton d'identité représente un compte d'organisation Google Workspace ou Cloud Identity, vous pouvez vérifier la revendication hd, qui indique le domaine hébergé de l'utilisateur. Cette option doit être utilisée pour limiter l'accès à une ressource aux membres de certains domaines uniquement. L'absence de cette revendication indique que le compte n'appartient pas à un domaine hébergé par Google.

   Les champs email, email_verified et hd vous permettent de déterminer si Google héberge une adresse e-mail et en est l'autorité. Dans les cas où Google fait autorité, l'utilisateur est connu comme étant le propriétaire légitime du compte. Vous pouvez donc ignorer le mot de passe ou d'autres méthodes de validation.

   Cas où Google fait autorité :

   • Si l'adresse e-mail de email se termine par @gmail.com, il s'agit d'un compte Gmail.
   • Si email_verified est défini sur "true" et que hd est défini, il s'agit d'un compte Google Workspace.

   Les utilisateurs peuvent s'inscrire à des comptes Google sans utiliser Gmail ni Google Workspace. Lorsque email ne contient pas de suffixe @gmail.com et que hd est absent, Google n'est pas une source fiable. Il est recommandé d'utiliser un mot de passe ou d'autres méthodes de validation pour vérifier l'identité de l'utilisateur. email_verified peut également être vrai, car Google a initialement validé l'utilisateur lors de la création du compte Google. Toutefois, la propriété du compte de messagerie tiers peut avoir changé depuis.

   Plutôt que d'écrire votre propre code pour effectuer ces étapes de validation, nous vous recommandons vivement d'utiliser une bibliothèque cliente des API Google pour votre plate-forme ou une bibliothèque JWT à usage général. Pour le développement et le débogage, vous pouvez appeler notre point de terminaison de validation tokeninfo.

   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.

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.