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

Une fois que Google a renvoyé un jeton d'ID, celui-ci est envoyé par une requête de méthode HTTP POST, avec le nom de paramètre credential, à votre point de terminaison de connexion.

Voici un exemple en langage Python qui montre les étapes habituelles de validation et d'utilisation du jeton d'ID:

  1. Vérifiez le jeton CSRF (Cross-Site Request Forgery). Lorsque vous envoyez des identifiants à votre point de terminaison de connexion, nous utilisons le modèle "double-submit-cookie" pour empêcher les attaques CSRF. Avant chaque envoi, nous générons un jeton. Le jeton est ensuite placé à la fois dans le cookie et dans le corps du post, comme illustré dans l'exemple de code suivant:

    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. Vérifiez le jeton d'ID.

    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 want to restrict access to only members of your G Suite domain, verify that the ID token has an hd claim that matches your G Suite domain name.

    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

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

    Java

    Pour valider un jeton d'ID en Java, utilisez l'objet 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 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.");
    }

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

    Si vous souhaitez limiter l'accès aux membres de votre domaine G Suite, validez également la revendication hd en vérifiant le nom de domaine renvoyé par la méthode Payload.getHostedDomain().

    Node.js

    Pour valider un jeton d'ID en 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: 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);
    

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

    Si vous souhaitez limiter l'accès aux membres de votre domaine G Suite, vérifiez également que la revendication hd correspond au nom de votre domaine G Suite.

    PHP

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

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

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

    Si vous souhaitez limiter l'accès aux membres de votre domaine G Suite, vérifiez également que la revendication hd correspond au nom de votre domaine G Suite.

    Python

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

    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
    

    La fonction verify_oauth2_token vérifie la signature JWT, la revendication aud et la revendication exp. Vous devez également vérifier la revendication hd (le cas échéant) en examinant l'objet renvoyé par verify_oauth2_token. Si plusieurs clients accèdent au serveur backend, validez également manuellement la revendication aud.

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

    • Utilisateur non enregistré:vous pouvez afficher une interface utilisateur pour l'inscription permettant à l'utilisateur de fournir des informations de profil supplémentaires, si nécessaire. Cela permet également à l'utilisateur de créer automatiquement le compte et une session utilisateur connectée.

    • Compte existant déjà sur votre site:vous pouvez afficher une page Web permettant à 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 connecter l'utilisateur en mode silencieux.