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

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

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

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

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

    (दूसरा तरीका)  BoM का इस्तेमाल किए बिना, 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(),
)

    Java 

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

  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 कंसोल में, सुरक्षा > App Check पर जाएं.

  5. अभी-अभी लॉग किए गए डीबग टोकन को रजिस्टर करें.

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

    &#39;डीबग टोकन मैनेज करें&#39; मेन्यू आइटम का स्क्रीनशॉट

टोकन रजिस्टर करने के बाद, Firebase की बैकएंड सेवाएं इसे मान्य मानेंगी.

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

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

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

  1. Firebase कंसोल में, सुरक्षा > App Check पर जाएं.

  2. डीबग टोकन बनाएं. आपको अगले चरण में इस टोकन की ज़रूरत होगी.

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

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

    &#39;डीबग टोकन मैनेज करें&#39; मेन्यू आइटम का स्क्रीनशॉट

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

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

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

    (दूसरा तरीका)  BoM का इस्तेमाल किए बिना, 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 लाइब्रेरी के ऐसे वर्शन का इस्तेमाल करेगा जो एक-दूसरे के साथ काम करते हैं.

    (दूसरा तरीका)  BoM का इस्तेमाल किए बिना, 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 की बैकएंड सेवाएं, भेजे गए टोकन को मान्य मानेंगी.