Melakukan Autentikasi dengan Firebase di Android Menggunakan Nomor Telepon

Anda dapat menggunakan Firebase Authentication untuk membuat pengguna login dengan mengirim pesan SMS ke ponselnya. Selanjutnya, pengguna login menggunakan kode sekali pakai yang dikirimkan dalam pesan SMS.

Cara termudah untuk menambahkan login dengan nomor telepon ke aplikasi adalah menggunakan FirebaseUI, yang mencakup widget login drop-in yang mengimplementasikan proses login untuk login dengan nomor telepon serta login berbasis sandi dan gabungan. Dokumen ini berisi penjelasan mengenai cara mengimplementasikan proses login dengan nomor telepon menggunakan Firebase SDK.

Sebelum memulai

  1. Tambahkan Firebase ke project Android jika Anda belum melakukannya.
  2. Dalam file Gradle modul (level aplikasi) (biasanya <project>/<app-module>/build.gradle.kts atau <project>/<app-module>/build.gradle), tambahkan dependensi untuk library Android Firebase Authentication. Sebaiknya gunakan Firebase Android BoM untuk mengontrol pembuatan versi library.

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // Add the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-auth-ktx")
    }
    

    Dengan menggunakan Firebase Android BoM, aplikasi Anda akan selalu menggunakan versi library Android Firebase yang kompatibel.

    (Alternatif) Tambahkan dependensi library Firebase tanpa menggunakan BoM

    Jika memilih untuk tidak menggunakan Firebase BoM, Anda harus menentukan setiap versi library Firebase di baris dependensinya.

    Perlu diperhatikan bahwa jika Anda menggunakan beberapa library Firebase di aplikasi, sebaiknya gunakan BoM untuk mengelola versi library, yang memastikan bahwa semua versi kompatibel.

    dependencies {
        // Add the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-auth-ktx:22.1.2")
    }
    

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // Add the dependency for the Firebase Authentication library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-auth")
    }
    

    Dengan menggunakan Firebase Android BoM, aplikasi Anda akan selalu menggunakan versi library Android Firebase yang kompatibel.

    (Alternatif) Tambahkan dependensi library Firebase tanpa menggunakan BoM

    Jika memilih untuk tidak menggunakan Firebase BoM, Anda harus menentukan setiap versi library Firebase di baris dependensinya.

    Perlu diperhatikan bahwa jika Anda menggunakan beberapa library Firebase di aplikasi, sebaiknya gunakan BoM untuk mengelola versi library, yang memastikan bahwa semua versi kompatibel.

    dependencies {
        // Add the dependency for the Firebase Authentication library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-auth:22.1.2")
    }
    
  3. Jika belum menghubungkan aplikasi ke project Firebase, lakukanlah dari Firebase console.
  4. Tentukan hash SHA-1 aplikasi Anda di Firebase console jika Anda belum melakukannya. Baca artikel Mengautentikasi Klien untuk mengetahui cara menemukan hash SHA-1 aplikasi.

Masalah keamanan

Meskipun mudah, autentikasi hanya melalui nomor telepon kurang aman dibandingkan metode lain yang tersedia, karena nomor tersebut dapat berpindah tangan antarpengguna dengan mudah. Selain itu, pada perangkat yang memuat beberapa profil pengguna, setiap pengguna yang dapat menerima pesan SMS dapat login ke akun menggunakan nomor telepon perangkat tersebut.

Jika menggunakan fitur login dengan nomor telepon di aplikasi, Anda harus menawarkannya bersama metode login yang lebih aman, dan memberi tahu pengguna tentang kelemahan keamanan jika menggunakan metode login dengan nomor telepon.

Mengaktifkan login dengan Nomor Telepon untuk project Firebase

Untuk memproses login pengguna melalui SMS, Anda harus mengaktifkan metode login dengan Nomor Telepon untuk project Firebase terlebih dahulu:

  1. Di Firebase console, buka bagian Authentication.
  2. Di halaman Sign-in Method, aktifkan metode login dengan Phone Number.

Kuota permintaan login dengan nomor telepon di Firebase cukup tinggi, sehingga sebagian besar aplikasi tidak akan terpengaruh. Namun, jika perlu memproses login pengguna dalam jumlah yang sangat besar menggunakan autentikasi dengan nomor telepon, Anda mungkin harus mengupgrade paket harga. Lihat halaman harga.

Mengaktifkan verifikasi aplikasi

Untuk menggunakan autentikasi dengan nomor telepon, Firebase harus dapat memverifikasi bahwa permintaan login dengan nomor telepon berasal dari aplikasi Anda. Ada tiga cara yang digunakan Firebase Authentication untuk menyelesaikan hal ini:

  • Play Integrity API: Jika pengguna memiliki perangkat yang telah diinstal dengan layanan Google Play, dan Firebase Authentication dapat memverifikasi bahwa perangkat tersebut sah dengan Play Integrity API, proses login dengan nomor telepon dapat dilanjutkan. Play Integrity API diaktifkan di project milik Google oleh Firebase Authentication, bukan di project Anda. Hal ini tidak memengaruhi kuota Play Integrity API di project Anda. Dukungan Play Integrity tersedia dengan Authentication SDK v21.2.0 dan yang lebih baru (Firebase BoM v31.4.0 dan yang lebih baru).

    Untuk menggunakan Play Integrity, jika Anda belum menentukan sidik jari SHA-256 aplikasi, lakukanlah dari Project settings dari Firebase console. Baca artikel Mengautentikasi Klien untuk mengetahui detail tentang cara mendapatkan sidik jari SHA-256 aplikasi.

  • Verifikasi reCAPTCHA: Jika Play Integrity tidak dapat digunakan, seperti saat pengguna memiliki perangkattanpa Layanan Google Play yang terinstal, Firebase Authentication menggunakan verifikasi reCAPTCHA untuk menyelesaikan alur login dengan nomor telepon. Tantangan reCAPTCHA sering kali dapat diselesaikan sekalipun pengguna tidak menyelesaikan apa pun. Perlu diperhatikan bahwa alur ini memerlukan SHA-1 yang dikaitkan dengan aplikasi Anda. Alur ini juga mengharuskan Kunci API Anda tidak dibatasi atau diizinkan untuk PROJECT_ID.firebaseapp.com.

    Beberapa skenario yang memicu reCAPTCHA:

    • Jika perangkat pengguna akhir tidak menginstal layanan Google Play.
    • Jika aplikasi tidak didistribusikan melalui Google Play Store (di Authentication SDK v21.2.0+).
    • Jika token SafetyNet yang diperoleh tidak valid (di Authentication SDK versi < v21.2.0).

    Jika SafetyNet atau Play Integrity digunakan untuk verifikasi Aplikasi, kolom %APP_NAME% di template SMS akan diisi dengan nama aplikasi yang ditentukan dari Google Play Store. Pada skenario di mana reCAPTCHA terpicu, %APP_NAME% akan diisi sebagai PROJECT_ID.firebaseapp.com.

Anda dapat memaksa alur verifikasi reCAPTCHA dengan forceRecaptchaFlowForTesting Anda dapat menonaktifkan verifikasi aplikasi (saat menggunakan nomor telepon fiktif) menggunakan setAppVerificationDisabledForTesting.

Pemecahan masalah

  • Error "Status awal tidak ada" saat menggunakan reCAPTCHA untuk verifikasi aplikasi

    Hal ini dapat terjadi jika alur reCAPTCHA berhasil diselesaikan, tetapi tidak mengalihkan pengguna kembali ke aplikasi native. Jika ini terjadi, pengguna akan dialihkan ke URL penggantian PROJECT_ID.firebaseapp.com/__/auth/handler. Di browser Firefox, membuka link aplikasi native dinonaktifkan secara default. Jika Anda melihat error di atas di Firefox, ikuti langkah-langkah di bagian Menetapkan Firefox untuk Android agar membuka link di aplikasi native untuk mengaktifkan pembukaan link aplikasi.

Mengirim kode verifikasi ke ponsel pengguna

Untuk memulai metode login dengan nomor telepon, tunjukkan kepada pengguna antarmuka yang akan meminta mereka untuk memasukkan nomor telepon. Persyaratan hukum dapat berbeda-beda. Namun, sebagai praktik terbaik dan demi menetapkan ekspektasi pengguna, sebaiknya beri tahukan bahwa jika mereka menggunakan metode login melalui telepon, akan muncul pesan SMS berisi permintaan verifikasi dan pemberlakuan tarif standar.

Kemudian, teruskan nomor telepon tersebut ke metode PhoneAuthProvider.verifyPhoneNumber untuk meminta agar Firebase memverifikasinya. Contoh:

Kotlin+KTX

val options = PhoneAuthOptions.newBuilder(auth)
    .setPhoneNumber(phoneNumber) // Phone number to verify
    .setTimeout(60L, TimeUnit.SECONDS) // Timeout and unit
    .setActivity(this) // Activity (for callback binding)
    .setCallbacks(callbacks) // OnVerificationStateChangedCallbacks
    .build()
PhoneAuthProvider.verifyPhoneNumber(options)

Java

PhoneAuthOptions options = 
  PhoneAuthOptions.newBuilder(mAuth) 
      .setPhoneNumber(phoneNumber)       // Phone number to verify
      .setTimeout(60L, TimeUnit.SECONDS) // Timeout and unit
      .setActivity(this)                 // (optional) Activity for callback binding
      // If no activity is passed, reCAPTCHA verification can not be used.
      .setCallbacks(mCallbacks)          // OnVerificationStateChangedCallbacks
      .build();
  PhoneAuthProvider.verifyPhoneNumber(options);     

Metode verifyPhoneNumber bersifat reentrant: jika dipanggil berkali-kali, misalnya dalam metode onStart aktivitas, metode verifyPhoneNumber tidak akan mengirim SMS kedua kecuali jika waktu tunggu permintaan aslinya telah habis.

Anda dapat menggunakan perilaku ini untuk melanjutkan proses login dengan nomor telepon, jika aplikasi Anda ditutup sebelum pengguna dapat login (misalnya, saat pengguna menggunakan aplikasi SMS). Setelah memanggil verifyPhoneNumber, tetapkan flag yang menunjukkan bahwa verifikasi sedang berlangsung. Kemudian, simpan flag tersebut di metode onSaveInstanceState Aktivitas Anda dan pulihkan di onRestoreInstanceState. Terakhir, dalam metode onStart Aktivitas tersebut, pastikan bahwa verifikasi sudah berlangsung, dan jika ya, panggil verifyPhoneNumber lagi. Pastikan untuk menghapus flag saat verifikasi selesai atau gagal (baca artikel tentang Callback verifikasi).

Untuk dapat dengan mudah menangani rotasi layar dan instance mulai ulang Aktivitas lainnya, teruskan Aktivitas Anda ke metode verifyPhoneNumber. Callback akan terlepas secara otomatis saat Aktivitas berhenti, sehingga Anda dapat dengan leluasa menulis kode transisi UI dalam metode callback.

Pesan SMS yang dikirim oleh Firebase juga dapat dilokalkan dengan menentukan bahasa autentikasi melalui metode setLanguageCode pada instance Auth Anda.

Kotlin+KTX

auth.setLanguageCode("fr")
// To apply the default app language instead of explicitly setting it.
// auth.useAppLanguage()

Java

auth.setLanguageCode("fr");
// To apply the default app language instead of explicitly setting it.
// auth.useAppLanguage();

Saat memanggil PhoneAuthProvider.verifyPhoneNumber, Anda juga harus menyediakan instance OnVerificationStateChangedCallbacks yang berisi penerapan fungsi callback yang menangani hasil permintaan. Contoh:

Kotlin+KTX

callbacks = object : PhoneAuthProvider.OnVerificationStateChangedCallbacks() {

    override fun onVerificationCompleted(credential: PhoneAuthCredential) {
        // This callback will be invoked in two situations:
        // 1 - Instant verification. In some cases the phone number can be instantly
        //     verified without needing to send or enter a verification code.
        // 2 - Auto-retrieval. On some devices Google Play services can automatically
        //     detect the incoming verification SMS and perform verification without
        //     user action.
        Log.d(TAG, "onVerificationCompleted:$credential")
        signInWithPhoneAuthCredential(credential)
    }

    override fun onVerificationFailed(e: FirebaseException) {
        // This callback is invoked in an invalid request for verification is made,
        // for instance if the the phone number format is not valid.
        Log.w(TAG, "onVerificationFailed", e)

        if (e is FirebaseAuthInvalidCredentialsException) {
            // Invalid request
        } else if (e is FirebaseTooManyRequestsException) {
            // The SMS quota for the project has been exceeded
        } else if (e is FirebaseAuthMissingActivityForRecaptchaException) {
            // reCAPTCHA verification attempted with null Activity
        }

        // Show a message and update the UI
    }

    override fun onCodeSent(
        verificationId: String,
        token: PhoneAuthProvider.ForceResendingToken,
    ) {
        // The SMS verification code has been sent to the provided phone number, we
        // now need to ask the user to enter the code and then construct a credential
        // by combining the code with a verification ID.
        Log.d(TAG, "onCodeSent:$verificationId")

        // Save verification ID and resending token so we can use them later
        storedVerificationId = verificationId
        resendToken = token
    }
}

Java

mCallbacks = new PhoneAuthProvider.OnVerificationStateChangedCallbacks() {

    @Override
    public void onVerificationCompleted(@NonNull PhoneAuthCredential credential) {
        // This callback will be invoked in two situations:
        // 1 - Instant verification. In some cases the phone number can be instantly
        //     verified without needing to send or enter a verification code.
        // 2 - Auto-retrieval. On some devices Google Play services can automatically
        //     detect the incoming verification SMS and perform verification without
        //     user action.
        Log.d(TAG, "onVerificationCompleted:" + credential);

        signInWithPhoneAuthCredential(credential);
    }

    @Override
    public void onVerificationFailed(@NonNull FirebaseException e) {
        // This callback is invoked in an invalid request for verification is made,
        // for instance if the the phone number format is not valid.
        Log.w(TAG, "onVerificationFailed", e);

        if (e instanceof FirebaseAuthInvalidCredentialsException) {
            // Invalid request
        } else if (e instanceof FirebaseTooManyRequestsException) {
            // The SMS quota for the project has been exceeded
        } else if (e instanceof FirebaseAuthMissingActivityForRecaptchaException) {
            // reCAPTCHA verification attempted with null Activity
        }

        // Show a message and update the UI
    }

    @Override
    public void onCodeSent(@NonNull String verificationId,
                           @NonNull PhoneAuthProvider.ForceResendingToken token) {
        // The SMS verification code has been sent to the provided phone number, we
        // now need to ask the user to enter the code and then construct a credential
        // by combining the code with a verification ID.
        Log.d(TAG, "onCodeSent:" + verificationId);

        // Save verification ID and resending token so we can use them later
        mVerificationId = verificationId;
        mResendToken = token;
    }
};

Callback verifikasi

Di sebagian besar aplikasi, Anda akan menerapkan callback onVerificationCompleted, onVerificationFailed, dan onCodeSent. Anda juga dapat menerapkan onCodeAutoRetrievalTimeOut jika memang sesuai dengan persyaratan aplikasi Anda.

onVerificationCompleted(PhoneAuthCredential)

Metode ini dipanggil dalam dua situasi:

  • Verifikasi instan: dalam beberapa kasus, nomor telepon dapat langsung diverifikasi tanpa perlu mengirim atau memasukkan kode verifikasi.
  • Pemungutan otomatis: pada beberapa perangkat, layanan Google Play dapat secara otomatis mendeteksi SMS verifikasi yang masuk dan melakukan verifikasi tanpa perlu tindakan pengguna. (Kemampuan ini mungkin tidak tersedia pada beberapa operator). Ini menggunakan SMS Retriever API, yang menyertakan hash 11 karakter di bagian akhir pesan SMS.
Dalam kedua kasus tersebut, nomor telepon pengguna telah berhasil diverifikasi, dan Anda dapat menggunakan objek PhoneAuthCredential yang diteruskan ke callback untuk memproses login pengguna.

onVerificationFailed(FirebaseException)

Metode ini dipanggil sebagai respons atas permintaan verifikasi yang tidak valid, seperti permintaan yang berisi nomor telepon atau kode verifikasi yang tidak valid.

onCodeSent(String verificationId, PhoneAuthProvider.ForceResendingToken)

Opsional. Metode ini dipanggil setelah kode verifikasi dikirim melalui SMS ke nomor telepon yang diberikan.

Saat metode ini dipanggil, sebagian besar aplikasi akan menampilkan UI yang meminta pengguna untuk memasukkan kode verifikasi dari pesan SMS. (Pada saat bersamaan, verifikasi otomatis mungkin berlangsung di latar belakang). Selanjutnya, setelah pengguna memasukkan kode verifikasi, Anda dapat menggunakannya beserta ID verifikasi yang diteruskan ke metode tersebut untuk membuat objek PhoneAuthCredential, yang bisa digunakan untuk memproses login pengguna. Namun, beberapa aplikasi mungkin akan menunggu hingga onCodeAutoRetrievalTimeOut dipanggil sebelum menampilkan UI kode verifikasi (tidak direkomendasikan).

onCodeAutoRetrievalTimeOut(String verificationId)

Opsional. Metode ini dipanggil setelah durasi waktu tunggu yang ditetapkan ke verifyPhoneNumber habis dan onVerificationCompleted belum terpicu. Pada perangkat tanpa kartu SIM, metode ini segera dipanggil karena pemungutan otomatis SMS tidak memungkinkan.

Beberapa aplikasi memblokir input pengguna sampai waktu tunggu verifikasi otomatis habis, kemudian menampilkan UI yang meminta pengguna memasukkan kode verifikasi dari pesan SMS (tidak direkomendasikan).

Membuat objek PhoneAuthCredential

Setelah pengguna memasukkan kode verifikasi yang dikirimkan Firebase ke ponselnya, buat objek PhoneAuthCredential menggunakan kode verifikasi tersebut dan ID verifikasi yang diteruskan ke callback onCodeSent atau onCodeAutoRetrievalTimeOut. (Saat onVerificationCompleted dipanggil, Anda akan langsung mendapatkan objek PhoneAuthCredential sehingga bisa melewatkan langkah ini.)

Untuk membuat objek PhoneAuthCredential, panggil PhoneAuthProvider.getCredential:

Kotlin+KTX

val credential = PhoneAuthProvider.getCredential(verificationId!!, code)

Java

PhoneAuthCredential credential = PhoneAuthProvider.getCredential(verificationId, code);

Memproses login pengguna

Setelah mendapatkan objek PhoneAuthCredential, baik dalam callback onVerificationCompleted maupun dengan memanggil PhoneAuthProvider.getCredential, selesaikan alur login dengan meneruskan objek PhoneAuthCredential ke FirebaseAuth.signInWithCredential:

Kotlin+KTX

private fun signInWithPhoneAuthCredential(credential: PhoneAuthCredential) {
    auth.signInWithCredential(credential)
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                // Sign in success, update UI with the signed-in user's information
                Log.d(TAG, "signInWithCredential:success")

                val user = task.result?.user
            } else {
                // Sign in failed, display a message and update the UI
                Log.w(TAG, "signInWithCredential:failure", task.exception)
                if (task.exception is FirebaseAuthInvalidCredentialsException) {
                    // The verification code entered was invalid
                }
                // Update UI
            }
        }
}

Java

private void signInWithPhoneAuthCredential(PhoneAuthCredential credential) {
    mAuth.signInWithCredential(credential)
            .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
                @Override
                public void onComplete(@NonNull Task<AuthResult> task) {
                    if (task.isSuccessful()) {
                        // Sign in success, update UI with the signed-in user's information
                        Log.d(TAG, "signInWithCredential:success");

                        FirebaseUser user = task.getResult().getUser();
                        // Update UI
                    } else {
                        // Sign in failed, display a message and update the UI
                        Log.w(TAG, "signInWithCredential:failure", task.getException());
                        if (task.getException() instanceof FirebaseAuthInvalidCredentialsException) {
                            // The verification code entered was invalid
                        }
                    }
                }
            });
}

Menguji dengan nomor telepon fiktif

Anda dapat menyiapkan nomor telepon fiktif untuk pengembangan melalui Firebase console. Pengujian dengan nomor telepon fiktif memberikan sejumlah manfaat berikut:

  • Menguji autentikasi nomor telepon tanpa menghabiskan kuota penggunaan Anda.
  • Menguji autentikasi nomor telepon tanpa benar-benar mengirim pesan SMS.
  • Menjalankan pengujian berturut-turut dengan nomor telepon yang sama tanpa throttling. Tindakan ini meminimalkan risiko penolakan selama proses peninjauan App store jika peninjau kebetulan menggunakan nomor telepon yang sama untuk melakukan pengujian.
  • Pengujian langsung di lingkungan pengembangan tanpa upaya tambahan, seperti kemampuan untuk melakukan pengembangan dalam simulator iOS atau emulator Android tanpa Layanan Google Play.
  • Menulis pengujian integrasi tanpa diblokir oleh pemeriksaan keamanan yang biasanya diterapkan pada nomor telepon asli di lingkungan produksi.

Nomor telepon fiktif harus memenuhi persyaratan berikut:

  1. Pastikan nomor telepon yang digunakan benar-benar fiktif dan belum pernah ada. Firebase Authentication tidak mengizinkan nomor telepon yang memang ada dan digunakan oleh pengguna sungguhan sebagai nomor telepon pengujian. Salah satu opsinya adalah menggunakan nomor berawalan 555 sebagai nomor telepon pengujian di Amerika Serikat, misalnya: +1 650-555-3434
  2. Nomor telepon harus diformat dengan benar menurut batasan panjang dan batasan lainnya. Nomor telepon tersebut akan melalui validasi yang sama seperti nomor telepon pengguna sungguhan.
  3. Anda dapat menambahkan hingga 10 nomor telepon untuk proses pengembangan.
  4. Gunakan nomor telepon/kode pengujian yang sulit ditebak dan seringlah mengubahnya.

Membuat nomor telepon dan kode verifikasi fiktif

  1. Di Firebase console, buka bagian Authentication.
  2. Di tab Sign-in method, aktifkan penyedia Phone jika Anda belum melakukannya.
  3. Buka menu akordeon Phone numbers for testing.
  4. Berikan nomor telepon yang ingin Anda uji, misalnya: +1 650-555-3434.
  5. Sediakan kode verifikasi 6 digit untuk nomor tersebut, misalnya: 654321.
  6. Klik Add untuk menambahkan nomor telepon. Jika perlu, Anda dapat menghapus nomor telepon beserta kodenya dengan mengarahkan kursor ke baris yang sesuai dan mengklik ikon tempat sampah.

Pengujian manual

Anda dapat langsung mulai menggunakan nomor telepon fiktif dalam aplikasi. Dengan demikian, Anda bisa langsung melakukan pengujian manual selama tahap pengembangan tanpa mengalami masalah kuota atau throttling. Anda juga dapat menguji langsung dari simulator iOS atau emulator Android tanpa menginstal Layanan Google Play.

Ketika Anda memberikan nomor telepon fiktif dan mengirim kode verifikasi, sebenarnya tidak ada SMS yang dikirim. Sebagai gantinya, Anda harus memberikan kode verifikasi yang dikonfigurasi sebelumnya untuk menyelesaikan login.

Saat login selesai, pengguna Firebase dibuat dengan nomor telepon itu. Pengguna tersebut memiliki perilaku dan properti seperti halnya pengguna nomor telepon sungguhan dan dapat mengakses Realtime Database/Cloud Firestore serta layanan lainnya dengan cara yang sama. Token ID yang dibuat selama proses ini memiliki tanda tangan yang sama dengan pengguna nomor telepon sungguhan.

Pilihan lainnya adalah menetapkan peran pengujian melalui klaim khusus pada pengguna ini untuk membedakannya dari pengguna palsu jika Anda ingin membatasi akses lebih lanjut.

Untuk memicu alur reCAPTCHA secara manual untuk pengujian, gunakan metode forceRecaptchaFlowForTesting().

// Force reCAPTCHA flow
FirebaseAuth.getInstance().getFirebaseAuthSettings().forceRecaptchaFlowForTesting();

Pengujian integrasi

Selain pengujian manual, Firebase Authentication menyediakan API untuk membantu menulis pengujian integrasi untuk pengujian autentikasi ponsel. API ini menonaktifkan verifikasi aplikasi dengan menonaktifkan persyaratan reCAPTCHA di web dan notifikasi push senyap di iOS. Dengan demikian, pengujian otomatisasi dapat dilakukan dalam alur ini dan lebih mudah diimplementasikan. Selain itu, API ini memungkinkan pengujian alur verifikasi instan di Android.

Di Android, panggil setAppVerificationDisabledForTesting() sebelum panggilan signInWithPhoneNumber. Tindakan ini akan otomatis menonaktifkan verifikasi aplikasi sehingga Anda dapat meneruskan nomor telepon tanpa menyelesaikannya secara manual. Meskipun Play Integrity, SafetyNet, dan reCAPTCHA dinonaktifkan, penggunaan nomor telepon sungguhan akan tetap menggagalkan proses login. Hanya nomor telepon fiktif yang dapat digunakan dengan API ini.

// Turn off phone auth app verification.
FirebaseAuth.getInstance().getFirebaseAuthSettings()
   .setAppVerificationDisabledForTesting();

Memanggil verifyPhoneNumber dengan nomor fiktif akan memicu callback onCodeSent, dan Anda harus memberikan kode verifikasi yang sesuai. Hal ini memungkinkan pengujian di Android Emulator.

Java

String phoneNum = "+16505554567";
String testVerificationCode = "123456";

// Whenever verification is triggered with the whitelisted number,
// provided it is not set for auto-retrieval, onCodeSent will be triggered.
FirebaseAuth auth = FirebaseAuth.getInstance();
PhoneAuthOptions options = PhoneAuthOptions.newBuilder(auth)
        .setPhoneNumber(phoneNum)
        .setTimeout(60L, TimeUnit.SECONDS)
        .setActivity(this)
        .setCallbacks(new PhoneAuthProvider.OnVerificationStateChangedCallbacks() {
            @Override
            public void onCodeSent(@NonNull String verificationId,
                                   @NonNull PhoneAuthProvider.ForceResendingToken forceResendingToken) {
                // Save the verification id somewhere
                // ...

                // The corresponding whitelisted code above should be used to complete sign-in.
                MainActivity.this.enableUserManuallyInputCode();
            }

            @Override
            public void onVerificationCompleted(@NonNull PhoneAuthCredential phoneAuthCredential) {
                // Sign in with the credential
                // ...
            }

            @Override
            public void onVerificationFailed(@NonNull FirebaseException e) {
                // ...
            }
        })
        .build();
PhoneAuthProvider.verifyPhoneNumber(options);

Kotlin+KTX

val phoneNum = "+16505554567"
val testVerificationCode = "123456"

// Whenever verification is triggered with the whitelisted number,
// provided it is not set for auto-retrieval, onCodeSent will be triggered.
val options = PhoneAuthOptions.newBuilder(Firebase.auth)
    .setPhoneNumber(phoneNum)
    .setTimeout(30L, TimeUnit.SECONDS)
    .setActivity(this)
    .setCallbacks(object : PhoneAuthProvider.OnVerificationStateChangedCallbacks() {

        override fun onCodeSent(
            verificationId: String,
            forceResendingToken: PhoneAuthProvider.ForceResendingToken,
        ) {
            // Save the verification id somewhere
            // ...

            // The corresponding whitelisted code above should be used to complete sign-in.
            this@MainActivity.enableUserManuallyInputCode()
        }

        override fun onVerificationCompleted(phoneAuthCredential: PhoneAuthCredential) {
            // Sign in with the credential
            // ...
        }

        override fun onVerificationFailed(e: FirebaseException) {
            // ...
        }
    })
    .build()
PhoneAuthProvider.verifyPhoneNumber(options)

Selain itu, Anda dapat menguji alur pemungutan otomatis di Android dengan menetapkan nomor fiktif dan kode verifikasinya untuk fitur pemungutan otomatis dengan memanggil setAutoRetrievedSmsCodeForPhoneNumber.

Jika verifyPhoneNumber dipanggil, onVerificationCompleted akan langsung terpicu dengan PhoneAuthCredential. Ini hanya berfungsi dengan nomor telepon fiktif.

Pastikan ini dinonaktifkan dan tidak ada nomor telepon fiktif yang ditulis secara hardcode di aplikasi Anda saat memublikasikan aplikasi ke Google Play Store.

Java

// The test phone number and code should be whitelisted in the console.
String phoneNumber = "+16505554567";
String smsCode = "123456";

FirebaseAuth firebaseAuth = FirebaseAuth.getInstance();
FirebaseAuthSettings firebaseAuthSettings = firebaseAuth.getFirebaseAuthSettings();

// Configure faking the auto-retrieval with the whitelisted numbers.
firebaseAuthSettings.setAutoRetrievedSmsCodeForPhoneNumber(phoneNumber, smsCode);

PhoneAuthOptions options = PhoneAuthOptions.newBuilder(firebaseAuth)
        .setPhoneNumber(phoneNumber)
        .setTimeout(60L, TimeUnit.SECONDS)
        .setActivity(this)
        .setCallbacks(new PhoneAuthProvider.OnVerificationStateChangedCallbacks() {
            @Override
            public void onVerificationCompleted(@NonNull PhoneAuthCredential credential) {
                // Instant verification is applied and a credential is directly returned.
                // ...
            }

            // ...
        })
        .build();
PhoneAuthProvider.verifyPhoneNumber(options);

Kotlin+KTX

// The test phone number and code should be whitelisted in the console.
val phoneNumber = "+16505554567"
val smsCode = "123456"

val firebaseAuth = Firebase.auth
val firebaseAuthSettings = firebaseAuth.firebaseAuthSettings

// Configure faking the auto-retrieval with the whitelisted numbers.
firebaseAuthSettings.setAutoRetrievedSmsCodeForPhoneNumber(phoneNumber, smsCode)

val options = PhoneAuthOptions.newBuilder(firebaseAuth)
    .setPhoneNumber(phoneNumber)
    .setTimeout(60L, TimeUnit.SECONDS)
    .setActivity(this)
    .setCallbacks(object : PhoneAuthProvider.OnVerificationStateChangedCallbacks() {
        override fun onVerificationCompleted(credential: PhoneAuthCredential) {
            // Instant verification is applied and a credential is directly returned.
            // ...
        }

        // ...
    })
    .build()
PhoneAuthProvider.verifyPhoneNumber(options)

Langkah berikutnya

Setelah pengguna login untuk pertama kalinya, akun pengguna baru akan dibuat dan ditautkan ke kredensial, yaitu nama pengguna dan sandi, nomor telepon, atau informasi penyedia autentikasi, yang digunakan pengguna tersebut untuk login. Akun baru ini disimpan sebagai bagian dari project Firebase Anda, dan dapat digunakan untuk mengidentifikasi pengguna di setiap aplikasi dalam project, terlepas dari cara pengguna login.

  • Di aplikasi, Anda bisa mendapatkan informasi profil dasar pengguna dari objek FirebaseUser. Baca bagian Mengelola Pengguna.

  • Di Aturan Keamanan Firebase Realtime Database dan Cloud Storage, Anda bisa mendapatkan ID pengguna unik milik pengguna yang login dari variabel auth, dan menggunakannya untuk mengontrol data yang dapat diakses oleh pengguna.

Anda dapat mengizinkan pengguna untuk login ke aplikasi menggunakan beberapa penyedia autentikasi dengan menautkan kredensial penyedia autentikasi ke akun pengguna yang ada.

Untuk memproses logout pengguna, panggil signOut:

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();