फ़ोन नंबर का इस्तेमाल करके Android पर Firebase की मदद से पुष्टि करें

उपयोगकर्ता के फ़ोन पर एसएमएस भेजकर, उसे साइन इन करने के लिए Firebase Authentication का इस्तेमाल किया जा सकता है. उपयोगकर्ता, एसएमएस में मिले एक बार इस्तेमाल किए जा सकने वाले कोड का इस्तेमाल करके साइन इन करता है.

अपने ऐप्लिकेशन में फ़ोन नंबर से साइन-इन करने की सुविधा जोड़ने का सबसे आसान तरीका है FirebaseUI का इस्तेमाल करना. इसमें एक ड्रॉप-इन साइन-इन विजेट शामिल होता है. यह फ़ोन नंबर से साइन-इन करने के साथ-साथ, पासवर्ड और फ़ेडरेटेड साइन-इन के लिए साइन-इन फ़्लो लागू करता है. इस दस्तावेज़ में, Firebase SDK का इस्तेमाल करके फ़ोन नंबर से साइन-इन करने की प्रोसेस को लागू करने का तरीका बताया गया है.

शुरू करने से पहले

  1. अगर आपने पहले से ऐसा नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें.
  2. अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए Firebase Authentication लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें. 
    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.0.0"))

    // 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")
}

    Firebase Android BoM का इस्तेमाल करने पर, आपका ऐप्लिकेशन हमेशा Firebase Android लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

    (वैकल्पिक)  BoM का इस्तेमाल किए बिना, Firebase लाइब्रेरी की डिपेंडेंसी जोड़ें

    अगर आपको Firebase BoM का इस्तेमाल नहीं करना है, तो आपको डिपेंडेंसी लाइन में Firebase की हर लाइब्रेरी के वर्शन की जानकारी देनी होगी.

    ध्यान दें कि अगर आपके ऐप्लिकेशन में Firebase की एक से ज़्यादा लाइब्रेरी का इस्तेमाल किया जाता है, तो हमारा सुझाव है कि लाइब्रेरी के वर्शन मैनेज करने के लिए BoM का इस्तेमाल करें. इससे यह पक्का किया जा सकता है कि सभी वर्शन एक-दूसरे के साथ काम करते हों. 

    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:24.0.0")
}
  3. अगर आपने अब तक अपने ऐप्लिकेशन को Firebase प्रोजेक्ट से कनेक्ट नहीं किया है, तो Firebase कंसोल से कनेक्ट करें.
  4. अगर आपने Firebase कंसोल में अपने ऐप्लिकेशन का SHA-1 हैश पहले से सेट नहीं किया है, तो ऐसा करें. अपने ऐप्लिकेशन का SHA-1 हैश ढूंढने के बारे में जानकारी के लिए, अपने क्लाइंट की पुष्टि करना लेख पढ़ें.

सुरक्षा से जुड़ी समस्याएं

सिर्फ़ फ़ोन नंबर का इस्तेमाल करके पुष्टि करना आसान है, लेकिन यह अन्य उपलब्ध तरीकों की तुलना में कम सुरक्षित है. ऐसा इसलिए, क्योंकि फ़ोन नंबर का मालिकाना हक उपयोगकर्ताओं के बीच आसानी से ट्रांसफ़र किया जा सकता है. इसके अलावा, जिन डिवाइसों में एक से ज़्यादा उपयोगकर्ता प्रोफ़ाइल होती हैं उनमें एसएमएस पाने वाला कोई भी उपयोगकर्ता, डिवाइस के फ़ोन नंबर का इस्तेमाल करके किसी खाते में साइन इन कर सकता है.

अगर आपके ऐप्लिकेशन में फ़ोन नंबर के ज़रिए साइन इन करने की सुविधा उपलब्ध है, तो आपको इसे साइन इन करने के ज़्यादा सुरक्षित तरीकों के साथ उपलब्ध कराना चाहिए. साथ ही, उपयोगकर्ताओं को फ़ोन नंबर के ज़रिए साइन इन करने के सुरक्षा से जुड़े जोखिमों के बारे में बताना चाहिए.

अपने Firebase प्रोजेक्ट के लिए, फ़ोन नंबर से साइन इन करने की सुविधा चालू करना

एसएमएस से उपयोगकर्ताओं को साइन इन करने की सुविधा देने के लिए, आपको पहले अपने Firebase प्रोजेक्ट के लिए फ़ोन नंबर से साइन इन करने का तरीका चालू करना होगा:

  1. Firebase कंसोल में, Authentication सेक्शन खोलें.
  2. साइन-इन करने का तरीका पेज पर, फ़ोन नंबर से साइन-इन करने का तरीका चालू करें.

ऐप्लिकेशन की पुष्टि करने की सुविधा चालू करना

फ़ोन नंबर से पुष्टि करने की सुविधा का इस्तेमाल करने के लिए, Firebase को यह पुष्टि करनी होगी कि फ़ोन नंबर से साइन इन करने के अनुरोध, आपके ऐप्लिकेशन से आ रहे हैं. Firebase Authentication ऐसा तीन तरीकों से करता है:

  • Play Integrity API: अगर किसी व्यक्ति के पास ऐसा डिवाइस है जिसमें Google Play services इंस्टॉल है, तो Firebase Authentication Play Integrity API की मदद से, डिवाइस की पुष्टि कर सकता है. इसके बाद, फ़ोन नंबर से साइन इन किया जा सकता है. Play Integrity API, Google के मालिकाना हक वाले प्रोजेक्ट पर चालू है. इसे Firebase Authentication ने चालू किया है, न कि आपके प्रोजेक्ट पर. इससे आपके प्रोजेक्ट के किसी भी Play Integrity API कोटा पर कोई असर नहीं पड़ता. Play Integrity API के साथ काम करने वाला SDK टूल, Authentication SDK v21.2.0+ (Firebase BoM v31.4.0+) के साथ उपलब्ध है.

    Play Integrity का इस्तेमाल करने के लिए, अगर आपने अब तक अपने ऐप्लिकेशन का SHA-256 फ़िंगरप्रिंट नहीं दिया है, तो Firebase कंसोल की प्रोजेक्ट सेटिंग में जाकर ऐसा करें. अपने ऐप्लिकेशन का SHA-256 फ़िंगरप्रिंट पाने के तरीके के बारे में जानने के लिए, अपने क्लाइंट की पुष्टि करना लेख पढ़ें.

  • reCAPTCHA से पुष्टि करना: अगर Play Integrity का इस्तेमाल नहीं किया जा सकता, तो reCAPTCHA से पुष्टि करने की सुविधा का इस्तेमाल किया जाता है. ऐसा तब होता है, जब किसी उपयोगकर्ता के पास Google Play services नहीं है या वह Firebase Authentication का इस्तेमाल करता है. इससे फ़ोन से साइन इन करने की प्रोसेस पूरी की जाती है. reCAPTCHA चैलेंज को अक्सर बिना किसी समस्या के पूरा किया जा सकता है. ध्यान दें कि इस फ़्लो के लिए, आपके ऐप्लिकेशन से SHA-1 जुड़ा होना चाहिए. इस फ़्लो के लिए, यह भी ज़रूरी है कि आपकी एपीआई कुंजी पर कोई पाबंदी न हो या उसे PROJECT_ID.firebaseapp.com के लिए अनुमति दी गई हो.

    यहां कुछ ऐसे उदाहरण दिए गए हैं जिनमें reCAPTCHA ट्रिगर होता है:

    • अगर एंड-यूज़र के डिवाइस पर Google Play services इंस्टॉल नहीं है.
    • अगर ऐप्लिकेशन को Google Play Store के ज़रिए डिस्ट्रिब्यूट नहीं किया गया है (Authentication SDK v21.2.0+ पर).
    • अगर मिला हुआ SafetyNet टोकन मान्य नहीं था (Authentication SDK टूल के v21.2.0 से पहले के वर्शन पर).

    जब ऐप्लिकेशन की पुष्टि करने के लिए SafetyNet या Play Integrity का इस्तेमाल किया जाता है, तो एसएमएस टेंप्लेट में मौजूद %APP_NAME% फ़ील्ड में, Google Play Store से तय किया गया ऐप्लिकेशन का नाम अपने-आप भर जाता है. जिन मामलों में reCAPTCHA ट्रिगर होता है उनमें %APP_NAME% को PROJECT_ID.firebaseapp.com के तौर पर दिखाया जाता है.

forceRecaptchaFlowForTesting का इस्तेमाल करके, reCAPTCHA की पुष्टि करने की प्रोसेस को लागू किया जा सकता है setAppVerificationDisabledForTesting का इस्तेमाल करके, ऐप्लिकेशन की पुष्टि करने की सुविधा बंद की जा सकती है (जब काल्पनिक फ़ोन नंबर इस्तेमाल किए जा रहे हों).

समस्या का हल

  • ऐप्लिकेशन की पुष्टि के लिए reCAPTCHA का इस्तेमाल करते समय, "शुरुआती स्थिति मौजूद नहीं है" गड़बड़ी

    ऐसा तब हो सकता है, जब reCAPTCHA फ़्लो पूरा हो जाए, लेकिन उपयोगकर्ता को वापस नेटिव ऐप्लिकेशन पर रीडायरेक्ट न किया जाए. ऐसा होने पर, उपयोगकर्ता को फ़ॉलबैक यूआरएल PROJECT_ID.firebaseapp.com/__/auth/handler पर रीडायरेक्ट कर दिया जाता है. Firefox ब्राउज़र पर, नेटिव ऐप्लिकेशन के लिंक खोलने की सुविधा डिफ़ॉल्ट रूप से बंद होती है. अगर आपको Firefox पर ऊपर दी गई गड़बड़ी दिखती है, तो ऐप्लिकेशन के लिंक खोलने की सुविधा चालू करने के लिए, Firefox for Android को नेटिव ऐप्लिकेशन में लिंक खोलने के लिए सेट करना में दिया गया तरीका अपनाएं.

उपयोगकर्ता के फ़ोन पर पुष्टि करने के लिए कोड भेजना

फ़ोन नंबर से साइन इन करने की सुविधा शुरू करने के लिए, उपयोगकर्ता को ऐसा इंटरफ़ेस दिखाएं जिसमें उन्हें अपना फ़ोन नंबर डालने के लिए कहा जाए. कानूनी शर्तें अलग-अलग होती हैं. हालांकि, सबसे सही तरीका यह है कि आप अपने उपयोगकर्ताओं को यह बताएं कि अगर वे फ़ोन से साइन इन करने की सुविधा का इस्तेमाल करते हैं, तो उन्हें पुष्टि करने के लिए एक एसएमएस मिल सकता है. साथ ही, उन पर सामान्य शुल्क लागू होगा.

इसके बाद, उनके फ़ोन नंबर को PhoneAuthProvider.verifyPhoneNumber तरीके से पास करें, ताकि Firebase उपयोगकर्ता के फ़ोन नंबर की पुष्टि करने का अनुरोध कर सके. उदाहरण के लिए:

Kotlin

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)
PhoneAuthActivity.kt

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);     
PhoneAuthActivity.java

verifyPhoneNumber मेथड को फिर से चालू किया जा सकता है: अगर इसे कई बार कॉल किया जाता है, जैसे कि किसी गतिविधि के onStart मेथड में, तो verifyPhoneNumber मेथड दूसरा एसएमएस नहीं भेजेगा. ऐसा तब तक होगा, जब तक कि मूल अनुरोध का समय खत्म नहीं हो जाता.

अगर उपयोगकर्ता के साइन इन करने से पहले आपका ऐप्लिकेशन बंद हो जाता है, तो इस व्यवहार का इस्तेमाल करके फ़ोन नंबर से साइन इन करने की प्रोसेस को फिर से शुरू किया जा सकता है. उदाहरण के लिए, जब उपयोगकर्ता अपने एसएमएस ऐप्लिकेशन का इस्तेमाल कर रहा हो. verifyPhoneNumber को कॉल करने के बाद, एक फ़्लैग सेट करें. इससे पता चलेगा कि पुष्टि की जा रही है. इसके बाद, अपनी गतिविधि के onSaveInstanceState तरीके में फ़्लैग सेव करें और onRestoreInstanceState में फ़्लैग वापस लाएं. आखिर में, अपनी गतिविधि के onStart तरीके में जाकर देखें कि पुष्टि की प्रक्रिया पहले से चल रही है या नहीं. अगर ऐसा है, तो verifyPhoneNumber को फिर से कॉल करें. पुष्टि की प्रोसेस पूरी होने या फ़ेल होने पर, फ़्लैग को हटाना न भूलें. इसके लिए, पुष्टि के लिए कॉलबैक देखें.

स्क्रीन रोटेशन और गतिविधि के फिर से शुरू होने के अन्य उदाहरणों को आसानी से हैंडल करने के लिए, अपनी गतिविधि को verifyPhoneNumber तरीके से पास करें. गतिविधि रुकने पर, कॉलबैक अपने-आप अलग हो जाएंगे. इसलिए, कॉलबैक मैथड में यूज़र इंटरफ़ेस ट्रांज़िशन कोड को आसानी से लिखा जा सकता है.

Firebase से भेजे गए एसएमएस मैसेज को भी स्थानीय भाषा में भेजा जा सकता है. इसके लिए, अपने Auth इंस्टेंस पर setLanguageCode तरीके का इस्तेमाल करके, पुष्टि करने के लिए इस्तेमाल की जाने वाली भाषा तय करें.

Kotlin

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

Java

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

PhoneAuthProvider.verifyPhoneNumber को कॉल करते समय, आपको OnVerificationStateChangedCallbacks का एक इंस्टेंस भी देना होगा. इसमें कॉलबैक फ़ंक्शन के ऐसे तरीके शामिल होते हैं जो अनुरोध के नतीजों को मैनेज करते हैं. उदाहरण के लिए:

Kotlin

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
    }
}
PhoneAuthActivity.kt

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;
    }
};
PhoneAuthActivity.java

पुष्टि करने के लिए कॉलबैक

ज़्यादातर ऐप्लिकेशन में, onVerificationCompleted, onVerificationFailed, और onCodeSent कॉलबैक लागू किए जाते हैं. अपने ऐप्लिकेशन की ज़रूरतों के हिसाब से, onCodeAutoRetrievalTimeOut को भी लागू किया जा सकता है.

onVerificationCompleted(PhoneAuthCredential)

इस तरीके का इस्तेमाल दो स्थितियों में किया जाता है:

  • तुरंत पुष्टि: कुछ मामलों में, फ़ोन नंबर की पुष्टि तुरंत हो सकती है. इसके लिए, पुष्टि करने वाला कोड भेजने या डालने की ज़रूरत नहीं होती.
  • एसएमएस अपने-आप वापस पाना: कुछ डिवाइसों पर, Google Play services, पुष्टि करने के लिए आने वाले एसएमएस का अपने-आप पता लगा सकती हैं. साथ ही, उपयोगकर्ता की कार्रवाई के बिना ही पुष्टि कर सकती हैं. (ऐसा हो सकता है कि मोबाइल और इंटरनेट सेवा देने वाली कुछ कंपनियों के साथ यह सुविधा उपलब्ध न हो.) यह SMS Retriever API का इस्तेमाल करता है. इसमें एसएमएस मैसेज के आखिर में 11 वर्णों वाला हैश शामिल होता है.
दोनों ही मामलों में, उपयोगकर्ता के फ़ोन नंबर की पुष्टि हो गई है. साथ ही, कॉल बैक को पास किए गए PhoneAuthCredential ऑब्जेक्ट का इस्तेमाल करके, उपयोगकर्ता को साइन इन किया जा सकता है.

onVerificationFailed(FirebaseException)

इस तरीके को पुष्टि करने के अमान्य अनुरोध के जवाब में कॉल किया जाता है. जैसे, ऐसा अनुरोध जिसमें अमान्य फ़ोन नंबर या पुष्टि करने के लिए कोड दिया गया हो.

onCodeSent(String verificationId, PhoneAuthProvider.ForceResendingToken)

ज़रूरी नहीं. इस तरीके का इस्तेमाल तब किया जाता है, जब दिए गए फ़ोन नंबर पर एसएमएस के ज़रिए पुष्टि करने का कोड भेज दिया जाता है.

इस तरीके का इस्तेमाल करने पर, ज़्यादातर ऐप्लिकेशन एक यूज़र इंटरफ़ेस (यूआई) दिखाते हैं. इसमें उपयोगकर्ता को एसएमएस से मिले पुष्टि करने के कोड को टाइप करने के लिए कहा जाता है. (इसी दौरान, बैकग्राउंड में अपने-आप पुष्टि होने की प्रोसेस जारी रहती है.) इसके बाद, जब उपयोगकर्ता पुष्टि करने का कोड डालता है, तब पुष्टि करने के लिए इस्तेमाल किए गए कोड और पुष्टि करने के लिए इस्तेमाल किए गए आईडी का इस्तेमाल करके, PhoneAuthCredential ऑब्जेक्ट बनाया जा सकता है. इसका इस्तेमाल करके, उपयोगकर्ता को साइन इन कराया जा सकता है. हालांकि, कुछ ऐप्लिकेशन onCodeAutoRetrievalTimeOut को कॉल किए जाने तक इंतज़ार कर सकते हैं. इसके बाद, वे पुष्टि करने वाले कोड का यूज़र इंटरफ़ेस (यूआई) दिखा सकते हैं. हमारा सुझाव है कि ऐसा न करें.

onCodeAutoRetrievalTimeOut(String verificationId)

ज़रूरी नहीं. इस तरीके को तब कॉल किया जाता है, जब verifyPhoneNumber के लिए तय की गई टाइम आउट की अवधि खत्म हो जाती है और onVerificationCompleted पहली बार ट्रिगर नहीं होता है. जिन डिवाइसों में सिम कार्ड नहीं होते हैं उन पर इस तरीके का इस्तेमाल तुरंत किया जाता है, क्योंकि एसएमएस अपने-आप वापस पाने की सुविधा उपलब्ध नहीं होती है.

कुछ ऐप्लिकेशन, अपने-आप पुष्टि होने की अवधि खत्म होने तक उपयोगकर्ता के इनपुट को ब्लॉक कर देते हैं. इसके बाद, वे ऐसा यूज़र इंटरफ़ेस (यूआई) दिखाते हैं जिसमें उपयोगकर्ता को मैसेज में मिले पुष्टि करने के कोड को टाइप करने के लिए कहा जाता है. हमारा सुझाव है कि ऐसा न करें.

PhoneAuthCredential ऑब्जेक्ट बनाना

जब उपयोगकर्ता, Firebase से मिले पुष्टि करने के कोड को अपने फ़ोन में डालता है, तब PhoneAuthCredential ऑब्जेक्ट बनाएं. इसके लिए, पुष्टि करने के उस कोड और पुष्टि करने के उस आईडी का इस्तेमाल करें जो onCodeSent या onCodeAutoRetrievalTimeOut कॉलबैक को पास किया गया था. (जब onVerificationCompleted को कॉल किया जाता है, तब आपको सीधे तौर पर PhoneAuthCredential ऑब्जेक्ट मिलता है. इसलिए, इस चरण को छोड़ा जा सकता है.)

PhoneAuthCredential ऑब्जेक्ट बनाने के लिए, PhoneAuthProvider.getCredential को कॉल करें:

Kotlin

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

Java

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

उपयोगकर्ता को साइन इन करना

PhoneAuthCredential ऑब्जेक्ट मिलने के बाद, चाहे वह onVerificationCompleted कॉलबैक में मिला हो या PhoneAuthProvider.getCredential को कॉल करके, साइन-इन फ़्लो पूरा करें. इसके लिए, PhoneAuthCredential ऑब्जेक्ट को FirebaseAuth.signInWithCredential पर पास करें:

Kotlin

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
            }
        }
}
PhoneAuthActivity.kt

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
                        }
                    }
                }
            });
}
PhoneAuthActivity.java

फ़र्ज़ी फ़ोन नंबरों से टेस्ट करना

Firebase कंसोल की मदद से, डेवलपमेंट के लिए काल्पनिक फ़ोन नंबर सेट अप किए जा सकते हैं. फ़र्ज़ी फ़ोन नंबरों का इस्तेमाल करके टेस्टिंग करने से ये फ़ायदे मिलते हैं:

  • इस्तेमाल के कोटे का इस्तेमाल किए बिना, फ़ोन नंबर से पुष्टि करने की सुविधा को टेस्ट करें.
  • असल मैसेज भेजे बिना, फ़ोन नंबर की पुष्टि करने की सुविधा को टेस्ट करें.
  • एक ही फ़ोन नंबर से लगातार टेस्ट चलाएं. ऐसा करने पर, आपको थ्रॉटल नहीं किया जाएगा. इससे App Store की समीक्षा के दौरान, ऐप्लिकेशन के अस्वीकार होने का जोखिम कम हो जाता है. ऐसा तब होता है, जब समीक्षक जांच के लिए उसी फ़ोन नंबर का इस्तेमाल करता है.
  • डेवलपमेंट एनवायरमेंट में आसानी से टेस्ट करें. इसके लिए, आपको कोई अतिरिक्त प्रयास करने की ज़रूरत नहीं है. जैसे, Google Play services के बिना iOS सिम्युलेटर या Android Emulator में डेवलप करने की सुविधा.
  • इंटिग्रेशन टेस्ट लिखें. ऐसा करते समय, आपको उन सुरक्षा जांचों से नहीं रोका जाएगा जो आम तौर पर प्रोडक्शन एनवायरमेंट में असली फ़ोन नंबरों पर लागू होती हैं.

फ़र्ज़ी फ़ोन नंबरों को ये ज़रूरी शर्तें पूरी करनी होंगी:

  1. पक्का करें कि आपने ऐसे फ़ोन नंबर इस्तेमाल किए हों जो वाकई काल्पनिक हों और पहले से मौजूद न हों. Firebase Authentication आपको असली उपयोगकर्ताओं के इस्तेमाल किए गए मौजूदा फ़ोन नंबरों को टेस्ट नंबर के तौर पर सेट करने की अनुमति नहीं देता. एक विकल्प यह है कि अमेरिका में टेस्ट के लिए इस्तेमाल किए जाने वाले फ़ोन नंबर के तौर पर, 555 से शुरू होने वाले नंबरों का इस्तेमाल किया जाए. उदाहरण के लिए: +1 650-555-3434
  2. फ़ोन नंबर की लंबाई और अन्य पाबंदियों के हिसाब से, उन्हें सही फ़ॉर्मैट में होना चाहिए. इनकी पुष्टि भी उसी तरह की जाएगी जिस तरह किसी असली उपयोगकर्ता के फ़ोन नंबर की पुष्टि की जाती है.
  3. डेवलपमेंट के लिए, ज़्यादा से ज़्यादा 10 फ़ोन नंबर जोड़े जा सकते हैं.
  4. ऐसे टेस्ट फ़ोन नंबर/कोड का इस्तेमाल करें जिनका अनुमान लगाना मुश्किल हो और उन्हें बार-बार बदलें.

फ़र्ज़ी फ़ोन नंबर और पुष्टि करने के कोड बनाना

  1. Firebase कंसोल में, Authentication सेक्शन खोलें.
  2. अगर आपने पहले से ही साइन इन करने का तरीका टैब में जाकर, फ़ोन सेवा देने वाली कंपनी के ज़रिए साइन इन करने की सुविधा चालू नहीं की है, तो अब कर लें.
  3. जांच के लिए फ़ोन नंबर वाला अकॉर्डियन मेन्यू खोलें.
  4. वह फ़ोन नंबर डालें जिसकी आपको जांच करनी है. उदाहरण के लिए: +1 650-555-3434.
  5. उस नंबर के लिए, छह अंकों का पुष्टि करने वाला कोड डालें. उदाहरण के लिए: 654321.
  6. नंबर जोड़ें. अगर आपको फ़ोन नंबर और उसके कोड को मिटाना है, तो उससे जुड़ी लाइन पर कर्सर घुमाएँ और ट्रैश आइकॉन पर क्लिक करें.

मैन्युअल टेस्टिंग

अपने ऐप्लिकेशन में, काल्पनिक फ़ोन नंबर का इस्तेमाल सीधे तौर पर शुरू किया जा सकता है. इससे आपको डेवलपमेंट के चरणों के दौरान, मैन्युअल तरीके से टेस्टिंग करने की सुविधा मिलती है. इसके लिए, आपको कोटा से जुड़ी समस्याओं या थ्रॉटलिंग का सामना नहीं करना पड़ता. Google Play Services इंस्टॉल किए बिना, सीधे तौर पर iOS सिम्युलेटर या Android Emulator से भी टेस्ट किया जा सकता है.

फ़र्ज़ी फ़ोन नंबर देने और पुष्टि करने के लिए कोड भेजने पर, कोई भी असली एसएमएस नहीं भेजा जाता. इसके बजाय, आपको साइन इन करने के लिए, पहले से कॉन्फ़िगर किया गया पुष्टि करने वाला कोड डालना होगा.

साइन-इन की प्रोसेस पूरी होने पर, उस फ़ोन नंबर से Firebase उपयोगकर्ता बनाया जाता है. इस नंबर का इस्तेमाल करने वाले व्यक्ति का व्यवहार और प्रॉपर्टी, फ़ोन नंबर का इस्तेमाल करने वाले किसी असली व्यक्ति की तरह ही होती है. साथ ही, वह Realtime Database/Cloud Firestore और अन्य सेवाओं को उसी तरह ऐक्सेस कर सकता है. इस प्रोसेस के दौरान मिंट किए गए आईडी टोकन का सिग्नेचर, फ़ोन नंबर का इस्तेमाल करने वाले असली उपयोगकर्ता के सिग्नेचर जैसा ही होता है.

अगर आपको ऐक्सेस पर और पाबंदी लगानी है, तो इन उपयोगकर्ताओं के लिए कस्टम दावों के ज़रिए टेस्ट रोल सेट करें. इससे उन्हें फ़र्ज़ी उपयोगकर्ताओं के तौर पर अलग किया जा सकेगा.

जांच के लिए reCAPTCHA फ़्लो को मैन्युअल तरीके से ट्रिगर करने के लिए, forceRecaptchaFlowForTesting() तरीके का इस्तेमाल करें. 

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

इंटिग्रेशन टेस्टिंग

मैन्युअल टेस्टिंग के अलावा, Firebase Authentication फ़ोन से पुष्टि करने की सुविधा की टेस्टिंग के लिए, इंटिग्रेशन टेस्ट लिखने में मदद करने वाले एपीआई उपलब्ध कराता है. ये एपीआई, ऐप्लिकेशन की पुष्टि करने की सुविधा को बंद कर देते हैं. इसके लिए, ये वेब में reCAPTCHA की ज़रूरत को बंद कर देते हैं. साथ ही, iOS में साइलेंट पुश नोटिफ़िकेशन की सुविधा को बंद कर देते हैं. इससे इन फ़्लो में ऑटोमेशन टेस्टिंग की जा सकती है और इसे लागू करना आसान हो जाता है. इसके अलावा, ये Android पर तुरंत पुष्टि करने की सुविधा के फ़्लो की जांच करने में भी मदद करते हैं.

Android पर, signInWithPhoneNumber कॉल से पहले setAppVerificationDisabledForTesting() को कॉल करें. इससे ऐप्लिकेशन की पुष्टि करने की सुविधा अपने-आप बंद हो जाती है. इससे आपको मैन्युअल तरीके से पुष्टि करने की ज़रूरत नहीं पड़ती. Play Integrity और reCAPTCHA की सुविधा बंद होने पर भी, असली फ़ोन नंबर का इस्तेमाल करके साइन इन नहीं किया जा सकेगा. इस एपीआई के साथ सिर्फ़ काल्पनिक फ़ोन नंबर इस्तेमाल किए जा सकते हैं. 

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

verifyPhoneNumber पर किसी काल्पनिक नंबर से कॉल करने पर, onCodeSent कॉलबैक ट्रिगर होता है. इसमें आपको पुष्टि करने के लिए कोड देना होगा. इससे 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);
MainActivity.java

Kotlin

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)
MainActivity.kt

इसके अलावा, Android में ऑटोमैटिक तरीके से कोड पाने की सुविधा की जांच की जा सकती है. इसके लिए, setAutoRetrievedSmsCodeForPhoneNumber को कॉल करके, काल्पनिक नंबर और उससे जुड़ा पुष्टि करने का कोड सेट करें.

verifyPhoneNumber को कॉल करने पर, यह सीधे PhoneAuthCredential के साथ onVerificationCompleted को ट्रिगर करता है. यह सुविधा सिर्फ़ काल्पनिक फ़ोन नंबरों के साथ काम करती है.

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);
MainActivity.java

Kotlin

// 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)
MainActivity.kt

अगले चरण

जब कोई उपयोगकर्ता पहली बार साइन इन करता है, तो एक नया उपयोगकर्ता खाता बनता है. यह खाता, उन क्रेडेंशियल से लिंक होता है जिनका इस्तेमाल करके उपयोगकर्ता ने साइन इन किया है. जैसे, उपयोगकर्ता का नाम और पासवर्ड, फ़ोन नंबर या पुष्टि करने वाली कंपनी की जानकारी. यह नया खाता, आपके Firebase प्रोजेक्ट के हिस्से के तौर पर सेव किया जाता है. इसका इस्तेमाल, आपके प्रोजेक्ट के हर ऐप्लिकेशन में किसी उपयोगकर्ता की पहचान करने के लिए किया जा सकता है. इससे कोई फ़र्क़ नहीं पड़ता कि उपयोगकर्ता ने किस तरह से साइन इन किया है.

  • अपने ऐप्लिकेशन में, आपको FirebaseUser ऑब्जेक्ट से उपयोगकर्ता की प्रोफ़ाइल की सामान्य जानकारी मिल सकती है. उपयोगकर्ताओं को मैनेज करना लेख पढ़ें.

  • अपनी Firebase Realtime Database और Cloud Storage सुरक्षा से जुड़े नियमों में, auth वैरिएबल से साइन इन किए हुए उपयोगकर्ता का यूनीक User-ID पाया जा सकता है. साथ ही, इसका इस्तेमाल यह कंट्रोल करने के लिए किया जा सकता है कि कोई उपयोगकर्ता किस डेटा को ऐक्सेस कर सकता है.

उपयोगकर्ताओं को पुष्टि करने वाले कई प्रोवाइडर का इस्तेमाल करके, आपके ऐप्लिकेशन में साइन इन करने की अनुमति दी जा सकती है. इसके लिए, पुष्टि करने वाले प्रोवाइडर के क्रेडेंशियल को किसी मौजूदा उपयोगकर्ता खाते से लिंक करें.

किसी उपयोगकर्ता को साइन आउट करने के लिए, signOut को कॉल करें:

Kotlin

Firebase.auth.signOut()
MainActivity.kt

Java

FirebaseAuth.getInstance().signOut();
MainActivity.java