Android पर, डीबग की सेवा देने वाली कंपनी के साथ ऐप्लिकेशन की जांच करने की सुविधा का इस्तेमाल करना

किसी बैकएंड सेवा के लिए App Check लागू होने के बाद, आपके ऐप्लिकेशन की वे सुविधाएं काम नहीं करेंगी जो उस बैकएंड सेवा पर निर्भर करती हैं. ये सुविधाएं, किसी एम्युलेटर या लगातार इंटिग्रेशन (सीआई) वाले एनवायरमेंट में काम नहीं करेंगी. ऐसा इसलिए, क्योंकि ये एनवायरमेंट मान्य डिवाइसों की ज़रूरी शर्तें पूरी नहीं करते. डेवलपमेंट और टेस्टिंग के दौरान, अपने ऐप्लिकेशन को इन एनवायरमेंट में चलाने के लिए, आपको अपने ऐप्लिकेशन का डीबग के लिए बिल्ड बनाना होगा. यह बिल्ड, प्रोडक्शन अटेस्टेशन प्रोवाइडर के बजाय App Check डीबग प्रोवाइडर का इस्तेमाल करता है.

एम्युलेटर में डीबग प्रोवाइडर का इस्तेमाल करना

एम्युलेटर में ऐप्लिकेशन को इंटरैक्टिव तरीके से चलाने के दौरान, डीबग प्रोवाइडर का इस्तेमाल करने का तरीका यहां बताया गया है. उदाहरण के लिए, लोकल डेवलपमेंट के दौरान:

1. मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए App Check लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:35.0.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 लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

   (दूसरा तरीका)  BoM का इस्तेमाल किए बिना, Firebase लाइब्रेरी डिपेंडेंसी जोड़ें

   अगर आपको 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.0.0")
   }

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. अपना डीबग टोकन पाना:

   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 कंसोल में, सुरक्षा > App Check > ऐप्लिकेशन टैब पर जाएं.

   2. अपना ऐप्लिकेशन ढूंढें और तीन बिंदु वाले ओवरफ़्लो मेन्यू (more_vert) पर क्लिक करें. इसके बाद, डीबग टोकन मैनेज करें को चुनें.

   3. डीबग टोकन को रजिस्टर करने के लिए, स्क्रीन पर दिए गए निर्देशों का पालन करें.

   

App Check के साथ टोकन रजिस्टर करने के बाद, आपकी बैकएंड सेवाएं इसे मान्य मान लेंगी.

इस टोकन की मदद से, किसी मान्य डिवाइस के बिना भी बैकएंड सेवाओं को ऐक्सेस किया जा सकता है. इसलिए, यह ज़रूरी है कि आप इसे निजी रखें. इसे किसी सार्वजनिक रिपॉज़िटरी में कमिट न करें या अपने ऐप्लिकेशन के प्रोडक्शन बिल्ड में शिप न करें. अगर रजिस्टर किए गए किसी टोकन के साथ कभी छेड़छाड़ की जाती है, तो Firebase कंसोल में डीबग टोकन मैनेज करें का इस्तेमाल करके, उसे तुरंत मिटा दें.

सीआई एनवायरमेंट में यूनिट टेस्टिंग के लिए, डीबग प्रोवाइडर का इस्तेमाल करना

यहां लगातार इंटिग्रेशन (सीआई) वाले एनवायरमेंट में यूनिट टेस्टिंग के लिए, डीबग प्रोवाइडर का इस्तेमाल करने का तरीका बताया गया है:

1. Firebase कंसोल में, डीबग टोकन बनाएं:

   1. Firebase कंसोल में, सुरक्षा > App Check > ऐप्लिकेशन टैब पर जाएं.

   2. अपना ऐप्लिकेशन ढूंढें और तीन बिंदु वाले ओवरफ़्लो मेन्यू (more_vert) पर क्लिक करें. इसके बाद, डीबग टोकन मैनेज करें को चुनें.

   3. नया डीबग टोकन बनाने के लिए, स्क्रीन पर दिए गए निर्देशों का पालन करें.

   इस टोकन की मदद से, किसी मान्य डिवाइस के बिना भी बैकएंड सेवाओं को ऐक्सेस किया जा सकता है. इसलिए, यह ज़रूरी है कि आप इसे निजी रखें. इसे किसी सार्वजनिक रिपॉज़िटरी में कमिट न करें या अपने ऐप्लिकेशन के प्रोडक्शन बिल्ड में शिप न करें. अगर रजिस्टर किए गए किसी टोकन के साथ कभी छेड़छाड़ की जाती है, तो Firebase कंसोल में डीबग टोकन मैनेज करें का इस्तेमाल करके, उसे तुरंत मिटा दें.

   

2. अभी-अभी बनाए गए डीबग टोकन को अपने सीआई सिस्टम के सुरक्षित की स्टोर में जोड़ें. उदाहरण के लिए, GitHub Actions के एन्क्रिप्ट किए गए सीक्रेट या Travis CI के एन्क्रिप्ट किए गए वैरिएबल.

3. अगर ज़रूरी हो, तो अपने सीआई सिस्टम को कॉन्फ़िगर करें, ताकि डीबग टोकन को सीआई एनवायरमेंट में एनवायरमेंट वैरिएबल के तौर पर उपलब्ध कराया जा सके. वैरिएबल को APP_CHECK_DEBUG_TOKEN_FROM_CI जैसा कोई नाम दें.

4. मॉड्यूल (ऐप्लिकेशन-लेवल) की Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए App Check लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें.

   Kotlin

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:35.0.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 लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

   (दूसरा तरीका)  BoM का इस्तेमाल किए बिना, Firebase लाइब्रेरी डिपेंडेंसी जोड़ें

   अगर आपको 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.0.0")
   }

   Java

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:35.0.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 लाइब्रेरी के साथ काम करने वाले वर्शन का इस्तेमाल करेगा.

   (दूसरा तरीका)  BoM का इस्तेमाल किए बिना, Firebase लाइब्रेरी डिपेंडेंसी जोड़ें

   अगर आपको 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.0.0")
   }

5. अपने सीआई बिल्ड वैरिएंट के कॉन्फ़िगरेशन में यह जोड़ें:

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

जब आपका ऐप्लिकेशन सीआई एनवायरमेंट में चलता है, तो आपकी बैकएंड सेवाएं, ऐप्लिकेशन से भेजे गए टोकन को मान्य मान लेंगी.