Melakukan autentikasi dengan backend menggunakan token ID

Klien login Sekali Ketuk akan mengambil token ID Google saat pengguna memilih Akun Google. Token ID adalah pernyataan bertanda tangan dari identitas pengguna yang juga berisi informasi profil dasar pengguna, mungkin termasuk alamat email yang telah diverifikasi oleh Google.

Jika token ID tersedia, Anda dapat menggunakannya untuk melakukan autentikasi secara aman dengan backend aplikasi Anda, atau untuk mendaftarkan pengguna ke akun baru secara otomatis tanpa perlu memverifikasi alamat email pengguna.

Untuk membuat atau mendaftarkan pengguna dengan token ID, kirim token tersebut ke backend aplikasi Anda. Di backend, verifikasi token menggunakan library klien Google API atau library JWT tujuan umum. Jika pengguna belum pernah login ke aplikasi Anda dengan Akun Google ini, buat akun baru.

Jika Anda memilih untuk menggunakan nonce guna membantu menghindari serangan replay, gunakan getNonce untuk mengirimkannya bersama dengan Token ID ke server backend, dan periksa nilai yang diharapkan. Sebaiknya pertimbangkan untuk menggunakan nonce untuk meningkatkan keselamatan dan keamanan pengguna.

Mendapatkan token ID dari objek kredensial

Setelah Anda mengambil kredensial pengguna, periksa apakah objek kredensial tersebut berisi token ID. Jika ya, kirimkan ke backend Anda.

Java

public class YourActivity extends AppCompatActivity {

  // ...
  private static final int REQ_ONE_TAP = 2;  // Can be any integer unique to the Activity.
  private boolean showOneTapUI = true;
  // ...

  @Override
  protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
      super.onActivityResult(requestCode, resultCode, data);

      switch (requestCode) {
          case REQ_ONE_TAP:
              try {
                  SignInCredential credential = oneTapClient.getSignInCredentialFromIntent(data);
                  String idToken = credential.getGoogleIdToken();
                  if (idToken !=  null) {
                      // Got an ID token from Google. Use it to authenticate
                      // with your backend.
                      Log.d(TAG, "Got ID token.");
                  }
              } catch (ApiException e) {
                  // ...
              }
              break;
      }
  }
}

Kotlin

class YourActivity : AppCompatActivity() {

    // ...
    private val REQ_ONE_TAP = 2  // Can be any integer unique to the Activity
    private var showOneTapUI = true
    // ...

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)

        when (requestCode) {
             REQ_ONE_TAP -> {
                try {
                    val credential = oneTapClient.getSignInCredentialFromIntent(data)
                    val idToken = credential.googleIdToken
                    when {
                        idToken != null -> {
                            // Got an ID token from Google. Use it to authenticate
                            // with your backend.
                            Log.d(TAG, "Got ID token.")
                        }
                        else -> {
                            // Shouldn't happen.
                            Log.d(TAG, "No ID token!")
                        }
                    }
                } catch (e: ApiException) {
                    // ...
            }
        }
    }
    // ...
}

Memverifikasi integritas token ID

Setelah menerima token ID melalui HTTPS POST, Anda harus memverifikasi integritas token.

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.

Memanggil endpoint tokeninfo

Cara mudah untuk memvalidasi tanda tangan token ID untuk proses debug adalah dengan menggunakan endpoint tokeninfo. Pemanggilan endpoint ini melibatkan permintaan jaringan tambahan yang melakukan sebagian besar validasi untuk Anda saat Anda menguji validasi dan ekstraksi payload yang tepat dalam kode Anda sendiri. Fitur ini tidak cocok untuk digunakan dalam kode produksi karena permintaan dapat diperlambat atau dapat mengalami error yang berselang-seling.

Untuk memvalidasi token ID menggunakan endpoint tokeninfo, buat permintaan HTTPS POST atau GET ke endpoint, dan teruskan token ID di parameter id_token. Misalnya, untuk memvalidasi token "XYZ123", buat permintaan GET berikut:

https://oauth2.googleapis.com/tokeninfo?id_token=XYZ123

Jika token ditandatangani dengan benar dan klaim iss serta exp memiliki nilai yang diharapkan, Anda akan mendapatkan respons HTTP 200, dengan isinya berisi klaim token ID berformat JSON. Berikut adalah contoh respons:

{
 // These six fields are included in all Google ID Tokens.
 "iss": "https://accounts.google.com",
 "sub": "110169484474386276334",
 "azp": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
 "aud": "1008719970978-hb24n2dstb40o45d4feuo2ukqmcc6381.apps.googleusercontent.com",
 "iat": "1433978353",
 "exp": "1433981953",

 // These seven fields are only included when the user has granted the "profile" and
 // "email" OAuth scopes to the application.
 "email": "testuser@gmail.com",
 "email_verified": "true",
 "name" : "Test User",
 "picture": "https://lh4.googleusercontent.com/-kYgzyAWpZzJ/ABCDEFGHI/AAAJKLMNOP/tIXL9Ir44LE/s99-c/photo.jpg",
 "given_name": "Test",
 "family_name": "User",
 "locale": "en"
}

Jika perlu memvalidasi bahwa token ID mewakili akun Google Workspace, Anda dapat memeriksa klaim hd, yang menunjukkan domain yang dihosting dari 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 Workspace.

Membuat akun atau sesi

Setelah memverifikasi token, periksa apakah pengguna sudah ada di database pengguna Anda. Jika demikian, buat sesi yang diautentikasi untuk pengguna. Jika pengguna belum berada di database pengguna, buat record pengguna baru dari informasi dalam payload token ID, dan buat sesi untuk pengguna tersebut. Anda dapat meminta pengguna untuk memberikan informasi profil tambahan yang diperlukan saat mendeteksi pengguna yang baru dibuat di aplikasi Anda.

Mengamankan akun pengguna Anda dengan Perlindungan Lintas Akun

Jika Anda mengandalkan Google untuk memproses login pengguna, Anda akan otomatis mendapatkan manfaat dari semua fitur keamanan dan infrastruktur yang dibuat oleh Google untuk mengamankan data pengguna. Namun, seandainya Akun Google pengguna disusupi atau terjadi beberapa peristiwa keamanan signifikan lainnya, aplikasi Anda juga dapat rentan terhadap serangan. Untuk melindungi akun Anda dengan lebih baik dari peristiwa keamanan besar, gunakan Perlindungan Lintas Akun untuk menerima notifikasi keamanan dari Google. Saat menerima peristiwa ini, Anda dapat melihat perubahan penting pada keamanan Akun Google pengguna, dan Anda dapat mengambil tindakan pada layanan untuk mengamankan akun Anda.