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.

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

    • Le jeton d'ID est correctement signé par Google. Utiliser les clés publiques de Google (disponible en JWK ou PEM). pour vérifier la signature du jeton. Ces clés font l'objet d'une rotation régulière. examiner 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'ID est égale à l'une des d'identifiants clients. Cette vérification est nécessaire pour empêcher les jetons d'identification émis vers application utilisée pour accéder aux données concernant le même utilisateur sur le serveur backend de votre application.
    • La valeur de iss dans le jeton d'ID est égale à accounts.google.com ou https://accounts.google.com.
    • Le délai d'expiration (exp) du jeton d'ID n'est pas écoulé.
    • 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. Il doit être utilisé lorsque vous restreignez 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.

    À l'aide des champs email, email_verified et hd, vous pouvez déterminer Google héberge les adresses e-mail et fait autorité pour celles-ci. Dans les cas où Google fait autorité, l'utilisateur est connu comme étant le titulaire légitime du compte, et vous pouvez ignorer le mot de passe ou d'autres méthodes de défi.

    Cas dans lesquels Google fait autorité:

    • email comporte le suffixe @gmail.com. Il s'agit d'un compte Gmail.
    • email_verified est "true" et hd est défini. Il s'agit d'un compte G Suite.

    Les utilisateurs peuvent créer un compte Google sans utiliser Gmail ni G Suite. Quand ? email ne contient pas de suffixe @gmail.com et hd est absent, Google ne l'est pas faisant autorité et un mot de passe ou d'autres méthodes d'authentification sont recommandés pour l'utilisateur. email_verified peut également être défini sur "true", car Google a initialement validé utilisateur lors de la création du compte Google, quelle que soit la propriété du tiers compte de messagerie peut avoir changé depuis.

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

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

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

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

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