फ़ोन नंबर का इस्तेमाल करके 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:33.15.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:23.2.1")
}
         क्या आपको Kotlin के लिए कोई लाइब्रेरी मॉड्यूल चाहिए? अक्टूबर 2023 (Firebase BoM 32.5.0) से, Kotlin और Java, दोनों डेवलपर मुख्य लाइब्रेरी मॉड्यूल का इस्तेमाल कर सकते हैं. ज़्यादा जानकारी के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले सवाल देखें.
  3. अगर आपने अब तक अपने ऐप्लिकेशन को Firebase प्रोजेक्ट से कनेक्ट नहीं किया है, तो Firebase कंसोल से ऐसा करें.
  4. अगर आपने अपने ऐप्लिकेशन का SHA-1 हैश, Firebase कंसोल में पहले से सेट नहीं किया है, तो ऐसा करें. अपने ऐप्लिकेशन का SHA-1 हैश ढूंढने के बारे में जानने के लिए, अपने क्लाइंट की पुष्टि करना लेख पढ़ें.

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

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

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

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

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

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

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

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

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

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

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

    reCAPTCHA इन स्थितियों में ट्रिगर होता है:

    • अगर असली उपयोगकर्ता के डिवाइस पर Google Play services इंस्टॉल नहीं है.
    • अगर ऐप्लिकेशन को Google Play Store (Authentication SDK टूल के 21.2.0 के बाद के वर्शन पर) के ज़रिए डिस्ट्रिब्यूट नहीं किया जाता है.
    • अगर SafetyNet से मिला टोकन मान्य नहीं था (Authentication SDK टूल के 21.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 पर ऊपर दी गई गड़बड़ी दिखती है, तो ऐप्लिकेशन के लिंक खोलने की सुविधा चालू करने के लिए, Android के लिए Firefox को नेटिव ऐप्लिकेशन में लिंक खोलने के लिए सेट करना लेख में दिया गया तरीका अपनाएं.

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

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

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

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 instance पर 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 के ट्रिगर होने से पहले, 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 कंसोल की मदद से, डेवलपमेंट के लिए फ़िक्शनल फ़ोन नंबर सेट अप किए जा सकते हैं. काल्पनिक फ़ोन नंबरों की मदद से जांच करने से ये फ़ायदे मिलते हैं:

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

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

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

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

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

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

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

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

साइन इन करने के बाद, उस फ़ोन नंबर से 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 एम्युलेटर में टेस्टिंग की जा सकती है.

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 वैरिएबल से साइन इन किए गए उपयोगकर्ता का यूनीक उपयोगकर्ता आईडी पाने का विकल्प है. साथ ही, इसका इस्तेमाल करके यह कंट्रोल किया जा सकता है कि उपयोगकर्ता कौनसा डेटा ऐक्सेस कर सकता है.

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

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

Kotlin

Firebase.auth.signOut()
MainActivity.kt

Java

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