Memverifikasi token ID Google di sisi server

Saat menggunakan Google Identity Services atau alur kode otorisasi OAuth 2.0, Google akan menampilkan token ID menggunakan metode POST ke endpoint pengalihan. Atau, alur implisit OIDC menggunakan permintaan GET. Oleh karena itu, aplikasi Anda bertanggung jawab untuk mengirimkan kredensial yang diterima ini ke server Anda secara aman.

GET

Ini adalah alur implisit, token ID ditampilkan dalam fragmen URL, yang harus diuraikan oleh JavaScript sisi klien. Aplikasi Anda bertanggung jawab untuk menerapkan mekanisme validasinya sendiri guna memastikan keaslian permintaan dan mencegah serangan seperti CSRF. 

    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

Token ID dikirim kembali sebagai kolom credential. Saat bersiap mengirim Token ID ke server, library GIS akan otomatis menambahkan g_csrf_token ke cookie header dan isi permintaan. Berikut adalah contoh permintaan POST:

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. Memvalidasi g_csrf_token untuk mencegah serangan Pemalsuan Permintaan Lintas Situs (CSRF):

    • Ekstrak nilai token CSRF dari cookie g_csrf_token.
    • Ekstrak nilai token CSRF dari isi permintaan. Library GIS menyertakan token ini dalam isi permintaan POST sebagai parameter, yang juga bernama g_csrf_token.
    • Bandingkan kedua nilai token
      • Jika kedua nilai ada dan cocok sepenuhnya, permintaan dianggap sah dan berasal dari domain Anda.
      • Jika nilai tidak ada atau tidak cocok, permintaan harus ditolak oleh server. Pemeriksaan ini memastikan bahwa permintaan dimulai dari JavaScript yang berjalan di domain Anda sendiri, karena hanya domain Anda yang dapat mengakses cookie g_csrf_token.

  2. Verifikasi token ID.

    Untuk memverifikasi bahwa token valid, pastikan kriteria berikut terpenuhi:

    • Token ID ditandatangani dengan benar oleh Google. Gunakan kunci publik Google (tersedia dalam format JWK atau PEM) untuk memverifikasi tanda tangan token. Kunci ini diubah secara rutin; periksa header Cache-Control dalam respons untuk menentukan kapan Anda harus mengambilnya lagi.
    • Nilai aud dalam token ID sama dengan salah satu ID klien aplikasi Anda. Pemeriksaan ini diperlukan untuk mencegah token ID yang dikeluarkan ke aplikasi berbahaya digunakan untuk mengakses data tentang pengguna yang sama di server backend aplikasi Anda.
    • Nilai iss dalam token ID sama dengan accounts.google.com atau https://accounts.google.com.
    • Waktu habis masa berlaku (exp) token ID belum berlalu.
    • Jika perlu memvalidasi bahwa token ID mewakili akun organisasi Google Workspace atau Cloud, Anda dapat memeriksa klaim hd, yang menunjukkan domain yang dihosting pengguna. Ini harus digunakan saat membatasi akses ke resource hanya untuk anggota domain tertentu. Tidak adanya klaim ini menunjukkan bahwa akun tersebut bukan milik domain yang dihosting Google.

    Dengan menggunakan kolom email, email_verified, dan hd, Anda dapat menentukan apakah Google menghosting dan memiliki otoritas untuk alamat email. Jika Google adalah otoritasnya, pengguna diketahui sebagai pemilik akun yang sah, dan Anda dapat melewati sandi atau metode verifikasi lainnya.

    Kasus saat Google bersifat otoritatif:

    • email memiliki akhiran @gmail.com, ini adalah akun Gmail.
    • email_verified benar dan hd disetel, maka ini adalah akun Google Workspace.

    Pengguna dapat mendaftar Akun Google tanpa menggunakan Gmail atau Google Workspace. Jika email tidak berisi akhiran @gmail.com dan hd tidak ada, Google tidak bersifat otoritatif dan metode verifikasi sandi atau verifikasi lainnya direkomendasikan untuk memverifikasi pengguna. email_verified juga dapat bernilai benar karena Google awalnya memverifikasi pengguna saat Akun Google dibuat, tetapi kepemilikan akun email pihak ketiga mungkin telah berubah sejak saat itu.

    Daripada menulis kode Anda sendiri untuk melakukan langkah-langkah verifikasi ini, sebaiknya gunakan library klien Google API untuk platform Anda, atau library JWT serbaguna. Untuk pengembangan dan proses debug, Anda dapat memanggil endpoint validasi tokeninfo kami.

    使用 Google API 客户端库

    使用某个 Google API 客户端库（例如 Java、 Node.js、 PHP、 Python） 是在生产环境中验证 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. Setelah validitas token dikonfirmasi, Anda dapat menggunakan informasi dalam token ID Google untuk mengorelasikan status akun situs Anda:

    • Pengguna yang tidak terdaftar: Anda dapat menampilkan antarmuka pengguna (UI) pendaftaran yang memungkinkan pengguna memberikan informasi profil tambahan, jika diperlukan. Selain itu, pengguna dapat membuat akun baru dan sesi pengguna yang login secara diam-diam.

    • Akun yang sudah ada di situs Anda: Anda dapat menampilkan halaman web yang memungkinkan pengguna akhir memasukkan sandi mereka dan menautkan akun lama dengan kredensial Google mereka. Hal ini mengonfirmasi bahwa pengguna memiliki akses ke akun yang ada.

    • Pengguna gabungan yang kembali: Anda dapat login pengguna secara diam-diam.