Memverifikasi token ID Google di sisi server Anda

Setelah Google menampilkan token ID, token ID akan dikirimkan oleh permintaan metode POST HTTP, dengan nama parameter credential, ke endpoint login Anda.

Berikut adalah contoh dalam bahasa Python yang menunjukkan langkah-langkah biasa untuk memvalidasi dan menggunakan token ID:

1. Verifikasi token Pemalsuan Permintaan Lintas Situs (CSRF). Saat Anda mengirimkan kredensial ke endpoint login, kami akan menggunakan pola pengiriman cookie ganda untuk mencegah serangan CSRF. Sebelum setiap pengiriman, kami membuat token. Kemudian, token dimasukkan ke dalam cookie dan isi postingan, seperti yang ditunjukkan pada contoh kode berikut:

   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. 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 dirotasi secara rutin; periksa header Cache-Control dalam respons untuk menentukan kapan Anda harus mengambilnya lagi.
   • Nilai aud dalam token ID sama dengan salah satu client ID 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.

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

   Menggunakan Library Klien Google API

   Menggunakan salah satu Library Klien Google API (misalnya 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 objek 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 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.");
   }

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

   Jika perlu memvalidasi bahwa token ID mewakili akun organisasi Google Workspace atau Cloud, Anda dapat memverifikasi klaim hd dengan memeriksa nama domain yang ditampilkan oleh metode Payload.getHostedDomain(). Domain dari 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

   Lalu, 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: 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 request specified a G Suite domain:
     // const domain = payload['hd'];
   }
   verify().catch(console.error);
   

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

   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.

   PHP

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

   composer require google/apiclient

   Lalu, panggil fungsi verifyIdToken(). Contoh:

   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 request specified a G Suite domain:
     //$domain = $payload['hd'];
   } else {
     // Invalid ID token
   }
   

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

   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.

   Python

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

   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 auth request is from a G Suite domain:
       # if idinfo['hd'] != GSUITE_DOMAIN_NAME:
       #     raise ValueError('Wrong hosted domain.')
   
       # ID token is valid. Get the user's Google Account ID from the decoded token.
       userid = idinfo['sub']
   except ValueError:
       # Invalid token
       pass
   

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

   Poin Penting: Token ID ditampilkan dalam kolom credential, bukan kolom g_csrf_token.

3. Setelah validitas token dikonfirmasi, Anda dapat menggunakan informasi di token ID Google untuk menghubungkan status akun situs Anda:

   • Pengguna yang tidak terdaftar: Anda dapat menampilkan antarmuka pengguna (UI) pendaftaran yang memungkinkan pengguna memberikan informasi profil tambahan, jika diperlukan. Fitur ini juga memungkinkan pengguna membuat akun baru dan sesi pengguna yang login secara otomatis.

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

   • Pengguna federasi yang kembali: Anda dapat membuat pengguna login secara otomatis.

Poin Penting: Hanya gunakan kolom token ID Google sub sebagai ID untuk pengguna karena kolom ini unik di antara semua Akun Google dan tidak pernah digunakan kembali. Anda harus menyimpan kolom sub dan mengaitkannya dengan pengguna di sistem pengelolaan akun. Meskipun Anda dapat menggunakan alamat email dari token ID untuk memeriksa apakah pengguna sudah memiliki akun, jangan gunakan alamat email sebagai ID karena Akun Google dapat memiliki beberapa alamat email pada waktu yang berbeda-beda.