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.

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

   Menggunakan Library Klien Google API

   Menggunakan salah satu Library Klien Google API (mis. Java, Node.js, PHP, Python) adalah cara yang direkomendasikan untuk memvalidasi token ID Google di lingkungan produksi.

   Java

   Untuk memvalidasi token ID di Java, gunakan GoogleIdTokenVerifier. Contoh:

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

   Metode GoogleIdTokenVerifier.verify() memverifikasi JWT tanda tangan, klaim aud, klaim iss, dan Klaim exp.

   Jika Anda perlu memvalidasi bahwa token ID tersebut mewakili jaringan Google Workspace atau Cloud akun organisasi, Anda dapat memverifikasi klaim hd dengan memeriksa nama domain yang ditampilkan oleh metode Payload.getHostedDomain(). Domain Klaim email tidak cukup untuk memastikan bahwa akun dikelola oleh domain atau organisasi.

   Node.js

   Untuk memvalidasi token ID di Node.js, gunakan Library Google Auth untuk Node.js. Instal library:

   npm install google-auth-library --save

   Kemudian, panggil fungsi verifyIdToken(). Contoh:

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

   Fungsi verifyIdToken memverifikasi tanda tangan JWT, klaim aud, klaim exp, dan klaim iss.

   Jika Anda perlu memvalidasi bahwa token ID tersebut mewakili jaringan Google Workspace atau Cloud akun organisasi Anda, Anda dapat memeriksa klaim hd, yang menunjukkan bahwa domain pengguna. Ini harus digunakan saat membatasi akses ke resource hanya untuk anggota domain tertentu. Tidak adanya klaim ini mengindikasikan bahwa akun tersebut bukan milik domain yang dihosting Google.

   PHP

   Untuk memvalidasi token ID di PHP, gunakan Library Klien Google API untuk PHP. Instal library (misalnya, menggunakan Composer):

   composer require google/apiclient

   Kemudian, panggil fungsi verifyIdToken(). Contoh:

   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
   }

   Fungsi verifyIdToken memverifikasi tanda tangan JWT, klaim aud, klaim exp, dan klaim iss.

   Jika Anda perlu memvalidasi bahwa token ID tersebut mewakili jaringan Google Workspace atau Cloud akun organisasi Anda, Anda dapat memeriksa klaim hd, yang menunjukkan bahwa domain pengguna. Ini harus digunakan saat membatasi akses ke resource hanya untuk anggota domain tertentu. Tidak adanya klaim ini mengindikasikan bahwa akun tersebut bukan milik domain yang dihosting Google.

   Python

   Untuk memvalidasi token ID di Python, gunakan metode verify_oauth2_token . Contoh:

   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

   Fungsi verify_oauth2_token memverifikasi JWT tanda tangan, klaim aud, dan klaim exp. Anda juga harus memverifikasi hd klaim (jika berlaku) dengan memeriksa objek yang verify_oauth2_token ditampilkan. Jika beberapa klien mengakses server backend, juga memverifikasi klaim aud secara manual.

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.