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

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

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

Kotlin+KTX

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

Java

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

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

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

Kotlin+KTX

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

Java

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

अगले चरण

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 का इस्तेमाल करना देखें.