استخدام ميزة "فحص التطبيقات" مع موفِّر تصحيح الأخطاء على نظام Android

بعد تسجيل تطبيقك في App Check، إذا أردت تشغيل تطبيقك في بيئة لا يصنّفها App Check عادةً على أنّها صالحة، مثل المحاكي أثناء التطوير أو من بيئة التكامل المستمر (CI)، يمكنك إنشاء إصدار مخصص لتصحيح الأخطاء من تطبيقك يستخدم موفّر تصحيح الأخطاء في App Check بدلاً من موفّر شهادات حقيقي.

استخدام موفّر تصحيح الأخطاء في المحاكي

لاستخدام موفّر تصحيح الأخطاء أثناء تشغيل تطبيقك بشكل تفاعلي في محاكي (أثناء التطوير مثلاً)، اتّبِع الخطوات التالية:

1. في ملف Gradle للوحدة (على مستوى التطبيق) (عادةً ما يكون <project>/<app-module>/build.gradle.kts أو <project>/<app-module>/build.gradle)، أضِف التبعية لمكتبة App Check لنظام التشغيل Android. ننصحك باستخدام الـ Firebase Android BoM للتحكّم في تحديد إصدار المكتبة.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:34.13.0"))
   
       // Add the dependencies for the App Check libraries
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-appcheck-debug")
   }

   باستخدام Firebase Android BoM، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات Firebase لنظام التشغيل Android.

   (بديل)  إضافة تبعيات مكتبة Firebase بدون استخدام BoM

   إذا اخترت عدم استخدام Firebase BoM، عليك تحديد إصدار كل مكتبة من مكتبات Firebase في سطر التبعية الخاص بها.

   ملاحظة: إذا كنت تستخدم مكتبات متعدّدة من Firebase في تطبيقك، ننصحك بشدة باستخدام BoM لإدارة إصدارات المكتبات، ما يضمن توافق جميع الإصدارات.

   dependencies {
       // Add the dependencies for the App Check libraries
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-appcheck-debug:19.0.2")
   }

2. في إصدار مخصص لتصحيح الأخطاء، اضبط App Check لاستخدام مصنع موفّر تصحيح الأخطاء:

   Kotlin

   Firebase.initialize(context = this)
   Firebase.appCheck.installAppCheckProviderFactory(
       DebugAppCheckProviderFactory.getInstance(),
   )
   MainActivity.kt

   Java

   FirebaseApp.initializeApp(/*context=*/ this);
   FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
   firebaseAppCheck.installAppCheckProviderFactory(
           DebugAppCheckProviderFactory.getInstance());
   MainActivity.java

3. شغِّل التطبيق وفعِّل طلبًا إلى إحدى خدمات Firebase الخلفية. سيتم تسجيل رمز تصحيح أخطاء محلي عندما تحاول حزمة SDK إرسال طلب إلى الخلفية. على سبيل المثال:

   D DebugAppCheckProvider: Enter this debug secret into the allow list in
   the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678

4. في وحدة تحكّم Firebase، انتقِل إلى الأمان > فحص التطبيقات.

5. سجِّل رمز تصحيح الأخطاء الذي سجّلته للتو.

   1. في علامة التبويب التطبيقات ، ابحث عن تطبيقك.
   2. من القائمة الكاملة لتطبيقك، اختَر إدارة رموز تصحيح الأخطاء.
   3. اتّبِع التعليمات الظاهرة على الشاشة لتسجيل رمز تصحيح الأخطاء.

   

بعد تسجيل الرمز، ستقبله خدمات Firebase الخلفية على أنّه صالح.

بما أنّ هذا الرمز يتيح الوصول إلى موارد Firebase بدون جهاز صالح، من المهم جدًا الحفاظ على خصوصيته. لا ترسِله إلى مستودع علني، وإذا تم اختراق رمز مسجَّل، عليك إبطاله على الفور في وحدة تحكّم Firebase.

استخدام موفّر تصحيح الأخطاء لإجراء اختبارات الوحدة في بيئة التكامل المستمر

لاستخدام موفّر تصحيح الأخطاء لإجراء اختبارات الوحدة في بيئة التكامل المستمر (CI)، اتّبِع الخطوات التالية:

1. في وحدة تحكّم Firebase، انتقِل إلى الأمان > فحص التطبيقات.

2. أنشئ رمز تصحيح أخطاء. ستحتاج إلى هذا الرمز في الخطوة التالية.

   1. في علامة التبويب التطبيقات ، ابحث عن تطبيقك.
   2. من القائمة الكاملة لتطبيقك، اختَر إدارة رموز تصحيح الأخطاء.
   3. اتّبِع التعليمات الظاهرة على الشاشة لإنشاء رمز تصحيح أخطاء جديد.

   بما أنّ هذا الرمز يتيح الوصول إلى موارد Firebase بدون جهاز صالح، من المهم جدًا الحفاظ على خصوصيته. لا ترسِله إلى مستودع علني، وإذا تم اختراق رمز مسجَّل، عليك إبطاله على الفور في وحدة تحكّم Firebase.

   

3. أضِف رمز تصحيح الأخطاء الذي أنشأته للتو إلى مخزن المفاتيح الآمن لنظام التكامل المستمر (على سبيل المثال، الأسرار المشفرة في GitHub Actions أو المتغيّرات المشفرة في Travis CI).

4. إذا لزم الأمر، اضبط نظام التكامل المستمر لجعل رمز تصحيح الأخطاء متاحًا في بيئة التكامل المستمر كمتغيّر بيئة. امنح المتغيّر اسمًا مثل APP_CHECK_DEBUG_TOKEN_FROM_CI.

5. في ملف Gradle للوحدة (على مستوى التطبيق) (عادةً ما يكون <project>/<app-module>/build.gradle.kts أو <project>/<app-module>/build.gradle)، أضِف التبعية لمكتبة App Check لنظام التشغيل Android. ننصحك باستخدام الـ Firebase Android BoM للتحكّم في تحديد إصدار المكتبة.

   Kotlin

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

   باستخدام Firebase Android BoM، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات Firebase لنظام التشغيل Android.

   (بديل)  إضافة تبعيات مكتبة Firebase بدون استخدام BoM

   إذا اخترت عدم استخدام Firebase BoM، عليك تحديد إصدار كل مكتبة من مكتبات Firebase في سطر التبعية الخاص بها.

   ملاحظة: إذا كنت تستخدم مكتبات متعدّدة من Firebase في تطبيقك، ننصحك بشدة باستخدام BoM لإدارة إصدارات المكتبات، ما يضمن توافق جميع الإصدارات.

   dependencies {
       // Add the dependency for the App Check library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-appcheck-debug:19.0.2")
   }

   Java

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

   باستخدام Firebase Android BoM، سيستخدم تطبيقك دائمًا إصدارات متوافقة من مكتبات Firebase لنظام التشغيل Android.

   (بديل)  إضافة تبعيات مكتبة Firebase بدون استخدام BoM

   إذا اخترت عدم استخدام Firebase BoM، عليك تحديد إصدار كل مكتبة من مكتبات Firebase في سطر التبعية الخاص بها.

   ملاحظة: إذا كنت تستخدم مكتبات متعدّدة من Firebase في تطبيقك، ننصحك بشدة باستخدام BoM لإدارة إصدارات المكتبات، ما يضمن توافق جميع الإصدارات.

   dependencies {
       // Add the dependency for the App Check library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-appcheck-debug:19.0.2")
   }

6. أضِف ما يلي إلى إعدادات تنويعة تصميم التكامل المستمر:

   testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
       System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""
   

7. في فئات الاختبار، استخدِم DebugAppCheckTestHelper لتضمين أي رمز يحتاج إلى رمز App Check:

   Kotlin

   @RunWith(AndroidJunit4::class)
   class MyTests {
       private val debugAppCheckTestHelper =
           DebugAppCheckTestHelper.fromInstrumentationArgs()
   
       @Test
       fun testWithDefaultApp() {
           debugAppCheckTestHelper.withDebugProvider {
               // Test code that requires a debug AppCheckToken.
           }
       }
   
       @Test
       fun testWithNonDefaultApp() {
           debugAppCheckTestHelper.withDebugProvider(
               FirebaseApp.getInstance("nonDefaultApp")
           ) {
               // Test code that requires a debug AppCheckToken.
           }
       }
   }
   

   Java

   @RunWith(AndroidJunit4.class)
   public class YourTests {
       private final DebugAppCheckTestHelper debugAppCheckTestHelper =
               DebugAppCheckTestHelper.fromInstrumentationArgs();
   
       @Test
       public void testWithDefaultApp() {
           debugAppCheckTestHelper.withDebugProvider(() -> {
               // Test code that requires a debug AppCheckToken.
           });
       }
   
       @Test
       public void testWithNonDefaultApp() {
           debugAppCheckTestHelper.withDebugProvider(
                   FirebaseApp.getInstance("nonDefaultApp"),
                   () -> {
                       // Test code that requires a debug AppCheckToken.
                   });
       }
   }
   

عند تشغيل تطبيقك في بيئة التكامل المستمر، ستقبل خدمات Firebase الخلفية الرمز الذي ترسله على أنّه صالح.