Mengautentikasi dengan server backend

Jika Anda menggunakan Login dengan Google dengan aplikasi atau situs yang berkomunikasi dengan server backend, Anda mungkin perlu mengidentifikasi pengguna yang saat ini sudah login di server. Untuk melakukannya dengan aman, setelah pengguna berhasil login, kirim token ID pengguna tersebut ke server Anda menggunakan HTTPS. Kemudian, pada server, verifikasi integritas token ID dan gunakan informasi pengguna yang terdapat dalam token untuk membuat sesi atau membuat akun baru.

Mengirim token ID ke server Anda

Pertama-tama, saat pengguna login, dapatkan token ID-nya:

  1. Saat mengonfigurasi Login dengan Google, panggil metode requestIdToken dan teruskan client ID web server Anda.

    // Request only the user's ID token, which can be used to identify the
    // user securely to your backend. This will contain the user's basic
    // profile (name, profile picture URL, etc) so you should not need to
    // make an additional call to personalize your application.
    GoogleSignInOptions gso = new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
            .requestIdToken(getString(R.string.server_client_id))
            .requestEmail()
            .build();
  2. Saat aplikasi dimulai, periksa apakah pengguna sudah login ke aplikasi Anda menggunakan Google, di perangkat ini atau perangkat lain, dengan memanggil silentSignIn:

    GoogleSignIn.silentSignIn()
        .addOnCompleteListener(
            this,
            new OnCompleteListener<GoogleSignInAccount>() {
              @Override
              public void onComplete(@NonNull Task<GoogleSignInAccount> task) {
                handleSignInResult(task);
              }
            });
  3. Jika pengguna tidak dapat login secara otomatis, tampilkan pengalaman logout seperti biasa, dengan memberi pengguna opsi untuk login. Saat pengguna login, dapatkan GoogleSignInAccount pengguna dalam hasil aktivitas intent login:

    // This task is always completed immediately, there is no need to attach an
    // asynchronous listener.
    Task<GoogleSignInAccount> task = GoogleSignIn.getSignedInAccountFromIntent(data);
    handleSignInResult(task);
  4. Setelah pengguna login secara otomatis atau eksplisit, dapatkan token ID dari objek GoogleSignInAccount:

    private void handleSignInResult(@NonNull Task<GoogleSignInAccount> completedTask) {
        try {
            GoogleSignInAccount account = completedTask.getResult(ApiException.class);
            String idToken = account.getIdToken();
    
            // TODO(developer): send ID Token to server and validate
    
            updateUI(account);
        } catch (ApiException e) {
            Log.w(TAG, "handleSignInResult:error", e);
            updateUI(null);
        }
    }

Kemudian, kirim token ID ke server Anda dengan permintaan POST HTTPS:

HttpClient httpClient = new DefaultHttpClient();
HttpPost httpPost = new HttpPost("https://yourbackend.example.com/tokensignin");

try {
  List<NameValuePair> nameValuePairs = new ArrayList<NameValuePair>(1);
  nameValuePairs.add(new BasicNameValuePair("idToken", idToken));
  httpPost.setEntity(new UrlEncodedFormEntity(nameValuePairs));

  HttpResponse response = httpClient.execute(httpPost);
  int statusCode = response.getStatusLine().getStatusCode();
  final String responseBody = EntityUtils.toString(response.getEntity());
  Log.i(TAG, "Signed in as: " + responseBody);
} catch (ClientProtocolException e) {
  Log.e(TAG, "Error sending ID token to backend.", e);
} catch (IOException e) {
  Log.e(TAG, "Error sending ID token to backend.", e);
}

Memverifikasi integritas token ID

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

Untuk memverifikasi bahwa token valid, pastikan hal berikut kriteria terpenuhi:

  • Token ID ditandatangani dengan benar oleh Google. Gunakan kunci publik Google (tersedia di JWK atau format PEM) untuk memverifikasi tanda tangan token. Kunci-kunci ini dirotasi secara berkala; memeriksa header Cache-Control dalam respons untuk menentukan kapan Anda harus mengambilnya lagi.
  • Nilai aud di token ID sama dengan salah satu nilai aplikasi Anda client ID. Pemeriksaan ini diperlukan untuk mencegah token ID yang dikeluarkan untuk aplikasi yang digunakan untuk mengakses data tentang pengguna yang sama di server backend aplikasi Anda.
  • Nilai iss di token ID sama dengan accounts.google.com atau https://accounts.google.com.
  • Waktu habis masa berlaku (exp) token ID belum berlalu.
  • 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 ketika membatasi akses ke sumber daya hanya untuk anggota domain tertentu. Tidak adanya klaim ini mengindikasikan bahwa akun tersebut bukan milik Domain yang dihosting Google.

Dengan kolom email, email_verified, dan hd, Anda dapat menentukan apakah Google menghosting dan bersifat otoritatif untuk alamat email. Dalam kasus di mana Google bersifat otoritatif, pengguna diketahui sebagai pemilik akun yang sah, dan Anda dapat melewati {i>password<i} atau metode-metode tantangan.

Kasus saat Google bersifat otoritatif:

  • email memiliki akhiran @gmail.com, ini adalah akun Gmail.
  • email_verified benar dan hd ditetapkan, ini adalah akun G Suite.

Pengguna dapat mendaftar ke Akun Google tanpa menggunakan Gmail atau G Suite. Kapan email tidak berisi akhiran @gmail.com dan hd tidak ada, Google tidak otoritatif, dan menggunakan {i>password<i} atau metode verifikasi lainnya disarankan untuk pengguna. email_verified juga bisa benar karena Google awalnya memverifikasi pengguna saat Akun Google dibuat, namun kepemilikan pihak ketiga akun email Anda mungkin telah berubah.

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

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 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 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: 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 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' => $CLIENT_ID]);  // Specify the CLIENT_ID of the app that accesses the backend
$payload = $client->verifyIdToken($id_token);
if ($payload) {
  $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 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 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.
    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.

Memanggil endpoint tokeninfo

Cara mudah untuk memvalidasi tanda tangan token ID untuk proses debug adalah dengan gunakan endpoint tokeninfo. Memanggil endpoint ini melibatkan permintaan jaringan tambahan yang melakukan sebagian besar validasi untuk Anda saat menguji validasi dan ekstraksi payload dalam kode Anda sendiri. Tidak cocok untuk digunakan dalam produksi kode karena permintaan dapat terhambat atau mengalami error intermiten.

Untuk memvalidasi token ID menggunakan endpoint tokeninfo, buat 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 iss serta exp klaim memiliki nilai yang diharapkan, Anda akan mendapatkan respons HTTP 200, dengan bagian 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 memeriksanya klaim hd, yang menunjukkan domain pengguna yang dihosting. Ini harus digunakan saat membatasi akses ke sumber daya hanya untuk anggota domain tertentu. Tidak adanya klaim ini menunjukkan bahwa akun tersebut tidak termasuk dalam 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.