Verificare il token ID di Google sul lato server

Dopo che Google restituisce un token ID, questo viene inviato tramite una richiesta con metodo HTTP POST, con il nome del parametro credential, al tuo endpoint di accesso.

Di seguito è riportato un esempio in linguaggio Python che mostra i passaggi consueti per convalidare e utilizzare l'ID token:

  1. Verifica il token CSRF (Cross-Site Request Forgery). Quando invii le credenziali all'endpoint di accesso, utilizziamo il pattern di invio doppio del cookie per impedire gli attacchi CSRF. Prima di ogni invio, generiamo un token. Quindi, il token viene inserito sia nel cookie sia nel corpo del post, come mostrato nell'esempio di codice seguente:

    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. Verifica il token ID.

    如需验证令牌是否有效,请确保满足以下条件:

    • ID 令牌已由 Google 正确签名。使用 Google 的公钥(以 JWKPEM 格式提供)验证令牌的签名。这些密钥会定期轮换;请检查响应中的 Cache-Control 标头,以确定何时应再次检索这些密钥。
    • ID 令牌中的 aud 值等于您应用的某个客户端 ID。此检查是必要的,可防止向恶意应用发放的 ID 令牌被用于访问您应用后端服务器上有关同一用户的数据。
    • ID 令牌中 iss 的值等于 accounts.google.comhttps://accounts.google.com
    • ID 令牌的到期时间 (exp) 尚未到期。
    • 如果您需要验证 ID 令牌是否代表 Google Workspace 或 Cloud 组织账号,可以检查 hd 声明,该声明表示用户的托管网域。如果需要将对资源的访问权限限制为仅限特定网域的成员,则必须使用此方法。如果缺少此声明,则表示相应账号不属于 Google 托管网域。

    通过使用 emailemail_verifiedhd 字段,您可以确定 Google 是否托管某个电子邮件地址并对其具有权威性。如果 Google 是权威方,则表示用户是合法的账号所有者,您可以跳过密码或其他身份验证方法。

    Google 具有权威性的情况:

    • email 带有 @gmail.com 后缀,则表示这是 Gmail 账号。
    • email_verified 为 true 且设置了 hd,则为 Google Workspace 账号。

    用户可以注册 Google 账号,而无需使用 Gmail 或 Google Workspace。如果 email 不包含 @gmail.com 后缀且 hd 不存在,则 Google 不具有权威性,建议使用密码或其他质询方法来验证用户身份。email_verified 也可能为 true,因为 Google 最初在创建 Google 账号时验证了用户身份,但第三方电子邮件账号的所有权可能已发生变化。

    我们强烈建议您使用适用于您平台的 Google API 客户端库或通用 JWT 库,而不是自行编写代码来执行这些验证步骤。对于开发和调试,您可以调用我们的 tokeninfo 验证端点。

    Utilizzo di una libreria client dell'API di Google

    Utilizzi una delle librerie client delle API di Google (ad es. Java Node.js, PHP, Python) è il metodo consigliato per convalidare i token ID Google in un ambiente di produzione.

    Java

    Per convalidare un token ID in Java, utilizza la GoogleIdTokenVerifier. Ad esempio:

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

    Il metodo GoogleIdTokenVerifier.verify() verifica il JWT la rivendicazione aud, la rivendicazione iss e la Rivendicazione di exp.

    Se devi confermare che il token ID rappresenta un account Google Workspace o Cloud account dell'organizzazione, puoi verificare la rivendicazione hd controllando il nome di dominio restituito dal metodo Payload.getHostedDomain(). Il dominio del Il reclamo email non è sufficiente per garantire che l'account sia gestito da un dominio o organizzazione.

    di Gemini Advanced.
    Node.js

    Per convalidare un token ID in Node.js, utilizza la libreria di autenticazione di Google per Node.js. Installa la libreria:

    npm install google-auth-library --save
    Quindi, chiama la funzione verifyIdToken(). Ad esempio:

    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 funzione verifyIdToken verifica la firma JWT, la dichiarazione aud, la dichiarazione exp, e la rivendicazione iss.

    Se devi confermare che il token ID rappresenta un account Google Workspace o Cloud dell'organizzazione, puoi controllare la rivendicazione hd, che indica la presenza di dominio dell'utente. Deve essere utilizzato quando limiti l'accesso a una risorsa ai soli membri di determinati domini. L'assenza di questa rivendicazione indica che l'account non appartiene a un dominio ospitato da Google.

    di Gemini Advanced.
    PHP

    Per convalidare un token ID in PHP, utilizza la libreria client dell'API di Google per PHP. Installa la libreria (ad esempio utilizzando Composer):

    composer require google/apiclient
    Quindi, chiama la funzione verifyIdToken(). Ad esempio:

    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 funzione verifyIdToken verifica la firma JWT, la dichiarazione aud, la dichiarazione exp, e la rivendicazione iss.

    Se devi confermare che il token ID rappresenta un account Google Workspace o Cloud dell'organizzazione, puoi controllare la rivendicazione hd, che indica la presenza di dominio dell'utente. Deve essere utilizzato quando limiti l'accesso a una risorsa ai soli membri di determinati domini. L'assenza di questa rivendicazione indica che l'account non appartiene a un dominio ospitato da Google.

    di Gemini Advanced.
    Python

    Per convalidare un token ID in Python, utilizza la classe verify_oauth2_token personalizzata. Ad esempio:

    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 funzione verify_oauth2_token verifica il JWT firma, la rivendicazione aud e la rivendicazione exp. Devi anche verificare il hd dichiarativa (se applicabile) esaminando l'oggetto Resi di verify_oauth2_token. Se più client accedono server di backend, inoltre verifica manualmente l'attestazione aud.

  3. Una volta confermata la validità del token, puoi utilizzare le informazioni contenute nel token ID di Google per correlare lo stato dell'account del tuo sito:

    • Un utente non registrato: puoi mostrare un'interfaccia utente (UI) di registrazione che consenta all'utente di fornire ulteriori informazioni sul profilo, se necessario. Consente inoltre all'utente di creare in silenzio il nuovo account e una sessione utente di accesso.

    • Un account esistente già presente nel tuo sito: puoi mostrare una pagina web che consenta all'utente finale di inserire la password e collegare l'account precedente con le sue credenziali Google. Ciò conferma che l'utente ha accesso all'account esistente.

    • Un utente federato di ritorno: puoi far accedere l'utente in modalità silenziosa.