احراز هویت با Firebase در Android بااستفاده از شماره تلفن

می‌توانید از Firebase Authentication برای ورود کاربر به سیستم با ارسال پیامک به تلفن کاربر استفاده کنید. کاربر بااستفاده از کد یک‌بارمصرف موجود در پیامک به سیستم وارد می‌شود.

ساده‌ترین راه برای افزودن ورود به سیستم با شماره تلفن به برنامه‌تان استفاده از FirebaseUI است، که شامل ابزاره ورود به سیستم drop-in است که جریان‌های ورود به سیستم را برای ورود به سیستم با شماره تلفن، و همچنین ورود به سیستم مبتنی بر گذرواژه و فدرال پیاده‌سازی می‌کند. این سند نحوه پیاده‌سازی جریان ورود به سیستم با شماره تلفن را بااستفاده از کیت توسعه نرم‌افزار Firebase شرح می‌دهد.

قبل از شروع

  1. اگر قبلاً این کار را نکرده‌اید، Firebase را به پروژه Android خود اضافه کنید.
  2. در فایل Gradle واحد (سطح برنامه) (معمولاً <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle)، وابستگی کتابخانه Firebase Authentication را برای Android اضافه کنید. توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌بندی کتابخانه استفاده کنید.
    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:35.2.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 استفاده خواهد کرد.

    (جایگزین)  افزودن وابستگی‌های کتابخانه Firebase بدون استفاده از BoM

    اگر انتخاب کنید که از 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:25.0.0")
    }
  3. اگر هنوز برنامه‌تان را به پروژه Firebase متصل نکرده‌اید، این کار را از کنسول Firebase انجام دهید.
  4. اگر قبلاً درهم‌سازی SHA-1 برنامه‌تان را در کنسول Firebase تنظیم نکرده‌اید، این کار را انجام دهید. برای کسب اطلاعات درباره پیدا کردن درهم‌سازی SHA-1 برنامه‌تان، اصالت‌سنجی کردن مشتری را ببینید.

نگرانی‌های امنیتی

اصالت‌سنجی فقط بااستفاده از شماره تلفن، هرچند راحت است، اما نسبت‌به سایر روش‌های موجود امنیت کمتری دارد، زیرا مالکیت شماره تلفن می‌تواند بین کاربران منتقل شود. همچنین، در دستگاه‌هایی که چند نمایه کاربر دارند، هر کاربری که بتواند پیامک دریافت کند می‌تواند بااستفاده از شماره تلفن دستگاه به سیستم حساب وارد شود.

اگر در برنامه‌تان از ورود به سیستم مبتنی بر شماره تلفن استفاده می‌کنید، باید آن را در کنار روش‌های ایمن‌تر ورود به سیستم ارائه دهید و کاربران را از معایب امنیتی استفاده از ورود به سیستم با شماره تلفن مطلع کنید.

ورود به سیستم با شماره تلفن را برای پروژه Firebase خود فعال کنید

برای ورود به سیستم کاربران ازطریق پیامک، ابتدا باید روش ورود به سیستم با «شماره تلفن» را برای پروژه Firebase خود فعال کنید:

  1. در کنسول Firebase، به امنیت > اصالت‌سنجی بروید.
  2. در برگه روش ورود به سیستم، ارائه‌دهنده ورود به سیستم تلفن را فعال کنید.
  3. خط‌مشی‌ای برای مناطقی که می‌خواهید ارسال پیامک به آن‌ها مجاز یا ممنوع باشد تنظیم کنید. تنظیم خط‌مشی منطقه پیامک می‌تواند به محافظت از برنامه‌هایتان دربرابر سوءاستفاده از پیامک کمک کند. برای پروژه‌های جدید، خط‌مشی پیش‌فرض هیچ منطقه‌ای را مجاز نمی‌کند.
    1. در کنسول Firebase، به امنیت > اصالت‌سنجی > زبانه تنظیمات بروید.
    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» با کیت توسعه نرم‌افزار Authentication نسخه ۲۱.۲.۰+ (Firebase BoM نسخه ۳۱.۴.۰+) دردسترس است.

    برای استفاده از Play Integrity، اثر انگشت SHA-256 برنامه‌تان را مشخص کنید (اگر قبلاً این کار را نکرده‌اید).

    1. در کنسول Firebase، به تنظیمات > زبانه «کلی» بروید.
    2. به پایین پیمایش کنید تا به کارت برنامه‌های شما برسید، برنامه Android خود را انتخاب کنید، و اثر انگشت SHA-256 خود را در فیلد اثر انگشت‌های گواهی SHA اضافه کنید.

    برای جزئیات مربوط به نحوه دریافت اثر انگشت SHA برنامه‌تان، اصالت‌سنجی مشتری را ببینید.

  • درستی‌سنجی 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 v21.2.0+).
    • اگر کد SafetyNet دریافت‌شده معتبر نبود (در نسخه‌های کیت توسعه نرم‌افزار Authentication < v21.2.0).

    وقتی از SafetyNet یا Play Integrity برای درستی‌سنجی برنامه استفاده می‌شود، فیلد %APP_NAME% در الگوی پیامک با نام برنامه تعیین‌شده از Google Play Store تکمیل می‌شود. در سناریوهایی که reCAPTCHA راه‌اندازی می‌شود، %APP_NAME% به‌عنوان PROJECT_ID.firebaseapp.com درج می‌شود.

می‌توانید جریان درستی‌سنجی reCAPTCHA را با forceRecaptchaFlowForTesting اجباری کنید می‌توانید درستی‌سنجی برنامه را (هنگام استفاده از شماره تلفن‌های ساختگی) بااستفاده از setAppVerificationDisabledForTesting غیرفعال کنید.

عیب‌یابی

  • خطای «Missing initial state» (وضعیت اولیه وجود ندارد) هنگام استفاده از reCAPTCHA برای درستی‌سنجی برنامه

    این مشکل زمانی رخ می‌دهد که جریان reCAPTCHA با موفقیت تکمیل می‌شود اما کاربر را به برنامه بومی هدایت نمی‌کند. اگر این اتفاق بیفتد، کاربر به نشانی وب بازگشتی PROJECT_ID.firebaseapp.com/__/auth/handler هدایت می‌شود. در مرورگرهای Firefox، باز کردن پیوندهای برنامه به زبان اصلی دستگاه به‌طور پیش‌فرض غیرفعال است. اگر خطای بالا را در Firefox می‌بینید، مراحل تنظیم Firefox برای 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)

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 ارسال کنید. وقتی «فعالیت» متوقف می‌شود، فراخوانی‌های برگشتی به‌طور خودکار جدا می‌شوند، بنابراین می‌توانید کد انتقال میانای کاربر را آزادانه در روش‌های فراخوانی برگشتی بنویسید.

پیامک ارسال‌شده توسط Firebase را نیز می‌توان با مشخص کردن زبان احراز هویت ازطریق روش setLanguageCode در نمونه Auth بومی‌سازی کرد.

Kotlin

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

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 را نیز پیاده‌سازی کنید.

onVerificationCompleted(PhoneAuthCredential)

این روش در دو موقعیت فراخوانی می‌شود:

  • درستی‌سنجی فوری: در برخی موارد، شماره تلفن می‌تواند فوراً بدون نیاز به ارسال یا وارد کردن کد درستی‌سنجی، درستی‌سنجی شود.
  • بازیابی خودکار: در برخی دستگاه‌ها، خدمات Google Play می‌تواند به‌طور خودکار پیامک درستی‌سنجی ورودی را شناسایی کند و درستی‌سنجی را بدون اقدام کاربر انجام دهد. (ممکن است این قابلیت در برخی‌از شرکت‌های مخابراتی دردسترس نباشد.) این روش از SMS Retriever API استفاده می‌کند که شامل یک درهم‌ساز ۱۱ نویسه‌ای در انتهای پیامک است.
در هر دو حالت، شماره تلفن کاربر با موفقیت درستی‌سنجی شده است و می‌توانید از شیء PhoneAuthCredential که به فراخوانی برگشتی ارسال شده است برای ورود کاربر به سیستم استفاده کنید.

onVerificationFailed(FirebaseException)

این روش در پاسخ به درخواست درستی‌سنجی نامعتبر فراخوانده می‌شود، مثل درخواستی که شماره تلفن یا کد درستی‌سنجی نامعتبر را مشخص می‌کند.

onCodeSent(String verificationId, PhoneAuthProvider.ForceResendingToken)

اختیاری است. این روش پس‌از ارسال کد درستی‌سنجی ازطریق پیامک به شماره تلفن ارائه‌شده فراخوانی می‌شود.

وقتی این روش فراخوانی می‌شود، اکثر برنامه‌ها میانای کاربری‌ای را نمایش می‌دهند که از کاربر می‌خواهد کد درستی‌سنجی را از پیامک تایپ کند. (هم‌زمان، درستی‌سنجی خودکار ممکن است در پس‌زمینه ادامه یابد.) سپس، پس‌از اینکه کاربر کد درستی‌سنجی را تایپ کرد، می‌توانید از کد درستی‌سنجی و شناسه درستی‌سنجی که به روش ارسال شده است برای ایجاد شیء PhoneAuthCredential استفاده کنید که به‌نوبه خود می‌توانید از آن برای وارد کردن کاربر به سیستم استفاده کنید. بااین‌حال، برخی‌از برنامه‌ها ممکن است تا زمانی که onCodeAutoRetrievalTimeOut فراخوانی شود منتظر بمانند و سپس میانای کاربر کد درستی‌سنجی را نمایش دهند (توصیه نمی‌شود).

onCodeAutoRetrievalTimeOut(String verificationId)

اختیاری است. این روش پس‌از گذشت مدت زمان وقفه مشخص‌شده برای verifyPhoneNumber بدون اینکه onVerificationCompleted ابتدا راه‌اندازی شود، فراخوانی می‌شود. در دستگاه‌های بدون سیم‌کارت، این روش بلافاصله فراخوانی می‌شود زیرا بازیابی خودکار پیامک امکان‌پذیر نیست.

برخی‌از برنامه‌ها ورودی کاربر را تا پایان دوره درستی‌سنجی خودکار مسدود می‌کنند، و تنها پس‌از آن میانای کاربری را نمایش می‌دهند که از کاربر می‌خواهد کد درستی‌سنجی را از پیامک تایپ کند (توصیه نمی‌شود).

ایجاد کردن شیء PhoneAuthCredential

پس‌از اینکه کاربر کد درستی‌سنجی را که Firebase به تلفن کاربر ارسال کرده است وارد کرد، بااستفاده از کد درستی‌سنجی و شناسه درستی‌سنجی که به فراخوانی برگشتی onCodeSent یا onCodeAutoRetrievalTimeOut ارسال شده است، یک شیء PhoneAuthCredential ایجاد کنید. (وقتی onVerificationCompleted فراخوانی می‌شود، مستقیماً یک شیء PhoneAuthCredential دریافت می‌کنید، بنابراین می‌توانید از این مرحله رد شوید.)

برای ایجاد شیء PhoneAuthCredential، PhoneAuthProvider.getCredential را فراخوانی کنید:

Kotlin

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

Java

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

ورود کاربر به سیستم

پس‌از دریافت شیء 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
            }
        }
}

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

آزمایش با شماره تلفن‌های ساختگی

می‌توانید شماره تلفن‌های ساختگی را برای توسعه بااستفاده از کنسول Firebase راه‌اندازی کنید. آزمایش با شماره تلفن‌های ساختگی این مزایا را دارد:

  • اصالت‌سنجی شماره تلفن را بدون مصرف سهمیه استفاده‌تان آزمایش کنید.
  • اصالت‌سنجی شماره تلفن را بدون ارسال پیامک واقعی آزمایش کنید.
  • آزمایش‌های متوالی را با همان شماره تلفن بدون محدود شدن اجرا کنید. این کار خطر رد شدن در فرایند بازبینی «فروشگاه برنامه‌ها» را درصورتی‌که بازبین از همان شماره تلفن برای آزمایش استفاده کند به‌حداقل می‌رساند.
  • به‌راحتی در محیط‌های توسعه بدون هیچ تلاش اضافی آزمایش کنید، مانند توانایی توسعه در شبیه‌ساز iOS یا شبیه‌ساز Android بدون «خدمات Google Play».
  • آزمایش‌های ادغام را بدون اینکه با بررسی‌های امنیتی که معمولاً روی شماره تلفن‌های واقعی در محیط تولید اعمال می‌شود مسدود شوید بنویسید.

شماره تلفن‌های ساختگی باید این شرایط را داشته باشند:

  1. مطمئن شوید از شماره تلفن‌هایی استفاده می‌کنید که واقعاً ساختگی هستند و ازقبل وجود ندارند. Firebase Authentication به شما اجازه نمی‌دهد شماره تلفن‌های موجود را که کاربران واقعی استفاده می‌کنند به‌عنوان شماره آزمایشی تنظیم کنید. یک گزینه این است که از شماره‌های با پیشوند ۵۵۵ به‌عنوان شماره تلفن آزمایشی ایالات متحده استفاده کنید، برای مثال: ‎+۱ ۶۵۰-۵۵۵-۳۴۳۴
  2. شماره تلفن‌ها باید ازنظر طول و سایر محدودیت‌ها به‌درستی قالب‌بندی شده باشند. این شماره‌ها همچنان همان اعتبارسنجی شماره تلفن کاربر واقعی را طی خواهند کرد.
  3. می‌توانید حداکثر ۱۰ شماره تلفن برای توسعه اضافه کنید.
  4. از شماره تلفن‌ها/ کدهای آزمایشی استفاده کنید که حدس زدن آن‌ها دشوار است و آن‌ها را مرتباً تغییر دهید.

ایجاد شماره تلفن‌ها و کدهای درستی‌سنجی ساختگی

  1. در کنسول Firebase، به امنیت > اصالت‌سنجی بروید.
  2. در برگه روش ورود به سیستم، ارائه‌دهنده ورود به سیستم تلفن را فعال کنید (اگر قبلاً این کار را نکرده‌اید).
  3. بخش شماره‌های تلفن برای آزمایش را ازهم باز کنید.
  4. شماره تلفنی را که می‌خواهید آزمایش کنید ارائه دهید، برای مثال: +1 650-555-3434.
  5. کد درستی‌سنجی ۶ رقمی را برای آن شماره خاص ارائه دهید، برای مثال: 654321.
  6. برای هر شماره، روی افزودن کلیک کنید. درصورت نیاز، می‌توانید شماره تلفن و کد آن را با نگه داشتن نشانگر روی ردیف مربوطه و کلیک کردن روی نماد سطل زباله حذف کنید.

آزمایش دستی

می‌توانید مستقیماً از شماره تلفن ساختگی در برنامه‌تان استفاده کنید. این کار به شما امکان می‌دهد آزمایش دستی را در مراحل توسعه بدون مواجه شدن با مشکلات سهمیه یا محدودسازی انجام دهید. همچنین می‌توانید مستقیماً از شبیه‌ساز iOS یا شبیه‌ساز Android بدون نصب «خدمات Google Play» آزمایش کنید.

وقتی شماره تلفن ساختگی را ارائه می‌دهید و کد درستی‌سنجی را ارسال می‌کنید، هیچ پیامک واقعی‌ای ارسال نمی‌شود. درعوض، باید کد درستی‌سنجی‌ای را که قبلاً پیکربندی شده است ارائه دهید تا ورود به سیستم تکمیل شود.

پس‌از تکمیل ورود به سیستم، کاربر 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 غیرفعال هستند، استفاده از شماره تلفن واقعی همچنان باعث می‌شود ورود به سیستم تکمیل نشود. فقط شماره تلفن‌های ساختگی را می‌توان با این API استفاده کرد.

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

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)

علاوه‌براین، می‌توانید جریان‌های بازیابی خودکار را در Android با تنظیم شماره ساختگی و کد درستی‌سنجی مربوط به آن برای بازیابی خودکار با تماس گرفتن با setAutoRetrievedSmsCodeForPhoneNumber آزمایش کنید.

وقتی verifyPhoneNumber فراخوانده می‌شود، onVerificationCompleted را مستقیماً با PhoneAuthCredential راه‌اندازی می‌کند. این ویژگی فقط با شماره تلفن‌های ساختگی کار می‌کند.

هنگام انتشار برنامه‌تان در فروشگاه 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

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

مراحل بعدی

پس‌از اینکه کاربر برای اولین‌بار به سیستم وارد شد، حساب کاربری جدیدی ایجاد می‌شود و به اطلاعات اعتباری (یعنی نام کاربری و گذرواژه، شماره تلفن، یا اطلاعات ارائه‌دهنده احراز هویت) که کاربر با آن به سیستم وارد شده است پیوند داده می‌شود. این حساب جدید به‌عنوان بخشی از پروژه Firebase شما ذخیره می‌شود و می‌توان از آن برای شناسایی کاربر در هر برنامه در پروژه شما، صرف‌نظر از نحوه ورود کاربر به سیستم، استفاده کرد.

  • در برنامه‌هایتان، می‌توانید اطلاعات نمایه پایه کاربر را از شیء FirebaseUser دریافت کنید. مدیریت کاربران را ببینید.

  • در Firebase Realtime Database و Cloud Storage قوانین امنیتی، می‌توانید شناسه کاربر منحصربه‌فرد کاربر واردشده به سیستم را از متغیر auth دریافت کنید، و از آن برای کنترل داده‌هایی که کاربر می‌تواند به آن‌ها دسترسی داشته باشد استفاده کنید.

می‌توانید به کاربران اجازه دهید بااستفاده از چند ارائه‌دهنده اصالت‌سنجی به سیستم برنامه‌تان وارد شوند. برای این کار، اعتبارنامه‌های ارائه‌دهنده اصالت‌سنجی را به حساب کاربری موجود پیوند دهید.

برای خارج کردن کاربر از سیستم، signOut را فراخوانی کنید:

Kotlin

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();