了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

फ़ोन नंबर का उपयोग करके Android पर Firebase से प्रमाणित करें

आप उपयोगकर्ता के फोन पर एसएमएस संदेश भेजकर साइन इन करने के लिए फायरबेस प्रमाणीकरण का उपयोग कर सकते हैं। उपयोगकर्ता एसएमएस संदेश में निहित एक बार के कोड का उपयोग करके साइन इन करता है।

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

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

  1. यदि आपने पहले से नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें
  2. अपने मॉड्यूल (ऐप-लेवल) ग्रैडल फ़ाइल (आमतौर पर <project>/<app-module>/build.gradle ) में, फायरबेस ऑथेंटिकेशन एंड्रॉइड लाइब्रेरी के लिए निर्भरता जोड़ें। हम लाइब्रेरी वर्ज़निंग को नियंत्रित करने के लिए Firebase Android BoM का उपयोग करने की सलाह देते हैं।

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:32.1.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-ktx'
    }
    

    Firebase Android BoM का उपयोग करके, आपका ऐप हमेशा Firebase Android पुस्तकालयों के संगत संस्करणों का उपयोग करेगा।

    (वैकल्पिक) BoM का उपयोग किए बिना Firebase लाइब्रेरी निर्भरताएँ जोड़ें

    यदि आप Firebase BoM का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक Firebase लाइब्रेरी संस्करण को उसकी निर्भरता रेखा में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए बीओएम का उपयोग करने की दृढ़ता से अनुशंसा करते हैं, जो सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    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.0.0'
    }
    

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:32.1.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 लाइब्रेरी संस्करण को उसकी निर्भरता रेखा में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए बीओएम का उपयोग करने की दृढ़ता से अनुशंसा करते हैं, जो सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    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.0.0'
    }
    
  3. अगर आपने अभी तक अपने ऐप को अपने फायरबेस प्रोजेक्ट से कनेक्ट नहीं किया है, तो फायरबेस कंसोल से ऐसा करें।
  4. यदि आपने अपने ऐप का SHA-1 हैश Firebase कंसोल में पहले से सेट नहीं किया है, तो ऐसा करें। अपने ऐप के SHA-1 हैश को खोजने के बारे में जानकारी के लिए अपने क्लाइंट को प्रमाणित करना देखें।

सुरक्षा चिंताएं

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

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

अपने फायरबेस प्रोजेक्ट के लिए फ़ोन नंबर साइन-इन सक्षम करें

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

  1. फायरबेस कंसोल में, प्रमाणीकरण अनुभाग खोलें।
  2. साइन-इन विधि पृष्ठ पर, फ़ोन नंबर साइन-इन विधि सक्षम करें।

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

ऐप सत्यापन सक्षम करें

फ़ोन नंबर प्रमाणीकरण का उपयोग करने के लिए, Firebase को यह सत्यापित करने में सक्षम होना चाहिए कि आपके ऐप से फ़ोन नंबर साइन-इन अनुरोध आ रहे हैं। फायरबेस प्रमाणीकरण तीन तरीकों से इसे पूरा करता है:

  • Play Integrity API : यदि किसी उपयोगकर्ता के पास Google Play सेवाओं के साथ एक उपकरण स्थापित है, और Firebase प्रमाणीकरण डिवाइस को Play Integrity API के साथ वैध के रूप में सत्यापित कर सकता है, तो फ़ोन नंबर साइन-इन आगे बढ़ सकता है। Play Integrity API को Google के स्वामित्व वाले प्रोजेक्ट पर Firebase प्रमाणीकरण द्वारा सक्षम किया गया है, आपके प्रोजेक्ट पर नहीं। यह आपके प्रोजेक्ट पर किसी Play Integrity API कोटा में योगदान नहीं करता है। Play अखंडता समर्थन प्रमाणीकरण SDK v21.2.0+ (Firebase BoM v31.4.0+) के साथ उपलब्ध है।

    Play Integrity का उपयोग करने के लिए, यदि आपने अभी तक अपने ऐप का SHA-256 फ़िंगरप्रिंट निर्दिष्ट नहीं किया है, तो Firebase कंसोल की प्रोजेक्ट सेटिंग से ऐसा करें। अपने ऐप का SHA-256 फ़िंगरप्रिंट कैसे प्राप्त करें, इसके विवरण के लिए अपने क्लाइंट को प्रमाणित करना देखें।

  • reCAPTCHA सत्यापन : उस स्थिति में जब Play Integrity का उपयोग नहीं किया जा सकता है, जैसे कि जब उपयोगकर्ता के पास Google Play सेवाओं के बिना डिवाइस स्थापित हो, तो Firebase प्रमाणीकरण फ़ोन साइन-इन प्रवाह को पूरा करने के लिए reCAPTCHA सत्यापन का उपयोग करता है। ReCAPTCHA चुनौती को अक्सर उपयोगकर्ता द्वारा कुछ भी हल किए बिना पूरा किया जा सकता है। ध्यान दें कि इस प्रवाह के लिए आवश्यक है कि SHA-1 आपके एप्लिकेशन से जुड़ा हो। इस प्रवाह के लिए यह भी आवश्यक है कि आपकी API कुंजी PROJECT_ID .firebaseapp.com के लिए अप्रतिबंधित या अनुमत सूची में हो।

    कुछ परिदृश्य जहां reCAPTCHA ट्रिगर होता है:

    • अगर एंड-यूज़र के डिवाइस में Google Play सेवाएं इंस्टॉल नहीं हैं।
    • यदि ऐप Google Play store ( प्रमाणीकरण SDK v21.2.0+ पर) के माध्यम से वितरित नहीं किया गया है।
    • यदि प्राप्त किया गया सेफ्टीनेट टोकन मान्य नहीं था (प्रमाणीकरण एसडीके संस्करण <v21.2.0 पर)।

    जब ऐप सत्यापन के लिए सेफ्टीनेट या प्ले इंटीग्रिटी का उपयोग किया जाता है, तो एसएमएस टेम्पलेट में %APP_NAME% फ़ील्ड Google Play स्टोर से निर्धारित ऐप नाम से पॉप्युलेट हो जाती है। उन परिदृश्यों में जहां reCAPTCHA को ट्रिगर किया जाता है, %APP_NAME% PROJECT_ID .firebaseapp.com के रूप में पॉप्युलेट किया जाता है।

आप forceRecaptchaFlowForTesting के साथ reCAPTCHA सत्यापन प्रवाह को बाध्य कर सकते हैं आप setAppVerificationDisabledForTesting उपयोग करके ऐप सत्यापन (काल्पनिक फ़ोन नंबरों का उपयोग करते समय) को अक्षम कर सकते हैं।

उपयोगकर्ता के फ़ोन पर एक सत्यापन कोड भेजें

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

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

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);     

verifyPhoneNumber मेथड रीएन्ट्रेंट है: यदि आप इसे कई बार कॉल करते हैं, जैसे कि किसी एक्टिविटी के onStart मेथड में, verifyPhoneNumber मेथड तब तक दूसरा एसएमएस नहीं भेजेगा जब तक कि ओरिजिनल रिक्वेस्ट टाइम आउट न हो जाए।

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

स्क्रीन रोटेशन और गतिविधि के पुनरारंभ होने के अन्य उदाहरणों को आसानी से संभालने के लिए, अपनी गतिविधि को verifyPhoneNumber विधि में पास करें। गतिविधि बंद होने पर कॉलबैक स्वत: अलग हो जाएंगे, ताकि आप कॉलबैक विधियों में स्वतंत्र रूप से यूआई संक्रमण कोड लिख सकें।

फायरबेस द्वारा भेजे गए एसएमएस संदेश को आपके प्रामाणिक उदाहरण पर setLanguageCode विधि के माध्यम से ऑथ भाषा निर्दिष्ट करके भी स्थानीयकृत किया जा सकता है।

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();

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

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;
    }
};

सत्यापन कॉलबैक

अधिकांश ऐप्स में, आप onVerificationCompleted , onVerificationFailed , और onCodeSent कॉलबैक लागू करते हैं। आप अपने ऐप की आवश्यकताओं के आधार पर onCodeAutoRetrievalTimeOut भी लागू कर सकते हैं।

सत्यापन पूरा होने पर (फोनऑथ क्रेडेंशियल)

इस विधि को दो स्थितियों में कहा जाता है:

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

onVerificationFailed (FirebaseException)

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

onCodeSent(स्ट्रिंग सत्यापन आईडी, PhoneAuthProvider.ForceResendingToken)

वैकल्पिक। प्रदान किए गए फ़ोन नंबर पर सत्यापन कोड एसएमएस द्वारा भेजे जाने के बाद इस विधि को कॉल किया जाता है।

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

onCodeAutoRetrievalTimeOut(स्ट्रिंग सत्यापनआईडी)

वैकल्पिक। इस विधि को verifyPhoneNumber के लिए निर्दिष्ट टाइमआउट अवधि के बाद कहा जाता है, जो पहले बिना onVerificationCompleted ट्रिगरिंग के पारित हो गया है। सिम कार्ड के बिना उपकरणों पर, इस विधि को तुरंत कॉल किया जाता है क्योंकि एसएमएस ऑटो-पुनर्प्राप्ति संभव नहीं है।

कुछ ऐप उपयोगकर्ता इनपुट को तब तक रोकते हैं जब तक कि ऑटो-सत्यापन अवधि का समय समाप्त नहीं हो जाता है, और उसके बाद ही एक UI प्रदर्शित करता है जो उपयोगकर्ता को एसएमएस संदेश से सत्यापन कोड टाइप करने के लिए संकेत देता है (अनुशंसित नहीं)।

एक PhoneAuthCredential वस्तु बनाएँ

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

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

Kotlin+KTX

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

Java

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

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

आपके द्वारा PhoneAuthCredential ऑब्जेक्ट प्राप्त करने के बाद, चाहे onVerificationCompleted कॉलबैक में या PhoneAuthProvider.getCredential पर कॉल करके, PhoneAuthCredential ऑब्जेक्ट को 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
                        }
                    }
                }
            });
}

काल्पनिक फोन नंबरों के साथ परीक्षण करें

आप फायरबेस कंसोल के माध्यम से विकास के लिए काल्पनिक फोन नंबर सेट कर सकते हैं। काल्पनिक फ़ोन नंबरों के साथ परीक्षण करने से ये लाभ मिलते हैं:

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

काल्पनिक फ़ोन नंबरों को इन आवश्यकताओं को पूरा करना चाहिए:

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

काल्पनिक फोन नंबर और सत्यापन कोड बनाएं

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

मैनुअल परीक्षण

आप सीधे अपने आवेदन में एक काल्पनिक फोन नंबर का उपयोग शुरू कर सकते हैं। यह आपको कोटा मुद्दों या थ्रॉटलिंग के बिना विकास चरणों के दौरान मैन्युअल परीक्षण करने की अनुमति देता है। आप Google Play सेवाओं को इंस्टॉल किए बिना iOS सिम्युलेटर या Android एमुलेटर से भी सीधे परीक्षण कर सकते हैं।

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

साइन-इन पूर्ण होने पर, उस फ़ोन नंबर के साथ एक Firebase उपयोगकर्ता बनाया जाता है। उपयोगकर्ता के पास वास्तविक फ़ोन नंबर उपयोगकर्ता के समान व्यवहार और गुण होते हैं, और उसी तरह रीयलटाइम डेटाबेस/क्लाउड फायरस्टोर और अन्य सेवाओं तक पहुंच सकते हैं। इस प्रक्रिया के दौरान बनाए गए आईडी टोकन में वास्तविक फ़ोन नंबर उपयोगकर्ता के समान हस्ताक्षर होते हैं।

एक अन्य विकल्प इन उपयोगकर्ताओं पर कस्टम दावों के माध्यम से एक परीक्षण भूमिका निर्धारित करना है ताकि उन्हें नकली उपयोगकर्ताओं के रूप में अलग किया जा सके यदि आप पहुंच को और प्रतिबंधित करना चाहते हैं।

परीक्षण के लिए रीकैप्चा प्रवाह को मैन्युअल रूप से ट्रिगर करने के लिए, forceRecaptchaFlowForTesting() विधि का उपयोग करें।

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

एकीकरण जांच

मैन्युअल परीक्षण के अलावा, Firebase प्रमाणीकरण फ़ोन प्रमाणन परीक्षण के लिए एकीकरण परीक्षण लिखने में सहायता के लिए API प्रदान करता है। ये API वेब में reCAPTCHA आवश्यकता और iOS में साइलेंट पुश नोटिफिकेशन को अक्षम करके ऐप सत्यापन को अक्षम कर देते हैं। यह इन प्रवाहों में स्वचालन परीक्षण को संभव बनाता है और इसे लागू करना आसान बनाता है। इसके अलावा, वे Android पर तत्काल सत्यापन प्रवाह का परीक्षण करने की क्षमता प्रदान करने में सहायता करते हैं।

Android पर, signInWithPhoneNumber कॉल से पहले setAppVerificationDisabledForTesting() कॉल करें। यह ऐप सत्यापन को स्वचालित रूप से अक्षम कर देता है, जिससे आप फ़ोन नंबर को मैन्युअल रूप से हल किए बिना पास कर सकते हैं। भले ही Play Integrity और reCAPTCHA अक्षम हैं, फिर भी वास्तविक फ़ोन नंबर का उपयोग करने से साइन इन पूर्ण नहीं हो पाएगा। इस API के साथ केवल काल्पनिक फ़ोन नंबरों का उपयोग किया जा सकता है।

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

एक काल्पनिक नंबर के साथ verifyPhoneNumber कॉल करना onCodeSent कॉलबैक को ट्रिगर करता है, जिसमें आपको संबंधित सत्यापन कोड प्रदान करने की आवश्यकता होगी। यह एंड्रॉइड एमुलेटर में परीक्षण की अनुमति देता है।

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)

इसके अतिरिक्त, आप काल्पनिक संख्या और उसके संबंधित सत्यापन कोड को setAutoRetrievedSmsCodeForPhoneNumber पर कॉल करके ऑटो-पुनर्प्राप्ति के लिए सेट करके Android में ऑटो-पुनर्प्राप्ति प्रवाह का परीक्षण कर सकते हैं।

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

सुनिश्चित करें कि यह अक्षम है और Google Play स्टोर पर अपना एप्लिकेशन प्रकाशित करते समय कोई भी काल्पनिक फ़ोन नंबर आपके ऐप में हार्डकोड नहीं किया गया है।

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)

अगले कदम

उपयोगकर्ता द्वारा पहली बार साइन इन करने के बाद, एक नया उपयोगकर्ता खाता बनाया जाता है और क्रेडेंशियल्स से लिंक किया जाता है—यानी, उपयोगकर्ता नाम और पासवर्ड, फ़ोन नंबर, या प्रमाणीकरण प्रदाता जानकारी—जिसके साथ उपयोगकर्ता ने साइन इन किया है। यह नया खाता आपके फायरबेस प्रोजेक्ट के हिस्से के रूप में संग्रहीत है, और उपयोगकर्ता द्वारा साइन इन किए जाने पर ध्यान दिए बिना, आपके प्रोजेक्ट में प्रत्येक ऐप में उपयोगकर्ता की पहचान करने के लिए इसका उपयोग किया जा सकता है।

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

  • आपके फायरबेस रीयलटाइम डेटाबेस और क्लाउड स्टोरेज सुरक्षा नियमों में, आप auth चर से साइन-इन किए गए उपयोगकर्ता की विशिष्ट उपयोगकर्ता आईडी प्राप्त कर सकते हैं, और इसका उपयोग यह नियंत्रित करने के लिए कर सकते हैं कि उपयोगकर्ता किस डेटा तक पहुंच सकता है।

आप प्रमाणीकरण प्रदाता क्रेडेंशियल्स को किसी मौजूदा उपयोगकर्ता खाते से लिंक करके उपयोगकर्ताओं को एकाधिक प्रमाणीकरण प्रदाताओं का उपयोग करके अपने ऐप में साइन इन करने की अनुमति दे सकते हैं।

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

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();