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

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

Voici un exemple en langage Python qui montre les étapes habituelles pour valider et utiliser le 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 de double envoi de cookies pour empêcher les attaques CSRF. Avant chaque envoi, nous générons un jeton. Ensuite, le jeton est placé à la fois dans le cookie et dans le corps de la publication, 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 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.

    使用 Google API 客户端库

    使用某个 Google API 客户端库(例如 JavaNode.jsPHPPython) 是在生产环境中验证 Google ID 令牌的推荐方法。

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

    要在 Java 中验证 ID 令牌,请使用 GoogleIdTokenVerifier 对象。例如:

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

    GoogleIdTokenVerifier.verify() 方法验证 JWT 签名、aud 声明、iss 声明以及 exp 项版权主张。

    如果您需要验证 ID 令牌是否代表 Google Workspace 或 Cloud 组织账号,您可以通过检查域名来验证 hd 所有权声明 由 Payload.getHostedDomain() 方法返回。该 email 声明不足以保证账号是由网域管理 或组织。

    。 <ph type="x-smartling-placeholder">
    </ph>
    Node.js

    要在 Node.js 中验证 ID 令牌,请使用适用于 Node.js 的 Google Auth 库。 安装该库:

    npm install google-auth-library --save
    然后,调用 verifyIdToken() 函数。例如:

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

    verifyIdToken 函数用于验证 JWT 签名、aud 声明、exp 声明 以及 iss 声明。

    如果您需要验证 ID 令牌是否代表 Google Workspace 或 Cloud 组织账号时,您可以查看 hd 声明,该声明表示托管的 用户的网域。将资源访问权限限制为仅允许成员访问时,必须使用此设置 特定网域的用户缺少此声明即表示该账号不属于 Google 托管的域。

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

    要在 PHP 中验证 ID 令牌,请使用适用于 PHP 的 Google API 客户端库。 安装该库(例如,使用 Composer):

    composer require google/apiclient
    然后,调用 verifyIdToken() 函数。例如:

    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
    }

    verifyIdToken 函数用于验证 JWT 签名、aud 声明、exp 声明 以及 iss 声明。

    如果您需要验证 ID 令牌是否代表 Google Workspace 或 Cloud 组织账号时,您可以查看 hd 声明,该声明表示托管的 用户的网域。将资源访问权限限制为仅允许成员访问时,必须使用此设置 特定网域的用户缺少此声明即表示该账号不属于 Google 托管的域。

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

    要在 Python 中验证 ID 令牌,请使用 verify_oauth2_token 函数。例如:

    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

    verify_oauth2_token 函数验证 JWT 签名、aud 声明和 exp 声明。 您还必须验证 hd 检查 verify_oauth2_token 返回。如果多个客户端访问 后端服务器,另请手动验证 aud 声明。

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

    • Utilisateur non enregistré:vous pouvez afficher une interface utilisateur (UI) de connexion 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 de manière silencieuse.

    • Un compte existant 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.

    • Utilisateur fédéré connu:vous pouvez le connecter de manière silencieuse.