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

इस पेज पर, अपने पसंदीदा App Check प्रोवाइडर का इस्तेमाल करके, Android ऐप्लिकेशन में App Check को चालू करने का तरीका बताया गया है. App Check को चालू करने पर, आप यह पक्का कर सकते हैं कि आपका ऐप्लिकेशन ही आपके प्रोजेक्ट के Firebase संसाधनों को ऐक्सेस कर सके.

अगर आपको Play Integrity की सेवा देने वाली डिफ़ॉल्ट कंपनी के साथ App Check का इस्तेमाल करना है, तो Android पर Play Integrity की मदद से App Check को चालू करना लेख पढ़ें.

शुरू करने से पहले

1. अपने ऐप्लिकेशन में App Check लाइब्रेरी जोड़ना

अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) 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:33.6.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")
}

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:18.0.0")
}
क्या आपको Kotlin के लिए कोई लाइब्रेरी मॉड्यूल चाहिए? अक्टूबर 2023 (Firebase BoM 32.5.0) से, Kotlin और Java, दोनों डेवलपर मुख्य लाइब्रेरी मॉड्यूल का इस्तेमाल कर सकते हैं. ज़्यादा जानकारी के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले सवाल देखें.

2. App Check इंटरफ़ेस लागू करना

सबसे पहले, आपको ऐसी क्लास बनानी होंगी जो AppCheckProvider और AppCheckProviderFactory इंटरफ़ेस लागू करती हों.

आपकी AppCheckProvider क्लास में getToken() तरीका होना चाहिए. यह तरीका, पुष्टि के सबूत के तौर पर, आपके कस्टम App Check प्रोवाइडर के लिए ज़रूरी जानकारी इकट्ठा करता है. साथ ही, इसे App Check टोकन के बदले, टोकन हासिल करने की आपकी सेवा को भेजता है. App Check SDK टूल, टोकन कैश मेमोरी को मैनेज करता है. इसलिए, getToken() को लागू करते समय हमेशा नया टोकन पाएं.

Kotlin+KTX 

class YourCustomAppCheckToken(
    private val token: String,
    private val expiration: Long,
) : AppCheckToken() {
    override fun getToken(): String = token
    override fun getExpireTimeMillis(): Long = expiration
}

class YourCustomAppCheckProvider(firebaseApp: FirebaseApp) : AppCheckProvider {
    override fun getToken(): Task<AppCheckToken> {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        val expMillis = expirationFromServer * 1000L - 60000L

        // Create AppCheckToken object.
        val appCheckToken: AppCheckToken = YourCustomAppCheckToken(tokenFromServer, expMillis)
        return Tasks.forResult(appCheckToken)
    }
}
CustomProvider.kt

Java 

public class YourCustomAppCheckToken extends AppCheckToken {
    private String token;
    private long expiration;

    YourCustomAppCheckToken(String token, long expiration) {
        this.token = token;
        this.expiration = expiration;
    }

    @NonNull
    @Override
    public String getToken() {
        return token;
    }

    @Override
    public long getExpireTimeMillis() {
        return expiration;
    }
}

public class YourCustomAppCheckProvider implements AppCheckProvider {
    public YourCustomAppCheckProvider(FirebaseApp firebaseApp) {
        // ...
    }

    @NonNull
    @Override
    public Task<AppCheckToken> getToken() {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        long expMillis = expirationFromServer * 1000L - 60000L;

        // Create AppCheckToken object.
        AppCheckToken appCheckToken =
                new YourCustomAppCheckToken(tokenFromServer, expMillis);

        return Tasks.forResult(appCheckToken);
    }
}
CustomProvider.java

साथ ही, एक AppCheckProviderFactory क्लास लागू करें, जो आपके AppCheckProvider लागू करने के इंस्टेंस बनाती है:

Kotlin+KTX 

class YourCustomAppCheckProviderFactory : AppCheckProviderFactory {
    override fun create(firebaseApp: FirebaseApp): AppCheckProvider {
        // Create and return an AppCheckProvider object.
        return YourCustomAppCheckProvider(firebaseApp)
    }
}
CustomProvider.kt

Java 

public class YourCustomAppCheckProviderFactory implements AppCheckProviderFactory {
    @NonNull
    @Override
    public AppCheckProvider create(@NonNull FirebaseApp firebaseApp) {
        // Create and return an AppCheckProvider object.
        return new YourCustomAppCheckProvider(firebaseApp);
    }
}
CustomProvider.java

3. App Check शुरू करना

अपने ऐप्लिकेशन में नीचे दिया गया कोड जोड़ें, ताकि किसी भी दूसरे Firebase SDK टूल का इस्तेमाल करने से पहले, यह कोड चल सके:

Kotlin+KTX 

Firebase.initialize(context)
Firebase.appCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory(),
)
CustomProvider.kt

Java 

FirebaseApp.initializeApp(/*context=*/ context);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        new YourCustomAppCheckProviderFactory());
CustomProvider.java

अगले चरण

App Check लाइब्रेरी आपके ऐप्लिकेशन में इंस्टॉल हो जाने के बाद, अपने उपयोगकर्ताओं को अपडेट किया गया ऐप्लिकेशन डिस्ट्रिब्यूट करना शुरू करें.

अपडेट किया गया क्लाइंट ऐप्लिकेशन, Firebase को किए जाने वाले हर अनुरोध के साथ App Check टोकन भेजना शुरू कर देगा. हालांकि, Firebase के प्रॉडक्ट के लिए टोकन तब तक मान्य नहीं होने चाहिए, जब तक Firebase कंसोल के App Check सेक्शन में नीति उल्लंघन ठीक करने की सुविधा चालू नहीं की जाती.

मेट्रिक मॉनिटर करना और नीति उल्लंघन ठीक करने की सुविधा चालू करना

हालांकि, नीति उल्लंघन ठीक करने की सुविधा चालू करने से पहले, आपको यह पक्का करना होगा कि इससे आपके मौजूदा मान्य उपयोगकर्ताओं को कोई परेशानी न हो. दूसरी ओर, अगर आपको अपने ऐप्लिकेशन के संसाधनों का संदिग्ध इस्तेमाल दिख रहा है, तो हो सकता है कि आप जल्द से जल्द नीति उल्लंघन ठीक करने की सुविधा चालू करना चाहें.

यह फ़ैसला लेने में मदद पाने के लिए, इस्तेमाल की जा रही सेवाओं के लिए App Check मेट्रिक देखी जा सकती हैं:

App Check एनफ़ोर्समेंट चालू करना

जब आपको यह समझ आ जाए कि App Check से आपके उपयोगकर्ताओं पर क्या असर पड़ेगा और आप आगे बढ़ने के लिए तैयार हों, तो App Check लागू करने की सुविधा चालू की जा सकती है:

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

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

Android पर डीबग प्रोवाइडर के साथ App Check का इस्तेमाल करना देखें.