ใช้ App Check กับผู้ให้บริการแก้ไขข้อบกพร่องใน Android

หลังจากลงทะเบียนแอปสำหรับ App Check แล้ว คุณต้องการเรียกใช้ แอปในสภาพแวดล้อมที่ App Check มักจะไม่จัดว่า "ถูกต้อง" เช่น โปรแกรมจำลองระหว่างการพัฒนา หรือจากการรวมอย่างต่อเนื่อง (CI) คุณสามารถสร้างบิลด์การแก้ไขข้อบกพร่องของแอปที่ใช้ ผู้ให้บริการแก้ไขข้อบกพร่องของ App Check แทนที่จะเป็นผู้ให้บริการเอกสารรับรองจริง

คำเตือน: ผู้ให้บริการแก้ไขข้อบกพร่องอนุญาตการเข้าถึงทรัพยากร Firebase ของคุณจาก อุปกรณ์ที่ไม่ได้รับการยืนยัน อย่าใช้ผู้ให้บริการแก้ไขข้อบกพร่องในบิลด์ที่ใช้งานจริง และอย่าแชร์บิลด์การแก้ไขข้อบกพร่องกับผู้ที่ไม่น่าเชื่อถือ

ใช้ผู้ให้บริการแก้ไขข้อบกพร่องในโปรแกรมจำลอง

วิธีใช้ผู้ให้บริการแก้ไขข้อบกพร่องขณะเรียกใช้แอปในโปรแกรมจําลองแบบอินเทอร์แอกทีฟ (เช่น ในระหว่างการพัฒนา) ให้ดำเนินการดังนี้

1. ในไฟล์ Gradle ของโมดูล (ระดับแอป) (ปกติ <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) เพิ่มทรัพยากร Dependency สำหรับไลบรารี App Check สำหรับ Android เราขอแนะนำให้ใช้ BoM ของ Firebase Android เพื่อควบคุมการกำหนดเวอร์ชันไลบรารี

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.1.2"))
   
       // 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 เวอร์ชันที่เข้ากันได้เสมอ

   (ทางเลือก) เพิ่มทรัพยากร Dependency ของไลบรารี Firebase โดยไม่ต้องใช้ BoM

   หากเลือกไม่ใช้ Firebase BoM คุณต้องระบุเวอร์ชันไลบรารี Firebase แต่ละเวอร์ชัน ในบรรทัดทรัพยากร Dependency

   โปรดทราบว่าหากคุณใช้ไลบรารี 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:18.0.0")
   }
   

   หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ จะเริ่มต้นใน ตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนาซอฟต์แวร์ Kotlin และ Java สามารถ ขึ้นอยู่กับโมดูลไลบรารีหลัก (ดูรายละเอียดได้ที่ คําถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

2. กำหนดค่า App Check เพื่อใช้ผู้ให้บริการแก้ไขข้อบกพร่องในบิลด์การแก้ไขข้อบกพร่อง โรงงาน:

   Kotlin+KTX

   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. ในส่วน App Check ของคอนโซล Firebase ให้เลือกจัดการโทเค็นการแก้ไขข้อบกพร่องจากส่วนของแอป เมนูรายการเพิ่มเติม จากนั้นลงทะเบียนโทเค็นการแก้ไขข้อบกพร่องที่คุณบันทึกไว้ก่อนหน้านี้ ครั้งแรก

   

หลังจากที่ลงทะเบียนโทเค็นแล้ว บริการแบ็กเอนด์ของ Firebase จะยอมรับโทเค็นว่าถูกต้อง

เนื่องจากโทเค็นนี้อนุญาตให้เข้าถึงทรัพยากร Firebase โดยไม่มี อุปกรณ์ที่ถูกต้อง คุณจำเป็นต้อง รักษาอุปกรณ์ไว้เป็นส่วนตัว อย่านำไปใช้กับ ที่เก็บสาธารณะ และหากโทเค็นที่ลงทะเบียนถูกบุกรุก ให้เพิกถอน ได้ทันทีในคอนโซล Firebase

ใช้ผู้ให้บริการแก้ไขข้อบกพร่องสำหรับการทดสอบหน่วยในสภาพแวดล้อม CI

ใช้ผู้ให้บริการแก้ไขข้อบกพร่องสำหรับการทดสอบหน่วยในการผสานรวมต่อเนื่อง (CI) มีดังนี้

1. ในส่วน App Check ของคอนโซล Firebase ให้เลือกจัดการโทเค็นการแก้ไขข้อบกพร่องจากในแอป เมนูรายการเพิ่มเติม จากนั้นจึงสร้างโทเค็นการแก้ไขข้อบกพร่องใหม่ คุณจะต้องใช้โทเค็นใน ขั้นตอนถัดไป

   เนื่องจากโทเค็นนี้อนุญาตให้เข้าถึงทรัพยากร Firebase โดยไม่มี อุปกรณ์ที่ถูกต้อง คุณจำเป็นต้องเก็บอุปกรณ์ไว้เป็นส่วนตัว อย่านำไปใช้กับ ที่เก็บสาธารณะ และหากโทเค็นที่ลงทะเบียนถูกบุกรุก ให้เพิกถอน ได้ทันทีในคอนโซล 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) เพิ่มทรัพยากร Dependency สำหรับไลบรารี App Check สำหรับ Android เราขอแนะนำให้ใช้ BoM ของ Firebase Android เพื่อควบคุมการกำหนดเวอร์ชันไลบรารี

   Kotlin+KTX

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.1.2"))
   
       // 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 เวอร์ชันที่เข้ากันได้เสมอ

   (ทางเลือก) เพิ่มทรัพยากร Dependency ของไลบรารี Firebase โดยไม่ต้องใช้ BoM

   หากเลือกไม่ใช้ Firebase BoM คุณต้องระบุเวอร์ชันไลบรารี Firebase แต่ละเวอร์ชัน ในบรรทัดทรัพยากร Dependency

   โปรดทราบว่าหากคุณใช้ไลบรารี 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:18.0.0")
   }
   

   หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ จะเริ่มต้นใน ตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนาซอฟต์แวร์ Kotlin และ Java สามารถ ขึ้นอยู่กับโมดูลไลบรารีหลัก (ดูรายละเอียดได้ที่ คําถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

   Java

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.1.2"))
   
       // 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 เวอร์ชันที่เข้ากันได้เสมอ

   (ทางเลือก) เพิ่มทรัพยากร Dependency ของไลบรารี Firebase โดยไม่ต้องใช้ BoM

   หากเลือกไม่ใช้ Firebase BoM คุณต้องระบุเวอร์ชันไลบรารี Firebase แต่ละเวอร์ชัน ในบรรทัดทรัพยากร Dependency

   โปรดทราบว่าหากคุณใช้ไลบรารี 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:18.0.0")
   }
   

   หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ จะเริ่มต้นใน ตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนาซอฟต์แวร์ Kotlin และ Java สามารถ ขึ้นอยู่กับโมดูลไลบรารีหลัก (ดูรายละเอียดได้ที่ คําถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)

5. เพิ่มข้อมูลต่อไปนี้ลงในการกําหนดค่าตัวแปรบิลด์ CI

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

6. ในชั้นเรียนทดสอบของคุณ ให้ใช้ DebugAppCheckTestHelper เพื่อรวมโค้ด ที่ต้องใช้โทเค็น App Check ดังนี้

   Kotlin+KTX

   @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 บริการแบ็กเอนด์ของ Firebase จะยอมรับ โทเค็นที่ส่งเป็นโทเค็นที่ถูกต้อง