Mengintegrasikan Identity Platform dengan reCAPTCHA Enterprise API

Penyedia email-sandi

Mode audit dan penerapan berperilaku sebagai berikut untuk alur autentikasi email-sandi.

Mode audit

Saat Anda menyetel penegakan sandi email ke mode audit, Identity Platform akan membuat satu atau beberapa kunci reCAPTCHA di project Anda yang digunakan untuk menilai traffic ke Identity Platform API tanpa memblokir permintaan apa pun. Gunakan metrik yang dikeluarkan selama mode audit untuk menentukan apakah Anda harus mengaktifkan penerapan reCAPTCHA.

Mode terapkan

Saat Anda menyetel penegakan sandi email ke mode penegakan, Identity Platform akan membuat satu atau beberapa kunci reCAPTCHA di project Anda yang digunakan untuk menilai traffic ke Identity Platform API. Permintaan API yang tidak menyertakan token reCAPTCHA akan ditolak. Aktifkan penerapan hanya setelah Anda memigrasikan semua klien ke SDK dengan dukungan reCAPTCHA.

Penyedia telepon

Mode audit dan penegakan berperilaku sebagai berikut untuk alur autentikasi telepon.

Mode audit

Saat Anda menyetel penerapan autentikasi telepon ke mode audit, Identity Platform menggunakan perlindungan bot reCAPTCHA untuk verifikasi aplikasi. Jika permintaan pengguna lulus penilaian penipuan pulsa, kode verifikasi SMS akan dikirim. Jika permintaan pengguna gagal dalam penilaian penipuan pulsa dan Anda menggunakan SDK klien, Identity Platform akan memicu metode verifikasi pengganti untuk menyelesaikan alur autentikasi telepon. Metode penggantian yang diterima bergantung pada platform aplikasi Anda.

SDK klien memicu metode verifikasi penggantian dalam skenario berikut:

• Token reCAPTCHA tidak ada.
• Token reCAPTCHA tidak valid atau sudah tidak berlaku.
• Token reCAPTCHA tidak melewati nilai minimum.
• reCAPTCHA tidak dikonfigurasi dengan benar.

Pastikan metode verifikasi penggantian untuk platform aplikasi Anda disiapkan dan siap dipicu oleh SDK klien jika diperlukan.

Mode terapkan

Saat Anda menyetel penerapan autentikasi telepon ke mode penerapan, Identity Platform menggunakan perlindungan bot reCAPTCHA untuk verifikasi aplikasi. Jika permintaan pengguna lulus penilaian penipuan pulsa, kode verifikasi SMS akan dikirim. Jika permintaan pengguna gagal dalam penilaian penipuan melalui telepon, Identity Platform akan memblokir permintaan tersebut dan tidak mengirimkan pesan SMS yang berisi kode verifikasi.

Tidak ada verifikasi penggantian yang diperlukan dalam mode terapkan, Anda tidak perlu menyiapkan metode verifikasi tambahan untuk aplikasi Anda. Namun, sebaiknya siapkan pemverifikasi reCAPTCHA untuk aplikasi web guna memastikan reCAPTCHA v2 diaktifkan jika Anda memutuskan untuk mengubah mode reCAPTCHA aplikasi Anda menjadi AUDIT atau OFF.

Penyedia email-sandi

Untuk mengaktifkan perlindungan bot reCAPTCHA untuk alur autentikasi email-sandi, lakukan hal berikut:

1. Jika Anda belum melakukannya, aktifkan reCAPTCHA Enterprise API di project Anda.

2. Untuk mengaktifkan perlindungan bot untuk project, gunakan Admin SDK. Dukungan reCAPTCHA tersedia di Admin SDK Node.js versi 11.7.0 dan yang lebih baru.

   Contoh:

   // Update project config with reCAPTCHA config
   const updateConfigRequest = {
     recaptchaConfig: {
       emailPasswordEnforcementState:  'ENFORCE_MODE',
       managedRules: [{
         endScore: END_SCORE,
         action: 'BLOCK'
       }]
     }
   };
   const updateProjectConfigWithRecaptcha = () => {
     getAuth().projectConfigManager().updateProjectConfig(updateConfigRequest).then((response) => {
       console.log('Updated reCAPTCHA config for project: ', response.recaptchaConfig);
     }).catch((error) => {
       console.log('Error updating project config:', error);
     });
   }
   

   Ganti kode berikut:

   • ENFORCE_MODE: mode yang ingin Anda tetapkan untuk penerapan autentikasi email-sandi reCAPTCHA. Nilai yang valid adalah OFF, AUDIT, dan ENFORCE. Untuk mengaktifkan perlindungan bot, parameter ini harus ditetapkan ke AUDIT atau ENFORCE. Saat Anda mengaktifkan perlindungan bot untuk pertama kalinya, sebaiknya tetapkan parameter ini ke AUDIT dan pastikan alur autentikasi Anda dilindungi sebelum menetapkannya ke ENFORCE. Untuk mengetahui informasi selengkapnya tentang cara kerja mode, lihat Mode perlindungan bot reCAPTCHA.
   • END_SCORE: skor penilaian perlindungan bot terendah yang dapat dimiliki permintaan sebelum gagal. Anda dapat menetapkan skor ini antara 0.0 dan 1.0. Misalnya, jika Anda menetapkan nilai minimum 0.6, reCAPTCHA akan gagal memproses permintaan dengan nilai 0.5 atau lebih rendah. Oleh karena itu, semakin tinggi skor yang Anda tetapkan, semakin ketat aturannya.

   Anda juga dapat mengaktifkan perlindungan bot dengan metode konfigurasi yang sama untuk tenant menggunakan Admin SDK. Untuk mengetahui informasi selengkapnya tentang cara memperbarui tenant, lihat Memperbarui tenant.

3. Jika Anda menggunakan Identity Platform di iOS atau Android, Anda harus mendaftarkan aplikasi dari Firebase console:

   • Untuk iOS, daftarkan setiap ID paket yang menggunakan Identity Platform
   • Untuk Android, daftarkan setiap nama paket Android yang menggunakan Identity Platform

   Jika menggunakan Identity Platform di web, Anda harus menambahkan domain yang diizinkan untuk setiap domain yang menggunakan reCAPTCHA. Untuk menambahkan domain yang diizinkan, lakukan hal berikut:

   1. Di konsol Google Cloud , buka halaman Identity Platform.

      Buka Identity Platform

   2. Buka Setelan > Keamanan.

   3. Klik Tambahkan domain.

   4. Masukkan nama domain, lalu klik Tambahkan untuk menyimpan domain.

   Penyediaan kunci reCAPTCHA dapat memerlukan waktu beberapa menit untuk diselesaikan.

4. Jika Anda telah menyetel penerapan ke mode audit, sebaiknya pantau metrik reCAPTCHA untuk perlindungan bot guna memastikan alur Anda dilindungi.

Penyedia telepon

Untuk mengaktifkan perlindungan bot reCAPTCHA untuk alur autentikasi berbasis SMS, lakukan hal berikut:

1. Jika Anda belum melakukannya, aktifkan reCAPTCHA Enterprise API di project Anda.

2. Untuk mengaktifkan perlindungan bot untuk project, gunakan Admin SDK. Dukungan reCAPTCHA tersedia di Admin SDK Node.js versi 12.7.0 dan yang lebih baru.

   Contoh:

   // Update project config with reCAPTCHA config
   const updateProjectConfigRequest = {
     recaptchaConfig: {
       phoneEnforcementState: 'ENFORCE_MODE',
       managedRules: [{ endScore: END_SCORE, action: 'BLOCK' }],
       useSmsBotScore: 'true',
     }
   }
   let projectConfig = await getAuth().projectConfigManager().updateProject(updateProjectConfigRequest);
   

   Ganti kode berikut:

   • ENFORCE_MODE: mode yang ingin Anda tetapkan untuk penerapan autentikasi telepon reCAPTCHA. Nilai yang valid adalah OFF, AUDIT, dan ENFORCE. Untuk mengaktifkan perlindungan bot untuk alur berbasis SMS, parameter ini harus ditetapkan ke AUDIT atau ENFORCE dan useSmsBotScore harus ditetapkan ke true.

     Saat mengaktifkan perlindungan bot untuk pertama kalinya, sebaiknya setel parameter ini ke AUDIT dan pastikan alur autentikasi Anda dilindungi sebelum menyetelnya ke ENFORCE. Untuk mengetahui informasi selengkapnya tentang cara kerja mode, lihat Mode perlindungan bot reCAPTCHA.

   • END_SCORE: skor penilaian perlindungan bot terendah yang dapat dimiliki permintaan sebelum gagal. Anda dapat menetapkan skor ini antara 0.0 dan 1.0. Misalnya, jika Anda menetapkan nilai minimum 0.6, reCAPTCHA akan gagal memproses permintaan dengan nilai 0.5 atau lebih rendah. Oleh karena itu, semakin tinggi skor yang Anda tetapkan, semakin ketat aturannya.

   Anda juga dapat mengaktifkan perlindungan bot dengan metode konfigurasi yang sama untuk tenant menggunakan Admin SDK. Untuk mengetahui informasi selengkapnya tentang memperbarui tenant, lihat Memperbarui tenant.

3. Jika Anda menggunakan Identity Platform di iOS atau Android, Anda harus mendaftarkan aplikasi dari Firebase console:

   • Untuk iOS, daftarkan setiap ID paket yang menggunakan Identity Platform
   • Untuk Android, daftarkan setiap nama paket Android yang menggunakan Identity Platform

   Jika menggunakan Identity Platform di web, Anda harus menambahkan domain yang diotorisasi untuk setiap domain yang menggunakan reCAPTCHA. Untuk menambahkan domain resmi, lakukan hal berikut:

   1. Di konsol Google Cloud , buka halaman Identity Platform.

      Buka Identity Platform

   2. Buka Setelan > Keamanan.

   3. Klik Tambahkan domain.

   4. Masukkan nama domain, lalu klik Tambahkan untuk menyimpan domain.

   Penyediaan kunci reCAPTCHA dapat memerlukan waktu beberapa menit untuk diselesaikan.

4. Jika Anda telah menyetel penerapan ke mode audit, sebaiknya pantau metrik reCAPTCHA untuk perlindungan bot guna memastikan alur Anda dilindungi.

Web

1. Update ke versi terbaru Web SDK.

   • Dukungan reCAPTCHA untuk autentikasi email dan sandi di aplikasi web tersedia di JavaScript SDK versi 9.20.0 dan yang lebih baru.
   • Dukungan reCAPTCHA untuk autentikasi telepon di aplikasi web tersedia di JavaScript SDK versi 11 dan yang lebih baru.

   Setelah Anda mengintegrasikan SDK web dengan aplikasi, SDK akan otomatis mengambil konfigurasi reCAPTCHA Anda dan mengaktifkan perlindungan untuk penyedia yang telah Anda konfigurasi.

2. Jika diperlukan, Anda dapat memaksa pengambilan sinyal reCAPTCHA sebagai berikut:

   import { initializeRecaptchaConfig } from '@firebase/auth';
   
   // Initialize Firebase Authentication
   const auth = getAuth();
   initializeRecaptchaConfig(auth)
     .then(() => {
       console.log("Recaptcha Enterprise Config Initialization successful.")
     })
     .catch((error) => {
       console.error("Recaptcha Enterprise Config Initialization failed with " + error)
     });
   

Android

1. Update ke Android SDK versi terbaru. Dukungan reCAPTCHA untuk autentikasi email dan sandi serta autentikasi telepon di aplikasi Android tersedia di Android SDK versi 23.1.0 dan yang lebih baru.

   Selain itu, dukungan reCAPTCHA memerlukan level API 23 (Marshmallow) atau yang lebih tinggi dan Android 6 atau yang lebih tinggi.

   Setelah mengintegrasikan Android SDK dengan aplikasi, SDK akan otomatis mengambil konfigurasi reCAPTCHA dan mengaktifkan perlindungan untuk penyedia yang telah Anda konfigurasi.

2. Tambahkan aturan build berikut ke bagian dependensi file build.gradle tingkat aplikasi Anda:

   implementation 'com.google.android.recaptcha:recaptcha:18.5.1'
   

   Pastikan untuk menggunakan reCAPTCHA SDK versi 18.5.1 atau yang lebih baru.

3. Jika diperlukan, Anda dapat memaksa pengambilan sinyal reCAPTCHA sebagai berikut:

   • Kotlin:

   // Initialize Firebase Authentication
   auth = Firebase.auth
   
   auth.initializeRecaptchaConfig().addOnCompleteListener(this) { task ->
       if (task.isSuccessful) {
           Log.d(TAG, "Recaptcha Enterprise Initialization successful.")
       } else {
           Log.w(TAG, "Recaptcha Enterprise Initialization failed.")
       }
   }
   

   • Java:

   // Initialize Firebase Authentication
   auth = FirebaseAuth.getInstance();
   auth.initializeRecaptchaConfig().addOnCompleteListener(
     this, new OnCompleteListener<void>() {
     @Override
     public void onComplete(@NonNull Task<void> task) {
       if (task.isSuccessful()) {
         Log.d(TAG, "Recaptcha Enterprise Initialization successful.");
       } else {
         Log.w(TAG, "Recaptcha Enterprise Initialization failed.");
       }
     }
   });
   

iOS

1. Update ke iOS SDK versi 11.6.0 atau yang lebih baru. Setelah Anda mengintegrasikan iOS SDK dengan aplikasi, SDK akan otomatis mengambil konfigurasi reCAPTCHA Anda dan mengaktifkan perlindungan untuk penyedia yang telah Anda konfigurasi.

2. Untuk mengintegrasikan reCAPTCHA iOS SDK ke aplikasi Anda, lihat Menyiapkan lingkungan Anda.

3. Pastikan -ObjC tercantum dalam flag linker Anda. Buka Target > Build Settings > All > Linking dan pastikan Other Linker Flags menampilkan -ObjC.

4. Jika diperlukan, Anda dapat memaksa pengambilan sinyal reCAPTCHA sebagai berikut:

   • Swift:

   // Initialize Firebase Authentication
   try await Auth.auth().initializeRecaptchaConfig()
   

   • Objective-C:

   // Initialize Firebase Authentication
   [[FIRAuth auth] initializeRecaptchaConfigWithCompletion:^(NSError * _Nullable error) {
     // Firebase Authentication initialization finished
   }];
   

Penyedia email-sandi

Untuk mengaktifkan penerapan reCAPTCHA untuk alur autentikasi email-sandi di project atau tenant, gunakan Admin SDK untuk menjalankan perintah berikut:

const enforceRequest = {
  recaptchaConfig: {
    emailPasswordEnforcementState:  'ENFORCE',
    }]
  }
};

Penyedia telepon

Untuk mengaktifkan penerapan reCAPTCHA untuk alur autentikasi berbasis SMS di project atau tenant, gunakan Admin SDK untuk menjalankan perintah berikut:

const enforceRequest = {
  recaptchaConfig: {
    phoneEnforcementState:  'ENFORCE',
    useSmsBotScore: 'true'
    }]
  }
};

Penyedia email-sandi

Untuk menonaktifkan perlindungan bot untuk alur autentikasi email-sandi, gunakan Admin SDK untuk menjalankan perintah berikut:

const disableRequest = {
  recaptchaConfig: {
    emailPasswordEnforcementState:  'OFF',
  }
};

Penyedia telepon

Untuk menonaktifkan perlindungan bot untuk alur autentikasi berbasis SMS, gunakan Admin SDK untuk menjalankan perintah berikut:

const disableRequest = {
  recaptchaConfig: {
    phoneEnforcementState:  'OFF',
    useSmsBotScore: 'false'
  }
};