שימוש ב-App Check עם ספק ניפוי הבאגים ב-Android

אחרי אכיפת App Check בשירות לקצה העורפי, התכונות של האפליקציה שתלויות בשירות הזה לא יפעלו באמולטור או בסביבת שילוב רציף (CI), כי הסביבות האלה לא נחשבות למכשירים תקינים. כדי להריץ את האפליקציה בסביבות האלה במהלך הפיתוח והבדיקה, צריך ליצור גרסת build לניפוי באגים של האפליקציה שמשתמשת בApp Check ספק אימות לצורכי ניפוי באגים במקום בספק אימות בסביבת הייצור.

אזהרה: חשוב לשמור על הפרטיות של אסימון ניפוי הבאגים ושל גרסת ה-build לניפוי באגים. אסימון תקין לניפוי באגים וספק אימות לצורכי ניפוי באגים בגרסת ה-build לניפוי באגים מאפשרים גישה לשירותי הקצה העורפי ממכשירים לא מאומתים. אל תשלחו את אסימון ניפוי הבאגים למאגר ציבורי, ואל תשלחו את אסימון ניפוי הבאגים או את גרסת ה-build לניפוי באגים בגרסאות ה-build בסביבת הייצור של האפליקציה. אם אסימון רשום נחשף, צריך למחוק אותו מיד במסוף Firebase.

שימוש בספק אימות לצורכי ניפוי באגים באמולטור

כך משתמשים בספק האימות לצורכי ניפוי באגים כשמריצים את האפליקציה באמולטור באופן אינטראקטיבי (לדוגמה, במהלך פיתוח מקומי):

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:35.2.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:20.1.0")
   }

2. בגרסת ה-build לניפוי באגים, מגדירים את App Check כך שישתמש ב-factory של ספק האימות לצורכי ניפוי באגים:

   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. משיגים את טוקן ניפוי הבאגים:

   1. מפעילים את האפליקציה באמולטור או במכשיר הבדיקה.

   2. מחפשים את אסימון ניפוי הבאגים App Check ביומנים. לדוגמה:

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

   3. מעתיקים את הטוקן (לדוגמה, 123a4567-b89c-12d3-e456-789012345678).

4. רושמים את טוקן ניפוי הבאגים ב-App Check:

   1. במסוף Firebase, נכנסים לכרטיסייה Security ‏> App Check ‏> Apps.

   2. מוצאים את האפליקציה, לוחצים על סמל האפשרויות הנוספות () ובוחרים באפשרות Manage debug tokens.

   3. פועלים לפי ההוראות במסך כדי לרשום את אסימון ניפוי הבאגים.

   

אחרי שרושמים את האסימון ב-App Check, שירותי הקצה העורפי יקבלו אותו כאסימון תקין.

הטוקן הזה מאפשר גישה לשירות לקצה העורפי שלכם בלי מכשיר תקף, ולכן חשוב מאוד לשמור עליו כפרטי. אל תשלחו אותו למאגר ציבורי ואל תשלחו אותו בגרסאות ה-build של האפליקציה בסביבת הייצור. אם אסימון רשום נחשף, מחקו אותו מיד באמצעות ניהול אסימוני ניפוי באגים במסוף Firebase.

שימוש בספק אימות לצורכי ניפוי באגים לבדיקת יחידה בסביבת CI

כך משתמשים בספק אימות לצורכי ניפוי באגים לבדיקת יחידה בסביבת אינטגרציה רציפה (CI):

1. במסוף Firebase, יוצרים טוקן לניפוי באגים:

   1. במסוף Firebase, נכנסים לכרטיסייה Security ‏> App Check ‏> Apps.

   2. מוצאים את האפליקציה, לוחצים על סמל האפשרויות הנוספות () ובוחרים באפשרות Manage debug tokens.

   3. פועלים לפי ההוראות במסך כדי ליצור אסימון ניפוי באגים חדש.

   הטוקן הזה מאפשר גישה לשירות לקצה העורפי שלכם בלי מכשיר תקף, ולכן חשוב מאוד לשמור עליו כפרטי. אל תשלחו אותו למאגר ציבורי ואל תשלחו אותו בגרסאות ה-build של האפליקציה בסביבת הייצור. אם אסימון רשום נחשף, מחקו אותו מיד באמצעות ניהול אסימוני ניפוי באגים במסוף Firebase.

   

2. מוסיפים את אסימון ניפוי הבאגים שיצרתם למאגר המפתחות המאובטח של מערכת ה-CI (לדוגמה, הסודות המוצפנים של GitHub Actions או המשתנים המוצפנים של Travis CI).

3. אם צריך, מגדירים את מערכת ה-CI כך שאסימון ניפוי הבאגים יהיה זמין בסביבת ה-CI כמשתנה סביבה. נותנים למשתנה שם כמו APP_CHECK_DEBUG_TOKEN_FROM_CI.

4. בקובץ 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:35.2.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:20.1.0")
   }

   Java

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:35.2.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:20.1.0")
   }

5. מוסיפים את הקוד הבא להגדרות של וריאנט ה-build של ה-CI:

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

6. במחלקות הבדיקה, משתמשים ב-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.
                   });
       }
   }
   

כשהאפליקציה פועלת בסביבת CI, שירותי הקצה העורפי יקבלו את האסימון שהיא שולחת כאסימון תקין.